Class I18nShell

Shell for I18N management.

Cake\Console\Shell uses Cake\ORM\Locator\LocatorAwareTrait, Cake\Log\LogTrait, Cake\Utility\MergeVariablesTrait, Cake\Datasource\ModelAwareTrait
Extended by Cake\Shell\I18nShell
Namespace: Cake\Shell
Located at Shell/I18nShell.php

Method Detail

getOptionParsersource public

getOptionParser( )

Gets the option parser instance and configures it.

Returns

Cake\Console\ConsoleOptionParser
\Cake\Console\ConsoleOptionParser

Overrides

Cake\Console\Shell::getOptionParser()

initsource public

init( string|null $language null )

Inits PO file from POT file.

Parameters

string|null $language optional null
Language code to use.

Returns

integer|null
int|null

mainsource public

main( )

Override main() for help message hook

Methods inherited from Cake\Console\Shell

__constructsource public

__construct( Cake\Console\ConsoleIo $io null )

Constructs this Shell instance.

Parameters

Cake\Console\ConsoleIo $io optional null
An io instance.

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Shell

__debugInfosource public

__debugInfo( )

Returns an array that can be used to describe the internal state of this object.

Returns

array
array

__getsource public

__get( string $name )

Overload get for lazy building of tasks

Parameters

string $name
The task to get.

Returns

Cake\Console\Shell
Object of Task

_displayHelpsource protected

_displayHelp( string $command )

Display the help in the correct format

Parameters

string $command
The command to get help for.

Returns

integer|boolean
int|bool

_setOutputLevelsource protected

_setOutputLevel( )

Set the output level based on the parameters.

This reconfigures both the output level for out() and the configured stdout/stderr logging

_stopsource protected

