DaemonApplication
Extends CliApplicationClass to turn CliApplication applications into daemons. It requires CLI and PCNTL support built into PHP.
link | |
---|---|
since |
1.7.0 |
package |
Joomla CMS |
Methods
__construct
Class constructor.
__construct(\Joomla\CMS\Input\Cli input = null, \Joomla\Registry\Registry config = null, \Joomla\Event\DispatcherInterface dispatcher = null) :
since |
1.7.0 |
---|
Arguments
- input
Cli
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.- config
Registry
An optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.- dispatcher
DispatcherInterface
An optional argument to provide dependency injection for the application's event dispatcher. If the argument is a DispatcherInterface 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.
Response
mixed
__get
Magic method to access properties of the application.
__get( name) :
since |
4.0.0 |
---|---|
deprecated |
4.0 will be removed in 6.0 This is a B/C proxy for deprecated read accesses Example: Factory::getApplication()->getInput(); |
Arguments
- name
string
The name of the property.
Response
mixed
A value if the property name is valid, null otherwise.
bootComponent
Boots the component with the given name.
bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface
bootModule
Boots the module with the given name.
bootModule( module, applicationName) : \Joomla\CMS\Extension\ModuleInterface
since |
4.0.0 |
---|
Arguments
- module
string
The module to boot- applicationName
string
The application name
Response
bootPlugin
Boots the plugin with the given name and type.
bootPlugin( plugin, type) : \Joomla\CMS\Extension\PluginInterface
since |
4.0.0 |
---|
Arguments
- plugin
string
The plugin name- type
string
The type of the plugin
Response
changeIdentity
Method to change the identity of the daemon process and resources.
changeIdentity() :
since |
1.7.0 |
---|---|
see | posix_setuid() |
Response
bool
True if identity successfully changed
createExtensionNamespaceMap
Allows the application to load a custom or default identity.
createExtensionNamespaceMap() :
since |
4.0.0 |
---|
Response
void
daemonize
Method to put the application into the background.
daemonize() :
since |
1.7.0 |
---|---|
throws |
|
Response
bool
detach
This is truly where the magic happens. This is where we fork the process and kill the parent process, which is essentially what turns the application into a daemon.
detach() :
since |
3.0.0 |
---|---|
throws |
|
Response
void
enqueueMessage
Enqueue a system message.
enqueueMessage( msg, type = self::MSG_INFO) :
since |
4.0.0 |
---|
Arguments
- msg
string
The message to enqueue.- type
string
The message type.
Response
void
execute
Execute the daemon.
execute() :
since |
1.7.0 |
---|
Response
void
fork
Method to fork the process.
fork() :
since |
1.7.0 |
---|---|
throws |
|
Response
int
The child process id to the parent process, zero to the child process.
gc
Method to perform basic garbage collection and memory management in the sense of clearing the stat cache. We will probably call this method pretty regularly in our main loop.
gc() :
since |
1.7.0 |
---|
Response
void
getCliInput
Get a CLI input object.
getCliInput() : \Joomla\CMS\Application\CLI\CliInput
getConfig
Retrieve the application configuration object.
getConfig() : \Joomla\Registry\Registry
since |
4.0.0 |
---|
Response
Registry
getContainer
Get the DI container.
getContainer() : \Joomla\DI\Container
since |
4.0.0 |
---|---|
throws |
|
Response
Container
getDispatcher
Get the event dispatcher.
getDispatcher() : \Joomla\Event\DispatcherInterface
since |
4.0.0 |
---|---|
throws |
|
Response
DispatcherInterface
getIdentity
Get the application identity.
getIdentity() : \Joomla\CMS\User\User
getInput
Method to get the application input object.
getInput() : \Joomla\Input\Input
since |
4.0.0 |
---|
Response
Input
getInstance
Returns a reference to the global CliApplication object, only creating it if it doesn't already exist.
getInstance( name = null) : \Joomla\CMS\Application\CliApplication
This method must be invoked as: $cli = CliApplication::getInstance();
since |
1.7.0 |
---|---|
deprecated |
4.0 will be removed in 6.0 Load the app through the container or via the Factory Example: Factory::getContainer()->get(CliApplication::class) |
throws |
|
Arguments
- name
string
The name (optional) of the Application Cli class to instantiate.
Response
getLanguage
Method to get the application language object.
getLanguage() : \Joomla\CMS\Language\Language
getLogger
Get the logger.
getLogger() : \Psr\Log\LoggerInterface
since |
4.0.0 |
---|
Response
LoggerInterface
getMessageQueue
Get the system message queue.
getMessageQueue() : mixed||string|int
since |
4.0.0 |
---|
Response
array<string|int, mixed>
The system message queue.
getOutput
Get an output object.
getOutput() : \Joomla\CMS\Application\CLI\CliOutput
getSession
Method to get the application session object.
getSession() : \Joomla\Session\SessionInterface
since |
4.0.0 |
---|
Response
SessionInterface
The session object
in
Get a value from standard input.
in() :
since |
4.0.0 |
---|
Response
string
The input string from standard input.
isActive
Check to see if the daemon is active. This does not assume that $this daemon is active, but only if an instance of the application is active as a daemon.
isActive() :
since |
1.7.0 |
---|
Response
bool
True if daemon is active.
isCli
Flag if the application instance is a CLI or web based application.
isCli() :
Helper function, you should use the native PHP functions to detect if it is a CLI application.
since |
4.0.0 |
---|---|
deprecated |
4.0 will be removed in 6.0 Will be removed without replacements |
Response
bool
isClient
Check the client interface by name.
isClient( identifier) :
since |
4.0.0 |
---|
Arguments
- identifier
string
String identifier for the application interface
Response
bool
True if this application is of the given type client interface.
loadConfiguration
Load an object or array into the application configuration object.
loadConfiguration( data) : \Joomla\CMS\Application\DaemonApplication
since |
1.7.0 |
---|
Arguments
- data
mixed
Either an array or object to be loaded into the configuration object.
Response
DaemonApplication
Instance of $this to allow chaining.
loadExtension
Loads the extension.
loadExtension( type, extensionName, extensionPath) : \Joomla\CMS\Extension\ComponentInterface|\Joomla\CMS\Extension\ModuleInterface|\Joomla\CMS\Extension\PluginInterface
since |
4.0.0 |
---|
Arguments
- type
string
The extension type- extensionName
string
The extension name- extensionPath
string
The path of the extension
Response
loadIdentity
Allows the application to load a custom or default identity.
loadIdentity(\Joomla\CMS\User\User identity = null) :
since |
4.0.0 |
---|
Arguments
- identity
User
An optional identity object. If omitted, a null user object is created.
Response
$this
loadPluginFromFilesystem
Creates a CMS plugin from the filesystem.
loadPluginFromFilesystem( plugin, type) : \Joomla\CMS\Plugin\CMSPlugin
out
Write a string to standard output.
out( text = '', nl = true) :
since |
4.0.0 |
---|
Arguments
- text
string
The text to display.- nl
bool
True (default) to append a new line at the end of the output string.
Response
$this
pcntlChildExitStatus
Method to return the exit code of a terminated child process.
pcntlChildExitStatus( status) :
see | pcntl_wexitstatus() |
---|---|
since |
1.7.3 |
Arguments
- status
int
The status parameter is the status parameter supplied to a successful call to pcntl_waitpid().
Response
int
The child process exit code.
pcntlFork
Method to return the exit code of a terminated child process.
pcntlFork() :
see | pcntl_fork() |
---|---|
since |
1.7.3 |
Response
int
On success, the PID of the child process is returned in the parent's thread
of execution, and a 0 is returned in the child's thread of execution. On
failure, a -1 will be returned in the parent's context, no child process
will be created, and a PHP error is raised.
pcntlSignal
Method to install a signal handler.
pcntlSignal( signal, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array handler, restart = true) :
see | pcntl_signal() |
---|---|
since |
1.7.3 |
Arguments
- signal
int
The signal number.- handler
callable
The signal handler which may be the name of a user created function, or method, or either of the two global constants SIG_IGN or SIG_DFL.- restart
bool
Specifies whether system call restarting should be used when this signal arrives.
Response
bool
True on success.
pcntlWait
Method to wait on or return the status of a forked child.
pcntlWait( &status, options) :
see | pcntl_wait() |
---|---|
since |
1.7.3 |
Arguments
- status
int
Status information.- options
int
If wait3 is available on your system (mostly BSD-style systems), you can provide the optional options parameter.
Response
int
The process ID of the child which exited, -1 on error or zero if WNOHANG
was provided as an option (on wait3-available systems) and no child was available.
postFork
Method to handle post-fork triggering of the onFork event.
postFork() :
since |
3.0.0 |
---|
Response
void
registerEvent
Registers a handler to a particular event group.
registerEvent( event, Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array handler) :
since |
4.0.0 |
---|
Arguments
- event
string
The event name.- handler
callable
The handler, a function or an instance of an event object.
Response
$this
restart
Restart daemon process.
restart() :
since |
1.7.0 |
---|
Response
void
setOutput
Set an output object.
setOutput(\Joomla\CMS\Application\CLI\CliOutput output) :
setupSignalHandlers
Method to attach the DaemonApplication signal handler to the known signals. Applications can override these handlers by using the pcntl_signal() function and attaching a different callback method.
setupSignalHandlers() :
since |
1.7.0 |
---|---|
see | pcntl_signal() |
Response
bool
shutdown
Method to shut down the daemon and optionally restart it.
shutdown( restart = false) :
since |
1.7.0 |
---|
Arguments
- restart
bool
True to restart the daemon on exit.
Response
void
signal
Method to handle POSIX signals.
signal( signal) :
since |
1.7.0 |
---|---|
see | pcntl_signal() |
throws |
|
Arguments
- signal
int
The received POSIX signal.
Response
void
stop
Stop daemon process.
stop() :
since |
1.7.0 |
---|
Response
void
triggerEvent
Calls all handlers associated with an event group.
triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
This is a legacy method, implementing old-style (Joomla! 3.x) plugin calls. It's best to go directly through the Dispatcher and handle the returned EventInterface object instead of going through this method. This method is deprecated and will be removed in Joomla! 5.x.
This method will only return the 'result' argument of the event
since |
4.0.0 |
---|---|
throws |
|
deprecated |
4.0 will be removed in 6.0 Use the Dispatcher method instead Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event); |
Arguments
- eventName
string
The event name.- args
array<string|int, mixed>|Event
An array of arguments or an Event object (optional).
Response
array<string|int, mixed>
An array of results from each function call. Note this will be an empty array if no dispatcher is set.
writeProcessIdFile
Method to write the process id file out to disk.
writeProcessIdFile() :
since |
1.7.0 |
---|
Response
bool
Properties
input
The input.
since |
4.0.0 |
---|
Type(s)
Input
messages
The application message queue.
since |
4.0.0 |
---|
Type(s)
array<string|int, mixed>
signals
The available POSIX signals to be caught by default.
link | |
---|---|
since |
1.7.0 |
Type(s)
array<string|int, mixed>
exiting
True if the daemon is in the process of exiting.
since |
1.7.0 |
---|
Type(s)
bool
parentId
The parent process id.
since |
3.0.0 |
---|
Type(s)
int
processId
The process id of the daemon.
since |
1.7.0 |
---|
Type(s)
int
running
True if the daemon is currently running.
since |
1.7.0 |
---|
Type(s)
bool