/**
* Create the Module.php content
*
* @return string
*/
public function createModule()
{
// get needed options to shorten code
$moduleName = $this->requestOptions->getModuleName();
$modulePath = $this->requestOptions->getModulePath();
$moduleFile = $modulePath . '/Module.php';
$moduleViewDir = $this->requestOptions->getModuleViewDir();
// create dirs
mkdir($modulePath . '/config', 0777, true);
mkdir($modulePath . '/src/' . $moduleName . '/Controller', 0777, true);
mkdir($modulePath . '/view/' . $moduleViewDir, 0777, true);
// create controller class with class generator
$code = new ClassGenerator();
$code->setNamespaceName($moduleName);
$code->setName('Module');
$code->addMethodFromGenerator($this->generateGetConfigMethod());
$code->addMethodFromGenerator($this->generateGetAutoloaderConfigMethod());
// add optional doc block
if ($this->flagCreateApiDocs) {
$code->setDocBlock(new DocBlockGenerator('Module', 'Please add a proper description for the ' . $moduleName . ' module', array($this->generatePackageTag($moduleName))));
}
// create file with file generator
$file = new FileGenerator();
$file->setClass($code);
// add optional doc block
if ($this->flagCreateApiDocs) {
$file->setDocBlock(new DocBlockGenerator('This file was generated by FrilleZFTool.', null, array($this->generatePackageTag($moduleName), $this->generateSeeTag())));
}
// write controller class
if (!file_put_contents($moduleFile, $file->generate())) {
return false;
}
return true;
}
/**
* Show actions for a controller in a module
*/
public function actionsAction()
{
// check for help mode
if ($this->requestOptions->getFlagHelp()) {
return $this->actionsHelp();
}
// output header
$this->consoleHeader('Fetching requested information');
// get needed options to shorten code
$path = $this->requestOptions->getPath();
$moduleName = $this->requestOptions->getModuleName();
$modulePath = $this->requestOptions->getModulePath();
$controllerKey = $this->requestOptions->getControllerKey();
$controllerName = $this->requestOptions->getControllerName();
$controllerPath = $this->requestOptions->getControllerPath();
$controllerFile = $this->requestOptions->getControllerFile();
// check for module path and application config
if (!file_exists($path . '/module') || !file_exists($path . '/config/application.config.php')) {
return $this->sendError(array(array(Color::NORMAL => 'The path '), array(Color::RED => $path), array(Color::NORMAL => ' doesn\'t contain a ZF2 application.')));
}
// check if controller name provided
if (!$controllerName) {
return $this->sendError(array(array(Color::NORMAL => 'Please provide the controller name as parameter.')));
}
// check if module name provided
if (!$moduleName) {
return $this->sendError(array(array(Color::NORMAL => 'Please provide the module name as parameter.')));
}
// check if module exists
if (!file_exists($modulePath)) {
return $this->sendError(array(array(Color::NORMAL => 'The module '), array(Color::RED => $moduleName), array(Color::NORMAL => ' does not exist.')));
}
// check if controller exists already in module
if (!file_exists($controllerPath . $controllerFile)) {
return $this->sendError(array(array(Color::NORMAL => 'The controller '), array(Color::RED => $controllerName), array(Color::NORMAL => ' does not exist in module '), array(Color::RED => $moduleName), array(Color::NORMAL => '.')));
}
// get actions
$actions = $this->getActionsForController($controllerPath . $controllerFile, $controllerKey);
// check actions
if (empty($actions)) {
return $this->sendError(array(array(Color::NORMAL => 'No actions available for controller '), array(Color::RED => $controllerName), array(Color::NORMAL => ' in module '), array(Color::RED => $moduleName), array(Color::NORMAL => '.')));
}
// start output
$this->console->write(' Done ', Color::NORMAL, Color::CYAN);
$this->console->write(' ');
$this->console->write('Actions available in controller ');
$this->console->write($controllerName, Color::GREEN);
$this->console->write(' in module ');
$this->console->write($moduleName, Color::GREEN);
$this->console->writeLine(PHP_EOL);
// output actions
foreach ($actions as $actionMethod) {
$this->console->writeLine(' => ' . $actionMethod . '()', Color::GREEN);
}
// output footer
$this->consoleFooter('requested info was successfully displayed');
}
/**
* Add configuration for a new view helper factory
*
* @return bool|mixed
*/
public function addViewHelperFactoryConfig()
{
// check for no config flag
if ($this->flagNoConfig) {
return false;
}
// get needed options to shorten code
$modulePath = $this->requestOptions->getModulePath();
$viewHelperName = lcfirst($this->requestOptions->getViewHelperName());
$viewHelperKey = $this->requestOptions->getViewHelperKey();
// Read module configuration
$moduleConfigOld = (require $modulePath . '/config/module.config.php');
$moduleConfigNew = $moduleConfigOld;
// check for view_helpers configuration
if (!isset($moduleConfigNew['view_helpers'])) {
$moduleConfigNew['view_helpers'] = array();
}
// check for view_helpers invokables configuration
if (!isset($moduleConfigNew['view_helpers']['invokables'])) {
$moduleConfigNew['view_helpers']['invokables'] = array();
}
// check for view_helpers invokables configuration
if (!isset($moduleConfigNew['view_helpers']['factories'])) {
$moduleConfigNew['view_helpers']['factories'] = array();
}
// check if factory key is already there
if (!in_array($viewHelperName, $moduleConfigNew['view_helpers']['factories'])) {
$moduleConfigNew['view_helpers']['factories'][$viewHelperName] = $viewHelperKey . 'Factory';
}
// check if invokable key is there
if (isset($moduleConfigNew['view_helpers']['invokables']) && isset($moduleConfigNew['view_helpers']['invokables'][$viewHelperName])) {
unset($moduleConfigNew['view_helpers']['invokables'][$viewHelperName]);
}
// set config dir
$configDir = realpath($modulePath . '/config');
// reset constant compilation
$moduleConfigNew = $this->resetConfigDirCompilation($moduleConfigNew, $configDir);
// check for module config updates
if ($moduleConfigNew !== $moduleConfigOld) {
return $moduleConfigNew;
} else {
return false;
}
}
/**
* Create a view helper
*
* @return ConsoleModel
*/
public function viewHelperAction()
{
// check for help mode
if ($this->requestOptions->getFlagHelp()) {
return $this->viewHelperHelp();
}
// output header
$this->consoleHeader('Creating new view helper');
// get needed options to shorten code
$path = $this->requestOptions->getPath();
$flagWithFactory = $this->requestOptions->getFlagWithFactory();
$moduleName = $this->requestOptions->getModuleName();
$modulePath = $this->requestOptions->getModulePath();
$viewHelperName = $this->requestOptions->getViewHelperName();
$viewHelperPath = $this->requestOptions->getViewHelperPath();
$viewHelperClass = $this->requestOptions->getViewHelperClass();
$viewHelperFile = $this->requestOptions->getViewHelperFile();
// check for module path and application config
if (!file_exists($path . '/module') || !file_exists($path . '/config/application.config.php')) {
return $this->sendError(array(array(Color::NORMAL => 'The path '), array(Color::RED => $path), array(Color::NORMAL => ' doesn\'t contain a ZF2 application.')));
}
// check if helper name provided
if (!$viewHelperName) {
return $this->sendError(array(array(Color::NORMAL => 'Please provide the view helper name as parameter.')));
}
// check if module name provided
if (!$moduleName) {
return $this->sendError(array(array(Color::NORMAL => 'Please provide the module name as parameter.')));
}
// set mode
if (file_exists($viewHelperPath . $viewHelperFile)) {
$mode = 'update';
} else {
$mode = 'insert';
}
// check if view helper exists already in module
if ($mode == 'update' && !$flagWithFactory) {
return $this->sendError(array(array(Color::NORMAL => 'The view helper '), array(Color::RED => $viewHelperName), array(Color::NORMAL => ' already exists in module '), array(Color::RED => $moduleName), array(Color::NORMAL => '.')));
}
// create view helper
if ($mode == 'insert') {
// write start message
$this->console->write(' => Creating view helper ');
$this->console->write($viewHelperName, Color::GREEN);
$this->console->write(' in module ');
$this->console->writeLine($moduleName, Color::GREEN);
// create view helper class
$viewHelperFlag = $this->moduleGenerator->createViewHelper();
// write start message
$this->console->write(' => Adding view helper configuration for ');
$this->console->writeLine($moduleName, Color::GREEN);
// add view helper configuration to module
$moduleConfig = $this->moduleConfigurator->addViewHelperConfig();
}
// check for factory flag
if ($flagWithFactory) {
// create view helper factory class
try {
$factoryFlag = $this->moduleGenerator->createViewHelperFactory();
} catch (GeneratorException $e) {
return $this->sendError(array(array(Color::NORMAL => 'The factory for the view helper '), array(Color::RED => $viewHelperName), array(Color::NORMAL => ' of module '), array(Color::RED => $moduleName), array(Color::NORMAL => ' exists already.')));
}
// write start message
$this->console->write(' => Creating factory for view helper ');
$this->console->write($viewHelperName, Color::GREEN);
$this->console->write(' in module ');
$this->console->writeLine($moduleName, Color::GREEN);
// add view helper factory configuration to module
$moduleConfig = $this->moduleConfigurator->addViewHelperFactoryConfig();
} else {
$factoryFlag = false;
}
// check for module config updates
if ($moduleConfig) {
// update module configuration
$this->moduleGenerator->updateConfiguration($moduleConfig, $modulePath . '/config/module.config.php');
// write start message
$this->console->write(' => Updating configuration for module ');
$this->console->writeLine($moduleName, Color::GREEN);
}
$this->console->writeLine();
$this->console->write(' Done ', Color::NORMAL, Color::CYAN);
$this->console->write(' ');
// write message
if ($factoryFlag) {
$this->console->write('The view helper ');
$this->console->write($viewHelperName, Color::GREEN);
$this->console->write(' has been created with a factory in module ');
$this->console->writeLine($moduleName, Color::GREEN);
} else {
$this->console->write('The view helper ');
$this->console->write($viewHelperName, Color::GREEN);
$this->console->write(' has been created in module ');
$this->console->writeLine($moduleName, Color::GREEN);
}
$this->console->writeLine();
$this->console->writeLine(' => In order to use the view helper add the following code to any view script.');
$this->console->writeLine(' <?php echo $this->' . lcfirst($viewHelperName) . '(); ?>', Color::CYAN);
// output footer
$this->consoleFooter('view helper was successfully created');
}
