Class \Prado\Shell\TShellApplication

TShellApplication class.

TShellApplication is the base class for developing command-line PRADO tools that share the same configurations as their Web application counterparts.

A typical usage of TShellApplication in a command-line PHP script is as follows:

require 'path/to/vendor/autoload.php';
$application=new TShellApplication('path/to/application.xml');
$application->run($_SERVER);
// perform command-line tasks here

Since the application instance has access to all configurations, including path aliases, modules and parameters, the command-line script has nearly the same accessibility to resources as the PRADO Web applications.

Class hierarchy

\Prado\Shell\TShellApplication

\Prado\TApplication implements ISingleton

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Author: Brad Anderson <belisoful@icloud.com> shell refactor
Since: 3.1.0

Methods summary
`public`	`addShellActionClass(string $class) : mixed`
`public static`	`detectCronTabShell() : bool` This checks if shell environment is from a system CronTab.
`public`	`flushOutput([bool $continueBuffering = true ]) : mixed` Flushes output to shell.
`public`	`getQuietMode() : int`
`public`	`getShellActions() : array<string\|int, TShellAction>`
`public`	`getWriter() : TShellWriter`
`public`	`installShellActions() : mixed` Installs the shell actions.
`public`	`printGreeting(mixed $outWriter) : mixed`
`public`	`printHelp(mixed $outWriter) : mixed` Print command line help, default action.
`public`	`processActionArguments(array<string\|int, mixed> &$args, TShellAction $action, string $method) : mixed` This processes the arguments entered into the cli
`public`	`processArguments(object $sender, mixed $param) : mixed` This processes the arguments entered into the cli. This is processed after the application is initialized and modules can
`public`	`registerOption(string $name, callable $setCallback[, string $description = '' ][, string $values = '' ]) : mixed` This registers shell command line options and the setter callback
`public`	`registerOptionAlias(string $alias, string $name) : mixed` This registers shell command line option aliases and linked variable
`public`	`run([null\|array<string\|int, string> $args = null ]) : mixed` Runs the application. This method overrides the parent implementation by initializing application with configurations specified when it is created.
`public`	`runService() : mixed` Runs the requested service.
`public`	`setQuietMode(int $quietMode) : mixed`
`public`	`setWriter(TShellWriter $writer) : mixed`
`private`	`detectShellLanguageCharset() : mixed` This takes the shell LANG and sets the HTTP_ACCEPT_LANGUAGE/HTTP_ACCEPT_CHARSET for the application to do I18N.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, applyConfiguration, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearGlobalState, completeRequest, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, flushOutput, fxAttachClassBehavior, fxDetachClassBehavior, getApplicationStatePersister, getAssetManager, getAuthorizationRules, getAutoGlobalListen, getBasePath, getBehaviors, getBehaviorsEnabled, getCache, getClassHierarchy, getConfigurationFile, getConfigurationFileExt, getConfigurationFileName, getConfigurationType, getErrorHandler, getEventHandlers, getGlobalization, getGlobalState, getID, getListeningToGlobalEvents, getMode, getModule, getModules, getModulesByType, getPageServiceID, getParameters, getRequest, getRequestCompleted, getResponse, getRuntimePath, getSecurityManager, getService, getSession, getSubProperty, getTemplateManager, getThemeManager, getUniqueID, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, onAuthentication, onAuthenticationComplete, onAuthorization, onAuthorizationComplete, onBeginRequest, onEndRequest, onError, onInitComplete, onLoadState, onLoadStateComplete, onPreFlushOutput, onPreRunService, onSaveState, onSaveStateComplete, onSetUser, raiseEvent, run, runService, setApplicationStatePersister, setAssetManager, setBasePath, setCache, setConfigurationFile, setConfigurationType, setErrorHandler, setGlobalization, setGlobalState, setID, setMode, setModule, setPageServiceID, setRequest, setResponse, setRuntimePath, setSecurityManager, setService, setSession, setSubProperty, setTemplateManager, setThemeManager, setUser, singleton, startService, unlisten, _getZappableSleepProps, getApplicationConfigurationClass, getCallChain, getClassFxEvents, initApplication, instanceBehavior, internalLoadModule, loadGlobals, resolvePaths, saveGlobals, filter_prado_fx

Inherited constants
`\Prado\TApplication::CONFIG_FILE_EXT_PHP, \Prado\TApplication::CONFIG_FILE_EXT_XML, \Prado\TApplication::CONFIG_FILE_PHP, \Prado\TApplication::CONFIG_FILE_XML, \Prado\TApplication::CONFIG_TYPE_PHP, \Prado\TApplication::CONFIG_TYPE_XML, \Prado\TApplication::CONFIGCACHE_FILE, \Prado\TApplication::GLOBAL_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\TApplication::PAGE_SERVICE_ID, \Prado\TApplication::RUNTIME_PATH`

Classes

Interfaces

Traits

Search results

Class \Prado\Shell\TShellApplication

Class hierarchy