Compare commits

..
8 Commits
Author SHA1 Message Date
Barry vd. Heuvel b0b324b8cc Use reflection and reflectiondocblock
Load the original docblock and append the changes. This way, you can
just copy the new comments in whole (next step, replace in file..)
2013-05-30 11:54:45 +02:00
Barry vd. Heuvel dab594804b Map enum to string
Fixes #19
2013-05-30 10:15:56 +02:00
Barry vd. Heuvel 83d5fe048d Revert changes 2013-05-29 17:32:38 +02:00
Barry vd. Heuvel 77b1bc923e Set mapping for enum 2013-05-29 18:31:33 +03:00
Barry vd. Heuvel 9090aeb766 Catch getType
Hopefully fixes #19
2013-05-29 18:24:43 +03:00
Barry vd. Heuvel a5c16b0751 update readme 2013-05-29 10:28:23 +02:00
Barry vd. Heuvel 16b3b872a3 Update license (MIT)
To source/readme
2013-05-29 10:24:30 +02:00
Barry vd. Heuvel 507775fda6 Update version in readme 2013-05-28 20:48:07 +02:00
4 changed files with 97 additions and 19 deletions
+5 -2
View File
@@ -1,4 +1,4 @@
## Laravel IDE Helper & Generator
## Laravel IDE Helper Generator
### Complete phpDocs, directly from the source
@@ -11,7 +11,7 @@ Add the helper file to your laravel folder (not in a public folder). The file is
Require this package in your composer.json:
"barryvdh/laravel-ide-helper": "dev-master"
"barryvdh/laravel-ide-helper": "1.*"
And add the ServiceProvider to the providers array in app/config/app.php
@@ -67,3 +67,6 @@ Also, all relations are Eloquent|Eloquent[] by default, you can change them to t
After copying the phpdocs to your model, you can clear the file, so your IDE only uses the real source.
### License
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
@@ -1,4 +1,14 @@
<?php namespace Barryvdh\LaravelIdeHelper;
<?php
/**
* Laravel IDE Helper Generator
*
* @author Barry vd. Heuvel <[email protected]>
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link https://github.com/barryvdh/laravel-ide-helper
*/
namespace Barryvdh\LaravelIdeHelper;
use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
@@ -1,4 +1,14 @@
<?php namespace Barryvdh\LaravelIdeHelper;
<?php
/**
* Laravel IDE Helper Generator
*
* @author Barry vd. Heuvel <[email protected]>
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link https://github.com/barryvdh/laravel-ide-helper
*/
namespace Barryvdh\LaravelIdeHelper;
use Illuminate\Support\ServiceProvider;
+70 -15
View File
@@ -1,8 +1,22 @@
<?php namespace Barryvdh\LaravelIdeHelper;
<?php
/**
* Laravel IDE Helper Generator
*
* @author Barry vd. Heuvel <[email protected]>
* @copyright 2013 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
* @license http://www.opensource.org/licenses/mit-license.php MIT
* @link https://github.com/barryvdh/laravel-ide-helper
*/
namespace Barryvdh\LaravelIdeHelper;
use Illuminate\Console\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\ClassLoader\ClassMapGenerator;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Context;
use phpDocumentor\Reflection\DocBlock\Tag;
use phpDocumentor\Reflection\DocBlock\Serializer as DocBlockSerializer;
/**
* A command to generate autocomplete information for your IDE
*
@@ -126,17 +140,23 @@ class ModelsCommand extends Command {
return $models;
}
/**
* Load the properties from the database table.
*
* @param \Illuminate\Database\Eloquent\Model $model
*/
protected function getPropertiesFromTable($model){
$table = $model->getTable();
$schema = $model->getConnection()->getDoctrineSchemaManager($table);
$schema->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
$columns = $schema->listTableColumns($table);
$properties = array();
if($columns){
foreach ($columns as $column) {
$name = $column->getName();
$type = $column->getType()->getName();
switch($type){
case 'string':
case 'text':
@@ -170,6 +190,9 @@ class ModelsCommand extends Command {
}
}
/**
* @param \Illuminate\Database\Eloquent\Model $model
*/
protected function getPropertiesFromMethods($model){
$methods = get_class_methods($model);
if($methods){
@@ -232,6 +255,12 @@ class ModelsCommand extends Command {
}
}
/**
* @param string $name
* @param string|null $type
* @param bool|null $read
* @param bool|null $write
*/
protected function setProperty($name, $type = null, $read = null, $write = null){
if(!isset($this->properties[$name])){
$this->properties[$name] = array();
@@ -260,18 +289,36 @@ class ModelsCommand extends Command {
}
}
/**
* @param string $class
* @return string
*/
protected function createPhpDocs($class){
if(strpos($class, '\\') !== false){
$parts = explode('\\', $class);
$class = array_pop($parts);
$namespace = implode($parts, '\\');
}else{
$namespace = '';
$reflection = new \ReflectionClass($class);
$namespace = $reflection->getNamespaceName();
$phpdoc = new DocBlock($reflection, new Context($namespace));
if(!$phpdoc->getText()){
$phpdoc->setText("Generated properties for $class");
}
$output = "namespace $namespace{\n";
$output .= "\t/**\n\t *\n\t * Generated properties for $class\n\t *\n";
$properties = array();
$methods = array();
foreach($phpdoc->getTags() as $tag){
$name = $tag->getName();
if($name == "property" || $name == "property-read" || $name == "property-write"){
$properties[] =$tag->getVariableName();
}elseif($name == "method"){
$methods[] = $tag->getMethodName();
}
}
foreach($this->properties as $name => $property){
$name = "\$$name";
if(in_array($name, $properties)){
continue;
}
if($property['read'] && $property['write']){
$attr = 'property';
}elseif($property['write']){
@@ -279,16 +326,24 @@ class ModelsCommand extends Command {
}else{
$attr = 'property-read';
}
$type = $property['type'];
$output .= "\t * @$attr $type \$$name \n";
$tag = Tag::createInstance("@{$attr} {$property['type']} {$name}", $phpdoc);
$phpdoc->appendTag($tag);
}
foreach($this->methods as $name => $method){
$type = $method['type'];
$output .= "\t * @method $type $name() \n";
if(in_array($name, $methods)){
continue;
}
$name = "$name()";
$tag = Tag::createInstance("@method {$method['type']} {$name}", $phpdoc);
$phpdoc->appendTag($tag);
}
$output .= "\t *\n\t */\n\tclass $class {}\n}\n\n";
$serializer = new DocBlockSerializer(1, "\t");
$serializer->getDocComment($phpdoc);
$docComment = $serializer->getDocComment($phpdoc);
$output = "namespace {$namespace}{\n{$docComment}\n\tclass {$class} {}\n}\n\n";
return $output;
}