_stop( integer|string $status 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

integer|string $status optional 0
see http://php.net/exit for values

_welcomesource protected

_welcome( )

Displays a header for the shell

createFilesource public

createFile( string $path , string $contents )

Creates a file at given path

Parameters

string $path
Where to put the file.
string $contents
Content to put in the file.

Returns

boolean
Success

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#creating-files

dispatchShellsource public

dispatchShell( )

Dispatch a command to another Shell. Similar to Object::requestAction() but intended for running shells from other shells.

Usage:

With a string command:

return $this->dispatchShell('schema create DbAcl');

Avoid using this form if you have string arguments, with spaces in them. The dispatched will be invoked incorrectly. Only use this form for simple command dispatching.

With an array command:

return $this->dispatchShell('schema', 'create', 'i18n', '--dry');

With an array having two key / value pairs: - command can accept either a string or an array. Represents the command to dispatch - extra can accept an array of extra parameters to pass on to the dispatcher. This parameters will be available in the param property of the called Shell

`return $this->dispatchShell([ 'command' => 'schema create DbAcl', 'extra' => ['param' => 'value'] ]);`

or

`return $this->dispatchShell([ 'command' => ['schema', 'create', 'DbAcl'], 'extra' => ['param' => 'value'] ]);`

Returns

mixed
The return of the other shell.

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#invoking-other-shells-from-your-shell

errsource public

err( string|array|null $message null , integer $newlines 1 )

Outputs a single or multiple error messages to stderr. If no parameters are passed outputs just a newline.

Parameters

string|array|null $message optional null
A string or an array of strings to output
integer $newlines optional 1
Number of newlines to append

errorsource public

error( string $title , string|null $message null )

Displays a formatted error message and exits the application with status code 1

Parameters

string $title
Title of the error
string|null $message optional null
An optional error message

Returns

integer
Error code

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#styling-output

hasMethodsource public

hasMethod( string $name )

Check to see if this shell has a callable method by the given name.

Parameters

string $name
The method name to check.

Returns

boolean
bool

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#shell-tasks

hasTasksource public

hasTask( string $task )

Check to see if this shell has a task with the provided name.

Parameters

string $task
The task name to check.

Returns

boolean
Success

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#shell-tasks

helpersource public

helper( string $name , array $settings [] )

Render a Console Helper

Create and render the output for a helper object. If the helper object has not already been loaded, it will be loaded and constructed.

Parameters

string $name
The name of the helper to render
array $settings optional []
Configuration data for the helper.

Returns

Cake\Console\Helper
The created helper instance.

hrsource public

hr( integer $newlines 0 , integer $width 63 )

Outputs a series of minus characters to the standard output, acts as a visual separator.

Parameters

integer $newlines optional 0
Number of newlines to pre- and append
integer $width optional 63
Width of the line, defaults to 63

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::hr

insource public

in( string $prompt , string|array|null $options null , string|null $default null )

Prompts the user for input, and returns it.

Parameters

string $prompt
Prompt text.
string|array|null $options optional null
Array or string of options.
string|null $default optional null
Default input value.

Returns

mixed
Either the default value, or the user-provided input.

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::in

initializesource public

initialize( )

Initializes the Shell acts as constructor for subclasses allows configuration of tasks prior to shell execution

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Cake\Console\ConsoleOptionParser::initialize

iosource public

io( Cake\Console\ConsoleIo $io null )

Get/Set the io object for this shell.

Parameters

Cake\Console\ConsoleIo $io optional null
The ConsoleIo object to use.

Returns

Cake\Console\ConsoleIo
The current ConsoleIo object.

loadTaskssource public

loadTasks( )

Loads tasks defined in public $tasks

Returns

boolean
bool

nlsource public

nl( integer $multiplier 1 )

Returns a single or multiple linefeeds sequences.

Parameters

integer $multiplier optional 1
Number of times the linefeed sequence should be repeated

Returns

string
string

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::nl

outsource public

out( string|array|null $message null , integer $newlines 1 , integer $level Cake\Shell\Shell::NORMAL )

Outputs a single or multiple messages to stdout. If no parameters are passed outputs just a newline.

Output levels

There are 3 built-in output level. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE. The verbose and quiet output levels, map to the verbose and quiet output switches present in most shells. Using Shell::QUIET for a message means it will always display. While using Shell::VERBOSE means it will only display when verbose output is toggled.

Parameters

string|array|null $message optional null
A string or an array of strings to output
integer $newlines optional 1
Number of newlines to append
integer $level optional Cake\Shell\Shell::NORMAL
The message's output level, see above.

Returns

integer|boolean
Returns the number of bytes returned from writing to stdout.

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::out

paramsource public

param( string $name )

Safely access the values in $this->params.

Parameters

string $name
The name of the parameter to get.

Returns

string|boolean|null
Value. Will return null if it doesn't exist.

parseDispatchArgumentssource public

parseDispatchArguments( array $args )

Parses the arguments for the dispatchShell() method.

Parameters

array $args
Arguments fetch from the dispatchShell() method with func_get_args()

Returns

array
First value has to be an array of the command arguments. Second value has to be an array of extra parameter to pass on to the dispatcher

quietsource public

quiet( string|array $message , integer $newlines 1 )

Output at all levels.

Parameters

string|array $message
A string or an array of strings to output
integer $newlines optional 1
Number of newlines to append

Returns

integer|boolean
Returns the number of bytes returned from writing to stdout.

runCommandsource public

runCommand( array $argv , boolean $autoMethod false , array $extra [] )

Runs the Shell with the provided argv.

Delegates calls to Tasks and resolves methods inside the class. Commands are looked up with the following order:

  • Method on the shell.
  • Matching task name.
  • main() method.

If a shell implements a main() method, all missing method calls will be sent to main() with the original method name in the argv.

For tasks to be invoked they must be exposed as subcommands. If you define any subcommands, you must define all the subcommands your shell needs, whether they be methods on this class or methods on tasks.

Parameters

array $argv
Array of arguments to run the shell with. This array should be missing the shell name.
boolean $autoMethod optional false
Set to true to allow any public method to be called even if it was not defined as a subcommand. This is used by ShellDispatcher to make building simple shells easy.
array $extra optional []
Extra parameters that you can manually pass to the Shell to be dispatched. Built-in extra parameter is : - requested : if used, will prevent the Shell welcome message to be displayed

Returns

mixed
mixed

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#the-cakephp-console

shortPathsource public

shortPath( string $file )

Makes absolute file path easier to read

Parameters

string $file
Absolute file path

Returns

string
short path

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::shortPath

startupsource public

startup( )

Starts up the Shell and displays the welcome message. Allows for checking and configuring prior to command or main execution

Override this method if you want to remove the welcome information, or otherwise modify the pre-command flow.

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Cake\Console\ConsoleOptionParser::startup

verbosesource public

verbose( string|array $message , integer $newlines 1 )

Output at the verbose level.

Parameters

string|array $message
A string or an array of strings to output
integer $newlines optional 1
Number of newlines to append

Returns

integer|boolean
Returns the number of bytes returned from writing to stdout.

wrapTextsource public

wrapText( string $text , integer|array $options [] )

Wrap a block of text. Allows you to set the width, and indenting on a block of text.

Options

  • width The width to wrap to. Defaults to 72
  • wordWrap Only wrap on words breaks (spaces) Defaults to true.
  • indent Indent the text with the string provided. Defaults to null.

Parameters

string $text
Text the text to format.
integer|array $options optional []
Array of options to use, or an integer to wrap the text to.

Returns

string
Wrapped / indented text

See

Cake\Utility\Text::wrap()

Link

http://book.cakephp.org/3.0/en/console-and-shells.html#Shell::wrapText

Methods used from Cake\ORM\Locator\LocatorAwareTrait

tableLocatorsource public

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )

