PHP Class Kraken\Console\Client\Command\Command

Inheritance: extends Symfony\Component\Console\Command\Command, implements CommandInterface

Show file Open project: kraken-php/framework Class Usage Examples

Protected Properties

Property	Type	Description
$async	boolean
$channel	Kraken\Channel\ChannelInterface
$receiver	string

Public Methods

Method	Description
__construct ( Kraken\Channel\ChannelInterface $channel, string $receiver )
__destruct ( )
isAsync ( )

Protected Methods

Method	Description
cancelMessage ( $exception, $message ) : string
command ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) : mixed[]	This method should contain command logic.
config ( )	This method should contain command configuration.
configure ( )
construct ( )	This method will be invoked during command construction.
destruct ( )	This method will be invoked during command destruction.
execute ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) : integer \| null \| void
failureMessage ( $exception, $message ) : string
informServer ( $commandParent, $commandName, $commandParams = [] )
onCancel ( Erro\Error \| Exceptio\Exception $ex ) : mixed
onFailure ( Erro\Error \| Exceptio\Exception $ex ) : mixed
onMessage ( mixed $value ) : mixed
onStart ( )
onStop ( )
onSuccess ( $value ) : mixed
successData ( mixed[] $input )
successMessage ( $message ) : string
validateCreateFlags ( integer \| string $flags ) : integer
validateDestroyFlags ( integer \| string $flags ) : integer

Method Details

__construct() public method

public __construct ( Kraken\Channel\ChannelInterface $channel, string $receiver )
$channel	Kraken\Channel\ChannelInterface
$receiver	string

__destruct() public method

public __destruct ( )

cancelMessage() protected method

protected cancelMessage ( $exception, $message ) : string
$exception
$message
return	string

command() abstract protected method

This method should contain command logic.

abstract protected command ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) : mixed[]
$input	Symfony\Component\Console\Input\InputInterface
$output	Symfony\Component\Console\Output\OutputInterface
return	mixed[]

config() abstract protected method

This method should contain command configuration.

abstract protected config ( )

configure() protected method

protected configure ( )

construct() protected method

This method will be invoked during command construction.

protected construct ( )

destruct() protected method

This method will be invoked during command destruction.

protected destruct ( )

execute() protected method

protected execute ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output ) : integer \| null \| void
$input	Symfony\Component\Console\Input\InputInterface
$output	Symfony\Component\Console\Output\OutputInterface
return	integer \| null \| void

failureMessage() protected method

protected failureMessage ( $exception, $message ) : string
$exception
$message
return	string

informServer() protected method

protected informServer ( $commandParent, $commandName, $commandParams = [] )

isAsync() public method

public isAsync ( )

onCancel() protected method

protected onCancel ( Erro\Error \| Exceptio\Exception $ex ) : mixed
$ex	Erro\Error \| Exceptio\Exception
return	mixed

onFailure() protected method

protected onFailure ( Erro\Error \| Exceptio\Exception $ex ) : mixed
$ex	Erro\Error \| Exceptio\Exception
return	mixed

onMessage() protected method

protected onMessage ( mixed $value ) : mixed
$value	mixed
return	mixed

onStart() protected method

protected onStart ( )

onStop() protected method

protected onStop ( )

onSuccess() protected method

protected onSuccess ( $value ) : mixed
$value
return	mixed

successData() protected method

protected successData ( mixed[] $input )
$input	mixed[]

successMessage() protected method

protected successMessage ( $message ) : string
$message
return	string

validateCreateFlags() protected method

protected validateCreateFlags ( integer \| string $flags ) : integer
$flags	integer \| string
return	integer

validateDestroyFlags() protected method

protected validateDestroyFlags ( integer \| string $flags ) : integer
$flags	integer \| string
return	integer

Property Details

$async protected property

protected bool $async
return	boolean

$channel protected property

protected ChannelInterface,Kraken\Channel $channel
return	Kraken\Channel\ChannelInterface

$receiver protected property

protected string $receiver
return	string