Joomla! API

Download
Launch

DaemonApplication

Extends CliApplication

Class to turn CliApplication applications into daemons. It requires CLI and PCNTL support built into PHP.

abstract
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

CliAn 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

RegistryAn 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

DispatcherInterfaceAn 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) :
inherited deprecated
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

stringThe name of the property.

Response

mixedA value if the property name is valid, null otherwise.

bootComponent

Boots the component with the given name.

bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface
inherited
since

4.0.0

Arguments

component

stringThe component to boot.

Response

ComponentInterface

bootModule

Boots the module with the given name.

bootModule( module,  applicationName) : \Joomla\CMS\Extension\ModuleInterface
inherited
since

4.0.0

Arguments

module

stringThe module to boot

applicationName

stringThe application name

Response

ModuleInterface

bootPlugin

Boots the plugin with the given name and type.

bootPlugin( plugin,  type) : \Joomla\CMS\Extension\PluginInterface
inherited
since

4.0.0

Arguments

plugin

stringThe plugin name

type

stringThe type of the plugin

Response

PluginInterface

changeIdentity

Method to change the identity of the daemon process and resources.

changeIdentity() :
since

1.7.0
see posix_setuid()

Response

boolTrue if identity successfully changed

createExtensionNamespaceMap

Allows the application to load a custom or default identity.

createExtensionNamespaceMap() :
inherited
since

4.0.0

Response

void

daemonize

Method to put the application into the background.

daemonize() :
since

1.7.0
throws

RuntimeException

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

RuntimeException

Response

void

enqueueMessage

Enqueue a system message.

enqueueMessage( msg,  type = self::MSG_INFO) :
inherited
since

4.0.0

Arguments

msg

stringThe message to enqueue.

type

stringThe 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

RuntimeException

Response

intThe 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
inherited
since

4.0.0

Response

CliInput

getConfig

Retrieve the application configuration object.

getConfig() : \Joomla\Registry\Registry
inherited
since

4.0.0

Response

Registry

getContainer

Get the DI container.

getContainer() : \Joomla\DI\Container
inherited abstract
since

4.0.0
throws

ContainerNotFoundExceptionMay be thrown if the container has not been set.

Response

Container

getDispatcher

Get the event dispatcher.

getDispatcher() : \Joomla\Event\DispatcherInterface
inherited abstract
since

4.0.0
throws

UnexpectedValueExceptionMay be thrown if the dispatcher has not been set.

Response

DispatcherInterface

getIdentity

Get the application identity.

getIdentity() : \Joomla\CMS\User\User
inherited
since

4.0.0

Response

User

getInput

Method to get the application input object.

getInput() : \Joomla\Input\Input
inherited
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
inherited static deprecated

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

RuntimeException

Arguments

name

stringThe name (optional) of the Application Cli class to instantiate.

Response

CliApplication

getLanguage

Method to get the application language object.

getLanguage() : \Joomla\CMS\Language\Language
inherited
since

4.0.0

Response

LanguageThe language object

getLogger

Get the logger.

getLogger() : \Psr\Log\LoggerInterface
inherited abstract
since

4.0.0

Response

LoggerInterface

getMessageQueue

Get the system message queue.

getMessageQueue() : mixed||string|int
inherited
since

4.0.0

Response

array<string|int, mixed>The system message queue.

getOutput

Get an output object.

getOutput() : \Joomla\CMS\Application\CLI\CliOutput
inherited
since

4.0.0

Response

CliOutput

getSession

Method to get the application session object.

getSession() : \Joomla\Session\SessionInterface
inherited
since

4.0.0

Response

SessionInterfaceThe session object

in

Get a value from standard input.

in() :
inherited
since

4.0.0

Response

stringThe 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

boolTrue if daemon is active.

isCli

Flag if the application instance is a CLI or web based application.

isCli() :
inherited deprecated

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) :
inherited
since

4.0.0

Arguments

identifier

stringString identifier for the application interface

Response

boolTrue 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

mixedEither an array or object to be loaded into the configuration object.

Response

DaemonApplicationInstance 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
inherited
since

4.0.0

Arguments

type

stringThe extension type

extensionName

stringThe extension name

extensionPath

stringThe path of the extension

Response

ComponentInterface|ModuleInterface|PluginInterface

loadIdentity

Allows the application to load a custom or default identity.

loadIdentity(\Joomla\CMS\User\User identity = null) :
inherited
since

4.0.0

Arguments

identity

UserAn 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
inherited
since

4.0.0

Arguments

plugin

stringThe plugin

type

stringThe type

Response

CMSPlugin

out

Write a string to standard output.

out( text = '',  nl = true) :
inherited
since

4.0.0

Arguments

text

stringThe text to display.

nl

boolTrue (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

intThe status parameter is the status parameter supplied to a successful call to pcntl_waitpid().

Response

intThe 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

intOn 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

intThe signal number.

handler

callableThe 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

boolSpecifies whether system call restarting should be used when this signal arrives.

Response

boolTrue 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

intStatus information.

options

intIf wait3 is available on your system (mostly BSD-style systems), you can provide the optional options parameter.

Response

intThe 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) :
inherited
since

4.0.0

Arguments

event

stringThe event name.

handler

callableThe 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) :
inherited
since

3.3

Arguments

output

CliOutputCliOutput object

Response

$this

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

boolTrue to restart the daemon on exit.

Response

void

signal

Method to handle POSIX signals.

signal( signal) :
static
since

1.7.0
see pcntl_signal()
throws

RuntimeException

Arguments

signal

intThe 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
inherited deprecated

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

InvalidArgumentException
deprecated

4.0 will be removed in 6.0 Use the Dispatcher method instead Example: Factory::getApplication()->getDispatcher()->dispatch($eventName, $event);

Arguments

eventName

stringThe event name.

args

array<string|int, mixed>|EventAn 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

identity

The application identity object.

inherited
since

4.0.0

Type(s)

User

output

Output object

inherited
since

4.0.0

Type(s)

CliOutput

input

The input.

inherited
since

4.0.0

Type(s)

Input

cliInput

CLI Input object

inherited
since

4.0.0

Type(s)

CliInput

language

The application language object.

inherited
since

4.0.0

Type(s)

Language

messages

The application message queue.

inherited
since

4.0.0

Type(s)

array<string|int, mixed>

instance

The application instance.

inherited static
since

1.7.0

Type(s)

CliApplication

signals

The available POSIX signals to be caught by default.

static
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
  • \ Joomla
  • \ CMS
  • \ Application
  • \ DaemonApplication