Skip to content

Y
yii2
Commit be54f24b by Tobias Munk
Options

updated defaults, UI, validation and templates

parent 01d444f6
Showing with 66 additions and 35 deletions
extensions/gii/generators/extension/Generator.php
......@@ -14,9 +14,7 @@ use yii\helpers\StringHelper;
/**
* This generator will generate the skeleton files needed by an extension.
*
* @property tbd
*
* @author Tobias Munk <schmunk@usrbin.de>
* @since 2.0
*/
......@@ -26,10 +24,10 @@ class Generator extends \yii\gii\Generator
public $packageName = "yii2-";
public $namespace;
public $type = "yii2-extension";
public $keywords = "yii2,";
public $keywords = "yii2,extension";
public $title;
public $description;
public $outputPath = "@app/tmp";
public $outputPath = "@app/runtime/tmp-extensions";
public $license;
public $authorName;
public $authorEmail;
......@@ -55,13 +53,40 @@ class Generator extends \yii\gii\Generator
*/
public function rules()
{
return array_merge(parent::rules(), [
return array_merge(
parent::rules(),
[
[['vendorName', 'packageName'], 'filter', 'filter' => 'trim'],
[['vendorName', 'packageName', 'namespace', 'type', 'license', 'title','description', 'authorName','authorEmail'], 'required'],
[
[
'vendorName',
'packageName',
'namespace',
'type',
'license',
'title',
'description',
'authorName',
'authorEmail',
'outputPath'
],
'required'
],
[['authorEmail'], 'email'],
[['packageName'], 'match', 'pattern' => '/^[a-z0-9-\.]+$/', 'message' => 'Only lowercase word characters, dashes and dots are allowed.'],
[['vendorName'], 'match', 'pattern' => '/^[\w\\\\]*$/', 'message' => 'Only word characters and backslashes are allowed.'],
]);
[
['vendorName', 'packageName'],
'match',
'pattern' => '/^[a-z0-9\-\.]+$/',
'message' => 'Only lowercase word characters, dashes and dots are allowed.'
],
[
['namespace'],
'match',
'pattern' => '/^[a-zA-Z0-9\\\]+\\\$/',
'message' => 'Only letters, numbers and backslashes are allowed. PSR-4 namespaces must end with a namespace separator.'
],
]
);
}
/**
......@@ -82,9 +107,10 @@ class Generator extends \yii\gii\Generator
public function hints()
{
return [
'vendorName' => 'This refers to the name of the publisher, often i.e. your GitHub user name.',
'packageName' => 'This is the name of the extension.',
'namespace' => 'This will be added to your autoloader by composer. Do not use yii or yii2 in the namespace',
'vendorName' => 'This refers to the name of the publisher, your GitHub user name is usually a good choice, eg. <code>myself</code>',
'packageName' => 'This is the name of the extension on packagist, eg. <code>yii2-foobar</code>',
'namespace' => 'PSR-4, eg. <code>myself\foobar</code> This will be added to your autoloading by composer. Do not use yii or yii2 in the namespace.',
'keywords' => 'Comma separated keywords for this extension.',
'outputPath' => 'The temporary location of the generated files.',
'title' => 'A more descriptive name of your application for the README file.',
'description' => 'A sentence or subline describing the main purpose of the extension.',
......@@ -96,7 +122,7 @@ class Generator extends \yii\gii\Generator
*/
public function stickyAttributes()
{
return ['vendorName','outputPath','authorName','authorEmail'];
return ['vendorName', 'outputPath', 'authorName', 'authorEmail'];
}
/**
......@@ -108,18 +134,20 @@ class Generator extends \yii\gii\Generator
# $link = Html::a('try it now', Yii::$app->getUrlManager()->createUrl($this->moduleID), ['target' => '_blank']);
# return "The module has been generated successfully. You may $link.";
#}
$outputPath = realpath(\Yii::getAlias($this->outputPath));
$output1 = <<<EOD
<p>The extension has been generated successfully.</p>
<p><em>The extension has been generated successfully.</em></p>
<p>To enable it in your application, you need to create a git repository
and require via composer.</p>
EOD;
$code1 = <<<EOD
cd tmp/{$this->packageName}
cd {$outputPath}/{$this->packageName}
git init
git add -A
git commit
git remote add origin https://path.to/your/repo
git push -u origin master
EOD;
$output2 = <<<EOD
<p>The next step is just for <em>local testing</em>, skip it if you directly publish the extension on e.g. packagist.org</p>
......@@ -129,23 +157,22 @@ EOD;
"repositories":[
{
"type": "git",
"url": "file://./tmp/{$this->packageName}"
"url": "https://path.to/your/repo"
}
]
EOD;
$output3 = <<<EOD
<p>Note: Make sure to remove the above lines after testing.</p>
<p class="well">Note: You may use the url <code>file://{$outputPath}/{$this->packageName}</code> for testing.</p>
<p>Require the package with composer</p>
EOD;
$code3 = <<<EOD
composer.phar require {$this->vendorName}/yii2-{$this->packageName}:*
composer.phar require {$this->vendorName}/{$this->packageName}:dev-master
EOD;
$output4 = <<<EOD
<p>And use it in your application.</p>
EOD;
$code4 = <<<EOD
\$x = new \\{$this->vendorName}\\{$this->packageName}\AutoloadExample::widget();
echo \$x->run();
\\{$this->namespace}AutoloadExample::widget();
EOD;
$return = $output1 . '<pre>' . highlight_string($code1, true) . '</pre>';
$return .= $output2 . '<pre>' . highlight_string($code2, true) . '</pre>';
......@@ -190,7 +217,14 @@ EOD;
public function getOutputPath()
{
return Yii::getAlias($this->outputPath);
#return Yii::getAlias('@' . str_replace('\\', '/', substr($this->moduleClass, 0, strrpos($this->moduleClass, '\\'))));
}
/**
* @return a json encoded array with the given keywords
*/
public function getKeywordsArrayJson()
{
return json_encode(explode(',', $this->keywords));
}
/**
......
extensions/gii/generators/extension/form.php
......@@ -5,6 +5,11 @@
* @var yii\gii\generators\module\Generator $generator
*/
?>
<div class="alert alert-info">
Please read the
<?= \yii\helpers\Html::a('Extension Guidelines', 'https://github.com/yiisoft/yii2/blob/master/docs/guide/extensions.md', ['target'=>'new']) ?>
before creating an extension.
</div>
<div class="module-form">
<?php
echo $form->field($generator, 'vendorName');
......@@ -12,7 +17,7 @@
echo $form->field($generator, 'namespace');
echo $form->field($generator, 'type')->dropDownList($generator->optsType());
echo $form->field($generator, 'keywords');
echo $form->field($generator, 'license')->dropDownList($generator->optsLicense());
echo $form->field($generator, 'license')->dropDownList($generator->optsLicense(), ['prompt'=>'Choose...']);
echo $form->field($generator, 'title');
echo $form->field($generator, 'description');
echo $form->field($generator, 'authorName');
......@@ -20,11 +25,3 @@
echo $form->field($generator, 'outputPath');
?>
</div>
<?php
$js = <<< EOS
$('#generator-packagename').keyup(function(){
$('#generator-namespace').val($('#generator-vendorname').val()+'\\\'+$('#generator-packagename').val());
});
EOS;
$this->registerJs($js);
extensions/gii/generators/extension/templates/AutoloadExample.php
......@@ -5,7 +5,7 @@
echo "<?php\n";
?>
namespace <?= $generator->namespace ?>;
namespace <?= substr($generator->namespace, 0, -1) ?>;
class AutoloadExample extends \yii\base\widget {
function run() {
......
extensions/gii/generators/extension/templates/composer.json
{
"name": "<?= $generator->vendorName ?>/yii2-<?= $generator->packageName ?>",
"name": "<?= $generator->vendorName ?>/<?= $generator->packageName ?>",
"description": "<?= $generator->description ?>",
"type": "<?= $generator->type ?>",
"keywords": ["TODO","ARRAY INPUT"],
"keywords": <?= $generator->keywordsArrayJson ?>,
"license": "<?= $generator->license ?>",
"authors": [
{
......@@ -12,7 +12,7 @@
],
"autoload": {
"psr-4": {
"<?= $generator->namespace ?>": ""
"<?= str_replace('\\','\\\\',$generator->namespace) ?>": ""
}
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment