PHP Class lithium\console\command\Create

li3 create --template=controller Posts li3 create --template=model Posts
Inheritance: extends lithium\console\Command
Afficher le fichier Open project: unionofrad/lithium Class Usage Examples

Méthodes publiques

Свойство Type Description
$library string Name of library to use
$template string The name of the template to use to generate the file. This allows you to add a custom template to be used in place of the core template for each command. Place templates in \extensions\command\create\template.

Protected Properties

Свойство Type Description
$_library array Holds library data from lithium\core\Libraries::get().

Méthodes publiques

Méthode Description
run ( string $command = null ) : boolean Run the create command. Takes $command and delegates to $command::$method

Méthodes protégées

Méthode Description
_default ( string $name ) : boolean Run through the default set. model, controller, test model, test controller
_execute ( string $command ) : boolean Execute the given sub-command for the current request.
_init ( ) : void Class initializer. Parses template and sets up params that need to be filled.
_instance ( string $name, array $config = [] ) : object Get an instance of a sub-command
_namespace ( string $request, array $options = [] ) : string Get the namespace.
_params ( ) : array Parse a template to find available variables specified in {:name} format. Each variable corresponds to a method in the sub command. For example, a {:namespace} variable will call the namespace method in the model command when li3 create model Post is called.
_save ( array $params = [] ) : string | boolean Save a template with the current params. Writes file to Create::$path.
_template ( ) : string Returns the contents of the template.

Method Details

_default() protected méthode

Run through the default set. model, controller, test model, test controller
protected _default ( string $name ) : boolean
$name string class name to create
Résultat boolean

_execute() protected méthode

Execute the given sub-command for the current request.
protected _execute ( string $command ) : boolean
$command string The sub-command name. example: Model, Controller, Test
Résultat boolean

_init() protected méthode

Class initializer. Parses template and sets up params that need to be filled.
protected _init ( ) : void
Résultat void

_instance() protected méthode

Get an instance of a sub-command
protected _instance ( string $name, array $config = [] ) : object
$name string the name of the sub-command to instantiate
$config array
Résultat object

_namespace() protected méthode

Get the namespace.
protected _namespace ( string $request, array $options = [] ) : string
$request string
$options array
Résultat string

_params() protected méthode

Parse a template to find available variables specified in {:name} format. Each variable corresponds to a method in the sub command. For example, a {:namespace} variable will call the namespace method in the model command when li3 create model Post is called.
protected _params ( ) : array
Résultat array

_save() protected méthode

Save a template with the current params. Writes file to Create::$path.
protected _save ( array $params = [] ) : string | boolean
$params array
Résultat string | boolean A result string on success of writing the file. If any errors occur along the way such as missing information boolean false is returned.

_template() protected méthode

Returns the contents of the template.
protected _template ( ) : string
Résultat string

run() public méthode

Run the create command. Takes $command and delegates to $command::$method
public run ( string $command = null ) : boolean
$command string
Résultat boolean

Property Details

$_library protected_oe property

Holds library data from lithium\core\Libraries::get().
protected array $_library
Résultat array

$library public_oe property

Name of library to use
public string $library
Résultat string

$template public_oe property

The name of the template to use to generate the file. This allows you to add a custom template to be used in place of the core template for each command. Place templates in \extensions\command\create\template.
public string $template
Résultat string