You've already forked joomla_test
first commit
This commit is contained in:
alazhar
294
libraries/joomla/application/cli.php
Normal file
294
libraries/joomla/application/cli.php
Normal file
@ -0,0 +1,294 @@
|
||||
<?php
|
||||
/**
|
||||
* @package Joomla.Platform
|
||||
* @subpackage Application
|
||||
*
|
||||
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
||||
* @license GNU General Public License version 2 or later; see LICENSE
|
||||
*/
|
||||
|
||||
defined('JPATH_PLATFORM') or die;
|
||||
|
||||
/**
|
||||
* Base class for a Joomla! command line application.
|
||||
*
|
||||
* @package Joomla.Platform
|
||||
* @subpackage Application
|
||||
* @since 11.4
|
||||
*/
|
||||
class JApplicationCli extends JApplicationBase
|
||||
{
|
||||
/**
|
||||
* @var JRegistry The application configuration object.
|
||||
* @since 11.1
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @var JApplicationCli The application instance.
|
||||
* @since 11.1
|
||||
*/
|
||||
protected static $instance;
|
||||
|
||||
/**
|
||||
* Class constructor.
|
||||
*
|
||||
* @param mixed $input An optional argument to provide dependency injection for the application's
|
||||
* input object. If the argument is a JInputCli object that object will become
|
||||
* the application's input object, otherwise a default input object is created.
|
||||
* @param mixed $config An optional argument to provide dependency injection for the application's
|
||||
* config object. If the argument is a JRegistry object that object will become
|
||||
* the application's config object, otherwise a default config object is created.
|
||||
* @param mixed $dispatcher An optional argument to provide dependency injection for the application's
|
||||
* event dispatcher. If the argument is a JEventDispatcher object that object will become
|
||||
* the application's event dispatcher, if it is null then the default event dispatcher
|
||||
* will be created based on the application's loadDispatcher() method.
|
||||
*
|
||||
* @see loadDispatcher()
|
||||
* @since 11.1
|
||||
*/
|
||||
public function __construct(JInputCli $input = null, JRegistry $config = null, JEventDispatcher $dispatcher = null)
|
||||
{
|
||||
// Close the application if we are not executed from the command line.
|
||||
// @codeCoverageIgnoreStart
|
||||
if (!defined('STDOUT') || !defined('STDIN') || !isset($_SERVER['argv']))
|
||||
{
|
||||
$this->close();
|
||||
}
|
||||
// @codeCoverageIgnoreEnd
|
||||
|
||||
// If a input object is given use it.
|
||||
if ($input instanceof JInput)
|
||||
{
|
||||
$this->input = $input;
|
||||
}
|
||||
// Create the input based on the application logic.
|
||||
else
|
||||
{
|
||||
if (class_exists('JInput'))
|
||||
{
|
||||
$this->input = new JInputCLI;
|
||||
}
|
||||
}
|
||||
|
||||
// If a config object is given use it.
|
||||
if ($config instanceof JRegistry)
|
||||
{
|
||||
$this->config = $config;
|
||||
}
|
||||
// Instantiate a new configuration object.
|
||||
else
|
||||
{
|
||||
$this->config = new JRegistry;
|
||||
}
|
||||
|
||||
$this->loadDispatcher($dispatcher);
|
||||
|
||||
// Load the configuration object.
|
||||
$this->loadConfiguration($this->fetchConfigurationData());
|
||||
|
||||
// Set the execution datetime and timestamp;
|
||||
$this->set('execution.datetime', gmdate('Y-m-d H:i:s'));
|
||||
$this->set('execution.timestamp', time());
|
||||
|
||||
// Set the current directory.
|
||||
$this->set('cwd', getcwd());
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a property of the object or the default value if the property is not set.
|
||||
*
|
||||
* @param string $key The name of the property.
|
||||
* @param mixed $default The default value (optional) if none is set.
|
||||
*
|
||||
* @return mixed The value of the configuration.
|
||||
*
|
||||
* @since 11.3
|
||||
*/
|
||||
public function get($key, $default = null)
|
||||
{
|
||||
return $this->config->get($key, $default);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a reference to the global JApplicationCli object, only creating it if it doesn't already exist.
|
||||
*
|
||||
* This method must be invoked as: $cli = JApplicationCli::getInstance();
|
||||
*
|
||||
* @param string $name The name (optional) of the JApplicationCli class to instantiate.
|
||||
*
|
||||
* @return JApplicationCli
|
||||
*
|
||||
* @since 11.1
|
||||
*/
|
||||
public static function getInstance($name = null)
|
||||
{
|
||||
// Only create the object if it doesn't exist.
|
||||
if (empty(self::$instance))
|
||||
{
|
||||
if (class_exists($name) && (is_subclass_of($name, 'JApplicationCli')))
|
||||
{
|
||||
self::$instance = new $name;
|
||||
}
|
||||
else
|
||||
{
|
||||
self::$instance = new JApplicationCli;
|
||||
}
|
||||
}
|
||||
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute the application.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 11.1
|
||||
*/
|
||||
public function execute()
|
||||
{
|
||||
// Trigger the onBeforeExecute event.
|
||||
$this->triggerEvent('onBeforeExecute');
|
||||
|
||||
// Perform application routines.
|
||||
$this->doExecute();
|
||||
|
||||
// Trigger the onAfterExecute event.
|
||||
$this->triggerEvent('onAfterExecute');
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an object or array into the application configuration object.
|
||||
*
|
||||
* @param mixed $data Either an array or object to be loaded into the configuration object.
|
||||
*
|
||||
* @return JApplicationCli Instance of $this to allow chaining.
|
||||
*
|
||||
* @since 11.1
|
||||
*/
|
||||
public function loadConfiguration($data)
|
||||
{
|
||||
// Load the data into the configuration object.
|
||||
if (is_array($data))
|
||||
{
|
||||
$this->config->loadArray($data);
|
||||
}
|
||||
elseif (is_object($data))
|
||||
{
|
||||
$this->config->loadObject($data);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write a string to standard output.
|
||||
*
|
||||
* @param string $text The text to display.
|
||||
* @param boolean $nl True (default) to append a new line at the end of the output string.
|
||||
*
|
||||
* @return JApplicationCli Instance of $this to allow chaining.
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @since 11.1
|
||||
*/
|
||||
public function out($text = '', $nl = true)
|
||||
{
|
||||
fwrite(STDOUT, $text . ($nl ? "\n" : null));
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a value from standard input.
|
||||
*
|
||||
* @return string The input string from standard input.
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @since 11.1
|
||||
*/
|
||||
public function in()
|
||||
{
|
||||
return rtrim(fread(STDIN, 8192), "\n");
|
||||
}
|
||||
|
||||
/**
|
||||
* Modifies a property of the object, creating it if it does not already exist.
|
||||
*
|
||||
* @param string $key The name of the property.
|
||||
* @param mixed $value The value of the property to set (optional).
|
||||
*
|
||||
* @return mixed Previous value of the property
|
||||
*
|
||||
* @since 11.3
|
||||
*/
|
||||
public function set($key, $value = null)
|
||||
{
|
||||
$previous = $this->config->get($key);
|
||||
$this->config->set($key, $value);
|
||||
|
||||
return $previous;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to load a PHP configuration class file based on convention and return the instantiated data object. You
|
||||
* will extend this method in child classes to provide configuration data from whatever data source is relevant
|
||||
* for your specific application.
|
||||
*
|
||||
* @param string $file The path and filename of the configuration file. If not provided, configuration.php
|
||||
* in JPATH_BASE will be used.
|
||||
* @param string $class The class name to instantiate.
|
||||
*
|
||||
* @return mixed Either an array or object to be loaded into the configuration object.
|
||||
*
|
||||
* @since 11.1
|
||||
*/
|
||||
protected function fetchConfigurationData($file = '', $class = 'JConfig')
|
||||
{
|
||||
// Instantiate variables.
|
||||
$config = array();
|
||||
|
||||
if (empty($file) && defined('JPATH_BASE'))
|
||||
{
|
||||
$file = JPATH_BASE . '/configuration.php';
|
||||
|
||||
// Applications can choose not to have any configuration data
|
||||
// by not implementing this method and not having a config file.
|
||||
if (!file_exists($file))
|
||||
{
|
||||
$file = '';
|
||||
}
|
||||
}
|
||||
|
||||
if (!empty($file))
|
||||
{
|
||||
JLoader::register($class, $file);
|
||||
|
||||
if (class_exists($class))
|
||||
{
|
||||
$config = new $class;
|
||||
}
|
||||
else
|
||||
{
|
||||
throw new RuntimeException('Configuration class does not exist.');
|
||||
}
|
||||
}
|
||||
|
||||
return $config;
|
||||
}
|
||||
|
||||
/**
|
||||
* Method to run the application routines. Most likely you will want to instantiate a controller
|
||||
* and execute it, or perform some sort of task directly.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
* @since 11.3
|
||||
*/
|
||||
protected function doExecute()
|
||||
{
|
||||
// Your application routines go here.
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user