Joomla! API

Download
Launch

AddEntryCommand

Extends AbstractKeychainCommand

Command class to add an entry to a keychain

since

2.0.0
package

Joomla Framework

Methods

__construct

Constructor

__construct(\Joomla\Crypt\Crypt crypt) :
inherited
since

2.0.0

Arguments

crypt

CryptThe encryption handler for use within the Keychain.

Response

mixed

addArgument

Adds an argument to the input definition.

addArgument( name, int mode = null,  description = '',  default = null) :
inherited
since

2.0.0

Arguments

name

stringThe argument name

mode

int|nullThe argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL

description

stringA description text

default

mixedThe default value (for InputArgument::OPTIONAL mode only)

Response

$this

addOption

Adds an option to the input definition.

addOption( name, string|array shortcut = null, int mode = null,  description = '', mixed default = null) :
inherited
since

2.0.0

Arguments

name

stringThe option name

shortcut

string|array<string|int, mixed>The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts

mode

int|nullThe option mode: One of the VALUE_* constants

description

stringA description text

default

mixed|nullThe default value (must be null for InputOption::VALUE_NONE)

Response

$this

configure

Configure the command.

configure() :
since

2.0.0

Response

void

doExecute

Internal function to execute the command.

doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
since

2.0.0

Arguments

input

InputInterfaceThe input to inject into the command.

output

OutputInterfaceThe output to inject into the command.

Response

intThe command exit code

execute

Executes the command.

execute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
inherited
since

2.0.0

Arguments

input

InputInterfaceThe input to inject into the command.

output

OutputInterfaceThe output to inject into the command.

Response

intThe command exit code

getAliases

Get the command's aliases.

getAliases() : string||string|int
inherited
since

2.0.0

Response

array<string|int, string>

getApplication

Get the application object.

getApplication() : \Joomla\Console\Application
inherited
since

2.0.0
throws

UnexpectedValueExceptionif the application has not been set.

Response

ApplicationThe application object.

getDefaultName

Get the default command name for this class.

getDefaultName() : string|null
inherited static

This allows a command name to defined and referenced without instantiating the full command class.

since

2.0.0

Response

string|null

getDefinition

Gets the InputDefinition attached to this command.

getDefinition() : \Symfony\Component\Console\Input\InputDefinition
inherited
since

2.0.0

Response

InputDefinition

getDescription

Get the command's description.

getDescription() :
inherited
since

2.0.0

Response

string

getHelp

Get the command's help.

getHelp() :
inherited
since

2.0.0

Response

string

getHelperSet

Get the command's input helper set.

getHelperSet() : \Symfony\Component\Console\Helper\HelperSet|null
inherited
since

2.0.0

Response

HelperSet|null

getName

Get the command's name.

getName() : string|null
inherited
since

2.0.0

Response

string|null

getProcessedHelp

Returns the processed help for the command.

getProcessedHelp() :
inherited

This method is used to replace placeholders in commands with the real values. By default, this supports %command.name% and %command.full_name.

since

2.0.0

Response

string

getSynopsis

Get the command's synopsis.

getSynopsis( short = false) :
inherited
since

2.0.0

Arguments

short

boolFlag indicating whether the short or long version of the synopsis should be returned

Response

string

initialise

Internal hook to initialise the command after the input has been bound and before the input is validated.

initialise(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
inherited
since

2.0.0

Arguments

input

InputInterfaceThe input to inject into the command.

output

OutputInterfaceThe output to inject into the command.

Response

void

initialiseKeychain

Initialise the Keychain.

initialiseKeychain(\Symfony\Component\Console\Input\InputInterface input) :
inherited
since

2.0.0
throws

InvalidArgumentException

Arguments

input

InputInterfaceThe input to inject into the command.

Response

void

isEnabled

Check if the command is enabled in this environment.

isEnabled() :
inherited
since

2.0.0

Response

bool

isHidden

Check if the command is hidden from the command listing.

isHidden() :
inherited
since

2.0.0

Response

bool

saveKeychain

Save the Keychain.

saveKeychain() :
inherited
since

2.0.0
throws

RuntimeException

Response

bool

setAliases

Set the command's aliases.

setAliases(string||string|int aliases) :
inherited
since

2.0.0

Arguments

aliases

array<string|int, string>The command aliases

Response

void

setApplication

Set the command's application.

setApplication(\Joomla\Console\Application application = null) :
inherited
since

2.0.0

Arguments

application

Application|nullThe command's application

Response

void

setDefinition

Sets the input definition for the command.

setDefinition(array|\Symfony\Component\Console\Input\InputDefinition definition) :
inherited
since

2.0.0

Arguments

definition

array<string|int, mixed>|InputDefinitionEither an InputDefinition object or an array of objects to write to the definition.

Response

void

setDescription

Sets the description for the command.

setDescription( description) :
inherited
since

2.0.0

Arguments

description

stringThe description for the command

Response

void

setHelp

Sets the help for the command.

setHelp( help) :
inherited
since

2.0.0

Arguments

help

stringThe help for the command

Response

void

setHelperSet

Set the command's input helper set.

setHelperSet(\Symfony\Component\Console\Helper\HelperSet helperSet) :
inherited
since

2.0.0

Arguments

helperSet

HelperSetThe helper set.

Response

void

setHidden

Set whether this command is hidden from the command listing.

setHidden( hidden) :
inherited
since

2.0.0

Arguments

hidden

boolFlag if this command is hidden.

Response

void

setName

Set the command's name.

setName( name) :
inherited
since

2.0.0

Arguments

name

stringThe command name

Response

void

Properties

defaultName

The default command name

static
since

2.0.0

Type(s)

string|null

crypt

The encryption handler.

inherited
since

2.0.0

Type(s)

Crypt

filename

The path to the keychain file.

inherited
since

2.0.0

Type(s)

string

keychain

The keychain being managed.

inherited
since

2.0.0

Type(s)

Keychain
  • \ Joomla
  • \ Keychain
  • \ Command
  • \ AddEntryCommand