Sets the table locator. If no parameters are passed, it will return the currently used locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator optional null
LocatorInterface instance.

Returns

Cake\ORM\Locator\LocatorInterface
\Cake\ORM\Locator\LocatorInterface

Methods used from Cake\Log\LogTrait

logsource public

log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.

Parameters

mixed $msg
Log message.
integer|string $level optional LogLevel::ERROR
Error level.
string|array $context optional []
Additional log data relevant to this message.

Returns

boolean
Success of log write.

Methods used from Cake\Utility\MergeVariablesTrait

_mergePropertysource protected

_mergeProperty( string $property , array $parentClasses , array $options )

Merge a single property with the values declared in all parent classes.

Parameters

string $property
The name of the property being merged.
array $parentClasses
An array of classes you want to merge with.
array $options
Options for merging the property, see _mergeVars()

_mergePropertyDatasource protected

_mergePropertyData( array $current , array $parent , boolean $isAssoc )

Merge each of the keys in a property together.

Parameters

array $current
The current merged value.
array $parent
The parent class' value.
boolean $isAssoc
Whether or not the merging should be done in associative mode.

Returns

mixed
The updated value.

_mergeVarssource protected

_mergeVars( array $properties , array $options [] )

Merge the list of $properties with all parent classes of the current class.

Options:

  • associative - A list of properties that should be treated as associative arrays. Properties in this list will be passed through Hash::normalize() before merging.

Parameters

array $properties
An array of properties and the merge strategy for them.
array $options optional []
The options to use when merging properties.

Methods used from Cake\Datasource\ModelAwareTrait

_setModelClasssource protected

_setModelClass( string $name )

Set the modelClass and modelKey properties based on conventions.

If the properties are already set they will not be overwritten

Parameters

string $name
Class name.

loadModelsource public

loadModel( string|null $modelClass null , string|null $modelType null )

Loads and constructs repository objects required by this object

Typically used to load ORM Table objects as required. Can also be used to load other types of repository objects your application uses.

If a repository provider does not return an object a MissingModelException will be thrown.

Parameters

string|null $modelClass optional null
Name of model class to load. Defaults to $this->modelClass
string|null $modelType optional null
The type of repository to load. Defaults to the modelType() value.

Returns

object
The model instance created.

Throws

Cake\Datasource\Exception\MissingModelException
If the model class cannot be found.
InvalidArgumentException
When using a type that has not been registered.
UnexpectedValueException
If no model type has been defined

modelFactorysource public

modelFactory( string $type , callable $factory )

Register a callable to generate repositories of a given type.

Parameters

string $type
The name of the repository type the factory function is for.
callable $factory
The factory function used to create instances.

modelTypesource public

modelType( string|null $modelType null )

Set or get the model type to be used by this class

Parameters

string|null $modelType optional null
The model type or null to retrieve the current

Returns

string|$this
$this

Constants inherited from Cake\Console\Shell

CODE_ERROR, NORMAL, QUIET, VERBOSE

Properties summary

$taskssource

public array

Contains tasks to load and instantiate

['Extract']

Properties inherited from Cake\Console\Shell

$OptionParsersource

public Cake\Console\ConsoleOptionParser

An instance of ConsoleOptionParser that has been configured for this class.

$Taskssource

public Cake\Console\TaskRegistry

Task Collection for the command, used to create Tasks.

$_iosource

protected Cake\Console\ConsoleIo

ConsoleIo instance.

$_taskMapsource

protected array

Normalized map of tasks.

[]

$argssource

public array

Contains arguments parsed from the command line.

[]

$commandsource

public string

The command (method/task) that is being run.

$interactivesource

public boolean

If true, the script will ask for permission to perform actions.

true

$namesource

public string

The name of the shell in camelized.

null

$paramssource

public array

Contains command switches parsed from the command line.

[]

$pluginsource

public string

The name of the plugin the shell belongs to. Is automatically set by ShellDispatcher when a shell is constructed.

null

$taskNamessource

public array

Contains the loaded tasks

[]

Properties used from Cake\ORM\Locator\LocatorAwareTrait

$_tableLocatorsource

protected Cake\ORM\Locator\LocatorInterface

Table locator instance

Properties used from Cake\Datasource\ModelAwareTrait

$_modelFactoriessource

protected array

A list of model factory functions.

[]

$_modelTypesource

protected string

The model type to use.

'Table'

$modelClasssource

public string

This object's primary model class name. Should be a plural form. CakePHP will not inflect the name.

Example: For an object named 'Comments', the modelClass would be 'Comments'. Plugin classes should use Plugin.Comments style names to correctly load models from the correct plugin.

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Shell.I18nShell.html