Access the docblock generator object
|
public getDocblock ( ) : |
||
| return | ||
/**
* Install the project class files
*
* @param \Pop\Config $install
* @param string $installDir
* @return void
*/
public static function install($install, $installDir)
{
// Create the project class file
$projectCls = new Generator($install->project->base . '/module/' . $install->project->name . '/src/' . $install->project->name . '/Project.php', Generator::CREATE_CLASS);
// Set namespace
$ns = new NamespaceGenerator($install->project->name);
$ns->setUse('Pop\\Project\\Project', 'P');
// Create 'run' method
$run = new MethodGenerator('run');
$run->setDesc('Add any project specific code to this method for run-time use here.');
$run->appendToBody('parent::run();', false);
$run->getDocblock()->setReturn('void');
// Finalize the project config file and save it
$projectCls->setNamespace($ns);
$projectCls->code()->setParent('P')->addMethod($run);
$projectCls->save();
$input = self::installWeb();
// Install any web config and controller files
if ($input != 'n') {
if (file_exists(__DIR__ . '/Web/index.php')) {
$index = new Generator(__DIR__ . '/Web/index.php');
$contents = $index->read() . '// Run the project' . PHP_EOL . 'try {' . PHP_EOL . ' $project->run();' . PHP_EOL . '} catch (\\Exception $e) {' . PHP_EOL . ' echo $e->getMessage();' . PHP_EOL . '}' . PHP_EOL;
file_put_contents($install->project->docroot . '/index.php', $contents);
}
if ($input == 'a') {
if (file_exists(__DIR__ . '/Web/ht.access')) {
copy(__DIR__ . '/Web/ht.access', $install->project->docroot . '/.htaccess');
}
} else {
if ($input == 'i') {
if (file_exists(__DIR__ . '/Web/web.config')) {
copy(__DIR__ . '/Web/web.config', $install->project->docroot . '/web.config');
}
} else {
echo \Pop\I18n\I18n::factory()->__('You will have to install your web server rewrite configuration manually.') . PHP_EOL;
}
}
}
}
/**
* Create the controller class files
*
* @param array $controllers
* @param array $base
* @param string $depth
* @param \Pop\Code\Generator $controllerCls
* @return void
*/
public static function createControllers($controllers, $base = null, $depth = null, $controllerCls = null)
{
foreach ($controllers as $key => $value) {
$level = strpos($key, '/') !== false ? $depth . $key : null;
if (null !== $level) {
if ($level != '/') {
$l = substr($level, 1);
if (strpos($l, '/') !== false) {
$l = substr($l, 0, strpos($l, '/'));
}
$ns = '\\' . ucfirst($l);
$l = '/' . ucfirst($l);
$lView = $level;
} else {
$ns = null;
$l = null;
$lView = null;
}
// Check to make sure an 'index' method is defined for the top-level controller
if (substr_count($level, '/') == 1 && !array_key_exists('index', $value)) {
echo "The 'index' method of the top level controller '{$key}' is not defined." . PHP_EOL;
exit(0);
}
$viewPath = $base['view'] . ($level != '/' ? $level : null);
$relativeViewPath = strpos($base['src'] . $l, 'Controller/') !== false ? '/../../../../view' . $lView : '/../../../view' . $lView;
$srcPath = $base['src'] . $l;
$namespace = $base['namespace'] . $ns;
if (array_key_exists('index', $value) && (null === $l || strtolower($key) == strtolower($l))) {
$ctrlFile = $base['src'] . $l . '/IndexController.php';
$parent = 'C';
} else {
if (array_key_exists('index', $value) && strtolower($key) != strtolower($l)) {
$ctrlFile = $base['src'] . $l . '/' . ucfirst(substr($key, 1)) . 'Controller.php';
$parent = 'C';
} else {
$ctrlFile = $base['src'] . $l . '/' . ucfirst(substr($key, 1)) . 'Controller.php';
$parent = 'IndexController';
}
}
if (!file_exists($viewPath)) {
mkdir($viewPath);
}
if (!file_exists($srcPath)) {
mkdir($srcPath);
}
if (null === $controllerCls || $controllerCls->getFullpath() != $ctrlFile) {
$controllerCls = new Generator($ctrlFile, Generator::CREATE_CLASS);
// Set namespace
$ns = new NamespaceGenerator($namespace);
$ns->setUses(array('Pop\\Http\\Response', 'Pop\\Http\\Request', array('Pop\\Mvc\\Controller', 'C'), 'Pop\\Mvc\\View', 'Pop\\Project\\Project'));
// Create the constructor
$construct = new MethodGenerator('__construct');
$construct->setDesc('Constructor method to instantiate the controller object');
$construct->addArguments(array(array('name' => 'request', 'value' => 'null', 'type' => 'Request'), array('name' => 'response', 'value' => 'null', 'type' => 'Response'), array('name' => 'project', 'value' => 'null', 'type' => 'Project'), array('name' => 'viewPath', 'value' => 'null', 'type' => 'string')));
if ($parent == 'C') {
$construct->appendToBody("if (null === \$viewPath) {")->appendToBody(" \$viewPath = __DIR__ . '{$relativeViewPath}';")->appendToBody("}" . PHP_EOL);
}
if ($level != '/') {
$construct->appendToBody("if (null === \$request) {")->appendToBody(" \$request = new Request(null, '{$level}');")->appendToBody("}" . PHP_EOL);
}
$construct->appendToBody("parent::__construct(\$request, \$response, \$project, \$viewPath);", false);
$construct->getDocblock()->setReturn('self');
$controllerCls->setNamespace($ns);
$controllerCls->code()->setParent($parent)->addMethod($construct);
}
}
if (is_array($value)) {
self::createControllers($value, $base, $level, $controllerCls);
} else {
// Copy view files over
$viewPath = $base['view'] . ($depth != '/' ? $depth : null);
if (!file_exists($viewPath)) {
mkdir($viewPath);
}
$viewFile = $base['installDir'] . '/view' . ($depth != '/' ? $depth : null) . '/' . $value;
$viewFileCopy = $base['view'] . ($depth != '/' ? $depth : null) . '/' . $value;
if (file_exists($viewFile)) {
copy($viewFile, $viewFileCopy);
}
// Create action methods
$method = new MethodGenerator($key);
$method->setDesc('The \'' . $key . '()\' method.');
$code = $key == 'error' ? '404' : null;
if ($controllerCls->code()->getParent() != 'C') {
$vp = substr($depth, strrpos($depth, '/') + 1) . '/' . $value;
} else {
$vp = $value;
}
$method->appendToBody("\$this->view = View::factory(\$this->viewPath . '/{$vp}');");
$method->appendToBody("\$this->send(" . $code . ");", false);
$method->getDocblock()->setReturn('void');
$controllerCls->code()->addMethod($method);
}
}
$controllerCls->save();
}
/**
* Install the form class files
*
* @param \Pop\Config $install
* @return void
*/
public static function install($install)
{
echo \Pop\I18n\I18n::factory()->__('Creating form class files...') . PHP_EOL;
// Create form class folder
$formDir = $install->project->base . '/module/' . $install->project->name . '/src/' . $install->project->name . '/Form';
if (!file_exists($formDir)) {
mkdir($formDir);
}
$forms = $install->forms->asArray();
foreach ($forms as $name => $form) {
$formName = ucfirst(\Pop\Filter\String::underscoreToCamelcase($name));
// Define namespace
$ns = new NamespaceGenerator($install->project->name . '\\Form');
$ns->setUse('Pop\\Form\\Form')->setUse('Pop\\Form\\Element')->setUse('Pop\\Validator');
// Create the constructor
$construct = new MethodGenerator('__construct');
$construct->setDesc('Constructor method to instantiate the form object');
$construct->getDocblock()->setReturn('self');
$construct->addArguments(array(array('name' => 'action', 'value' => 'null', 'type' => 'string'), array('name' => 'method', 'value' => "'post'", 'type' => 'string'), array('name' => 'fields', 'value' => 'null', 'type' => 'array'), array('name' => 'indent', 'value' => 'null', 'type' => 'string')));
// Create the init values array within the constructor
if (is_array($form) && count($form) > 0) {
$construct->appendToBody("\$this->initFieldsValues = array (");
$i = 0;
foreach ($form as $name => $field) {
$i++;
$construct->appendToBody(" '" . $name . "' => array (");
$j = 0;
foreach ($field as $key => $value) {
$j++;
$comma = $j < count($field) ? ',' : null;
if ($key == 'validators') {
$val = null;
if (is_array($value)) {
$val = 'array(' . PHP_EOL;
foreach ($value as $v) {
$val .= ' new Validator\\' . $v . ',' . PHP_EOL;
}
$val .= ' )';
} else {
$val = 'new Validator\\' . $value;
}
$construct->appendToBody(" '{$key}' => {$val}{$comma}");
} else {
if ($key == 'value' || $key == 'marked' || $key == 'attributes' || $key == 'error') {
$val = var_export($value, true);
$val = str_replace(PHP_EOL, PHP_EOL . ' ', $val);
if (strpos($val, 'Select::') !== false) {
$val = 'Element\\' . str_replace("'", '', $val);
}
$construct->appendToBody(" '{$key}' => {$val}{$comma}");
} else {
if (is_bool($value)) {
$val = $value ? 'true' : 'false';
} else {
$val = "'" . $value . "'";
}
$construct->appendToBody(" '{$key}' => {$val}{$comma}");
}
}
}
$end = $i < count($form) ? ' ),' : ' )';
$construct->appendToBody($end);
}
$construct->appendToBody(");");
}
$construct->appendToBody("parent::__construct(\$action, \$method, \$fields, \$indent);");
// Create and save form class file
$formCls = new Generator($formDir . '/' . $formName . '.php', Generator::CREATE_CLASS);
$formCls->setNamespace($ns);
$formCls->code()->setParent('Form')->addMethod($construct);
$formCls->save();
}
}