1
0
mirror of synced 2024-12-14 23:26:04 +03:00
doctrine2/lib/Doctrine/Task.php

230 lines
5.4 KiB
PHP
Raw Normal View History

<?php
/*
* $Id: Task.php 2761 2007-10-07 23:42:29Z zYne $
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.phpdoctrine.org>.
*/
/**
2007-10-20 06:30:15 +04:00
* Doctrine_Task
*
* Abstract class used for writing Doctrine Tasks
*
* @package Doctrine
* @subpackage Task
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.phpdoctrine.org
* @since 1.0
* @version $Revision: 2761 $
* @author Jonathan H. Wage <jwage@mac.com>
*/
abstract class Doctrine_Task
{
public $dispatcher = null,
$taskName = null,
2007-10-10 06:31:11 +04:00
$description = null,
2007-10-10 07:45:02 +04:00
$arguments = array(),
2007-10-10 06:31:11 +04:00
$requiredArguments = array(),
$optionalArguments = array();
/**
* __construct
*
2007-10-20 06:30:15 +04:00
* Since this is an abstract classes that extend this must follow a patter of Doctrine_Task_{TASK_NAME}
* This is what determines the task name for executing it.
*
* @return void
*/
public function __construct($dispatcher = null)
{
$this->dispatcher = $dispatcher;
$this->taskName = str_replace('_', '-', Doctrine::tableize(str_replace('Doctrine_Task_', '', get_class($this))));
}
/**
* notify
*
* @param string $notification
* @return void
*/
public function notify($notification = null)
{
if (is_object($this->dispatcher) && method_exists($this->dispatcher, 'notify')) {
$args = func_get_args();
return call_user_func_array(array($this->dispatcher, 'notify'), $args);
} else {
return $notification;
}
}
/**
* ask
*
* @return void
*/
public function ask()
{
$args = func_get_args();
call_user_func_array(array($this, 'notify'), $args);
$answer = strtolower(trim(fgets(STDIN)));
return $answer;
}
/**
* execute
*
* Override with each task class
*
* @return void
2007-10-20 06:30:15 +04:00
* @abstract
*/
2007-10-10 07:45:02 +04:00
abstract function execute();
/**
* validate
*
* Validates that all required fields are present
*
2007-10-20 06:30:15 +04:00
* @return bool true
*/
public function validate()
2007-10-10 06:31:11 +04:00
{
$requiredArguments = $this->getRequiredArguments();
foreach ($requiredArguments as $arg) {
if ( ! isset($this->arguments[$arg])) {
return false;
2007-10-10 06:31:11 +04:00
}
}
return true;
}
/**
* addArgument
*
* @param string $name
* @param string $value
* @return void
*/
public function addArgument($name, $value)
{
$this->arguments[$name] = $value;
}
/**
* getArgument
*
* @param string $name
* @param string $default
2007-10-20 06:30:15 +04:00
* @return mixed
*/
public function getArgument($name, $default = null)
2007-10-10 07:45:02 +04:00
{
if (isset($this->arguments[$name]) && $this->arguments[$name] !== null) {
return $this->arguments[$name];
} else {
return $default;
}
2007-10-10 07:45:02 +04:00
}
/**
* getArguments
*
* @return array $arguments
*/
2007-10-10 07:45:02 +04:00
public function getArguments()
2007-10-10 06:31:11 +04:00
{
2007-10-10 07:45:02 +04:00
return $this->arguments;
2007-10-10 06:31:11 +04:00
}
/**
* setArguments
*
2007-10-20 06:30:15 +04:00
* @param array $args
* @return void
*/
2007-10-20 06:30:15 +04:00
public function setArguments(array $args)
{
$this->arguments = $args;
}
/**
* getTaskName
*
2007-10-20 06:30:15 +04:00
* @return string $taskName
*/
2007-10-10 06:31:11 +04:00
public function getTaskName()
{
return $this->taskName;
}
/**
* getDescription
*
2007-10-20 06:30:15 +04:00
* @return string $description
*/
2007-10-10 06:31:11 +04:00
public function getDescription()
{
return $this->description;
}
/**
* getRequiredArguments
*
2007-10-20 06:30:15 +04:00
* @return array $requiredArguments
*/
2007-10-10 06:31:11 +04:00
public function getRequiredArguments()
{
2007-10-10 07:45:02 +04:00
return array_keys($this->requiredArguments);
2007-10-10 06:31:11 +04:00
}
/**
* getOptionalArguments
*
2007-10-20 06:30:15 +04:00
* @return array $optionalArguments
*/
2007-10-10 06:31:11 +04:00
public function getOptionalArguments()
2007-10-10 07:45:02 +04:00
{
return array_keys($this->optionalArguments);
}
/**
* getRequiredArgumentsDescriptions
*
2007-10-20 06:30:15 +04:00
* @return array $requiredArgumentsDescriptions
*/
2007-10-10 07:45:02 +04:00
public function getRequiredArgumentsDescriptions()
{
return $this->requiredArguments;
}
/**
* getOptionalArgumentsDescriptions
*
2007-10-20 06:30:15 +04:00
* @return array $optionalArgumentsDescriptions
*/
2007-10-10 07:45:02 +04:00
public function getOptionalArgumentsDescriptions()
2007-10-10 06:31:11 +04:00
{
return $this->optionalArguments;
}
}