CreateModule
extends AbstractCommandForApp
in package
Tags
Table of Contents
- $allEntryPoint : mixed
- indicate if the command apply for any entrypoints.
- $config : CommandConfig
- $output : OutputInterface
- $selectedEntryPointId : mixed
- indicate the entry point id on which the command should apply.
- $selectedEntryPointsIdList : array<string|int, mixed>
- $epListOptionName : mixed
- $epOptionName : mixed
- $isVerbose : mixed
- __construct() : mixed
- _execute() : mixed
- addEpListOption() : mixed
- addEpOption() : mixed
- configure() : mixed
- createDir() : mixed
- helper method to create a new directory. it set the rights on the directory as indicated in the configuration of jelix-scripts.
- createFile() : bool
- helper method to create a file from a template stored in the templates/ directory of jelix-scripts. it set the rights on the file as indicated in the configuration of jelix-scripts.
- execute() : mixed
- executeSubCommand() : mixed
- getEntryPointInfo() : EntryPoint
- getFrameworkInfos() : mixed
- getModulePath() : string
- helper method to retrieve the path of the module.
- getSelectedEntryPoint() : mixed
- loadAppConfig() : mixed
- registerModulesDir() : mixed
- verbose() : mixed
- normalizeEp() : mixed
Properties
$allEntryPoint
indicate if the command apply for any entrypoints.
protected
mixed
$allEntryPoint
= true
Filled by the option reader.
Tags
$config
protected
CommandConfig
$config
Tags
$output
protected
OutputInterface
$output
Tags
$selectedEntryPointId
indicate the entry point id on which the command should apply.
protected
mixed
$selectedEntryPointId
= ''
Filled by the option reader.
Tags
$selectedEntryPointsIdList
protected
array<string|int, mixed>
$selectedEntryPointsIdList
= array()
list of entry points id on which the command should apply
Tags
$epListOptionName
private
mixed
$epListOptionName
= ''
Tags
$epOptionName
private
mixed
$epOptionName
= ''
Tags
$isVerbose
private
mixed
$isVerbose
= false
Tags
Methods
__construct()
public
__construct(CommandConfig $config) : mixed
Parameters
- $config : CommandConfig
Tags
Return values
mixed —_execute()
protected
_execute(InputInterface $input, OutputInterface $output) : mixed
Parameters
- $input : InputInterface
- $output : OutputInterface
Tags
Return values
mixed —addEpListOption()
protected
addEpListOption([mixed $name = 'entry-points' ][, mixed $shortName = 'e' ]) : mixed
Parameters
- $name : mixed = 'entry-points'
- $shortName : mixed = 'e'
Tags
Return values
mixed —addEpOption()
protected
addEpOption([mixed $name = 'entry-point' ][, mixed $shortName = 'e' ]) : mixed
Parameters
- $name : mixed = 'entry-point'
- $shortName : mixed = 'e'
Tags
Return values
mixed —configure()
protected
configure() : mixed
Tags
Return values
mixed —createDir()
helper method to create a new directory. it set the rights on the directory as indicated in the configuration of jelix-scripts.
protected
createDir(string $dirname) : mixed
Parameters
- $dirname : string
-
the path of the directory
Tags
Return values
mixed —createFile()
helper method to create a file from a template stored in the templates/ directory of jelix-scripts. it set the rights on the file as indicated in the configuration of jelix-scripts.
protected
createFile(string $filename, string $template[, mixed $tplparam = array() ][, mixed $fileType = 'File' ]) : bool
Parameters
- $filename : string
-
the path of the new file created from the template
- $template : string
-
relative path to the templates/ directory, of the template file
- $tplparam : mixed = array()
- $fileType : mixed = 'File'
Tags
Return values
bool —true if it is ok
execute()
protected
execute(InputInterface $input, OutputInterface $output) : mixed
Parameters
- $input : InputInterface
- $output : OutputInterface
Tags
Return values
mixed —executeSubCommand()
protected
executeSubCommand(mixed $name, mixed $arguments, mixed $output) : mixed
Parameters
- $name : mixed
- $arguments : mixed
- $output : mixed
Tags
Return values
mixed —getEntryPointInfo()
protected
getEntryPointInfo(string $name) : EntryPoint
Parameters
- $name : string
-
the entry point name
Tags
Return values
EntryPoint —getFrameworkInfos()
protected
getFrameworkInfos() : mixed
Tags
Return values
mixed —getModulePath()
helper method to retrieve the path of the module.
protected
getModulePath(string $module) : string
Parameters
- $module : string
-
the name of the module
Tags
Return values
string —the path of the module
getSelectedEntryPoint()
protected
getSelectedEntryPoint(mixed $optionName, InputInterface $input[, mixed $allowList = false ]) : mixed
Parameters
- $optionName : mixed
- $input : InputInterface
- $allowList : mixed = false
Tags
Return values
mixed —loadAppConfig()
protected
loadAppConfig(mixed $epId) : mixed
Parameters
- $epId : mixed
Tags
Return values
mixed —registerModulesDir()
protected
registerModulesDir(mixed $repository, mixed $repositoryPath) : mixed
Parameters
- $repository : mixed
- $repositoryPath : mixed
Tags
Return values
mixed —verbose()
protected
verbose() : mixed
Tags
Return values
mixed —normalizeEp()
private
normalizeEp(mixed $ep) : mixed
Parameters
- $ep : mixed