🍲dfcv🏰dd⋉(● ∸ ●)⋊@% PNG %k25u25%fgd5n! PNG %k25u25%fgd5n!laravel-ide-helper/resources/views/helper.php000064400000011741152427540010015351 0ustar00 /* @noinspection ALL */ // @formatter:off // phpcs:ignoreFile /** * A helper file for Laravel, to provide autocomplete information to your IDE * Generated for Laravel . * * This file should not be included in your code, only analyzed by your IDE! * * @author Barry vd. Heuvel * @see https://github.com/barryvdh/laravel-ide-helper */ $aliases) : ?> namespace { getDocComment(' ')) ?> getClassType() ?> getExtendsClass() ?> { getMethods() as $method) : ?> getDocComment(' ')) ?> public static function getName() ?>(getParamsWithDefault() ?>) {getDeclaringClass() !== $method->getRoot()) : ?> //Method inherited from getDeclaringClass() ?> isInstanceCall()) : ?> /** @var getRoot()?> $instance */ shouldReturn() ? 'return ' : '' ?>getRootMethodCall() ?>; } } } $aliases) : ?> namespace { getClassType() ?> getShortName() ?> extends getExtends() ?> {getExtendsNamespace() == '\Illuminate\Database\Eloquent') : ?> getMethods() as $method) : ?> getDocComment(' ')) ?> public static function getName() ?>(getParamsWithDefault() ?>) {getDeclaringClass() !== $method->getRoot()) : ?> //Method inherited from getDeclaringClass() ?> isInstanceCall()) : ?> /** @var getRoot()?> $instance */ shouldReturn() ? 'return ' : '' ?>getRootMethodCall() ?>; } } } namespace { /** * @mixin */ class extends {} } namespace { } namespace Illuminate\Support { /** * Methods commonly used in migrations * * @method Fluent after(string $column) Add the after modifier * @method Fluent charset(string $charset) Add the character set modifier * @method Fluent collation(string $collation) Add the collation modifier * @method Fluent comment(string $comment) Add comment * @method Fluent default($value) Add the default modifier * @method Fluent first() Select first row * @method Fluent index(string $name = null) Add the in dex clause * @method Fluent on(string $table) `on` of a foreign key * @method Fluent onDelete(string $action) `on delete` of a foreign key * @method Fluent onUpdate(string $action) `on update` of a foreign key * @method Fluent primary() Add the primary key modifier * @method Fluent references(string $column) `references` of a foreign key * @method Fluent nullable(bool $value = true) Add the nullable modifier * @method Fluent unique(string $name = null) Add unique index clause * @method Fluent unsigned() Add the unsigned modifier * @method Fluent useCurrent() Add the default timestamp value * @method Fluent change() Add the change modifier */ class Fluent {} } namespace getNamespaceName()?> { /** * @method \Illuminate\Database\Eloquent\Collection|getShortName()?>[]|getShortName()?> create($attributes = []) * @method \Illuminate\Database\Eloquent\Collection|getShortName()?>[]|getShortName()?> make($attributes = []) */ class getShortName()?>FactoryBuilder extends \Illuminate\Database\Eloquent\FactoryBuilder {} } laravel-ide-helper/resources/views/meta.php000064400000005417152427540010015023 0ustar00 /* @noinspection ALL */ // @formatter:off // phpcs:ignoreFile namespace PHPSTORM_META { /** * PhpStorm Meta file, to provide autocomplete information for PhpStorm * * @author Barry vd. Heuvel * @see https://github.com/barryvdh/laravel-ide-helper */ override(, map([ '' => '@', $class) : ?> '' => \::class, ])); override(\factory(0), map([ '' => '@FactoryBuilder', 'getName() ?>' => \getName() ?>FactoryBuilder::class, ])); override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::mock(0), map(["" => "@&\Mockery\MockInterface"])); override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::partialMock(0), map(["" => "@&\Mockery\MockInterface"])); override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::instance(0), type(1)); override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::spy(0), map(["" => "@&\Mockery\MockInterface"])); override(\Illuminate\Support\Arr::add(0), type(0)); override(\Illuminate\Support\Arr::except(0), type(0)); override(\Illuminate\Support\Arr::first(0), elementType(0)); override(\Illuminate\Support\Arr::last(0), elementType(0)); override(\Illuminate\Support\Arr::get(0), elementType(0)); override(\Illuminate\Support\Arr::only(0), type(0)); override(\Illuminate\Support\Arr::prepend(0), type(0)); override(\Illuminate\Support\Arr::pull(0), elementType(0)); override(\Illuminate\Support\Arr::set(0), type(0)); override(\Illuminate\Support\Arr::shuffle(0), type(0)); override(\Illuminate\Support\Arr::sort(0), type(0)); override(\Illuminate\Support\Arr::sortRecursive(0), type(0)); override(\Illuminate\Support\Arr::where(0), type(0)); override(\array_add(0), type(0)); override(\array_except(0), type(0)); override(\array_first(0), elementType(0)); override(\array_last(0), elementType(0)); override(\array_get(0), elementType(0)); override(\array_only(0), type(0)); override(\array_prepend(0), type(0)); override(\array_pull(0), elementType(0)); override(\array_set(0), type(0)); override(\array_sort(0), type(0)); override(\array_sort_recursive(0), type(0)); override(\array_where(0), type(0)); override(\head(0), elementType(0)); override(\last(0), elementType(0)); override(\with(0), type(0)); override(\tap(0), type(0)); override(\optional(0), type(0)); } laravel-ide-helper/src/Listeners/GenerateModelHelper.php000064400000002345152427540010017335 0ustar00artisan = $artisan; $this->config = $config; } /** * Handle the event. * * @param CommandFinished $event */ public function handle(CommandFinished $event) { if (!self::$shouldRun) { return; } self::$shouldRun = false; foreach ($this->config->get('ide-helper.post_migrate', []) as $command) { $this->artisan->call($command, [], $event->output); } } } laravel-ide-helper/src/Console/GeneratorCommand.php000064400000011362152427540010016340 0ustar00 * @copyright 2014 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\Console; use Barryvdh\LaravelIdeHelper\Eloquent; use Barryvdh\LaravelIdeHelper\Generator; use Illuminate\Console\Command; use Illuminate\Filesystem\Filesystem; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputOption; /** * A command to generate autocomplete information for your IDE * * @author Barry vd. Heuvel */ class GeneratorCommand extends Command { /** * The console command name. * * @var string */ protected $name = 'ide-helper:generate'; /** * The console command description. * * @var string */ protected $description = 'Generate a new IDE Helper file.'; /** @var \Illuminate\Config\Repository */ protected $config; /** @var Filesystem */ protected $files; /** @var \Illuminate\View\Factory */ protected $view; protected $onlyExtend; /** * * @param \Illuminate\Config\Repository $config * @param Filesystem $files * @param \Illuminate\View\Factory $view */ public function __construct( /*ConfigRepository */ $config, Filesystem $files, /* Illuminate\View\Factory */ $view ) { $this->config = $config; $this->files = $files; $this->view = $view; parent::__construct(); } /** * Execute the console command. * * @return void */ public function handle() { if ( file_exists(base_path() . '/vendor/compiled.php') || file_exists(base_path() . '/bootstrap/cache/compiled.php') || file_exists(base_path() . '/storage/framework/compiled.php') ) { $this->error( 'Error generating IDE Helper: first delete your compiled file (php artisan clear-compiled)' ); return; } $filename = $this->argument('filename'); // Add the php extension if missing // This is a backwards-compatible shim and can be removed in the future if (substr($filename, -4, 4) !== '.php') { $filename .= '.php'; } if ($this->option('memory')) { $this->useMemoryDriver(); } $helpers = ''; if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) { foreach ($this->config->get('ide-helper.helper_files', []) as $helper) { if (file_exists($helper)) { $helpers .= str_replace([''], '', $this->files->get($helper)); } } } else { $helpers = ''; } $generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers); $content = $generator->generate(); $written = $this->files->put($filename, $content); if ($written !== false) { $this->info("A new helper file was written to $filename"); if ($this->option('write_mixins')) { Eloquent::writeEloquentModelHelper($this, $this->files); } } else { $this->error("The helper file could not be created at $filename"); } } protected function useMemoryDriver() { //Use a sqlite database in memory, to avoid connection errors on Database facades $this->config->set( 'database.connections.sqlite', [ 'driver' => 'sqlite', 'database' => ':memory:', ] ); $this->config->set('database.default', 'sqlite'); } /** * Get the console command arguments. * * @return array */ protected function getArguments() { $filename = $this->config->get('ide-helper.filename'); return [ [ 'filename', InputArgument::OPTIONAL, 'The path to the helper file', $filename, ], ]; } /** * Get the console command options. * * @return array */ protected function getOptions() { $writeMixins = $this->config->get('ide-helper.write_eloquent_model_mixins'); return [ ['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins], ['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'], ['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'], ]; } } laravel-ide-helper/src/Console/MetaCommand.php000064400000012326152427540010015301 0ustar00 * @copyright 2015 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\Console; use Barryvdh\LaravelIdeHelper\Factories; use Illuminate\Console\Command; use RuntimeException; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; /** * A command to generate phpstorm meta data * * @author Barry vd. Heuvel */ class MetaCommand extends Command { /** * The console command name. * * @var string */ protected $name = 'ide-helper:meta'; /** * The console command description. * * @var string */ protected $description = 'Generate metadata for PhpStorm'; /** @var \Illuminate\Contracts\Filesystem\Filesystem */ protected $files; /** @var \Illuminate\Contracts\View\Factory */ protected $view; /** @var \Illuminate\Contracts\Config\Repository */ protected $config; protected $methods = [ 'new \Illuminate\Contracts\Container\Container', '\Illuminate\Container\Container::makeWith(0)', '\Illuminate\Contracts\Container\Container::get(0)', '\Illuminate\Contracts\Container\Container::make(0)', '\Illuminate\Contracts\Container\Container::makeWith(0)', '\App::get(0)', '\App::make(0)', '\App::makeWith(0)', '\app(0)', '\resolve(0)', '\Psr\Container\ContainerInterface::get(0)', ]; /** * * @param \Illuminate\Contracts\Filesystem\Filesystem $files * @param \Illuminate\Contracts\View\Factory $view * @param \Illuminate\Contracts\Config\Repository $config */ public function __construct($files, $view, $config) { $this->files = $files; $this->view = $view; $this->config = $config; parent::__construct(); } /** * Execute the console command. * * @return void */ public function handle() { // Needs to run before exception handler is registered $factories = $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : []; $ourAutoloader = $this->registerClassAutoloadExceptions(); $bindings = []; foreach ($this->getAbstracts() as $abstract) { // Validator and seeder cause problems if (in_array($abstract, ['validator', 'seeder'])) { continue; } try { $concrete = $this->laravel->make($abstract); if ($concrete === null) { throw new RuntimeException("Cannot create instance for '$abstract', received 'null'"); } $reflectionClass = new \ReflectionClass($concrete); if (is_object($concrete) && !$reflectionClass->isAnonymous()) { $bindings[$abstract] = get_class($concrete); } } catch (\Throwable $e) { if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) { $this->comment("Cannot make '$abstract': " . $e->getMessage()); } } } $this->unregisterClassAutoloadExceptions($ourAutoloader); $content = $this->view->make('meta', [ 'bindings' => $bindings, 'methods' => $this->methods, 'factories' => $factories, ])->render(); $filename = $this->option('filename'); $written = $this->files->put($filename, $content); if ($written !== false) { $this->info("A new meta file was written to $filename"); } else { $this->error("The meta file could not be created at $filename"); } } /** * Get a list of abstracts from the Laravel Application. * * @return array */ protected function getAbstracts() { $abstracts = $this->laravel->getBindings(); // Return the abstract names only $keys = array_keys($abstracts); sort($keys); return $keys; } /** * Register an autoloader the throws exceptions when a class is not found. * * @return callable */ protected function registerClassAutoloadExceptions(): callable { $autoloader = function ($class) { throw new \ReflectionException("Class '$class' not found."); }; spl_autoload_register($autoloader); return $autoloader; } /** * Get the console command options. * * @return array */ protected function getOptions() { $filename = $this->config->get('ide-helper.meta_filename'); return [ ['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $filename], ]; } /** * Remove our custom autoloader that we pushed onto the autoload stack * * @param callable $ourAutoloader */ private function unregisterClassAutoloadExceptions(callable $ourAutoloader): void { spl_autoload_unregister($ourAutoloader); } } laravel-ide-helper/src/Console/EloquentCommand.php000064400000002531152427540010016204 0ustar00 * @copyright 2017 Charles A. Peterson / 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\Console; use Barryvdh\LaravelIdeHelper\Eloquent; use Illuminate\Console\Command; use Illuminate\Filesystem\Filesystem; /** * A command to add \Eloquent mixin to Eloquent\Model * * @author Charles A. Peterson */ class EloquentCommand extends Command { /** * The console command name. * * @var string */ protected $name = 'ide-helper:eloquent'; /** * @var Filesystem $files */ protected $files; /** * The console command description. * * @var string */ protected $description = 'Add \Eloquent helper to \Eloquent\Model'; /** * @param Filesystem $files */ public function __construct(Filesystem $files) { parent::__construct(); $this->files = $files; } /** * Execute the console command. * * @return void */ public function handle() { Eloquent::writeEloquentModelHelper($this, $this->files); } } laravel-ide-helper/src/Console/ModelsCommand.php000064400000171042152427540010015637 0ustar00 * @copyright 2014 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\Console; use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface; use Barryvdh\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock\Context; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Tag; use Composer\ClassMapGenerator\ClassMapGenerator; use Doctrine\DBAL\Exception as DBALException; use Doctrine\DBAL\Types\Type; use Illuminate\Console\Command; use Illuminate\Contracts\Database\Eloquent\Castable; use Illuminate\Contracts\Database\Eloquent\CastsAttributes; use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes; use Illuminate\Database\Eloquent\Casts\AsArrayObject; use Illuminate\Database\Eloquent\Casts\AsCollection; use Illuminate\Database\Eloquent\Casts\Attribute; use Illuminate\Database\Eloquent\Factories\Factory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; use Illuminate\Database\Eloquent\Relations\BelongsToMany; use Illuminate\Database\Eloquent\Relations\HasMany; use Illuminate\Database\Eloquent\Relations\HasManyThrough; use Illuminate\Database\Eloquent\Relations\HasOne; use Illuminate\Database\Eloquent\Relations\HasOneThrough; use Illuminate\Database\Eloquent\Relations\MorphMany; use Illuminate\Database\Eloquent\Relations\MorphOne; use Illuminate\Database\Eloquent\Relations\MorphTo; use Illuminate\Database\Eloquent\Relations\MorphToMany; use Illuminate\Database\Eloquent\Relations\Relation; use Illuminate\Filesystem\Filesystem; use Illuminate\Support\Arr; use Illuminate\Support\Collection; use Illuminate\Support\Str; use phpDocumentor\Reflection\Types\ContextFactory; use ReflectionClass; use ReflectionNamedType; use ReflectionObject; use ReflectionType; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use Throwable; /** * A command to generate autocomplete information for your IDE * * @author Barry vd. Heuvel */ class ModelsCommand extends Command { protected const RELATION_TYPES = [ 'hasMany' => HasMany::class, 'hasManyThrough' => HasManyThrough::class, 'hasOneThrough' => HasOneThrough::class, 'belongsToMany' => BelongsToMany::class, 'hasOne' => HasOne::class, 'belongsTo' => BelongsTo::class, 'morphOne' => MorphOne::class, 'morphTo' => MorphTo::class, 'morphMany' => MorphMany::class, 'morphToMany' => MorphToMany::class, 'morphedByMany' => MorphToMany::class, ]; /** * @var Filesystem $files */ protected $files; /** * The console command name. * * @var string */ protected $name = 'ide-helper:models'; /** * @var string */ protected $filename; /** * The console command description. * * @var string */ protected $description = 'Generate autocompletion for models'; protected $write_model_magic_where; protected $write_model_relation_count_properties; protected $properties = []; protected $methods = []; protected $write = false; protected $write_mixin = false; protected $dirs = []; protected $reset; protected $keep_text; protected $phpstorm_noinspections; protected $write_model_external_builder_methods; /** * @var bool[string] */ protected $nullableColumns = []; /** * @var string[] */ protected $foreignKeyConstraintsColumns = []; /** * During initialization we use Laravels Date Facade to * determine the actual date class and store it here. * * @var string */ protected $dateClass; /** * @param Filesystem $files */ public function __construct(Filesystem $files) { parent::__construct(); $this->files = $files; } /** * Execute the console command. * * @return void */ public function handle() { $this->filename = $this->laravel['config']->get('ide-helper.models_filename', '_ide_helper_models.php'); $filename = $this->option('filename') ?? $this->filename; $this->write = $this->option('write'); $this->write_mixin = $this->option('write-mixin'); $this->dirs = array_merge( $this->laravel['config']->get('ide-helper.model_locations', []), $this->option('dir') ); $model = $this->argument('model'); $ignore = $this->option('ignore'); $this->reset = $this->option('reset'); $this->phpstorm_noinspections = $this->option('phpstorm-noinspections'); if ($this->option('smart-reset')) { $this->keep_text = $this->reset = true; } $this->write_model_magic_where = $this->laravel['config']->get('ide-helper.write_model_magic_where', true); $this->write_model_external_builder_methods = $this->laravel['config']->get('ide-helper.write_model_external_builder_methods', true); $this->write_model_relation_count_properties = $this->laravel['config']->get('ide-helper.write_model_relation_count_properties', true); $this->write = $this->write_mixin ? true : $this->write; //If filename is default and Write is not specified, ask what to do if (!$this->write && $filename === $this->filename && !$this->option('nowrite')) { if ( $this->confirm( "Do you want to overwrite the existing model files? Choose no to write to $filename instead" ) ) { $this->write = true; } } $this->dateClass = class_exists(\Illuminate\Support\Facades\Date::class) ? '\\' . get_class(\Illuminate\Support\Facades\Date::now()) : '\Illuminate\Support\Carbon'; $content = $this->generateDocs($model, $ignore); if (!$this->write || $this->write_mixin) { $written = $this->files->put($filename, $content); if ($written !== false) { $this->info("Model information was written to $filename"); } else { $this->error("Failed to write model information to $filename"); } } } /** * Get the console command arguments. * * @return array */ protected function getArguments() { return [ ['model', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Which models to include', []], ]; } /** * Get the console command options. * * @return array */ protected function getOptions() { return [ ['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file'], ['dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The model dir, supports glob patterns', [], ], ['write', 'W', InputOption::VALUE_NONE, 'Write to Model file'], ['write-mixin', 'M', InputOption::VALUE_NONE, "Write models to {$this->filename} and adds @mixin to each model, avoiding IDE duplicate declaration warnings", ], ['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'], ['reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'], ['smart-reset', 'r', InputOption::VALUE_NONE, 'Refresh the properties/methods list, but keep the text'], ['phpstorm-noinspections', 'p', InputOption::VALUE_NONE, 'Add PhpFullyQualifiedNameUsageInspection and PhpUnnecessaryFullyQualifiedNameInspection PHPStorm ' . 'noinspection tags', ], ['ignore', 'I', InputOption::VALUE_OPTIONAL, 'Which models to ignore', ''], ]; } protected function generateDocs($loadModels, $ignore = '') { $output = " */ \n\n"; $hasDoctrine = interface_exists('Doctrine\DBAL\Driver'); if (empty($loadModels)) { $models = $this->loadModels(); } else { $models = []; foreach ($loadModels as $model) { $models = array_merge($models, explode(',', $model)); } } $ignore = array_merge( explode(',', $ignore), $this->laravel['config']->get('ide-helper.ignored_models', []) ); foreach ($models as $name) { if (in_array($name, $ignore)) { if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) { $this->comment("Ignoring model '$name'"); } continue; } $this->properties = []; $this->methods = []; $this->foreignKeyConstraintsColumns = []; if (class_exists($name)) { try { // handle abstract classes, interfaces, ... $reflectionClass = new ReflectionClass($name); if (!$reflectionClass->isSubclassOf('Illuminate\Database\Eloquent\Model')) { continue; } $this->comment("Loading model '$name'", OutputInterface::VERBOSITY_VERBOSE); if (!$reflectionClass->IsInstantiable()) { // ignore abstract class or interface continue; } $model = $this->laravel->make($name); if ($hasDoctrine) { $this->getPropertiesFromTable($model); } if (method_exists($model, 'getCasts')) { $this->castPropertiesType($model); } $this->getPropertiesFromMethods($model); $this->getSoftDeleteMethods($model); $this->getCollectionMethods($model); $this->getFactoryMethods($model); $this->runModelHooks($model); $output .= $this->createPhpDocs($name); $ignore[] = $name; $this->nullableColumns = []; } catch (Throwable $e) { $this->error('Exception: ' . $e->getMessage() . "\nCould not analyze class $name.\n\nTrace:\n" . $e->getTraceAsString()); } } } if (!$hasDoctrine) { $this->error( 'Warning: `"doctrine/dbal": "~2.3"` is required to load database information. ' . 'Please require that in your composer.json and run `composer update`.' ); } return $output; } protected function loadModels() { $models = []; foreach ($this->dirs as $dir) { if (is_dir(base_path($dir))) { $dir = base_path($dir); } $dirs = glob($dir, GLOB_ONLYDIR); foreach ($dirs as $dir) { if (!is_dir($dir)) { $this->error("Cannot locate directory '{$dir}'"); continue; } if (file_exists($dir)) { $classMap = ClassMapGenerator::createMap($dir); // Sort list so it's stable across different environments ksort($classMap); foreach ($classMap as $model => $path) { $models[] = $model; } } } } return $models; } /** * cast the properties's type from $casts. * * @param Model $model */ public function castPropertiesType($model) { $casts = $model->getCasts(); foreach ($casts as $name => $type) { if (Str::startsWith($type, 'decimal:')) { $type = 'decimal'; } elseif (Str::startsWith($type, 'custom_datetime:')) { $type = 'date'; } elseif (Str::startsWith($type, 'date:')) { $type = 'date'; } elseif (Str::startsWith($type, 'datetime:')) { $type = 'date'; } elseif (Str::startsWith($type, 'immutable_custom_datetime:')) { $type = 'immutable_date'; } elseif (Str::startsWith($type, 'immutable_date:')) { $type = 'immutable_date'; } elseif (Str::startsWith($type, 'immutable_datetime:')) { $type = 'immutable_datetime'; } elseif (Str::startsWith($type, 'encrypted:')) { $type = Str::after($type, ':'); } $params = []; switch ($type) { case 'encrypted': $realType = 'mixed'; break; case 'boolean': case 'bool': $realType = 'boolean'; break; case 'decimal': case 'string': $realType = 'string'; break; case 'array': case 'json': $realType = 'array'; break; case 'object': $realType = 'object'; break; case 'int': case 'integer': case 'timestamp': $realType = 'integer'; break; case 'real': case 'double': case 'float': $realType = 'float'; break; case 'date': case 'datetime': $realType = $this->dateClass; break; case 'immutable_date': case 'immutable_datetime': $realType = '\Carbon\CarbonImmutable'; break; case AsCollection::class: case 'collection': $realType = '\Illuminate\Support\Collection'; break; case AsArrayObject::class: $realType = '\ArrayObject'; break; default: // In case of an optional custom cast parameter , only evaluate // the `$type` until the `:` $type = strtok($type, ':'); $realType = class_exists($type) ? ('\\' . $type) : 'mixed'; $this->setProperty($name, null, true, true); $params = strtok(':'); $params = $params ? explode(',', $params) : []; break; } if (!isset($this->properties[$name])) { continue; } if ($this->isInboundCast($realType)) { continue; } $realType = $this->checkForCastableCasts($realType, $params); $realType = $this->checkForCustomLaravelCasts($realType); $realType = $this->getTypeOverride($realType); $realType = $this->getTypeInModel($model, $realType); $realType = $this->applyNullability($realType, isset($this->nullableColumns[$name])); $this->properties[$name]['type'] = $realType; } } protected function applyNullability(?string $type, bool $isNullable): ?string { if (!$type) { return null; } $nullString = null; // Find instance of: // A) start of string or non-word character (like space or pipe) followed by 'null|' // B) '|null' followed by end of string or non-word character (like space or pipe) // This will find 'or null' instances at the beginning, middle or end of a type string, // but will exclude solo/pure null instances and null being part of a type's name (e.g. class 'Benull'). if (preg_match('/(?:(?:^|\W)(null\|))|(\|null(?:$|\W))/', $type, $matches) === 1) { $nullString = array_pop($matches); } // Return the current type string if: // A) the type can be null and the type contains a null instance // B) the type can not be null and the type does not contain a null instance if (!($isNullable xor $nullString)) { return $type; } if ($isNullable) { $type .= '|null'; } else { $type = str_replace($nullString, '', $type); } return $type; } /** * Returns the override type for the give type. * * @param string $type * @return string|null */ protected function getTypeOverride($type) { $typeOverrides = $this->laravel['config']->get('ide-helper.type_overrides', []); return $typeOverrides[$type] ?? $type; } /** * Load the properties from the database table. * * @param Model $model * * @throws DBALException If custom field failed to register */ public function getPropertiesFromTable($model) { $database = $model->getConnection()->getDatabaseName(); $table = $model->getConnection()->getTablePrefix() . $model->getTable(); $schema = $model->getConnection()->getDoctrineSchemaManager(); $databasePlatform = $schema->getDatabasePlatform(); $databasePlatform->registerDoctrineTypeMapping('enum', 'string'); if (strpos($table, '.')) { [$database, $table] = explode('.', $table); } $platformName = $databasePlatform->getName(); $customTypes = $this->laravel['config']->get("ide-helper.custom_db_types.{$platformName}", []); foreach ($customTypes as $yourTypeName => $doctrineTypeName) { try { if (!Type::hasType($yourTypeName)) { Type::addType($yourTypeName, get_class(Type::getType($doctrineTypeName))); } } catch (DBALException $exception) { $this->error("Failed registering custom db type \"$yourTypeName\" as \"$doctrineTypeName\""); throw $exception; } $databasePlatform->registerDoctrineTypeMapping($yourTypeName, $doctrineTypeName); } $columns = $schema->listTableColumns($table, $database); if (!$columns) { return; } $this->setForeignKeys($schema, $table); foreach ($columns as $column) { $name = $column->getName(); if (in_array($name, $model->getDates())) { $type = $this->dateClass; } else { $type = $column->getType()->getName(); switch ($type) { case 'string': case 'text': case 'date': case 'time': case 'guid': case 'datetimetz': case 'datetime': case 'decimal': case 'binary': $type = 'string'; break; case 'integer': case 'bigint': case 'smallint': $type = 'integer'; break; case 'boolean': switch ($platformName) { case 'sqlite': case 'mysql': $type = 'integer'; break; default: $type = 'boolean'; break; } break; case 'float': $type = 'float'; break; default: $type = 'mixed'; break; } } $comment = $column->getComment(); if (!$column->getNotnull()) { $this->nullableColumns[$name] = true; } $this->setProperty( $name, $this->getTypeInModel($model, $type), true, true, $comment, !$column->getNotnull() ); if ($this->write_model_magic_where) { $builderClass = $this->write_model_external_builder_methods ? get_class($model->newModelQuery()) : '\Illuminate\Database\Eloquent\Builder'; $this->setMethod( Str::camel('where_' . $name), $this->getClassNameInDestinationFile($model, $builderClass) . '|' . $this->getClassNameInDestinationFile($model, get_class($model)), ['$value'] ); } } } /** * @param Model $model */ public function getPropertiesFromMethods($model) { $reflectionClass = new ReflectionClass($model); $reflections = $reflectionClass->getMethods(); if ($reflections) { // Filter out private methods because they can't be used to generate magic properties and HasAttributes' // methods that resemble mutators but aren't. $reflections = array_filter($reflections, function (\ReflectionMethod $methodReflection) { return !$methodReflection->isPrivate() && !( $methodReflection->getDeclaringClass()->getName() === Model::class && ( $methodReflection->getName() === 'setClassCastableAttribute' || $methodReflection->getName() === 'setEnumCastableAttribute' ) ); }); sort($reflections); foreach ($reflections as $reflection) { $type = $this->getReturnTypeFromReflection($reflection); $isAttribute = is_a($type, '\Illuminate\Database\Eloquent\Casts\Attribute', true); $method = $reflection->getName(); if ( Str::startsWith($method, 'get') && Str::endsWith( $method, 'Attribute' ) && $method !== 'getAttribute' ) { //Magic getAttribute $name = Str::snake(substr($method, 3, -9)); if (!empty($name)) { $type = $this->getReturnType($reflection); $type = $this->getTypeInModel($model, $type); $comment = $this->getCommentFromDocBlock($reflection); $this->setProperty($name, $type, true, null, $comment); } } elseif ($isAttribute) { $types = $this->getAttributeTypes($model, $reflection); $type = $this->getTypeInModel($model, $types->get('get') ?: $types->get('set')) ?: null; $this->setProperty( Str::snake($method), $type, $types->has('get'), $types->has('set'), $this->getCommentFromDocBlock($reflection) ); } elseif ( Str::startsWith($method, 'set') && Str::endsWith( $method, 'Attribute' ) && $method !== 'setAttribute' ) { //Magic setAttribute $name = Str::snake(substr($method, 3, -9)); if (!empty($name)) { $comment = $this->getCommentFromDocBlock($reflection); $this->setProperty($name, null, null, true, $comment); } } elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') { //Magic setAttribute $name = Str::camel(substr($method, 5)); if (!empty($name)) { $comment = $this->getCommentFromDocBlock($reflection); $args = $this->getParameters($reflection); //Remove the first ($query) argument array_shift($args); $builder = $this->getClassNameInDestinationFile( $reflection->getDeclaringClass(), get_class($model->newModelQuery()) ); $modelName = $this->getClassNameInDestinationFile( $reflection->getDeclaringClass(), $reflection->getDeclaringClass()->getName() ); $this->setMethod($name, $builder . '|' . $modelName, $args, $comment); } } elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])) { $builder = $this->getClassNameInDestinationFile($model, get_class($model->newModelQuery())); $this->setMethod( $method, $builder . '|' . $this->getClassNameInDestinationFile($model, get_class($model)) ); if ($this->write_model_external_builder_methods) { $this->writeModelExternalBuilderMethods($model); } } elseif ( !method_exists('Illuminate\Database\Eloquent\Model', $method) && !Str::startsWith($method, 'get') ) { //Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php if ($returnType = $reflection->getReturnType()) { $type = $returnType instanceof ReflectionNamedType ? $returnType->getName() : (string)$returnType; } else { // php 7.x type or fallback to docblock $type = (string)$this->getReturnTypeFromDocBlock($reflection); } $file = new \SplFileObject($reflection->getFileName()); $file->seek($reflection->getStartLine() - 1); $code = ''; while ($file->key() < $reflection->getEndLine()) { $code .= $file->current(); $file->next(); } $code = trim(preg_replace('/\s\s+/', '', $code)); $begin = strpos($code, 'function('); $code = substr($code, $begin, strrpos($code, '}') - $begin + 1); foreach ( $this->getRelationTypes() as $relation => $impl ) { $search = '$this->' . $relation . '('; if (stripos($code, $search) || ltrim($impl, '\\') === ltrim((string)$type, '\\')) { //Resolve the relation's model to a Relation object. if ($reflection->getNumberOfParameters()) { continue; } $comment = $this->getCommentFromDocBlock($reflection); // Adding constraints requires reading model properties which // can cause errors. Since we don't need constraints we can // disable them when we fetch the relation to avoid errors. $relationObj = Relation::noConstraints(function () use ($model, $reflection) { try { $methodName = $reflection->getName(); return $model->$methodName(); } catch (Throwable $e) { $this->warn(sprintf('Error resolving relation model of %s:%s() : %s', get_class($model), $reflection->getName(), $e->getMessage())); return null; } }); if ($relationObj instanceof Relation) { $relatedModel = $this->getClassNameInDestinationFile( $model, get_class($relationObj->getRelated()) ); $relationReturnType = $this->getRelationReturnTypes()[$relation] ?? false; if ( $relationReturnType === 'many' || ( !$relationReturnType && strpos(get_class($relationObj), 'Many') !== false ) ) { //Collection or array of models (because Collection is Arrayable) $relatedClass = '\\' . get_class($relationObj->getRelated()); $collectionClass = $this->getCollectionClass($relatedClass); $collectionClassNameInModel = $this->getClassNameInDestinationFile( $model, $collectionClass ); $collectionTypeHint = $this->getCollectionTypeHint($collectionClassNameInModel, $relatedModel); $this->setProperty( $method, $collectionTypeHint, true, null, $comment ); if ($this->write_model_relation_count_properties) { $this->setProperty( Str::snake($method) . '_count', 'int|null', true, false // What kind of comments should be added to the relation count here? ); } } elseif ( $relationReturnType === 'morphTo' || ( !$relationReturnType && $relation === 'morphTo' ) ) { // Model isn't specified because relation is polymorphic $this->setProperty( $method, $this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent', true, null, $comment ); } else { //Single model is returned $this->setProperty( $method, $relatedModel, true, null, $comment, $this->isRelationNullable($relation, $relationObj) ); } } } } } } } } /** * Check if the relation is nullable * * @param string $relation * @param Relation $relationObj * * @return bool */ protected function isRelationNullable(string $relation, Relation $relationObj): bool { $reflectionObj = new ReflectionObject($relationObj); if (in_array($relation, ['hasOne', 'hasOneThrough', 'morphOne'], true)) { $defaultProp = $reflectionObj->getProperty('withDefault'); $defaultProp->setAccessible(true); return !$defaultProp->getValue($relationObj); } if (!$reflectionObj->hasProperty('foreignKey')) { return false; } $fkProp = $reflectionObj->getProperty('foreignKey'); $fkProp->setAccessible(true); foreach (Arr::wrap($fkProp->getValue($relationObj)) as $foreignKey) { if (isset($this->nullableColumns[$foreignKey])) { return true; } if (!in_array($foreignKey, $this->foreignKeyConstraintsColumns, true)) { return true; } } return false; } /** * @param string $name * @param string|null $type * @param bool|null $read * @param bool|null $write * @param string|null $comment * @param bool $nullable */ public function setProperty($name, $type = null, $read = null, $write = null, $comment = '', $nullable = false) { if (!isset($this->properties[$name])) { $this->properties[$name] = []; $this->properties[$name]['type'] = 'mixed'; $this->properties[$name]['read'] = false; $this->properties[$name]['write'] = false; $this->properties[$name]['comment'] = (string) $comment; } if ($type !== null) { $newType = $this->getTypeOverride($type); if ($nullable) { $newType .= '|null'; } $this->properties[$name]['type'] = $newType; } if ($read !== null) { $this->properties[$name]['read'] = $read; } if ($write !== null) { $this->properties[$name]['write'] = $write; } } public function setMethod($name, $type = '', $arguments = [], $comment = '') { $methods = array_change_key_case($this->methods, CASE_LOWER); if (!isset($methods[strtolower($name)])) { $this->methods[$name] = []; $this->methods[$name]['type'] = $type; $this->methods[$name]['arguments'] = $arguments; $this->methods[$name]['comment'] = $comment; } } public function unsetMethod($name) { foreach ($this->methods as $k => $v) { if (strtolower($k) === strtolower($name)) { unset($this->methods[$k]); return; } } } public function getMethodType(Model $model, string $classType) { $modelName = $this->getClassNameInDestinationFile($model, get_class($model)); $builder = $this->getClassNameInDestinationFile($model, $classType); return $builder . '|' . $modelName; } /** * @param string $class * @return string */ protected function createPhpDocs($class) { $reflection = new ReflectionClass($class); $namespace = $reflection->getNamespaceName(); $classname = $reflection->getShortName(); $originalDoc = $reflection->getDocComment(); $keyword = $this->getClassKeyword($reflection); $interfaceNames = array_diff_key( $reflection->getInterfaceNames(), $reflection->getParentClass()->getInterfaceNames() ); if ($this->reset) { $phpdoc = new DocBlock('', new Context($namespace)); if ($this->keep_text) { $phpdoc->setText( (new DocBlock($reflection, new Context($namespace)))->getText() ); } } else { $phpdoc = new DocBlock($reflection, new Context($namespace)); } if (!$phpdoc->getText()) { $phpdoc->setText($class); } $properties = []; $methods = []; 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 ($this->hasCamelCaseModelProperties()) { $name = Str::camel($name); } if (in_array($name, $properties)) { continue; } if ($property['read'] && $property['write']) { $attr = 'property'; } elseif ($property['write']) { $attr = 'property-write'; } else { $attr = 'property-read'; } $tagLine = trim("@{$attr} {$property['type']} {$name} {$property['comment']}"); $tag = Tag::createInstance($tagLine, $phpdoc); $phpdoc->appendTag($tag); } ksort($this->methods); foreach ($this->methods as $name => $method) { if (in_array($name, $methods)) { continue; } $arguments = implode(', ', $method['arguments']); $tagLine = "@method static {$method['type']} {$name}({$arguments})"; if ($method['comment'] !== '') { $tagLine .= " {$method['comment']}"; } $tag = Tag::createInstance($tagLine, $phpdoc); $phpdoc->appendTag($tag); } if ($this->write) { $eloquentClassNameInModel = $this->getClassNameInDestinationFile($reflection, 'Eloquent'); // remove the already existing tag to prevent duplicates foreach ($phpdoc->getTagsByName('mixin') as $tag) { if ($tag->getContent() === $eloquentClassNameInModel) { $phpdoc->deleteTag($tag); } } $phpdoc->appendTag(Tag::createInstance('@mixin ' . $eloquentClassNameInModel, $phpdoc)); } if ($this->phpstorm_noinspections) { /** * Facades, Eloquent API * @see https://www.jetbrains.com/help/phpstorm/php-fully-qualified-name-usage.html */ $phpdoc->appendTag(Tag::createInstance('@noinspection PhpFullyQualifiedNameUsageInspection', $phpdoc)); /** * Relations, other models in the same namespace * @see https://www.jetbrains.com/help/phpstorm/php-unnecessary-fully-qualified-name.html */ $phpdoc->appendTag( Tag::createInstance('@noinspection PhpUnnecessaryFullyQualifiedNameInspection', $phpdoc) ); } $serializer = new DocBlockSerializer(); $docComment = $serializer->getDocComment($phpdoc); if ($this->write_mixin) { $phpdocMixin = new DocBlock($reflection, new Context($namespace)); // remove all mixin tags prefixed with IdeHelper foreach ($phpdocMixin->getTagsByName('mixin') as $tag) { if (Str::startsWith($tag->getContent(), 'IdeHelper')) { $phpdocMixin->deleteTag($tag); } } $mixinClassName = "IdeHelper{$classname}"; $phpdocMixin->appendTag(Tag::createInstance("@mixin {$mixinClassName}", $phpdocMixin)); $mixinDocComment = $serializer->getDocComment($phpdocMixin); // remove blank lines if there's no text if (!$phpdocMixin->getText()) { $mixinDocComment = preg_replace("/\s\*\s*\n/", '', $mixinDocComment); } foreach ($phpdoc->getTagsByName('mixin') as $tag) { if (Str::startsWith($tag->getContent(), 'IdeHelper')) { $phpdoc->deleteTag($tag); } } $docComment = $serializer->getDocComment($phpdoc); } if ($this->write) { $modelDocComment = $this->write_mixin ? $mixinDocComment : $docComment; $filename = $reflection->getFileName(); $contents = $this->files->get($filename); if ($originalDoc) { $contents = str_replace($originalDoc, $modelDocComment, $contents); } else { $replace = "{$modelDocComment}\n"; $pos = strpos($contents, "final class {$classname}") ?: strpos($contents, "class {$classname}"); if ($pos !== false) { $contents = substr_replace($contents, $replace, $pos, 0); } } if ($this->files->put($filename, $contents)) { $this->info('Written new phpDocBlock to ' . $filename); } } $classname = $this->write_mixin ? $mixinClassName : $classname; $allowDynamicAttributes = $this->write_mixin ? "#[\AllowDynamicProperties]\n\t" : ''; $output = "namespace {$namespace}{\n{$docComment}\n\t{$allowDynamicAttributes}{$keyword}class {$classname} "; if (!$this->write_mixin) { $output .= "extends \Eloquent "; if ($interfaceNames) { $interfaces = implode(', \\', $interfaceNames); $output .= "implements \\{$interfaces} "; } } return $output . "{}\n}\n\n"; } /** * Get the parameters and format them correctly * * @param $method * @return array * @throws \ReflectionException */ public function getParameters($method) { //Loop through the default values for parameters, and make the correct output string $paramsWithDefault = []; /** @var \ReflectionParameter $param */ foreach ($method->getParameters() as $param) { $paramStr = $param->isVariadic() ? '...$' . $param->getName() : '$' . $param->getName(); if ($paramType = $this->getParamType($method, $param)) { $paramStr = $paramType . ' ' . $paramStr; } if ($param->isOptional() && $param->isDefaultValueAvailable()) { $default = $param->getDefaultValue(); if (is_bool($default)) { $default = $default ? 'true' : 'false'; } elseif (is_array($default)) { $default = '[]'; } elseif (is_null($default)) { $default = 'null'; } elseif (is_int($default)) { //$default = $default; } elseif ($default instanceof \UnitEnum) { $default = '\\' . get_class($default) . '::' . $default->name; } else { $default = "'" . trim($default) . "'"; } $paramStr .= " = $default"; } $paramsWithDefault[] = $paramStr; } return $paramsWithDefault; } /** * Determine a model classes' collection type. * * @see http://laravel.com/docs/eloquent-collections#custom-collections * @param string $className * @return string */ protected function getCollectionClass($className) { // Return something in the very very unlikely scenario the model doesn't // have a newCollection() method. if (!method_exists($className, 'newCollection')) { return '\Illuminate\Database\Eloquent\Collection'; } /** @var Model $model */ $model = new $className(); return '\\' . get_class($model->newCollection()); } /** * Determine a model classes' collection type hint. * * @param string $collectionClassNameInModel * @param string $relatedModel * @return string */ protected function getCollectionTypeHint(string $collectionClassNameInModel, string $relatedModel): string { $useGenericsSyntax = $this->laravel['config']->get('ide-helper.use_generics_annotations', true); if ($useGenericsSyntax) { return $collectionClassNameInModel . ''; } else { return $collectionClassNameInModel . '|' . $relatedModel . '[]'; } } /** * Returns the available relation types */ protected function getRelationTypes(): array { $configuredRelations = $this->laravel['config']->get('ide-helper.additional_relation_types', []); return array_merge(self::RELATION_TYPES, $configuredRelations); } /** * Returns the return types of relations */ protected function getRelationReturnTypes(): array { return $this->laravel['config']->get('ide-helper.additional_relation_return_types', []); } /** * @return bool */ protected function hasCamelCaseModelProperties() { return $this->laravel['config']->get('ide-helper.model_camel_case_properties', false); } /** * @psalm-suppress NoValue */ protected function getAttributeTypes(Model $model, \ReflectionMethod $reflectionMethod): Collection { // Private/protected ReflectionMethods require setAccessible prior to PHP 8.1 $reflectionMethod->setAccessible(true); /** @var Attribute $attribute */ $attribute = $reflectionMethod->invoke($model); $methods = new Collection(); if ($attribute->get) { $methods['get'] = optional(new \ReflectionFunction($attribute->get))->getReturnType(); } if ($attribute->set) { $function = optional(new \ReflectionFunction($attribute->set)); if ($function->getNumberOfParameters() === 0) { $methods['set'] = null; } else { $methods['set'] = $function->getParameters()[0]->getType(); } } return $methods ->map(function ($type) { if ($type === null) { $types = collect([]); } elseif ($type instanceof \ReflectionUnionType) { $types = collect($type->getTypes()) /** @var ReflectionType $reflectionType */ ->map(function ($reflectionType) { return collect($this->extractReflectionTypes($reflectionType)); }) ->flatten(); } else { $types = collect($this->extractReflectionTypes($type)); } if ($type && $type->allowsNull()) { $types->push('null'); } return $types->join('|'); }); } protected function getReturnType(\ReflectionMethod $reflection): ?string { $type = $this->getReturnTypeFromDocBlock($reflection); if ($type) { return $type; } return $this->getReturnTypeFromReflection($reflection); } /** * Get method comment based on it DocBlock comment * * @param \ReflectionMethod $reflection * * @return null|string */ protected function getCommentFromDocBlock(\ReflectionMethod $reflection) { $phpDocContext = (new ContextFactory())->createFromReflector($reflection); $context = new Context( $phpDocContext->getNamespace(), $phpDocContext->getNamespaceAliases() ); $comment = ''; $phpdoc = new DocBlock($reflection, $context); if ($phpdoc->hasTag('comment')) { $comment = $phpdoc->getTagsByName('comment')[0]->getContent(); } return $comment; } /** * Get method return type based on it DocBlock comment * * @param \ReflectionMethod $reflection * * @return null|string */ protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection, \Reflector $reflectorForContext = null) { $phpDocContext = (new ContextFactory())->createFromReflector($reflectorForContext ?? $reflection); $context = new Context( $phpDocContext->getNamespace(), $phpDocContext->getNamespaceAliases() ); $type = null; $phpdoc = new DocBlock($reflection, $context); if ($phpdoc->hasTag('return')) { $type = $phpdoc->getTagsByName('return')[0]->getType(); } return $type; } protected function getReturnTypeFromReflection(\ReflectionMethod $reflection): ?string { $returnType = $reflection->getReturnType(); if (!$returnType) { return null; } $types = $this->extractReflectionTypes($returnType); $type = implode('|', $types); if ($returnType->allowsNull()) { $type .= '|null'; } return $type; } /** * Generates methods provided by the SoftDeletes trait * @param Model $model */ protected function getSoftDeleteMethods($model) { $traits = class_uses_recursive($model); if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) { $modelName = $this->getClassNameInDestinationFile($model, get_class($model)); $builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class); $this->setMethod('withTrashed', $builder . '|' . $modelName, []); $this->setMethod('withoutTrashed', $builder . '|' . $modelName, []); $this->setMethod('onlyTrashed', $builder . '|' . $modelName, []); } } /** * Generate factory method from "HasFactory" trait. * * @param Model $model */ protected function getFactoryMethods($model) { if (!class_exists(Factory::class)) { return; } $modelName = get_class($model); $traits = class_uses_recursive($modelName); if (!in_array('Illuminate\\Database\\Eloquent\\Factories\\HasFactory', $traits)) { return; } if ($modelName::newFactory()) { $factory = get_class($modelName::newFactory()); } else { $factory = Factory::resolveFactoryName($modelName); } $factory = '\\' . trim($factory, '\\'); if (!class_exists($factory)) { return; } $this->setMethod('factory', $factory, ['$count = null, $state = []']); } /** * Generates methods that return collections * @param Model $model */ protected function getCollectionMethods($model) { $collectionClass = $this->getCollectionClass(get_class($model)); if ($collectionClass !== '\\' . \Illuminate\Database\Eloquent\Collection::class) { $collectionClassInModel = $this->getClassNameInDestinationFile($model, $collectionClass); $collectionTypeHint = $this->getCollectionTypeHint($collectionClassInModel, 'static'); $this->setMethod('get', $collectionTypeHint, ['$columns = [\'*\']']); $this->setMethod('all', $collectionTypeHint, ['$columns = [\'*\']']); } } /** * @param ReflectionClass $reflection * @return string */ protected function getClassKeyword(ReflectionClass $reflection) { if ($reflection->isFinal()) { $keyword = 'final '; } elseif ($reflection->isAbstract()) { $keyword = 'abstract '; } else { $keyword = ''; } return $keyword; } protected function isInboundCast(string $type): bool { return class_exists($type) && is_subclass_of($type, CastsInboundAttributes::class); } protected function checkForCastableCasts(string $type, array $params = []): string { if (!class_exists($type) || !interface_exists(Castable::class)) { return $type; } $reflection = new ReflectionClass($type); if (!$reflection->implementsInterface(Castable::class)) { return $type; } $cast = call_user_func([$type, 'castUsing'], $params); if (is_string($cast) && !is_object($cast)) { return $cast; } $castReflection = new ReflectionObject($cast); $methodReflection = $castReflection->getMethod('get'); return $this->getReturnTypeFromReflection($methodReflection) ?? $this->getReturnTypeFromDocBlock($methodReflection, $reflection) ?? $type; } /** * @param string $type * @return string|null * @throws \ReflectionException */ protected function checkForCustomLaravelCasts(string $type): ?string { if (!class_exists($type) || !interface_exists(CastsAttributes::class)) { return $type; } $reflection = new ReflectionClass($type); if (!$reflection->implementsInterface(CastsAttributes::class)) { return $type; } $methodReflection = new \ReflectionMethod($type, 'get'); $reflectionType = $this->getReturnTypeFromReflection($methodReflection); if ($reflectionType === null) { $reflectionType = $this->getReturnTypeFromDocBlock($methodReflection); } if ($reflectionType === 'static' || $reflectionType === '$this') { $reflectionType = $type; } return $reflectionType; } protected function getTypeInModel(object $model, ?string $type): ?string { if ($type === null) { return null; } if (class_exists($type)) { $type = $this->getClassNameInDestinationFile($model, $type); } return $type; } protected function getClassNameInDestinationFile(object $model, string $className): string { $reflection = $model instanceof ReflectionClass ? $model : new ReflectionObject($model); $className = trim($className, '\\'); $writingToExternalFile = !$this->write || $this->write_mixin; $classIsNotInExternalFile = $reflection->getName() !== $className; $forceFQCN = $this->laravel['config']->get('ide-helper.force_fqn', false); if (($writingToExternalFile && $classIsNotInExternalFile) || $forceFQCN) { return '\\' . $className; } $usedClassNames = $this->getUsedClassNames($reflection); return $usedClassNames[$className] ?? ('\\' . $className); } /** * @param ReflectionClass $reflection * @return string[] */ protected function getUsedClassNames(ReflectionClass $reflection): array { $namespaceAliases = array_flip((new ContextFactory())->createFromReflector($reflection)->getNamespaceAliases()); $namespaceAliases[$reflection->getName()] = $reflection->getShortName(); return $namespaceAliases; } protected function writeModelExternalBuilderMethods(Model $model): void { $fullBuilderClass = '\\' . get_class($model->newModelQuery()); $newBuilderMethods = get_class_methods($fullBuilderClass); $originalBuilderMethods = get_class_methods('\Illuminate\Database\Eloquent\Builder'); // diff the methods between the new builder and original one // and create helpers for the ones that are new $newMethodsFromNewBuilder = array_diff($newBuilderMethods, $originalBuilderMethods); if (!$newMethodsFromNewBuilder) { return; } // after we have retrieved the builder's methods // get the class of the builder based on the FQCN option $builderClassBasedOnFQCNOption = $this->getClassNameInDestinationFile($model, get_class($model->newModelQuery())); foreach ($newMethodsFromNewBuilder as $builderMethod) { $reflection = new \ReflectionMethod($fullBuilderClass, $builderMethod); $args = $this->getParameters($reflection); $this->setMethod( $builderMethod, $builderClassBasedOnFQCNOption . '|' . $this->getClassNameInDestinationFile($model, get_class($model)), $args ); } } protected function getParamType(\ReflectionMethod $method, \ReflectionParameter $parameter): ?string { if ($paramType = $parameter->getType()) { $types = $this->extractReflectionTypes($paramType); $type = implode('|', $types); if ($paramType->allowsNull()) { if (count($types) == 1) { $type = '?' . $type; } else { $type .= '|null'; } } return $type; } $docComment = $method->getDocComment(); if (!$docComment) { return null; } preg_match( '/@param ((?:(?:[\w?|\\\\<>])+(?:\[])?)+)/', $docComment ?? '', $matches ); $type = $matches[1] ?? ''; if (strpos($type, '|') !== false) { $types = explode('|', $type); // if we have more than 2 types // we return null as we cannot use unions in php yet if (count($types) > 2) { return null; } $hasNull = false; foreach ($types as $currentType) { if ($currentType === 'null') { $hasNull = true; continue; } // if we didn't find null assign the current type to the type we want $type = $currentType; } // if we haven't found null type set // we return null as we cannot use unions with different types yet if (!$hasNull) { return null; } $type = '?' . $type; } // convert to proper type hint types in php $type = str_replace(['boolean', 'integer'], ['bool', 'int'], $type); $allowedTypes = [ 'int', 'bool', 'string', 'float', ]; // we replace the ? with an empty string so we can check the actual type if (!in_array(str_replace('?', '', $type), $allowedTypes)) { return null; } // if we have a match on index 1 // then we have found the type of the variable if not we return null return $type; } protected function extractReflectionTypes(ReflectionType $reflection_type) { if ($reflection_type instanceof ReflectionNamedType) { $types[] = $this->getReflectionNamedType($reflection_type); } else { $types = []; foreach ($reflection_type->getTypes() as $named_type) { if ($named_type->getName() === 'null') { continue; } $types[] = $this->getReflectionNamedType($named_type); } } return $types; } protected function getReflectionNamedType(ReflectionNamedType $paramType): string { $parameterName = $paramType->getName(); if (!$paramType->isBuiltin()) { $parameterName = '\\' . $parameterName; } return $parameterName; } /** * @param Model $model * @throws \Illuminate\Contracts\Container\BindingResolutionException * @throws \RuntimeException */ protected function runModelHooks($model): void { $hooks = $this->laravel['config']->get('ide-helper.model_hooks', []); foreach ($hooks as $hook) { $hookInstance = $this->laravel->make($hook); if (!$hookInstance instanceof ModelHookInterface) { throw new \RuntimeException( 'Your IDE helper model hook must implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface' ); } $hookInstance->run($this, $model); } } /** * @param \Doctrine\DBAL\Schema\AbstractSchemaManager $schema * @param string $table * @throws DBALException */ protected function setForeignKeys($schema, $table) { foreach ($schema->listTableForeignKeys($table) as $foreignKeyConstraint) { foreach ($foreignKeyConstraint->getLocalColumns() as $columnName) { $this->foreignKeyConstraintsColumns[] = $columnName; } } } } laravel-ide-helper/src/Contracts/ModelHookInterface.php000064400000000373152427540010017153 0ustar00 * @copyright 2014 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 Barryvdh\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock\Context; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Tag\MethodTag; use Closure; use Illuminate\Config\Repository as ConfigRepository; use Illuminate\Database\Eloquent\Builder as EloquentBuilder; use Illuminate\Support\Facades\Facade; use ReflectionClass; use Throwable; class Alias { protected $alias; /** @psalm-var class-string $facade */ protected $facade; protected $extends = null; protected $extendsClass = null; protected $extendsNamespace = null; protected $classType = 'class'; protected $short; protected $namespace = '__root'; protected $root = null; protected $classes = []; protected $methods = []; protected $usedMethods = []; protected $valid = false; protected $magicMethods = []; protected $interfaces = []; protected $phpdoc = null; protected $classAliases = []; /** @var ConfigRepository */ protected $config; /** * @param ConfigRepository $config * @param string $alias * @psalm-param class-string $facade * @param string $facade * @param array $magicMethods * @param array $interfaces */ public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = []) { $this->alias = $alias; $this->magicMethods = $magicMethods; $this->interfaces = $interfaces; $this->config = $config; // Make the class absolute $facade = '\\' . ltrim($facade, '\\'); $this->facade = $facade; $this->detectRoot(); if (!$this->root || $this->isTrait()) { return; } $this->valid = true; $this->addClass($this->root); $this->detectFake(); $this->detectNamespace(); $this->detectClassType(); $this->detectExtendsNamespace(); if (!empty($this->namespace)) { $this->classAliases = (new UsesResolver())->loadFromClass($this->root); //Create a DocBlock and serializer instance $this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace, $this->classAliases)); } if ($facade === '\Illuminate\Database\Eloquent\Model') { $this->usedMethods = ['decrement', 'increment']; } } /** * Add one or more classes to analyze * * @param array|string $classes */ public function addClass($classes) { $classes = (array)$classes; foreach ($classes as $class) { if (class_exists($class) || interface_exists($class)) { $this->classes[] = $class; } else { echo "Class not exists: $class\r\n"; } } } /** * Check if this class is valid to process. * @return bool */ public function isValid() { return $this->valid; } /** * Get the classtype, 'interface' or 'class' * * @return string */ public function getClasstype() { return $this->classType; } /** * Get the class which this alias extends * * @return null|string */ public function getExtends() { return $this->extends; } /** * Get the class short name which this alias extends * * @return null|string */ public function getExtendsClass() { return $this->extendsClass; } /** * Get the namespace of the class which this alias extends * * @return null|string */ public function getExtendsNamespace() { return $this->extendsNamespace; } /** * Get the Alias by which this class is called * * @return string */ public function getAlias() { return $this->alias; } /** * Return the short name (without namespace) */ public function getShortName() { return $this->short; } /** * Get the namespace from the alias * * @return string */ public function getNamespace() { return $this->namespace; } /** * Get the methods found by this Alias * * @return array|Method[] */ public function getMethods() { if (count($this->methods) > 0) { return $this->methods; } $this->addMagicMethods(); $this->detectMethods(); return $this->methods; } /** * Detect class returned by ::fake() */ protected function detectFake() { $facade = $this->facade; if (!is_subclass_of($facade, Facade::class)) { return; } if (!method_exists($facade, 'fake')) { return; } $real = $facade::getFacadeRoot(); try { $facade::fake(); $fake = $facade::getFacadeRoot(); if ($fake !== $real) { $this->addClass(get_class($fake)); } } finally { $facade::swap($real); } } /** * Detect the namespace */ protected function detectNamespace() { if (strpos($this->alias, '\\')) { $nsParts = explode('\\', $this->alias); $this->short = array_pop($nsParts); $this->namespace = implode('\\', $nsParts); } else { $this->short = $this->alias; } } /** * Detect the extends namespace */ protected function detectExtendsNamespace() { if (strpos($this->extends, '\\') !== false) { $nsParts = explode('\\', $this->extends); $this->extendsClass = array_pop($nsParts); $this->extendsNamespace = implode('\\', $nsParts); } } /** * Detect the class type */ protected function detectClassType() { //Some classes extend the facade if (interface_exists($this->facade)) { $this->classType = 'interface'; $this->extends = $this->facade; } else { $this->classType = 'class'; if (class_exists($this->facade)) { $this->extends = $this->facade; } } } /** * Get the real root of a facade * * @return bool|string */ protected function detectRoot() { $facade = $this->facade; try { //If possible, get the facade root if (method_exists($facade, 'getFacadeRoot')) { $root = get_class($facade::getFacadeRoot()); } else { $root = $facade; } //If it doesn't exist, skip it if (!class_exists($root) && !interface_exists($root)) { return; } $this->root = $root; //When the database connection is not set, some classes will be skipped } catch (\PDOException $e) { $this->error( 'PDOException: ' . $e->getMessage() . "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." . " Skipping $facade." ); } catch (Throwable $e) { $this->error('Exception: ' . $e->getMessage() . "\nSkipping $facade."); } } /** * Detect if this class is a trait or not. * * @return bool */ protected function isTrait() { // Check if the facade is not a Trait return trait_exists($this->facade); } /** * Add magic methods, as defined in the configuration files */ protected function addMagicMethods() { foreach ($this->magicMethods as $magic => $real) { [$className, $name] = explode('::', $real); if ((!class_exists($className) && !interface_exists($className)) || !method_exists($className, $name)) { continue; } $method = new \ReflectionMethod($className, $name); $class = new ReflectionClass($className); if (!in_array($magic, $this->usedMethods)) { if ($class !== $this->root) { $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces, $this->classAliases); } $this->usedMethods[] = $magic; } } } /** * Get the methods for one or multiple classes. * * @return string */ protected function detectMethods() { foreach ($this->classes as $class) { $reflection = new ReflectionClass($class); $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC); if ($methods) { foreach ($methods as $method) { if (!in_array($method->name, $this->usedMethods)) { // Only add the methods to the output when the root is not the same as the class. // And don't add the __*() methods if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') { $this->methods[] = new Method( $method, $this->alias, $reflection, $method->name, $this->interfaces, $this->classAliases ); } $this->usedMethods[] = $method->name; } } } // Check if the class is macroable // (Eloquent\Builder is also macroable but doesn't use Macroable trait) $traits = collect($reflection->getTraitNames()); if ($traits->contains('Illuminate\Support\Traits\Macroable') || $class === EloquentBuilder::class) { $properties = $reflection->getStaticProperties(); $macros = isset($properties['macros']) ? $properties['macros'] : []; foreach ($macros as $macro_name => $macro_func) { if (!in_array($macro_name, $this->usedMethods)) { // Add macros $this->methods[] = new Macro( $this->getMacroFunction($macro_func), $this->alias, $reflection, $macro_name, $this->interfaces, $this->classAliases ); $this->usedMethods[] = $macro_name; } } } } } /** * @param $macro_func * * @return \ReflectionFunctionAbstract * @throws \ReflectionException */ protected function getMacroFunction($macro_func) { if (is_array($macro_func) && is_callable($macro_func)) { return new \ReflectionMethod($macro_func[0], $macro_func[1]); } if (is_object($macro_func) && is_callable($macro_func) && !$macro_func instanceof Closure) { return new \ReflectionMethod($macro_func, '__invoke'); } return new \ReflectionFunction($macro_func); } /* * Get the docblock for this alias * * @param string $prefix * @return mixed */ public function getDocComment($prefix = "\t\t") { $serializer = new DocBlockSerializer(1, $prefix); if (!$this->phpdoc) { return ''; } if ($this->config->get('ide-helper.include_class_docblocks')) { // if a class doesn't expose any DocBlock tags // we can perform reflection on the class and // add in the original class DocBlock if (count($this->phpdoc->getTags()) === 0) { $class = new ReflectionClass($this->root); $this->phpdoc = new DocBlock($class->getDocComment()); } } $this->removeDuplicateMethodsFromPhpDoc(); return $serializer->getDocComment($this->phpdoc); } /** * Removes method tags from the doc comment that already appear as functions inside the class. * This prevents duplicate function errors in the IDE. * * @return void */ protected function removeDuplicateMethodsFromPhpDoc() { $methodNames = array_map(function (Method $method) { return $method->getName(); }, $this->getMethods()); foreach ($this->phpdoc->getTags() as $tag) { if ($tag instanceof MethodTag && in_array($tag->getMethodName(), $methodNames)) { $this->phpdoc->deleteTag($tag); } } } /** * Output an error. * * @param string $string * @return void */ protected function error($string) { echo $string . "\r\n"; } } laravel-ide-helper/src/UsesResolver.php000064400000006305152427540010014153 0ustar00 * @copyright 2014 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 PhpParser\Node\Stmt\GroupUse; use PhpParser\Node\Stmt\Namespace_; use PhpParser\Node\Stmt\Use_; use PhpParser\Node\Stmt\UseUse; use PhpParser\ParserFactory; class UsesResolver { /** * @param string $classFQN * @return array */ public function loadFromClass(string $classFQN): array { return $this->loadFromFile( $classFQN, (new \ReflectionClass($classFQN))->getFileName() ); } /** * @param string $classFQN * @param string $filename * @return array */ public function loadFromFile(string $classFQN, string $filename): array { return $this->loadFromCode( $classFQN, file_get_contents( $filename ) ); } /** * @param string $classFQN * @param string $code * @return array */ public function loadFromCode(string $classFQN, string $code): array { $classFQN = ltrim($classFQN, '\\'); $namespace = rtrim( preg_replace( '/([^\\\\]+)$/', '', $classFQN ), '\\' ); $parser = (new ParserFactory())->createForHostVersion(); $namespaceData = null; foreach ($parser->parse($code) as $node) { if ($node instanceof Namespace_ && $node->name->toCodeString() === $namespace) { $namespaceData = $node; break; } } if ($namespaceData === null) { return []; } /** @var Namespace_ $namespaceData */ $aliases = []; foreach ($namespaceData->stmts as $stmt) { if ($stmt instanceof Use_) { if ($stmt->type !== Use_::TYPE_NORMAL) { continue; } foreach ($stmt->uses as $use) { /** @var UseUse $use */ $alias = $use->alias ? $use->alias->name : self::classBasename($use->name->toCodeString()); $aliases[$alias] = '\\' . $use->name->toCodeString(); } } elseif ($stmt instanceof GroupUse) { foreach ($stmt->uses as $use) { /** @var UseUse $use */ $alias = $use->alias ? $use->alias->name : self::classBasename($use->name->toCodeString()); $aliases[$alias] = '\\' . $stmt->prefix->toCodeString() . '\\' . $use->name->toCodeString(); } } } return $aliases; } /** * @param string $classFQN * @return string */ protected static function classBasename(string $classFQN): string { return preg_replace('/^.*\\\\([^\\\\]+)$/', '$1', $classFQN); } } laravel-ide-helper/src/Macro.php000064400000010111152427540010012541 0ustar00phpdoc = new DocBlock($method); $this->addLocationToPhpDoc(); // Add macro parameters if they are missed in original docblock if (!$this->phpdoc->hasTag('param')) { foreach ($method->getParameters() as $parameter) { $reflectionType = $parameter->getType(); $type = $this->concatReflectionTypes($reflectionType); /** @psalm-suppress UndefinedClass */ if ($reflectionType && !$reflectionType instanceof \ReflectionUnionType && $reflectionType->allowsNull()) { $type .= '|null'; } $type = $type ?: 'mixed'; $name = $parameter->isVariadic() ? '...' : ''; $name .= '$' . $parameter->getName(); $this->phpdoc->appendTag(Tag::createInstance("@param {$type} {$name}")); } } // Add macro return type if it missed in original docblock if ($method->hasReturnType() && !$this->phpdoc->hasTag('return')) { $builder = EloquentBuilder::class; $return = $method->getReturnType(); $type = $this->concatReflectionTypes($return); /** @psalm-suppress UndefinedClass */ if (!$return instanceof \ReflectionUnionType) { $type .= $this->root === "\\{$builder}" && $return->getName() === $builder ? '|static' : ''; $type .= $return->allowsNull() ? '|null' : ''; } $this->phpdoc->appendTag(Tag::createInstance("@return {$type}")); } } protected function concatReflectionTypes(?\ReflectionType $type): string { /** @psalm-suppress UndefinedClass */ $returnTypes = $type instanceof \ReflectionUnionType ? $type->getTypes() : [$type]; return Collection::make($returnTypes) ->filter() ->map->getName() ->implode('|'); } protected function addLocationToPhpDoc() { if ($this->method->name === '__invoke') { $enclosingClass = $this->method->getDeclaringClass(); } else { $enclosingClass = $this->method->getClosureScopeClass(); } if (!$enclosingClass) { return; } /** @var \ReflectionMethod $enclosingMethod */ $enclosingMethod = Collection::make($enclosingClass->getMethods()) ->first(function (\ReflectionMethod $method) { return $method->getStartLine() <= $this->method->getStartLine() && $method->getEndLine() >= $this->method->getEndLine(); }); if ($enclosingMethod) { $this->phpdoc->appendTag(Tag::createInstance( '@see \\' . $enclosingClass->getName() . '::' . $enclosingMethod->getName() . '()' )); } } /** * @param \ReflectionFunctionAbstract $method * @param \ReflectionClass $class */ protected function initClassDefinedProperties($method, \ReflectionClass $class) { $this->namespace = $class->getNamespaceName(); $this->declaringClassName = '\\' . ltrim($class->name, '\\'); } } laravel-ide-helper/src/Method.php000064400000026160152427540010012733 0ustar00 * @copyright 2014 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 Barryvdh\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock\Context; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag\ParamTag; use Barryvdh\Reflection\DocBlock\Tag\ReturnTag; use Illuminate\Database\Eloquent\Builder; use Illuminate\Support\Str; class Method { /** @var DocBlock */ protected $phpdoc; /** @var \ReflectionMethod */ protected $method; protected $output = ''; protected $declaringClassName; protected $name; protected $namespace; protected $params = []; protected $params_with_default = []; protected $interfaces = []; protected $real_name; protected $return = null; protected $root; protected $classAliases; /** * @param \ReflectionMethod|\ReflectionFunctionAbstract $method * @param string $alias * @param \ReflectionClass $class * @param string|null $methodName * @param array $interfaces * @param array $classAliases */ public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = []) { $this->method = $method; $this->interfaces = $interfaces; $this->classAliases = $classAliases; $this->name = $methodName ?: $method->name; $this->real_name = $method->isClosure() ? $this->name : $method->name; $this->initClassDefinedProperties($method, $class); //Reference the 'real' function in the declaring class $this->root = '\\' . ltrim($method->name === '__invoke' ? $method->getDeclaringClass()->getName() : $class->getName(), '\\'); //Create a DocBlock and serializer instance $this->initPhpDoc($method); //Normalize the description and inherit the docs from parents/interfaces try { $this->normalizeParams($this->phpdoc); $this->normalizeReturn($this->phpdoc); $this->normalizeDescription($this->phpdoc); } catch (\Exception $e) { } //Get the parameters, including formatted default values $this->getParameters($method); //Make the method static $this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc)); } /** * @param \ReflectionMethod $method */ protected function initPhpDoc($method) { $this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases)); } /** * @param \ReflectionMethod $method * @param \ReflectionClass $class */ protected function initClassDefinedProperties($method, \ReflectionClass $class) { $declaringClass = $method->getDeclaringClass(); $this->namespace = $declaringClass->getNamespaceName(); $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\'); } /** * Get the class wherein the function resides * * @return string */ public function getDeclaringClass() { return $this->declaringClassName; } /** * Return the class from which this function would be called * * @return string */ public function getRoot() { return $this->root; } /** * @return bool */ public function isInstanceCall() { return !($this->method->isClosure() || $this->method->isStatic()); } /** * @return string */ public function getRootMethodCall() { if ($this->isInstanceCall()) { return "\$instance->{$this->getRealName()}({$this->getParams()})"; } else { return "{$this->getRoot()}::{$this->getRealName()}({$this->getParams()})"; } } /** * Get the docblock for this method * * @param string $prefix * @return mixed */ public function getDocComment($prefix = "\t\t") { $serializer = new DocBlockSerializer(1, $prefix); return $serializer->getDocComment($this->phpdoc); } /** * Get the method name * * @return string */ public function getName() { return $this->name; } /** * Get the real method name * * @return string */ public function getRealName() { return $this->real_name; } /** * Get the parameters for this method * * @param bool $implode Wether to implode the array or not * @return string */ public function getParams($implode = true) { return $implode ? implode(', ', $this->params) : $this->params; } /** * Get the parameters for this method including default values * * @param bool $implode Wether to implode the array or not * @return string */ public function getParamsWithDefault($implode = true) { return $implode ? implode(', ', $this->params_with_default) : $this->params_with_default; } /** * Get the description and get the inherited docs. * * @param DocBlock $phpdoc */ protected function normalizeDescription(DocBlock $phpdoc) { //Get the short + long description from the DocBlock $description = $phpdoc->getText(); //Loop through parents/interfaces, to fill in {@inheritdoc} if (strpos($description, '{@inheritdoc}') !== false) { $inheritdoc = $this->getInheritDoc($this->method); $inheritDescription = $inheritdoc->getText(); $description = str_replace('{@inheritdoc}', $inheritDescription, $description); $phpdoc->setText($description); $this->normalizeParams($inheritdoc); $this->normalizeReturn($inheritdoc); //Add the tags that are inherited $inheritTags = $inheritdoc->getTags(); if ($inheritTags) { /** @var Tag $tag */ foreach ($inheritTags as $tag) { $tag->setDocBlock(); $phpdoc->appendTag($tag); } } } } /** * Normalize the parameters * * @param DocBlock $phpdoc */ protected function normalizeParams(DocBlock $phpdoc) { //Get the return type and adjust them for beter autocomplete $paramTags = $phpdoc->getTagsByName('param'); if ($paramTags) { /** @var ParamTag $tag */ foreach ($paramTags as $tag) { // Convert the keywords $content = $this->convertKeywords($tag->getContent()); $tag->setContent($content); // Get the expanded type and re-set the content $content = $tag->getType() . ' ' . $tag->getVariableName() . ' ' . $tag->getDescription(); $tag->setContent(trim($content)); } } } /** * Normalize the return tag (make full namespace, replace interfaces) * * @param DocBlock $phpdoc */ protected function normalizeReturn(DocBlock $phpdoc) { //Get the return type and adjust them for better autocomplete $returnTags = $phpdoc->getTagsByName('return'); if (count($returnTags) === 0) { $this->return = null; return; } /** @var ReturnTag $tag */ $tag = reset($returnTags); // Get the expanded type $returnValue = $tag->getType(); // Replace the interfaces foreach ($this->interfaces as $interface => $real) { $returnValue = str_replace($interface, $real, $returnValue); } // Set the changed content $tag->setContent($returnValue . ' ' . $tag->getDescription()); $this->return = $returnValue; if ($tag->getType() === '$this') { Str::contains($this->root, Builder::class) ? $tag->setType($this->root . '|static') : $tag->setType($this->root); } } /** * Convert keywords that are incorrect. * * @param string $string * @return string */ protected function convertKeywords($string) { $string = str_replace('\Closure', 'Closure', $string); $string = str_replace('Closure', '\Closure', $string); $string = str_replace('dynamic', 'mixed', $string); return $string; } /** * Should the function return a value? * * @return bool */ public function shouldReturn() { if ($this->return !== 'void' && $this->method->name !== '__construct') { return true; } return false; } /** * Get the parameters and format them correctly * * @param \ReflectionMethod $method * @return void */ public function getParameters($method) { //Loop through the default values for parameters, and make the correct output string $params = []; $paramsWithDefault = []; foreach ($method->getParameters() as $param) { $paramStr = $param->isVariadic() ? '...$' . $param->getName() : '$' . $param->getName(); $params[] = $paramStr; if ($param->isOptional() && !$param->isVariadic()) { $default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null; if (is_bool($default)) { $default = $default ? 'true' : 'false'; } elseif (is_array($default)) { $default = '[]'; } elseif (is_null($default)) { $default = 'null'; } elseif (is_int($default)) { //$default = $default; } elseif (is_resource($default)) { //skip to not fail } else { $default = var_export($default, true); } $paramStr .= " = $default"; } $paramsWithDefault[] = $paramStr; } $this->params = $params; $this->params_with_default = $paramsWithDefault; } /** * @param \ReflectionMethod $reflectionMethod * @return DocBlock */ protected function getInheritDoc($reflectionMethod) { $parentClass = $reflectionMethod->getDeclaringClass()->getParentClass(); //Get either a parent or the interface if ($parentClass) { $method = $parentClass->getMethod($reflectionMethod->getName()); } else { $method = $reflectionMethod->getPrototype(); } if ($method) { $namespace = $method->getDeclaringClass()->getNamespaceName(); $phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases)); if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) { //Not at the end yet, try another parent/interface.. return $this->getInheritDoc($method); } return $phpdoc; } } } laravel-ide-helper/src/Eloquent.php000064400000006456152427540010013315 0ustar00 */ namespace Barryvdh\LaravelIdeHelper; use Barryvdh\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock\Context; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Tag; use Illuminate\Console\Command; use Illuminate\Filesystem\Filesystem; class Eloquent { /** * Write mixin helper to the Eloquent\Model * This is needed since laravel/framework v5.4.29 * * @param Command $command * @param Filesystem $files * * @return void */ public static function writeEloquentModelHelper(Command $command, Filesystem $files) { $class = 'Illuminate\Database\Eloquent\Model'; $reflection = new \ReflectionClass($class); $namespace = $reflection->getNamespaceName(); $originalDoc = $reflection->getDocComment(); if (!$originalDoc) { $command->info('Unexpected no document on ' . $class); } $phpdoc = new DocBlock($reflection, new Context($namespace)); $mixins = $phpdoc->getTagsByName('mixin'); $expectedMixins = [ '\Eloquent' => false, '\Illuminate\Database\Eloquent\Builder' => false, '\Illuminate\Database\Query\Builder' => false, ]; foreach ($mixins as $m) { $mixin = $m->getContent(); if (isset($expectedMixins[$mixin])) { $command->info('Tag Exists: @mixin ' . $mixin . ' in ' . $class); $expectedMixins[$mixin] = true; } } $changed = false; foreach ($expectedMixins as $expectedMixin => $present) { if ($present === false) { $phpdoc->appendTag(Tag::createInstance('@mixin ' . $expectedMixin, $phpdoc)); $changed = true; } } // If nothing's changed, stop here. if (!$changed) { return; } $serializer = new DocBlockSerializer(); $serializer->getDocComment($phpdoc); $docComment = $serializer->getDocComment($phpdoc); /* The new DocBlock is appended to the beginning of the class declaration. Since there is no DocBlock, the declaration is used as a guide. */ if (!$originalDoc) { $originalDoc = 'abstract class Model implements'; $docComment .= "\nabstract class Model implements"; } $filename = $reflection->getFileName(); if (!$filename) { $command->error('Filename not found ' . $class); return; } $contents = $files->get($filename); if (!$contents) { $command->error('No file contents found ' . $filename); return; } $count = 0; $contents = str_replace($originalDoc, $docComment, $contents, $count); if ($count <= 0) { $command->error('Content did not change ' . $contents); return; } if (!$files->put($filename, $contents)) { $command->error('File write failed to ' . $filename); return; } $command->info('Wrote expected docblock to ' . $filename); } } laravel-ide-helper/src/Factories.php000064400000001566152427540010013435 0ustar00getProperty('definitions'); $definitions->setAccessible(true); foreach ($definitions->getValue($factory) as $factory_target => $config) { try { $factories[] = new ReflectionClass($factory_target); } catch (Exception $exception) { } } } return $factories; } protected static function isLaravelSevenOrLower() { return class_exists('Illuminate\Database\Eloquent\Factory'); } } laravel-ide-helper/src/Generator.php000064400000027211152427540010013437 0ustar00 * @copyright 2014 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\Foundation\AliasLoader; use Illuminate\Support\Collection; use Illuminate\Support\Facades\Facade; use Illuminate\Support\Str; use Illuminate\Support\Traits\Macroable; use PhpParser\Lexer\Emulative; use PhpParser\Node\Stmt\Class_; use PhpParser\Node\Stmt\Namespace_; use PhpParser\Parser\Php7; use ReflectionClass; use Symfony\Component\Console\Output\OutputInterface; class Generator { /** @var \Illuminate\Config\Repository */ protected $config; /** @var \Illuminate\View\Factory */ protected $view; /** @var OutputInterface */ protected $output; protected $extra = []; protected $magic = []; protected $interfaces = []; protected $helpers; /** * @param \Illuminate\Config\Repository $config * @param \Illuminate\View\Factory $view * @param OutputInterface $output * @param string $helpers */ public function __construct( /*ConfigRepository */ $config, /* Illuminate\View\Factory */ $view, OutputInterface $output = null, $helpers = '' ) { $this->config = $config; $this->view = $view; // Find the drivers to add to the extra/interfaces $this->detectDrivers(); $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'), []); $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'), []); $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'), []); // Make all interface classes absolute foreach ($this->interfaces as &$interface) { $interface = '\\' . ltrim($interface, '\\'); } $this->helpers = $helpers; } /** * Generate the helper file contents; * * @return string; */ public function generate() { $app = app(); return $this->view->make('helper') ->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace()) ->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace()) ->with('real_time_facades', $this->getRealTimeFacades()) ->with('helpers', $this->helpers) ->with('version', $app->version()) ->with('include_fluent', $this->config->get('ide-helper.include_fluent', true)) ->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : []) ->render(); } protected function detectDrivers() { $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User')); $this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel; try { if ( class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true) && app()->bound('auth') ) { $class = get_class(\Auth::guard()); $this->extra['Auth'] = [$class]; $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class; } } catch (\Exception $e) { } try { if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) { $class = get_class(\DB::connection()); $this->extra['DB'] = [$class]; $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class; } } catch (\Exception $e) { } try { if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) { $driver = get_class(\Cache::driver()); $store = get_class(\Cache::getStore()); $this->extra['Cache'] = [$driver, $store]; $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store; } } catch (\Exception $e) { } try { if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) { $class = get_class(\Queue::connection()); $this->extra['Queue'] = [$class]; $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class; } } catch (\Exception $e) { } try { if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) { $class = get_class(\Storage::disk()); $this->extra['Storage'] = [$class]; $this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class; } } catch (\Exception $e) { } } /** * Find all aliases that are valid for us to render * * @return Collection */ protected function getValidAliases() { $aliases = new Collection(); // Get all aliases foreach ($this->getAliases() as $name => $facade) { // Skip the Redis facade, if not available (otherwise Fatal PHP Error) if ($facade == 'Illuminate\Support\Facades\Redis' && $name == 'Redis' && !class_exists('Predis\Client')) { continue; } // Skip the swoole if ($facade == 'SwooleTW\Http\Server\Facades\Server' && $name == 'Server' && !class_exists('Swoole\Http\Server')) { continue; } $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : []; $alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces); if ($alias->isValid()) { //Add extra methods, from other classes (magic static calls) if (array_key_exists($name, $this->extra)) { $alias->addClass($this->extra[$name]); } $aliases[] = $alias; } } return $aliases; } protected function getRealTimeFacades() { $facades = []; $realTimeFacadeFiles = glob(storage_path('framework/cache/facade-*.php')); foreach ($realTimeFacadeFiles as $file) { try { $name = $this->getFullyQualifiedClassNameInFile($file); $facades[$name] = $name; } catch (\Exception $e) { continue; } } return $facades; } protected function getFullyQualifiedClassNameInFile(string $path) { $contents = file_get_contents($path); $parsers = new Php7(new Emulative()); $parsed = collect($parsers->parse($contents) ?: []); $namespace = $parsed->first(function ($node) { return $node instanceof Namespace_; }); if ($namespace) { $name = $namespace->name->toString(); $class = collect($namespace->stmts)->first(function ($node) { return $node instanceof Class_; }); if ($class) { $name .= '\\' . $class->name->toString(); } return $name; } } /** * Regroup aliases by namespace of extended classes * * @return Collection */ protected function getAliasesByExtendsNamespace() { $aliases = $this->getValidAliases()->filter(static function (Alias $alias) { return is_subclass_of($alias->getExtends(), Facade::class); }); $this->addMacroableClasses($aliases); return $aliases->groupBy(function (Alias $alias) { return $alias->getExtendsNamespace(); }); } /** * Regroup aliases by namespace of alias * * @return Collection */ protected function getAliasesByAliasNamespace() { return $this->getValidAliases()->groupBy(function (Alias $alias) { return $alias->getNamespace(); }); } protected function getAliases() { // For Laravel, use the AliasLoader if (class_exists('Illuminate\Foundation\AliasLoader')) { return AliasLoader::getInstance()->getAliases(); } $facades = [ 'App' => 'Illuminate\Support\Facades\App', 'Auth' => 'Illuminate\Support\Facades\Auth', 'Bus' => 'Illuminate\Support\Facades\Bus', 'DB' => 'Illuminate\Support\Facades\DB', 'Cache' => 'Illuminate\Support\Facades\Cache', 'Cookie' => 'Illuminate\Support\Facades\Cookie', 'Crypt' => 'Illuminate\Support\Facades\Crypt', 'Event' => 'Illuminate\Support\Facades\Event', 'Hash' => 'Illuminate\Support\Facades\Hash', 'Log' => 'Illuminate\Support\Facades\Log', 'Mail' => 'Illuminate\Support\Facades\Mail', 'Queue' => 'Illuminate\Support\Facades\Queue', 'Request' => 'Illuminate\Support\Facades\Request', 'Schema' => 'Illuminate\Support\Facades\Schema', 'Session' => 'Illuminate\Support\Facades\Session', 'Storage' => 'Illuminate\Support\Facades\Storage', 'Validator' => 'Illuminate\Support\Facades\Validator', 'Gate' => 'Illuminate\Support\Facades\Gate', ]; $facades = array_merge($facades, $this->config->get('app.aliases', [])); // Only return the ones that actually exist return array_filter( $facades, function ($alias) { return class_exists($alias); }, ARRAY_FILTER_USE_KEY ); } /** * Write a string as error output. * * @param string $string * @return void */ protected function error($string) { if ($this->output) { $this->output->writeln("$string"); } else { echo $string . "\r\n"; } } /** * Add all macroable classes which are not already loaded as an alias and have defined macros. * * @param Collection $aliases */ protected function addMacroableClasses(Collection $aliases) { $macroable = $this->getMacroableClasses($aliases); foreach ($macroable as $class) { $reflection = new ReflectionClass($class); if (!$reflection->getStaticProperties()['macros']) { continue; } $aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces); } } /** * Get all loaded macroable classes which are not loaded as an alias. * * @param Collection $aliases * @return Collection */ protected function getMacroableClasses(Collection $aliases) { return (new Collection(get_declared_classes())) ->filter(function ($class) { $reflection = new ReflectionClass($class); // Filter out internal classes and class aliases return !$reflection->isInternal() && $reflection->getName() === $class; }) ->filter(function ($class) { $traits = class_uses_recursive($class); // Filter only classes with the macroable trait return isset($traits[Macroable::class]); }) ->filter(function ($class) use ($aliases) { $class = Str::start($class, '\\'); // Filter out aliases return !$aliases->first(function (Alias $alias) use ($class) { return $alias->getExtends() === $class; }); }); } } laravel-ide-helper/src/IdeHelperServiceProvider.php000064400000010024152427540010016400 0ustar00 * @copyright 2014 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 Barryvdh\LaravelIdeHelper\Console\EloquentCommand; use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand; use Barryvdh\LaravelIdeHelper\Console\MetaCommand; use Barryvdh\LaravelIdeHelper\Console\ModelsCommand; use Barryvdh\LaravelIdeHelper\Listeners\GenerateModelHelper; use Illuminate\Console\Events\CommandFinished; use Illuminate\Contracts\Support\DeferrableProvider; use Illuminate\Database\Events\MigrationsEnded; use Illuminate\Support\ServiceProvider; use Illuminate\View\Engines\EngineResolver; use Illuminate\View\Engines\PhpEngine; use Illuminate\View\Factory; use Illuminate\View\FileViewFinder; class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProvider { /** * Bootstrap the application events. * * @return void */ public function boot() { if (!$this->app->runningUnitTests() && $this->app['config']->get('ide-helper.post_migrate', [])) { $this->app['events']->listen(CommandFinished::class, GenerateModelHelper::class); $this->app['events']->listen(MigrationsEnded::class, function () { GenerateModelHelper::$shouldRun = true; }); } if ($this->app->has('view')) { $viewPath = __DIR__ . '/../resources/views'; $this->loadViewsFrom($viewPath, 'ide-helper'); } $configPath = __DIR__ . '/../config/ide-helper.php'; if (function_exists('config_path')) { $publishPath = config_path('ide-helper.php'); } else { $publishPath = base_path('config/ide-helper.php'); } $this->publishes([$configPath => $publishPath], 'config'); } /** * Register the service provider. * * @return void */ public function register() { $configPath = __DIR__ . '/../config/ide-helper.php'; $this->mergeConfigFrom($configPath, 'ide-helper'); $localViewFactory = $this->createLocalViewFactory(); $this->app->singleton( 'command.ide-helper.generate', function ($app) use ($localViewFactory) { return new GeneratorCommand($app['config'], $app['files'], $localViewFactory); } ); $this->app->singleton( 'command.ide-helper.models', function ($app) { return new ModelsCommand($app['files']); } ); $this->app->singleton( 'command.ide-helper.meta', function ($app) use ($localViewFactory) { return new MetaCommand($app['files'], $localViewFactory, $app['config']); } ); $this->app->singleton( 'command.ide-helper.eloquent', function ($app) { return new EloquentCommand($app['files']); } ); $this->commands( 'command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta', 'command.ide-helper.eloquent' ); } /** * Get the services provided by the provider. * * @return array */ public function provides() { return ['command.ide-helper.generate', 'command.ide-helper.models']; } /** * @return Factory */ private function createLocalViewFactory() { $resolver = new EngineResolver(); $resolver->register('php', function () { return new PhpEngine($this->app['files']); }); $finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']); $factory = new Factory($resolver, $finder, $this->app['events']); $factory->addExtension('php', 'php'); return $factory; } } laravel-ide-helper/config/ide-helper.php000064400000026151152427540010014207 0ustar00 '_ide_helper.php', /* |-------------------------------------------------------------------------- | Models filename |-------------------------------------------------------------------------- | | The default filename for the models helper file | */ 'models_filename' => '_ide_helper_models.php', /* |-------------------------------------------------------------------------- | Where to write the PhpStorm specific meta file |-------------------------------------------------------------------------- | | PhpStorm also supports the directory `.phpstorm.meta.php/` with arbitrary | files in it, should you need additional files for your project; e.g. | `.phpstorm.meta.php/laravel_ide_Helper.php'. | */ 'meta_filename' => '.phpstorm.meta.php', /* |-------------------------------------------------------------------------- | Fluent helpers |-------------------------------------------------------------------------- | | Set to true to generate commonly used Fluent methods | */ 'include_fluent' => false, /* |-------------------------------------------------------------------------- | Factory Builders |-------------------------------------------------------------------------- | | Set to true to generate factory generators for better factory() | method auto-completion. | | Deprecated for Laravel 8 or latest. | */ 'include_factory_builders' => false, /* |-------------------------------------------------------------------------- | Write Model Magic methods |-------------------------------------------------------------------------- | | Set to false to disable write magic methods of model | */ 'write_model_magic_where' => true, /* |-------------------------------------------------------------------------- | Write Model External Eloquent Builder methods |-------------------------------------------------------------------------- | | Set to false to disable write external eloquent builder methods | */ 'write_model_external_builder_methods' => true, /* |-------------------------------------------------------------------------- | Write Model relation count properties |-------------------------------------------------------------------------- | | Set to false to disable writing of relation count properties to model DocBlocks. | */ 'write_model_relation_count_properties' => true, /* |-------------------------------------------------------------------------- | Write Eloquent Model Mixins |-------------------------------------------------------------------------- | | This will add the necessary DocBlock mixins to the model class | contained in the Laravel Framework. This helps the IDE with | auto-completion. | | Please be aware that this setting changes a file within the /vendor directory. | */ 'write_eloquent_model_mixins' => false, /* |-------------------------------------------------------------------------- | Helper files to include |-------------------------------------------------------------------------- | | Include helper files. By default not included, but can be toggled with the | -- helpers (-H) option. Extra helper files can be included. | */ 'include_helpers' => false, 'helper_files' => [ base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php', ], /* |-------------------------------------------------------------------------- | Model locations to include |-------------------------------------------------------------------------- | | Define in which directories the ide-helper:models command should look | for models. | | glob patterns are supported to easier reach models in sub-directories, | e.g. `app/Services/* /Models` (without the space) | */ 'model_locations' => [ 'app', ], /* |-------------------------------------------------------------------------- | Models to ignore |-------------------------------------------------------------------------- | | Define which models should be ignored. | */ 'ignored_models' => [ ], /* |-------------------------------------------------------------------------- | Models hooks |-------------------------------------------------------------------------- | | Define which hook classes you want to run for models to add custom information | | Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface. | */ 'model_hooks' => [ // App\Support\IdeHelper\MyModelHook::class ], /* |-------------------------------------------------------------------------- | Extra classes |-------------------------------------------------------------------------- | | These implementations are not really extended, but called with magic functions | */ 'extra' => [ 'Eloquent' => ['Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'], 'Session' => ['Illuminate\Session\Store'], ], 'magic' => [], /* |-------------------------------------------------------------------------- | Interface implementations |-------------------------------------------------------------------------- | | These interfaces will be replaced with the implementing class. Some interfaces | are detected by the helpers, others can be listed below. | */ 'interfaces' => [ ], /* |-------------------------------------------------------------------------- | Support for custom DB types |-------------------------------------------------------------------------- | | This setting allow you to map any custom database type (that you may have | created using CREATE TYPE statement or imported using database plugin | / extension to a Doctrine type. | | Each key in this array is a name of the Doctrine2 DBAL Platform. Currently valid names are: | 'postgresql', 'db2', 'drizzle', 'mysql', 'oracle', 'sqlanywhere', 'sqlite', 'mssql' | | This name is returned by getName() method of the specific Doctrine/DBAL/Platforms/AbstractPlatform descendant | | The value of the array is an array of type mappings. Key is the name of the custom type, | (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in | our case it is 'json_array'. Doctrine types are listed here: | https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#types | | So to support jsonb in your models when working with Postgres, just add the following entry to the array below: | | "postgresql" => array( | "jsonb" => "json_array", | ), | */ 'custom_db_types' => [ ], /* |-------------------------------------------------------------------------- | Support for camel cased models |-------------------------------------------------------------------------- | | There are some Laravel packages (such as Eloquence) that allow for accessing | Eloquent model properties via camel case, instead of snake case. | | Enabling this option will support these packages by saving all model | properties as camel case, instead of snake case. | | For example, normally you would see this: | | * @property \Illuminate\Support\Carbon $created_at | * @property \Illuminate\Support\Carbon $updated_at | | With this enabled, the properties will be this: | | * @property \Illuminate\Support\Carbon $createdAt | * @property \Illuminate\Support\Carbon $updatedAt | | Note, it is currently an all-or-nothing option. | */ 'model_camel_case_properties' => false, /* |-------------------------------------------------------------------------- | Property Casts |-------------------------------------------------------------------------- | | Cast the given "real type" to the given "type". | */ 'type_overrides' => [ 'integer' => 'int', 'boolean' => 'bool', ], /* |-------------------------------------------------------------------------- | Include DocBlocks from classes |-------------------------------------------------------------------------- | | Include DocBlocks from classes to allow additional code inspection for | magic methods and properties. | */ 'include_class_docblocks' => false, /* |-------------------------------------------------------------------------- | Force FQN usage |-------------------------------------------------------------------------- | | Use the fully qualified (class) name in docBlock, | event if class exists in a given file | or there is an import (use className) of a given class | */ 'force_fqn' => false, /* |-------------------------------------------------------------------------- | Use generics syntax |-------------------------------------------------------------------------- | | Use generics syntax within DocBlocks, | e.g. `Collection` instead of `Collection|User[]`. | */ 'use_generics_annotations' => true, /* |-------------------------------------------------------------------------- | Additional relation types |-------------------------------------------------------------------------- | | Sometimes it's needed to create custom relation types. The key of the array | is the Relationship Method name. The value of the array is the canonical class | name of the Relationship, e.g. `'relationName' => RelationShipClass::class`. | */ 'additional_relation_types' => [], /* |-------------------------------------------------------------------------- | Additional relation return types |-------------------------------------------------------------------------- | | When using custom relation types its possible for the class name to not contain | the proper return type of the relation. The key of the array is the relationship | method name. The value of the array is the return type of the relation ('many' | or 'morphTo'). | e.g. `'relationName' => 'many'`. | */ 'additional_relation_return_types' => [], /* |-------------------------------------------------------------------------- | Run artisan commands after migrations to generate model helpers |-------------------------------------------------------------------------- | | The specified commands should run after migrations are finished running. | */ 'post_migrate' => [ // 'ide-helper:models --nowrite', ], ]; laravel-ide-helper/CHANGELOG.md000064400000036350152427540010012026 0ustar00# Changelog All notable changes to this project will be documented in this file. [Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.15.0...master) -------------- ### Fixed ### Changed ### Added 2024-02-15, 2.15.1 ------------------ ### Fixed - Fix final class keyword in wrong position [#1517 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1517) ### Changed ### Added 2024-02-14, 2.15.0 ------------------ ### Fixed - Fix case issue in `ModelsCommand::unsetMethod()` [#1453 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/1453) - Fix non-facade classes will result in no autocomplete [#841 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/841) - Skip swoole, otherwise fatal error [#1477 / TimoFrenzel](https://github.com/barryvdh/laravel-ide-helper/pull/1477) - Fix vulnerability CVE-2021-43608 [#1392 / allanlaal](https://github.com/barryvdh/laravel-ide-helper/pull/1392) - Reset foreignKeyConstraintsColumns on model loop start [#1461 / snmatsui](https://github.com/barryvdh/laravel-ide-helper/pull/1461) - Accept scope & scopes as relation [#1452 / Muetze42](https://github.com/barryvdh/laravel-ide-helper/pull/1452) - Fix #1300 relation_return_type must take precedence if it is defined [#1394 / menthol](https://github.com/barryvdh/laravel-ide-helper/pull/1394) ### Changed - Disable inspections of helper files [#1486 / eidng8](https://github.com/barryvdh/laravel-ide-helper/pull/1486) - Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504) ### Added - Add support for enum default arguments using enum cases. [#1464 / d8vjork](https://github.com/barryvdh/laravel-ide-helper/pull/1464) - Add support for real-time facades in the helper file. [#1455 / filipac](https://github.com/barryvdh/laravel-ide-helper/pull/1455) - Add support for relations with composite keys. [#1479 / calebdw](https://github.com/barryvdh/laravel-ide-helper/pull/1479) - Add support for attribute accessors with no backing field or type hinting [#1411 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1411). - Add support for AsCollection and AsArrayObject casts [#1393 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/1393) - Reintroduce support for multi-db setups [#1426 / benpoulson](https://github.com/barryvdh/laravel-ide-helper/pull/1426) - Support the BINARY(...) database field type [#1434 / Sfonxs](https://github.com/barryvdh/laravel-ide-helper/pull/1434) - Add AllowDynamicProperties Attribute to cooperate with php8.2 deprecation [#1428 / GeoSot](https://github.com/barryvdh/laravel-ide-helper/pull/1428) 2024-02-05, 2.14.0 ------------------ ### Changed - Official support for Lumen has been dropped [#1425 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1425) - Refactor resolving of null information for custom casted attribute types [#1330 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1330) ### Fixed - Catch exceptions when loading aliases [#1465 / dongm2ez](https://github.com/barryvdh/laravel-ide-helper/pull/1465) ### Added - Add support for nikic/php-parser 5 (next to 4) [#1502 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1502) - Add support for `immutable_date:*` and `immutable_datetime:*` casts. [#1380 / thekonz](https://github.com/barryvdh/laravel-ide-helper/pull/1380) - Add support for attribute accessors marked as protected. [#1339 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1339) 2023-02-04, 2.13.0 ------------------ ### Fixed - Fix return type of methods provided by `SoftDeletes` [#1345 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1345) - Handle PHP 8.1 deprecation warnings when passing `null` to `new \ReflectionClass` [#1351 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1351) - Fix issue where \Eloquent is not included when using write_mixin [#1352 / Jefemy](https://github.com/barryvdh/laravel-ide-helper/pull/1352) - Fix model factory method arguments for Laravel >= 9 [#1361 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1361) - Improve return type of mock helper methods in tests [#1405 / bentleyo](https://github.com/barryvdh/laravel-ide-helper/pull/1405) - Fix Castable class if failed to detect it from return types [#1388 / kwarcu](https://github.com/barryvdh/laravel-ide-helper/pull/1388) ### Added - Added Laravel 10 support [#1407 / lptn](https://github.com/barryvdh/laravel-ide-helper/pull/1407) - Add support for custom casts that implement `CastsInboundAttributes` [#1329 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1329) - Add option `use_generics_annotations` for collection type hints [#1298 / tanerkay](https://github.com/barryvdh/laravel-ide-helper/pull/1298) 2022-03-06, 2.12.3 ------------------ ### Fixed - Fix date and datetime handling for attributes that set a serialization format option for the Carbon instance [#1324 / FLeudts](https://github.com/barryvdh/laravel-ide-helper/pull/1324) - Fix composer conflict with composer/pcre version 2/3. [#1327 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1327) 2022-02-08, 2.12.2 ------------------ ### Fixed - Remove composer dependecy, use copy of ClassMapGenerator [#1313 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1313) 2022-01-24, 2.12.1 ------------------ ### Fixed - Properly handle `Castable`s without return type. [#1306 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1306) 2022-01-23, 2.12.0 ------------------ ### Added - Add support for custom casts that using `Castable` [#1287 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1287) - Added Laravel 9 support [#1297 / rcerljenko](https://github.com/barryvdh/laravel-ide-helper/pull/1297) - Added option `additional_relation_return_types` for custom relations that don't fit the typical naming scheme 2022-01-03, 2.11.0 ------------------ ### Added - Add support for Laravel 8.77 Attributes [\#1289 / SimonJnsson](https://github.com/barryvdh/laravel-ide-helper/pull/1289) - Add support for cast types `decimal:*`, `encrypted:*`, `immutable_date`, `immutable_datetime`, `custom_datetime`, and `immutable_custom_datetime` [#1262 / miken32](https://github.com/barryvdh/laravel-ide-helper/pull/1262) - Add support of variadic parameters in `ide-helper:models` [\#1234 / shaffe-fr](https://github.com/barryvdh/laravel-ide-helper/pull/1234) - Add support of custom casts without properties [\#1267 / sparclex](https://github.com/barryvdh/laravel-ide-helper/pull/1267) ### Fixed - Fix recursively searching for `HasFactory` and `Macroable` traits [\#1216 / daniel-de-wit](https://github.com/barryvdh/laravel-ide-helper/pull/1216) - Use platformName to determine db type when casting boolean types [\#1212 / stockalexander](https://github.com/barryvdh/laravel-ide-helper/pull/1212) ### Changed - Move default models helper filename to config [\#1241 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241) 2021-06-18, 2.10.1 ------------------ ### Added - Added Type registration according to [Custom Mapping Types documentation](https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#custom-mapping-types) [\#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241) ### Fixed - Fixing issue where configured custom_db_types could cause a DBAL exception to be thrown while running `ide-helper:models` [\#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241) 2021-04-09, 2.10.0 ------------------ ### Added - Allowing Methods to be set or unset in ModelHooks [\#1198 / jenga201](https://github.com/barryvdh/laravel-ide-helper/pull/1198)\ Note: the visibility of `\Barryvdh\LaravelIdeHelper\Console\ModelsCommand::setMethod` has been changed to **public**! ### Fixed - Fixing issue where incorrect autoloader unregistered [\#1210 / tezhm](https://github.com/barryvdh/laravel-ide-helper/pull/1210) 2021-04-02, 2.9.3 ----------------- ### Fixed - Support both customized namespace factories as well as default resolvable ones [\#1201 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1201) 2021-04-01, 2.9.2 ----------------- ### Added - Model hooks for adding custom information from external sources to model classes through the ModelsCommand [\#945 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/945) ### Fixed - Fix ide-helper:models exception if model doesn't have factory [\#1196 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1196) - Running tests triggering post_migrate hooks [\#1193 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1193) - Array_merge error when config is cached prior to package install [\#1184 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1184) 2021-03-15, 2.9.1 ----------------- ### Added - Generate PHPDoc for Laravel 8.x factories [\#1074 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1074) - Add a comment to a property like table columns [\#1168 / biiiiiigmonster](https://github.com/barryvdh/laravel-ide-helper/pull/1168) - Added `post_migrate` hook to run commands after a migration [\#1163 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1163) - Allow for PhpDoc for macros with union types [\#1148 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1148) ### Fixed - Error when generating helper for invokable classes [\#1124 / standaniels](https://github.com/barryvdh/laravel-ide-helper/pull/1124) - Fix broken ReflectionUnionTypes [\#1132 / def-studio](https://github.com/barryvdh/laravel-ide-helper/pull/1132) - Relative class names are not converted to fully-qualified class names [\#1005 / SavKS](https://github.com/barryvdh/laravel-ide-helper/pull/1005) 2020-12-30, 2.9.0 ----------------- ### Changed - Dropped support for Laravel 6 and Laravel 7, as well as support for PHP 7.2 and added support for doctrine/dbal:^3 [\#1114 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1114) ### Fixed - `Macro::initPhpDoc()` will save original docblock if present [\#1116 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1116) - `Alias` will grab macros from `\Illuminate\Database\Eloquent\Builder` too [\#1118 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1118) 2020-12-08, 2.8.2 ----------------- ### Added - Fix phpdoc generate for custom cast with parameter [\#986 / artelkr](https://github.com/barryvdh/laravel-ide-helper/pull/986) - Created a possibility to add custom relation type [\#987 / efinder2](https://github.com/barryvdh/laravel-ide-helper/pull/987) - Added `@see` with macro/mixin definition location to PhpDoc [\#1054 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1054) - Initial compatibility for PHP8 [\#1106 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1106) ### Changed - Implement DeferrableProvider [\#914 / kon-shou](https://github.com/barryvdh/laravel-ide-helper/pull/914) ### Fixed - Compatibility with Lumen [\#1043 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1043) - Allow model_locations to have glob patterns [\#1059 / saackearl](https://github.com/barryvdh/laravel-ide-helper/pull/1059) - Error when generating helper for macroable classes which are not facades and contain a "fake" method [\#1066 / domkrm] (https://github.com/barryvdh/laravel-ide-helper/pull/1066) - Casts with a return type of `static` or `$this` now resolve to an instance of the cast [\#1103 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1103) ### Removed - Removed format and broken generateJsonHelper [\#1053 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1053) 2020-09-07, 2.8.1 ----------------- ### Added - Support Laravel 8 [\#1022 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1022) - Add option to force usage of FQN [\#1031 / edvordo](https://github.com/barryvdh/laravel-ide-helper/pull/1031) - Add support for macros of all macroable classes [\#1006 / domkrm](https://github.com/barryvdh/laravel-ide-helper/pull/1006) 2020-08-11, 2.8.0 ----------------- ### Added - Add static return type to builder methods [\#924 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/924) - Add `optonal` to meta generator for PhpStorm [\#932 / halaei](https://github.com/barryvdh/laravel-ide-helper/pull/932) - Decimal columns as string in Models [\#948 / fgibaux](https://github.com/barryvdh/laravel-ide-helper/pull/948) - Simplify full namespaces for already included resources [\#954 / LANGERGabriel](https://github.com/barryvdh/laravel-ide-helper/pull/954) - Make writing relation count properties optional [\#969 / AegirLeet](https://github.com/barryvdh/laravel-ide-helper/pull/969) - Add more methods able to resolve container instances [\#996 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/996) ### Fixed - Test `auth` is bound before detect Auth driver [\#946 / zhwei](https://github.com/barryvdh/laravel-ide-helper/pull/946) - Fix inline doc-block for final models [\#944 / Gummibeer](https://github.com/barryvdh/laravel-ide-helper/pull/955) 2020-04-22, 2.7.0 ----------------- ### Added - Add `ignored_models` as config option [\#890 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/890) - Infer return type from reflection if no phpdoc given [\#906 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/906) - Add custom collection support for get and all methods [\#903 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/903) - if a model implements interfaces, include them in the stub [\#920 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/920) - Generate noinspections PHPStorm tags [\#905 / mzglinski](https://github.com/barryvdh/laravel-ide-helper/pull/905) - Added support for Laravel 7 custom casts [\#913 / belamov](https://github.com/barryvdh/laravel-ide-helper/pull/913) - Ability to use patterns for model_locations [\#921 / 4n70w4](https://github.com/barryvdh/laravel-ide-helper/pull/921) ### Fixed - MorphToMany relations with query not working [\#894 / UksusoFF](https://github.com/barryvdh/laravel-ide-helper/pull/894) - Fix camelCase duplicated properties generator [\#881 / bop10](https://github.com/barryvdh/laravel-ide-helper/pull/881) - Prevent generation of invalid code for certain parameter default values [\#901 / loilo](https://github.com/barryvdh/laravel-ide-helper/pull/901) - Make hasOne and morphOne nullable [\#864 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/864) - Remove unnecessary and wrong definition of SoftDelete methods [\#918 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/918) - Unregister meta command custom autoloader when it is no longer needed [\#919 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/919) 2020-02-25, 2.6.7 ----------------- ### Added - Support for Laravel 7 [commit by barryvdh](https://github.com/barryvdh/laravel-ide-helper/commit/edd69c5e0508972c81f1f7173236de2459c45814) 2019-12-02, 2.6.6 ----------------- ### Added - Add splat operator (...) support [\#860 / ngmy](https://github.com/barryvdh/laravel-ide-helper/pull/860) - Add support for custom date class via Date::use() [\#859 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/859) ### Fixed - Prevent undefined property errors [\#877 / matt-allan](https://github.com/barryvdh/laravel-ide-helper/pull/877) ---- Missing an older changelog? Feel free to submit a PR! laravel-ide-helper/.php-cs-fixer.common.php000064400000003225152427540010014573 0ustar00 true, 'blank_line_after_opening_tag' => true, 'braces' => [ 'allow_single_line_anonymous_class_with_empty_body' => true, ], 'compact_nullable_typehint' => true, 'declare_equal_normalize' => true, 'lowercase_cast' => true, 'lowercase_static_reference' => true, 'new_with_braces' => true, 'no_blank_lines_after_class_opening' => true, 'no_leading_import_slash' => true, 'no_whitespace_in_blank_line' => true, 'ordered_class_elements' => [ 'order' => [ 'use_trait', ], ], 'ordered_imports' => [ 'imports_order' => [ 'class', 'function', 'const', ], 'sort_algorithm' => 'alpha', ], 'return_type_declaration' => true, 'short_scalar_cast' => true, 'single_trait_insert_per_statement' => true, 'ternary_operator_spaces' => true, 'visibility_required' => [ 'elements' => [ 'const', 'method', 'property', ], ], // Further quality-of-life improvements 'array_syntax' => [ 'syntax' => 'short', ], 'concat_space' => [ 'spacing' => 'one', ], 'fully_qualified_strict_types' => true, 'native_function_invocation' => [ 'include' => [], 'strict' => true, ], 'no_unused_imports' => true, 'single_quote' => true, 'space_after_semicolon' => true, 'trailing_comma_in_multiline' => true, 'trim_array_spaces' => true, 'unary_operator_spaces' => true, 'whitespace_after_comma_in_array' => true, ]; laravel-ide-helper/.php-cs-fixer.dist.php000064400000000540152427540010014243 0ustar00in(__DIR__) ->exclude('tests'); $config = require __DIR__ . '/.php-cs-fixer.common.php'; return (new PhpCsFixer\Config()) ->setFinder($finder) ->setRules($config) ->setRiskyAllowed(true) ->setCacheFile(__DIR__ . '/.php-cs-fixer.cache'); laravel-ide-helper/README.md000064400000037742152427540010011502 0ustar00# IDE Helper Generator for Laravel [![Tests](https://github.com/barryvdh/laravel-ide-helper/actions/workflows/run-tests.yml/badge.svg)](https://github.com/barryvdh/laravel-ide-helper/actions) [![Packagist License](https://poser.pugx.org/barryvdh/laravel-ide-helper/license.png)](http://choosealicense.com/licenses/mit/) [![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-ide-helper/version.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper) [![Total Downloads](https://poser.pugx.org/barryvdh/laravel-ide-helper/d/total.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper) [![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](https://fruitcake.nl/) **Complete PHPDocs, directly from the source** This package generates helper files that enable your IDE to provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date. It supports Laravel 9+ and PHP 8.0+ - [Installation](#installation) - [Usage](#usage) - [Automatic PHPDoc generation for Laravel Facades](#automatic-phpdoc-generation-for-laravel-facades) - [Automatic PHPDocs for models](#automatic-phpdocs-for-models) - [Model Directories](#model-directories) - [Ignore Models](#ignore-models) - [Model Hooks](#model-hooks) - [Automatic PHPDocs generation for Laravel Fluent methods](#automatic-phpdocs-generation-for-laravel-fluent-methods) - [Auto-completion for factory builders](#auto-completion-for-factory-builders) - [PhpStorm Meta for Container instances](#phpstorm-meta-for-container-instances) - [License](#license) ## Installation Require this package with composer using the following command: ```bash composer require --dev barryvdh/laravel-ide-helper ``` > [!NOTE] > If you encounter version conflicts with doctrine/dbal, please try: > `composer require --dev barryvdh/laravel-ide-helper --with-all-dependencies` This package makes use of [Laravels package auto-discovery mechanism](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518), which means if you don't install dev dependencies in production, it also won't be loaded. If for some reason you want manually control this: - add the package to the `extra.laravel.dont-discover` key in `composer.json`, e.g. ```json "extra": { "laravel": { "dont-discover": [ "barryvdh/laravel-ide-helper" ] } } ``` - Add the following class to the `providers` array in `config/app.php`: ```php Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class, ``` If you want to manually load it only in non-production environments, instead you can add this to your `AppServiceProvider` with the `register()` method: ```php public function register() { if ($this->app->isLocal()) { $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class); } // ... } ``` > Note: Avoid caching the configuration in your development environment, it may cause issues after installing this package; respectively clear the cache beforehand via `php artisan cache:clear` if you encounter problems when running the commands ## Usage _Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_ - `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades) - `php artisan ide-helper:models` - [PHPDocs for models](#automatic-phpdocs-for-models) - `php artisan ide-helper:meta` - [PhpStorm Meta file](#phpstorm-meta-for-container-instances) Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice ### Automatic PHPDoc generation for Laravel Facades You can now re-generate the docs yourself (for future updates) ```bash php artisan ide-helper:generate ``` Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating. This will generate the file `_ide_helper.php` which is expected to be additionally parsed by your IDE for autocomplete. You can use the config `filename` to change its name. You can configure your `composer.json` to do this each time you update your dependencies: ```js "scripts": { "post-update-cmd": [ "Illuminate\\Foundation\\ComposerScripts::postUpdate", "@php artisan ide-helper:generate", "@php artisan ide-helper:meta" ] }, ``` You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers`. ```bash php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config ``` The generator tries to identify the real class, but if it cannot be found, you can define it in the config file. Some classes need a working database connection. If you do not have a default working connection, some facades will not be included. You can use an in-memory SQLite driver by adding the `-M` option. If you use [real-time facades](https://laravel.com/docs/master/facades#real-time-facades) in your app, those will also be included in the generated file using a `@mixin` annotation and extending the original class underneath the facade. **Note**: this feature uses the generated real-time facades files in the `storage/framework/cache` folder. Those files are generated on-demand as you use the real-time facade, so if the framework has not generated that first, it will not be included in the helper file. Run the route/command/code first and then regenerate the helper file and this time the real-time facade will be included in it. You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option. The `Illuminate/Support/helpers.php` is already set up, but you can add/remove your own files in the config file. ### Automatic PHPDoc generation for macros and mixins This package can generate PHPDocs for macros and mixins which will be added to the `_ide_helper.php` file. But this only works if you use type hinting when declaring a macro. ```php Str::macro('concat', function(string $str1, string $str2) : string { return $str1 . $str2; }); ``` ### Automatic PHPDocs for models If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate PHPDocs, based on table columns, relations and getters/setters. > Note: this command requires a working database connection to introspect the table of each model By default, you are asked to overwrite or write to a separate file (`_ide_helper_models.php`). You can write the comments directly to your Model file, using the `--write (-W)` option, or force to not write with `--nowrite (-N)`. Alternatively using the `--write-mixin (-M)` option will only add a mixin tag to your Model file, writing the rest in (`_ide_helper_models.php`). The class name will be different from the model, avoiding the IDE duplicate annoyance. > Please make sure to back up your models, before writing the info. Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods. With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made. The `--smart-reset` option will instead keep the 'text' part of the phpdoc comment, and just replace all the property/method defininitions. ```bash php artisan ide-helper:models "App\Models\Post" ``` ```php /** * App\Models\Post * * @property integer $id * @property integer $author_id * @property string $title * @property string $text * @property \Illuminate\Support\Carbon $created_at * @property \Illuminate\Support\Carbon $updated_at * @property-read \User $author * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newModelQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newQuery() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post query() * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post whereTitle($value) * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post forAuthors(\User ...$authors) * … */ ``` With the `--write-mixin (-M)` option ```php /** * … * @mixin IdeHelperPost */ ``` #### Model Directories By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models). ```bash php artisan ide-helper:models "App\Models\Post" "App\Models\User" ``` You can also scan a different directory, using the `--dir` option (relative from the base path): ```bash php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model" ``` You can publish the config file (`php artisan vendor:publish`) and set the default directories. #### Ignore Models Models can be ignored using the `--ignore (-I)` option ```bash php artisan ide-helper:models --ignore="App\Models\Post,App\Models\User" ``` Or can be ignored by setting the `ignored_models` config ```php 'ignored_models' => [ App\Post::class, Api\User::class ], ``` #### Magic `where*` methods Eloquent allows calling `where` on your models, e.g. `Post::whereTitle(…)` and automatically translates this to e.g. `Post::where('title', '=', '…')`. If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_magic_where` and setting it to `false`. #### Magic `*_count` properties You may use the [`::withCount`](https://laravel.com/docs/master/eloquent-relationships#counting-related-models) method to count the number results from a relationship without actually loading them. Those results are then placed in attributes following the `_count` convention. By default, these attributes are generated in the phpdoc. You can turn them off by setting the config `write_model_relation_count_properties` to `false`. #### Generics annotations Laravel 9 introduced generics annotations in DocBlocks for collections. PhpStorm 2022.3 and above support the use of generics annotations within `@property` and `@property-read` declarations in DocBlocks, e.g. `Collection` instead of `Collection|User[]`. These can be disabled by setting the config `use_generics_annotations` to `false`. #### Support `@comment` based on DocBlock In order to better support IDEs, relations and getters/setters can also add a comment to a property like table columns. Therefore a custom docblock `@comment` is used: ```php class Users extends Model { /** * @comment Get User's full name * * @return string */ public function getFullNameAttribute(): string { return $this->first_name . ' ' .$this->last_name ; } } // => after generate models /** * App\Models\Users * * @property-read string $full_name Get User's full name * … */ ``` #### Dedicated Eloquent Builder methods A new method to the eloquent models was added called `newEloquentBuilder` [Reference](https://timacdonald.me/dedicated-eloquent-model-query-builders/) where we can add support for creating a new dedicated class instead of using local scopes in the model itself. If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_external_builder_methods` and setting it to `false`. #### Unsupported or custom database types Common column types (e.g. varchar, integer) are correctly mapped to PHP types (`string`, `int`). But sometimes you may want to use custom column types in your database like `geography`, `jsonb`, `citext`, `bit`, etc. which may throw an "Unknown database type"-Exception. For those special cases, you can map them via the config `custom_db_types`. Example: ```php 'custom_db_types' => [ 'mysql' => [ 'geography' => 'array', 'point' => 'array', ], 'postgresql' => [ 'jsonb' => 'string', '_int4' => 'array', ], ], ``` #### Custom Relationship Types If you are using relationships not built into Laravel you will need to specify the name and returning class in the config to get proper generation. ```php 'additional_relation_types' => [ 'externalHasMany' => \My\Package\externalHasMany::class ], ``` Found relationships will typically generate a return value based on the name of the relationship. If your custom relationships don't follow this traditional naming scheme you can define its return type manually. The available options are `many` and `morphTo`. ```php 'additional_relation_return_types' => [ 'externalHasMultiple' => 'many' ], ``` #### Model Hooks If you need additional information on your model from sources that are not handled by default, you can hook in to the generation process with model hooks to add extra information on the fly. Simply create a class that implements `ModelHookInterface` and add it to the `model_hooks` array in the config: ```php 'model_hooks' => [ MyCustomHook::class, ], ``` The `run` method will be called during generation for every model and receives the current running `ModelsCommand` and the current `Model`, e.g.: ```php class MyCustomHook implements ModelHookInterface { public function run(ModelsCommand $command, Model $model): void { if (! $model instanceof MyModel) { return; } $command->setProperty('custom', 'string', true, false, 'My custom property'); $command->unsetMethod('method'); $command->setMethod('method', $command->getMethodType($model, '\Some\Class'), ['$param']); } } ``` ```php /** * MyModel * * @property integer $id * @property-read string $custom ``` ### Automatic PHPDocs generation for Laravel Fluent methods If you need PHPDocs support for Fluent methods in migration, for example ```php $table->string("somestring")->nullable()->index(); ``` After publishing vendor, simply change the `include_fluent` line in your `config/ide-helper.php` file into: ```php 'include_fluent' => true, ``` Then run `php artisan ide-helper:generate`, you will now see all Fluent methods recognized by your IDE. ### Auto-completion for factory builders If you would like the `factory()->create()` and `factory()->make()` methods to return the correct model class, you can enable custom factory builders with the `include_factory_builders` line in your `config/ide-helper.php` file. Deprecated for Laravel 8 or latest. ```php 'include_factory_builders' => true, ``` For this to work, you must also publish the PhpStorm Meta file (see below). ## PhpStorm Meta for Container instances It's possible to generate a PhpStorm meta file to [add support for factory design pattern](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods. ```bash php artisan ide-helper:meta ``` ```php app('events')->fire(); \App::make('events')->fire(); /** @var \Illuminate\Foundation\Application $app */ $app->make('events')->fire(); // When the key is not found, it uses the argument as class name app('App\SomeClass'); // Also works with app(App\SomeClass::class); ``` > Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed. > > Note: When you receive a FatalException: class not found, check your config > (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it). You can change the generated filename via the config `meta_filename`. This can be useful for cases where you want to take advantage of PhpStorm's support of the _directory_ `.phpstorm.meta.php/`: all files placed there are parsed, should you want to provide additional files to PhpStorm. ## License The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) laravel-ide-helper/composer.json000064400000005226152427540010012735 0ustar00{ "name": "barryvdh/laravel-ide-helper", "description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.", "license": "MIT", "keywords": [ "laravel", "autocomplete", "ide", "helper", "phpstorm", "netbeans", "sublime", "codeintel", "phpdoc" ], "authors": [ { "name": "Barry vd. Heuvel", "email": "barryvdh@gmail.com" } ], "require": { "php": "^8.0", "ext-json": "*", "barryvdh/reflection-docblock": "^2.0.6", "composer/class-map-generator": "^1.0", "doctrine/dbal": "^2.6 || ^3.1.4", "illuminate/console": "^9 || ^10", "illuminate/filesystem": "^9 || ^10", "illuminate/support": "^9 || ^10", "nikic/php-parser": "^4.18 || ^5", "phpdocumentor/type-resolver": "^1.1.0" }, "require-dev": { "ext-pdo_sqlite": "*", "friendsofphp/php-cs-fixer": "^3", "illuminate/config": "^9 || ^10", "illuminate/view": "^9 || ^10", "mockery/mockery": "^1.4", "orchestra/testbench": "^7 || ^8", "phpunit/phpunit": "^9", "spatie/phpunit-snapshot-assertions": "^4", "vimeo/psalm": "^5.4" }, "suggest": { "illuminate/events": "Required for automatic helper generation (^6|^7|^8|^9|^10)." }, "minimum-stability": "dev", "prefer-stable": true, "autoload": { "psr-4": { "Barryvdh\\LaravelIdeHelper\\": "src" } }, "autoload-dev": { "psr-4": { "Barryvdh\\LaravelIdeHelper\\Tests\\": "tests" } }, "config": { "allow-plugins": { "composer/package-versions-deprecated": true }, "sort-packages": true }, "extra": { "branch-alias": { "dev-master": "2.15-dev" }, "laravel": { "providers": [ "Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider" ] } }, "scripts": { "analyze": "psalm", "check-style": [ "php-cs-fixer fix --diff --diff-format=udiff --dry-run", "php-cs-fixer fix --diff --diff-format=udiff --dry-run --config=.php_cs.tests.php" ], "fix-style": [ "php-cs-fixer fix", "php-cs-fixer fix --config=.php-cs-fixer.tests.php" ], "psalm-set-baseline": "psalm --set-baseline=psalm-baseline.xml", "test": "phpunit", "test-ci": "phpunit -d --without-creating-snapshots", "test-regenerate": "phpunit -d --update-snapshots" } } laravel-ide-helper/.php-cs-fixer.tests.php000064400000000763152427540010014451 0ustar00in(__DIR__ . '/tests') ->exclude('__snapshots__'); $config = require __DIR__ . '/.php-cs-fixer.common.php'; // Additional rules for tests $config = array_merge( $config, [ 'declare_strict_types' => true, ] ); return (new PhpCsFixer\Config()) ->setFinder($finder) ->setRules($config) ->setRiskyAllowed(true) ->setCacheFile(__DIR__ . '/.php-cs-fixer.tests.cache'); laravel-ide-helper/LICENSE.md000064400000002155152427540010011615 0ustar00# The MIT License (MIT) Copyright (c) Barry vd. Heuvel > Permission is hereby granted, free of charge, to any person obtaining a copy > of this software and associated documentation files (the "Software"), to deal > in the Software without restriction, including without limitation the rights > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell > copies of the Software, and to permit persons to whom the Software is > furnished to do so, subject to the following conditions: > > The above copyright notice and this permission notice shall be included in > all copies or substantial portions of the Software. > > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN > THE SOFTWARE. reflection-docblock/.github/workflows/run-tests.yml000064400000001540152427540010016540 0ustar00name: Unit Tests on: push: branches: - master pull_request: branches: - "*" schedule: - cron: '0 0 * * *' jobs: php-tests: runs-on: ubuntu-latest timeout-minutes: 15 env: COMPOSER_NO_INTERACTION: 1 strategy: matrix: php: [8.1, 8.0, 7.4, 7.3, 7.2] dependency-version: [prefer-lowest, prefer-stable] name: P${{ matrix.php }} - ${{ matrix.dependency-version }} steps: - name: Checkout code uses: actions/checkout@v2 - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} coverage: none tools: composer:v2 - name: Install dependencies run: | composer update --${{ matrix.dependency-version }} --prefer-dist --no-progress - name: Execute Unit Tests run: vendor/bin/phpunit reflection-docblock/src/Barryvdh/Reflection/DocBlock/Type/Collection.php000064400000020667152427540010022336 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Type; use Barryvdh\Reflection\DocBlock\Context; /** * Collection * * @author Mike van Riel * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class Collection extends \ArrayObject { /** @var string Definition of the OR operator for types */ const OPERATOR_OR = '|'; /** @var string Definition of the ARRAY operator for types */ const OPERATOR_ARRAY = '[]'; /** @var string Definition of the NAMESPACE operator in PHP */ const OPERATOR_NAMESPACE = '\\'; /** @var string[] List of recognized keywords */ protected static $keywords = array( 'string', 'int', 'integer', 'bool', 'boolean', 'float', 'double', 'object', 'mixed', 'array', 'resource', 'void', 'null', 'scalar', 'callback', 'callable', 'false', 'true', 'self', '$this', 'static' ); /** * Current invoking location. * * This is used to prepend to type with a relative location. * May also be 'default' or 'global', in which case they are ignored. * * @var Context */ protected $context = null; /** * Registers the namespace and aliases; uses that to add and expand the * given types. * * @param string[] $types Array containing a list of types to add to this * container. * @param Context $location The current invoking location. */ public function __construct( array $types = array(), Context $context = null ) { $this->context = null === $context ? new Context() : $context; foreach ($types as $type) { $this->add($type); } } /** * Returns the current invoking location. * * @return Context */ public function getContext() { return $this->context; } /** * Adds a new type to the collection and expands it if it contains a * relative namespace. * * If a class in the type contains a relative namespace than this collection * will try to expand that into a FQCN. * * @param string $type A 'Type' as defined in the phpDocumentor * documentation. * * @throws \InvalidArgumentException if a non-string argument is passed. * * @see http://phpdoc.org/docs/latest/for-users/types.html for the * definition of a type. * * @return void */ public function add($type) { if (!is_string($type)) { throw new \InvalidArgumentException( 'A type should be represented by a string, received: ' .var_export($type, true) ); } // separate the type by the OR operator $type_parts = $this->explode($type); foreach ($type_parts as $part) { $expanded_type = $this->expand($part); if ($expanded_type) { $this[] = $expanded_type; } } } /** * Returns a string representation of the collection. * * @return string The resolved types across the collection, separated with * {@link self::OPERATOR_OR}. */ public function __toString() { return implode(self::OPERATOR_OR, $this->getArrayCopy()); } /** * Analyzes the given union of types and returns separated by OR operator * single types. * * @param string $type The type or union of types * * @return array */ protected function explode($type) { $type_parts = []; $curr_type = ''; $nest_level = 0; foreach (str_split($type) as $char) { if ($char === self::OPERATOR_OR && $nest_level === 0) { $type_parts[] = $curr_type; $curr_type = ''; } else { if ($char === '<' || $char === '(') { $nest_level++; } else if ($char === '>' || $char === ')') { $nest_level--; } $curr_type .= $char; } } $type_parts[] = $curr_type; return $type_parts; } /** * Analyzes the given type and returns the FQCN variant. * * When a type is provided this method checks whether it is not a keyword or * Fully Qualified Class Name. If so it will use the given namespace and * aliases to expand the type to a FQCN representation. * * This method only works as expected if the namespace and aliases are set; * no dynamic reflection is being performed here. * * @param string $type The relative or absolute type. * * @uses getNamespace to determine with what to prefix the type name. * @uses getNamespaceAliases to check whether the first part of the relative * type name should not be replaced with another namespace. * * @return string */ protected function expand($type) { $type = trim($type); if (!$type) { return ''; } if (substr($type, 0, 6) === 'array<' && substr($type, -1) === '>') { return $type; } if($type[0] === '(') { return $type; } if ($this->isTypeAnArray($type)) { return $this->expand(substr($type, 0, -2)) . self::OPERATOR_ARRAY; } if ($this->isRelativeType($type) && !$this->isTypeAKeyword($type)) { if($this->shouldBeAbsolute($type)){ return self::OPERATOR_NAMESPACE . $type; } $type_parts = explode(self::OPERATOR_NAMESPACE, $type, 2); $namespace_aliases = $this->context->getNamespaceAliases(); // if the first segment is not an alias; prepend namespace name and // return if (!isset($namespace_aliases[$type_parts[0]]) && !isset($namespace_aliases[strstr($type_parts[0], '::', true)])) { $namespace = $this->context->getNamespace(); if ('' !== $namespace) { $namespace .= self::OPERATOR_NAMESPACE; } return self::OPERATOR_NAMESPACE . $namespace . $type; } if (strpos($type_parts[0], '::')) { $type_parts[] = strstr($type_parts[0], '::'); $type_parts[0] = $namespace_aliases[strstr($type_parts[0], '::', true)]; return implode('', $type_parts); } $type_parts[0] = $namespace_aliases[$type_parts[0]]; $type = implode(self::OPERATOR_NAMESPACE, $type_parts); } return $type; } /** * Detects whether the given type represents an array. * * @param string $type A relative or absolute type as defined in the * phpDocumentor documentation. * * @return bool */ protected function isTypeAnArray($type) { return substr($type, -2) === self::OPERATOR_ARRAY; } /** * Detects whether the given type represents a PHPDoc keyword. * * @param string $type A relative or absolute type as defined in the * phpDocumentor documentation. * * @return bool */ protected function isTypeAKeyword($type) { return in_array(strtolower($type), static::$keywords, true); } /** * Detects whether the given type represents a relative or absolute path. * * This method will detect keywords as being absolute; even though they are * not preceeded by a namespace separator. * * @param string $type A relative or absolute type as defined in the * phpDocumentor documentation. * * @return bool */ protected function isRelativeType($type) { return ($type[0] !== self::OPERATOR_NAMESPACE) || $this->isTypeAKeyword($type); } /** * Detects if the type should actually be absolute, by checking if it exists. * * @param string $type A relative or absolute type as defined in the * phpDocumentor documentation. * * @return bool */ protected function shouldBeAbsolute($type){ return class_exists($type); } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/SuppressWarningsTag.php000064400000001326152427540010024015 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @SuppressWarnings tag in a Docblock. * * @author Andrew Smith * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class SuppressWarningsTag extends Tag { public function __toString() { return "@{$this->getName()}{$this->getContent()}"; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/LinkTag.php000064400000003102152427540010021347 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @link tag in a Docblock. * * @author Ben Selby * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class LinkTag extends Tag { /** @var string */ protected $link = ''; /** * {@inheritdoc} */ public function getContent() { if (null === $this->content) { $this->content = "{$this->link} {$this->description}"; } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { parent::setContent($content); $parts = preg_split('/\s+/Su', $this->description, 2); $this->link = $parts[0]; $this->setDescription(isset($parts[1]) ? $parts[1] : $parts[0]); $this->content = $content; return $this; } /** * Gets the link * * @return string */ public function getLink() { return $this->link; } /** * Sets the link * * @param string $link The link * * @return $this */ public function setLink($link) { $this->link = $link; $this->content = null; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/PropertyWriteTag.php000064400000001130152427540010023310 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @property-write tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class PropertyWriteTag extends PropertyTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/PropertyTag.php000064400000001112152427540010022275 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @property tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class PropertyTag extends ParamTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/ExampleTag.php000064400000007617152427540010022064 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @example tag in a Docblock. * * @author Vasil Rangelov * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class ExampleTag extends SourceTag { /** * @var string Path to a file to use as an example. * May also be an absolute URI. */ protected $filePath = ''; /** * @var bool Whether the file path component represents an URI. * This determines how the file portion appears at {@link getContent()}. */ protected $isURI = false; /** * {@inheritdoc} */ public function getContent() { if (null === $this->content) { $filePath = ''; if ($this->isURI) { if (false === strpos($this->filePath, ':')) { $filePath = str_replace( '%2F', '/', rawurlencode($this->filePath) ); } else { $filePath = $this->filePath; } } else { $filePath = '"' . $this->filePath . '"'; } $this->content = $filePath . ' ' . parent::getContent(); } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { Tag::setContent($content); if (preg_match( '/^ # File component (?: # File path in quotes \"([^\"]+)\" | # File URI (\S+) ) # Remaining content (parsed by SourceTag) (?:\s+(.*))? $/sux', $this->description, $matches )) { if ('' !== $matches[1]) { $this->setFilePath($matches[1]); } else { $this->setFileURI($matches[2]); } if (isset($matches[3])) { parent::setContent($matches[3]); } else { $this->setDescription(''); } $this->content = $content; } return $this; } /** * Returns the file path. * * @return string Path to a file to use as an example. * May also be an absolute URI. */ public function getFilePath() { return $this->filePath; } /** * Sets the file path. * * @param string $filePath The new file path to use for the example. * * @return $this */ public function setFilePath($filePath) { $this->isURI = false; $this->filePath = trim($filePath); $this->content = null; return $this; } /** * Sets the file path as an URI. * * This function is equivalent to {@link setFilePath()}, except that it * convers an URI to a file path before that. * * There is no getFileURI(), as {@link getFilePath()} is compatible. * * @param type $uri The new file URI to use as an example. */ public function setFileURI($uri) { $this->isURI = true; if (false === strpos($uri, ':')) { //Relative URL $this->filePath = rawurldecode( str_replace(array('/', '\\'), '%2F', $uri) ); } else { //Absolute URL or URI. $this->filePath = $uri; } $this->content = null; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/CoversTag.php000064400000001104152427540010021713 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @covers tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class CoversTag extends SeeTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/DeprecatedTag.php000064400000001174152427540010022521 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag\VersionTag; /** * Reflection class for a @deprecated tag in a Docblock. * * @author Vasil Rangelov * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class DeprecatedTag extends VersionTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/MethodTag.php000064400000012732152427540010021703 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @method in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class MethodTag extends ReturnTag { /** @var string */ protected $method_name = ''; /** @var string */ protected $arguments = ''; /** @var bool */ protected $isStatic = false; /** * {@inheritdoc} */ public function getContent() { if (null === $this->content) { $this->content = ''; if ($this->isStatic) { $this->content .= 'static '; } $this->content .= $this->type . " {$this->method_name}({$this->arguments}) " . $this->description; } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { Tag::setContent($content); // 1. none or more whitespace // 2. optionally the keyword "static" followed by whitespace // 3. optionally a word with underscores followed by whitespace : as // type for the return value // 4. then optionally a word with underscores followed by () and // whitespace : as method name as used by phpDocumentor // 5. then a word with underscores, followed by ( and any character // until a ) and whitespace : as method name with signature // 6. any remaining text : as description if (preg_match( '/^ # Static keyword # Declates a static method ONLY if type is also present (?: (static) \s+ )? # Return type (?: ( (?:[\w\|_\\\\]*\$this[\w\|_\\\\]*) | (?: (?:[\w\|_\\\\]+(?:<[\s\S]*>)?) # array notation (?:\[\])* )* | (?:\([\s\S]*\))? ) \s+ )? # Legacy method name (not captured) (?: [\w_]+\(\)\s+ )? # Method name ([\w\|_\\\\]+) # Arguments \(([^\)]*)\) \s* # Description (.*) $/sux', $this->description, $matches )) { list( , $static, $this->type, $this->method_name, $this->arguments, $this->description ) = $matches; if ($static) { if (!$this->type) { $this->type = 'static'; } else { $this->isStatic = true; } } else { if (!$this->type) { $this->type = 'void'; } } $this->parsedDescription = null; } return $this; } /** * Sets the name of this method. * * @param string $method_name The name of the method. * * @return $this */ public function setMethodName($method_name) { $this->method_name = $method_name; $this->content = null; return $this; } /** * Retrieves the method name. * * @return string */ public function getMethodName() { return $this->method_name; } /** * Sets the arguments for this method. * * @param string $arguments A comma-separated arguments line. * * @return void */ public function setArguments($arguments) { $this->arguments = $arguments; $this->content = null; return $this; } /** * Returns an array containing each argument as array of type and name. * * Please note that the argument sub-array may only contain 1 element if no * type was specified. * * @return string[] */ public function getArguments() { if (empty($this->arguments)) { return array(); } $arguments = explode(',', $this->arguments); foreach ($arguments as $key => $value) { $arguments[$key] = explode(' ', trim($value)); } return $arguments; } /** * Checks whether the method tag describes a static method or not. * * @return bool TRUE if the method declaration is for a static method, FALSE * otherwise. */ public function isStatic() { return $this->isStatic; } /** * Sets a new value for whether the method is static or not. * * @param bool $isStatic The new value to set. * * @return $this */ public function setIsStatic($isStatic) { $this->isStatic = $isStatic; $this->content = null; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/AuthorTag.php000064400000006103152427540010021720 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for an @author tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class AuthorTag extends Tag { /** * PCRE regular expression matching any valid value for the name component. */ const REGEX_AUTHOR_NAME = '[^\<]*'; /** * PCRE regular expression matching any valid value for the email component. */ const REGEX_AUTHOR_EMAIL = '[^\>]*'; /** @var string The name of the author */ protected $authorName = ''; /** @var string The email of the author */ protected $authorEmail = ''; public function getContent() { if (null === $this->content) { $this->content = $this->authorName; if ('' != $this->authorEmail) { $this->content .= "<{$this->authorEmail}>"; } } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { parent::setContent($content); if (preg_match( '/^(' . self::REGEX_AUTHOR_NAME . ')(\<(' . self::REGEX_AUTHOR_EMAIL . ')\>)?$/u', $this->description, $matches )) { $this->authorName = trim($matches[1]); if (isset($matches[3])) { $this->authorEmail = trim($matches[3]); } } return $this; } /** * Gets the author's name. * * @return string The author's name. */ public function getAuthorName() { return $this->authorName; } /** * Sets the author's name. * * @param string $authorName The new author name. * An invalid value will set an empty string. * * @return $this */ public function setAuthorName($authorName) { $this->content = null; $this->authorName = preg_match('/^' . self::REGEX_AUTHOR_NAME . '$/u', $authorName) ? $authorName : ''; return $this; } /** * Gets the author's email. * * @return string The author's email. */ public function getAuthorEmail() { return $this->authorEmail; } /** * Sets the author's email. * * @param string $authorEmail The new author email. * An invalid value will set an empty string. * * @return $this */ public function setAuthorEmail($authorEmail) { $this->authorEmail = preg_match('/^' . self::REGEX_AUTHOR_EMAIL . '$/u', $authorEmail) ? $authorEmail : ''; $this->content = null; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/SeeTag.php000064400000003365152427540010021201 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @see tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class SeeTag extends Tag { /** @var string */ protected $refers = null; /** * {@inheritdoc} */ public function getContent() { if (null === $this->content) { $this->content = "{$this->refers} {$this->description}"; } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { parent::setContent($content); $parts = preg_split('/\s+/Su', $this->description, 2); // any output is considered a type $this->refers = $parts[0]; $this->setDescription(isset($parts[1]) ? $parts[1] : ''); $this->content = $content; return $this; } /** * Gets the structural element this tag refers to. * * @return string */ public function getReference() { return $this->refers; } /** * Sets the structural element this tag refers to. * * @param string $refers The new type this tag refers to. * * @return $this */ public function setReference($refers) { $this->refers = $refers; $this->content = null; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/VersionTag.php000064400000005156152427540010022112 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @version tag in a Docblock. * * @author Vasil Rangelov * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class VersionTag extends Tag { /** * PCRE regular expression matching a version vector. * Assumes the "x" modifier. */ const REGEX_VECTOR = '(?: # Normal release vectors. \d\S* | # VCS version vectors. Per PHPCS, they are expected to # follow the form of the VCS name, followed by ":", followed # by the version vector itself. # By convention, popular VCSes like CVS, SVN and GIT use "$" # around the actual version vector. [^\s\:]+\:\s*\$[^\$]+\$ )'; /** @var string The version vector. */ protected $version = ''; public function getContent() { if (null === $this->content) { $this->content = "{$this->version} {$this->description}"; } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { parent::setContent($content); if (preg_match( '/^ # The version vector (' . self::REGEX_VECTOR . ') \s* # The description (.+)? $/sux', $this->description, $matches )) { $this->version = $matches[1]; $this->setDescription(isset($matches[2]) ? $matches[2] : ''); $this->content = $content; } return $this; } /** * Gets the version section of the tag. * * @return string The version section of the tag. */ public function getVersion() { return $this->version; } /** * Sets the version section of the tag. * * @param string $version The new version section of the tag. * An invalid value will set an empty string. * * @return $this */ public function setVersion($version) { $this->version = preg_match('/^' . self::REGEX_VECTOR . '$/ux', $version) ? $version : ''; $this->content = null; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/SinceTag.php000064400000001162152427540010021517 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag\VersionTag; /** * Reflection class for a @since tag in a Docblock. * * @author Vasil Rangelov * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class SinceTag extends VersionTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/ReturnTag.php000064400000005447152427540010021747 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Type\Collection; /** * Reflection class for a @return tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class ReturnTag extends Tag { /** @var string The raw type component. */ protected $type = ''; /** @var Collection The parsed type component. */ protected $types = null; /** * {@inheritdoc} */ public function getContent() { if (null === $this->content) { $this->content = "{$this->getType()} {$this->description}"; } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { parent::setContent($content); $parts = preg_split('/(?description, 2); // any output is considered a type $this->type = $parts[0]; $this->types = null; $this->setDescription(isset($parts[1]) ? $parts[1] : ''); $this->content = $content; return $this; } /** * Returns the unique types of the variable. * * @return string[] */ public function getTypes() { return $this->getTypesCollection()->getArrayCopy(); } /** * Returns the type section of the variable. * * @return string */ public function getType() { return (string) $this->getTypesCollection(); } /** * Set the type section of the variable * * @param string $type * @return $this */ public function setType($type) { $this->type = $type; $this->types = null; $this->content = null; return $this; } /** * Add a type to the type section of the variable * * @param string $type * @return $this */ public function addType($type) { $this->type = $this->type . Collection::OPERATOR_OR . $type; $this->types = null; $this->content = null; return $this; } /** * Returns the type collection. * * @return void */ protected function getTypesCollection() { if (null === $this->types) { $this->types = new Collection( array($this->type), $this->docblock ? $this->docblock->getContext() : null ); } return $this->types; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/PropertyReadTag.php000064400000001126152427540010023076 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @property-read tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class PropertyReadTag extends PropertyTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/UsesTag.php000064400000001100152427540010021365 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @uses tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class UsesTag extends SeeTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/VarTag.php000064400000001100152427540010021176 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @var tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class VarTag extends ParamTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/SourceTag.php000064400000006206152427540010021722 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @source tag in a Docblock. * * @author Vasil Rangelov * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class SourceTag extends Tag { /** * @var int The starting line, relative to the structural element's * location. */ protected $startingLine = 1; /** * @var int|null The number of lines, relative to the starting line. NULL * means "to the end". */ protected $lineCount = null; /** * {@inheritdoc} */ public function getContent() { if (null === $this->content) { $this->content = "{$this->startingLine} {$this->lineCount} {$this->description}"; } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { parent::setContent($content); if (preg_match( '/^ # Starting line ([1-9]\d*) \s* # Number of lines (?: ((?1)) \s+ )? # Description (.*) $/sux', $this->description, $matches )) { $this->startingLine = (int)$matches[1]; if (isset($matches[2]) && '' !== $matches[2]) { $this->lineCount = (int)$matches[2]; } $this->setDescription($matches[3]); $this->content = $content; } return $this; } /** * Gets the starting line. * * @return int The starting line, relative to the structural element's * location. */ public function getStartingLine() { return $this->startingLine; } /** * Sets the starting line. * * @param int $startingLine The new starting line, relative to the * structural element's location. * * @return $this */ public function setStartingLine($startingLine) { $this->startingLine = $startingLine; $this->content = null; return $this; } /** * Returns the number of lines. * * @return int|null The number of lines, relative to the starting line. NULL * means "to the end". */ public function getLineCount() { return $this->lineCount; } /** * Sets the number of lines. * * @param int|null $lineCount The new number of lines, relative to the * starting line. NULL means "to the end". * * @return $this */ public function setLineCount($lineCount) { $this->lineCount = $lineCount; $this->content = null; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/ThrowsTag.php000064400000001107152427540010021743 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @throws tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class ThrowsTag extends ReturnTag { } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag/ParamTag.php000064400000007245152427540010021526 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Tag; /** * Reflection class for a @param tag in a Docblock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class ParamTag extends ReturnTag { /** @var string */ protected $variableName = ''; /** @var bool determines whether this is a variadic argument */ protected $isVariadic = false; /** * {@inheritdoc} */ public function getContent() { if (null === $this->content) { $this->content = "{$this->type} {$this->variableName} {$this->description}"; } return $this->content; } /** * {@inheritdoc} */ public function setContent($content) { Tag::setContent($content); $parts = []; $rest = $this->description; // parsing generics and closures to detect types for($pos = 0, $stacks = []; $pos < strlen($rest); $pos++) { $char = $rest[$pos]; if($char === '<') { array_unshift($stacks, $char); } if($char === '(') { array_unshift($stacks, $char); } if($char === '>' && isset($stacks[0]) && $stacks[0] === '<') { array_shift($stacks); } if($char === ')' && isset($stacks[0]) && $stacks[0] === '(') { array_shift($stacks); } if(!$stacks && preg_match('/\A(\s+)(.*)/su', substr($rest, $pos), $matches)) { $parts[0] = substr($rest, 0, $pos); $parts[1] = $matches[1]; $rest = $matches[2]; break; } } array_push($parts, ...preg_split('/(\s+)/u', $rest, 2, PREG_SPLIT_DELIM_CAPTURE)); // if the first item that is encountered is not a variable; it is a type if (isset($parts[0]) && (strlen($parts[0]) > 0) && ($parts[0][0] !== '$') ) { $this->type = array_shift($parts); array_shift($parts); } // if the next item starts with a $ or ...$ it must be the variable name if (isset($parts[0]) && (strlen($parts[0]) > 0) && ($parts[0][0] == '$' || substr($parts[0], 0, 4) === '...$') ) { $this->variableName = array_shift($parts); array_shift($parts); if (substr($this->variableName, 0, 3) === '...') { $this->isVariadic = true; $this->variableName = substr($this->variableName, 3); } } $this->setDescription(implode('', $parts)); $this->content = $content; return $this; } /** * Returns the variable's name. * * @return string */ public function getVariableName() { return $this->variableName; } /** * Sets the variable's name. * * @param string $name The new name for this variable. * * @return $this */ public function setVariableName($name) { $this->variableName = $name; $this->content = null; return $this; } /** * Returns whether this tag is variadic. * * @return boolean */ public function isVariadic() { return $this->isVariadic; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Context.php000064400000010460152427540010020734 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock; /** * The context in which a DocBlock occurs. * * @author Vasil Rangelov * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class Context { /** @var string The current namespace. */ protected $namespace = ''; /** @var array List of namespace aliases => Fully Qualified Namespace. */ protected $namespace_aliases = array(); /** @var string Name of the structural element, within the namespace. */ protected $lsen = ''; /** * Cteates a new context. * @param string $namespace The namespace where this DocBlock * resides in. * @param array $namespace_aliases List of namespace aliases => Fully * Qualified Namespace. * @param string $lsen Name of the structural element, within * the namespace. */ public function __construct( $namespace = '', array $namespace_aliases = array(), $lsen = '' ) { if (!empty($namespace)) { $this->setNamespace($namespace); } $this->setNamespaceAliases($namespace_aliases); $this->setLSEN($lsen); } /** * @return string The namespace where this DocBlock resides in. */ public function getNamespace() { return $this->namespace; } /** * @return array List of namespace aliases => Fully Qualified Namespace. */ public function getNamespaceAliases() { return $this->namespace_aliases; } /** * Returns the Local Structural Element Name. * * @return string Name of the structural element, within the namespace. */ public function getLSEN() { return $this->lsen; } /** * Sets a new namespace. * * Sets a new namespace for the context. Leading and trailing slashes are * trimmed, and the keywords "global" and "default" are treated as aliases * to no namespace. * * @param string $namespace The new namespace to set. * * @return $this */ public function setNamespace($namespace) { if ('global' !== $namespace && 'default' !== $namespace ) { // Srip leading and trailing slash $this->namespace = trim((string)$namespace, '\\'); } else { $this->namespace = ''; } return $this; } /** * Sets the namespace aliases, replacing all previous ones. * * @param array $namespace_aliases List of namespace aliases => Fully * Qualified Namespace. * * @return $this */ public function setNamespaceAliases(array $namespace_aliases) { $this->namespace_aliases = array(); foreach ($namespace_aliases as $alias => $fqnn) { $this->setNamespaceAlias($alias, $fqnn); } return $this; } /** * Adds a namespace alias to the context. * * @param string $alias The alias name (the part after "as", or the last * part of the Fully Qualified Namespace Name) to add. * @param string $fqnn The Fully Qualified Namespace Name for this alias. * Any form of leading/trailing slashes are accepted, but what will be * stored is a name, prefixed with a slash, and no trailing slash. * * @return $this */ public function setNamespaceAlias($alias, $fqnn) { $this->namespace_aliases[$alias] = '\\' . trim((string)$fqnn, '\\'); return $this; } /** * Sets a new Local Structural Element Name. * * Sets a new Local Structural Element Name. A local name also contains * punctuation determining the kind of structural element (e.g. trailing "(" * and ")" for functions and methods). * * @param string $lsen The new local name of a structural element. * * @return $this */ public function setLSEN($lsen) { $this->lsen = (string)$lsen; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Serializer.php000064400000014514152427540010021425 0ustar00 * @copyright 2013 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock; /** * Serializes a DocBlock instance. * * @author Barry vd. Heuvel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class Serializer { /** @var string The string to indent the comment with. */ protected $indentString = ' '; /** @var int The number of times the indent string is repeated. */ protected $indent = 0; /** @var bool Whether to indent the first line. */ protected $isFirstLineIndented = true; /** @var int|null The max length of a line. */ protected $lineLength = null; /** @var bool Separate tag groups. */ protected $separateTags = false; /** * Create a Serializer instance. * * @param int $indent The number of times the indent string is * repeated. * @param string $indentString The string to indent the comment with. * @param bool $indentFirstLine Whether to indent the first line. * @param int|null $lineLength The max length of a line or NULL to * disable line wrapping. * @param bool $separateTags Separate tag groups. */ public function __construct( $indent = 0, $indentString = ' ', $indentFirstLine = true, $lineLength = null, $separateTags = false ) { $this->setIndentationString($indentString); $this->setIndent($indent); $this->setIsFirstLineIndented($indentFirstLine); $this->setLineLength($lineLength); $this->setSeparateTags($separateTags); } /** * Sets the string to indent comments with. * * @param string $indentationString The string to indent comments with. * * @return $this This serializer object. */ public function setIndentationString($indentString) { $this->indentString = (string)$indentString; return $this; } /** * Gets the string to indent comments with. * * @return string The indent string. */ public function getIndentationString() { return $this->indentString; } /** * Sets the number of indents. * * @param int $indent The number of times the indent string is repeated. * * @return $this This serializer object. */ public function setIndent($indent) { $this->indent = (int)$indent; return $this; } /** * Gets the number of indents. * * @return int The number of times the indent string is repeated. */ public function getIndent() { return $this->indent; } /** * Sets whether or not the first line should be indented. * * Sets whether or not the first line (the one with the "/**") should be * indented. * * @param bool $indentFirstLine The new value for this setting. * * @return $this This serializer object. */ public function setIsFirstLineIndented($indentFirstLine) { $this->isFirstLineIndented = (bool)$indentFirstLine; return $this; } /** * Gets whether or not the first line should be indented. * * @return bool Whether or not the first line should be indented. */ public function isFirstLineIndented() { return $this->isFirstLineIndented; } /** * Sets the line length. * * Sets the length of each line in the serialization. Content will be * wrapped within this limit. * * @param int|null $lineLength The length of each line. NULL to disable line * wrapping altogether. * * @return $this This serializer object. */ public function setLineLength($lineLength) { $this->lineLength = null === $lineLength ? null : (int)$lineLength; return $this; } /** * Gets the line length. * * @return int|null The length of each line or NULL if line wrapping is * disabled. */ public function getLineLength() { return $this->lineLength; } /** * Sets whether there should be an empty line between tag groups. * * @param bool $separateTags The new value for this setting. * * @return $this This serializer object. */ public function setSeparateTags($separateTags) { $this->separateTags = (bool)$separateTags; return $this; } /** * Gets whether there should be an empty line between tag groups. * * @return bool Whether there should be an empty line between tag groups. */ public function getSeparateTags() { return $this->separateTags; } /** * Generate a DocBlock comment. * * @param DocBlock The DocBlock to serialize. * * @return string The serialized doc block. */ public function getDocComment(DocBlock $docblock) { $indent = str_repeat($this->indentString, $this->indent); $firstIndent = $this->isFirstLineIndented ? $indent : ''; $text = $docblock->getText(); if ($this->lineLength) { //3 === strlen(' * ') $wrapLength = $this->lineLength - strlen($indent) - 3; $text = wordwrap($text, $wrapLength); } $text = str_replace("\n", "\n{$indent} * ", $text); $comment = "{$firstIndent}/**\n{$indent} * {$text}\n{$indent} *\n"; $tags = array_values($docblock->getTags()); /** @var Tag $tag */ foreach ($tags as $key => $tag) { $nextTag = isset($tags[$key + 1]) ? $tags[$key + 1] : null; $tagText = (string) $tag; if ($this->lineLength) { $tagText = wordwrap($tagText, $wrapLength); } $tagText = str_replace("\n", "\n{$indent} * ", $tagText); $comment .= "{$indent} * {$tagText}\n"; if ($this->separateTags && $nextTag !== null && ! $tag->inSameGroup($nextTag)) { $comment .= "{$indent} *\n"; } } $comment .= $indent . ' */'; return $comment; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Location.php000064400000003154152427540010021062 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock; /** * The location a DocBlock occurs within a file. * * @author Vasil Rangelov * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class Location { /** @var int Line where the DocBlock text starts. */ protected $lineNumber = 0; /** @var int Column where the DocBlock text starts. */ protected $columnNumber = 0; public function __construct( $lineNumber = 0, $columnNumber = 0 ) { $this->setLineNumber($lineNumber)->setColumnNumber($columnNumber); } /** * @return int Line where the DocBlock text starts. */ public function getLineNumber() { return $this->lineNumber; } /** * * @param type $lineNumber * @return $this */ public function setLineNumber($lineNumber) { $this->lineNumber = (int)$lineNumber; return $this; } /** * @return int Column where the DocBlock text starts. */ public function getColumnNumber() { return $this->columnNumber; } /** * * @param int $columnNumber * @return $this */ public function setColumnNumber($columnNumber) { $this->columnNumber = (int)$columnNumber; return $this; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Description.php000064400000015613152427540010021600 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock; /** * Parses a Description of a DocBlock or tag. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class Description implements \Reflector { /** @var string */ protected $contents = ''; /** @var array The contents, as an array of strings and Tag objects. */ protected $parsedContents = null; /** @var DocBlock The DocBlock which this description belongs to. */ protected $docblock = null; /** * Populates the fields of a description. * * @param string $content The description's conetnts. * @param DocBlock $docblock The DocBlock which this description belongs to. */ public function __construct($content, DocBlock $docblock = null) { $this->setContent($content)->setDocBlock($docblock); } /** * Gets the text of this description. * * @return string */ public function getContents() { return $this->contents; } /** * Sets the text of this description. * * @param string $content The new text of this description. * * @return $this */ public function setContent($content) { $this->contents = trim($content); $this->parsedContents = null; return $this; } /** * Returns the parsed text of this description. * * @return array An array of strings and tag objects, in the order they * occur within the description. */ public function getParsedContents() { if (null === $this->parsedContents) { $this->parsedContents = preg_split( '/\{ # "{@}" is not a valid inline tag. This ensures that # we do not treat it as one, but treat it literally. (?!@\}) # We want to capture the whole tag line, but without the # inline tag delimiters. (\@ # Match everything up to the next delimiter. [^{}]* # Nested inline tag content should not be captured, or # it will appear in the result separately. (?: # Match nested inline tags. (?: # Because we did not catch the tag delimiters # earlier, we must be explicit with them here. # Notice that this also matches "{}", as a way # to later introduce it as an escape sequence. \{(?1)?\} | # Make sure we match hanging "{". \{ ) # Match content after the nested inline tag. [^{}]* )* # If there are more inline tags, match them as well. # We use "*" since there may not be any nested inline # tags. ) \}/Sux', $this->contents, -1, PREG_SPLIT_DELIM_CAPTURE ); $count = count($this->parsedContents); for ($i=1; $i<$count; $i += 2) { $this->parsedContents[$i] = Tag::createInstance( $this->parsedContents[$i], $this->docblock ); } //In order to allow "literal" inline tags, the otherwise invalid //sequence "{@}" is changed to "@", and "{}" is changed to "}". //See unit tests for examples. for ($i=0; $i<$count; $i += 2) { $this->parsedContents[$i] = str_replace( array('{@}', '{}'), array('@', '}'), $this->parsedContents[$i] ); } } return $this->parsedContents; } /** * Return a formatted variant of the Long Description using MarkDown. * * @todo this should become a more intelligent piece of code where the * configuration contains a setting what format long descriptions are. * * @codeCoverageIgnore Will be removed soon, in favor of adapters at * PhpDocumentor itself that will process text in various formats. * * @return string */ public function getFormattedContents() { $result = $this->contents; // if the long description contains a plain HTML element, surround // it with a pre element. Please note that we explicitly used str_replace // and not preg_replace to gain performance if (strpos($result, '') !== false) { $result = str_replace( array('', "\r\n", "\n", "\r", ''), array('
', '', '', '', '
'), $result ); } if (class_exists('Parsedown')) { $markdown = \Parsedown::instance(); $result = $markdown->parse($result); } elseif (class_exists('dflydev\markdown\MarkdownExtraParser')) { $markdown = new \dflydev\markdown\MarkdownExtraParser(); $result = $markdown->transformMarkdown($result); } return trim($result); } /** * Gets the docblock this tag belongs to. * * @return DocBlock The docblock this description belongs to. */ public function getDocBlock() { return $this->docblock; } /** * Sets the docblock this tag belongs to. * * @param DocBlock $docblock The new docblock this description belongs to. * Setting NULL removes any association. * * @return $this */ public function setDocBlock(DocBlock $docblock = null) { $this->docblock = $docblock; return $this; } /** * Builds a string representation of this object. * * @todo determine the exact format as used by PHP Reflection * and implement it. * * @return void * @codeCoverageIgnore Not yet implemented */ public static function export() { throw new \Exception('Not yet implemented'); } /** * Returns the long description as a string. * * @return string */ public function __toString() { return $this->getContents(); } } reflection-docblock/src/Barryvdh/Reflection/DocBlock/Tag.php000064400000026052152427540010020027 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection\DocBlock; use Barryvdh\Reflection\DocBlock; /** * Parses a tag definition for a DocBlock. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class Tag implements \Reflector { /** * PCRE regular expression matching a tag name. */ const REGEX_TAGNAME = '[\w\-\_\\\\]+'; /** @var string Name of the tag */ protected $tag = ''; /** * @var string|null Content of the tag. * When set to NULL, it means it needs to be regenerated. */ protected $content = ''; /** @var string Description of the content of this tag */ protected $description = ''; /** * @var array|null The description, as an array of strings and Tag objects. * When set to NULL, it means it needs to be regenerated. */ protected $parsedDescription = null; /** @var Location Location of the tag. */ protected $location = null; /** @var DocBlock The DocBlock which this tag belongs to. */ protected $docblock = null; /** * @var array An array with a tag as a key, and an FQCN to a class that * handles it as an array value. The class is expected to inherit this * class. */ private static $tagHandlerMappings = array( 'author' => '\Barryvdh\Reflection\DocBlock\Tag\AuthorTag', 'covers' => '\Barryvdh\Reflection\DocBlock\Tag\CoversTag', 'deprecated' => '\Barryvdh\Reflection\DocBlock\Tag\DeprecatedTag', 'example' => '\Barryvdh\Reflection\DocBlock\Tag\ExampleTag', 'link' => '\Barryvdh\Reflection\DocBlock\Tag\LinkTag', 'method' => '\Barryvdh\Reflection\DocBlock\Tag\MethodTag', 'param' => '\Barryvdh\Reflection\DocBlock\Tag\ParamTag', 'property-read' => '\Barryvdh\Reflection\DocBlock\Tag\PropertyReadTag', 'property' => '\Barryvdh\Reflection\DocBlock\Tag\PropertyTag', 'property-write' => '\Barryvdh\Reflection\DocBlock\Tag\PropertyWriteTag', 'return' => '\Barryvdh\Reflection\DocBlock\Tag\ReturnTag', 'see' => '\Barryvdh\Reflection\DocBlock\Tag\SeeTag', 'since' => '\Barryvdh\Reflection\DocBlock\Tag\SinceTag', 'source' => '\Barryvdh\Reflection\DocBlock\Tag\SourceTag', 'throw' => '\Barryvdh\Reflection\DocBlock\Tag\ThrowsTag', 'throws' => '\Barryvdh\Reflection\DocBlock\Tag\ThrowsTag', 'uses' => '\Barryvdh\Reflection\DocBlock\Tag\UsesTag', 'var' => '\Barryvdh\Reflection\DocBlock\Tag\VarTag', 'version' => '\Barryvdh\Reflection\DocBlock\Tag\VersionTag', 'SuppressWarnings' => '\Barryvdh\Reflection\DocBlock\Tag\SuppressWarningsTag' ); /** * Factory method responsible for instantiating the correct sub type. * * @param string $tag_line The text for this tag, including description. * @param DocBlock $docblock The DocBlock which this tag belongs to. * @param Location $location Location of the tag. * * @throws \InvalidArgumentException if an invalid tag line was presented. * * @return static A new tag object. */ final public static function createInstance( $tag_line, DocBlock $docblock = null, Location $location = null ) { if (!preg_match( '/^@(' . self::REGEX_TAGNAME . ')(?:\s*([^\s].*)|$)?/us', $tag_line, $matches )) { throw new \InvalidArgumentException( 'Invalid tag_line detected: ' . $tag_line ); } $handler = __CLASS__; if (isset(self::$tagHandlerMappings[$matches[1]])) { $handler = self::$tagHandlerMappings[$matches[1]]; } elseif (isset($docblock)) { $tagName = (string)new Type\Collection( array($matches[1]), $docblock->getContext() ); if (isset(self::$tagHandlerMappings[$tagName])) { $handler = self::$tagHandlerMappings[$tagName]; } } return new $handler( $matches[1], isset($matches[2]) ? $matches[2] : '', $docblock, $location ); } /** * Registers a handler for tags. * * Registers a handler for tags. The class specified is autoloaded if it's * not available. It must inherit from this class. * * @param string $tag Name of tag to regiser a handler for. When * registering a namespaced tag, the full name, along with a prefixing * slash MUST be provided. * @param string|null $handler FQCN of handler. Specifing NULL removes the * handler for the specified tag, if any. * * @return bool TRUE on success, FALSE on failure. */ final public static function registerTagHandler($tag, $handler) { $tag = trim((string)$tag); if (null === $handler) { unset(self::$tagHandlerMappings[$tag]); return true; } if ('' !== $tag && class_exists($handler, true) && is_subclass_of($handler, __CLASS__) && !strpos($tag, '\\') //Accept no slash, and 1st slash at offset 0. ) { self::$tagHandlerMappings[$tag] = $handler; return true; } return false; } /** * Parses a tag and populates the member variables. * * @param string $name Name of the tag. * @param string $content The contents of the given tag. * @param DocBlock $docblock The DocBlock which this tag belongs to. * @param Location $location Location of the tag. */ public function __construct( $name, $content, DocBlock $docblock = null, Location $location = null ) { $this ->setName($name) ->setContent($content) ->setDocBlock($docblock) ->setLocation($location); } /** * Gets the name of this tag. * * @return string The name of this tag. */ public function getName() { return $this->tag; } /** * Sets the name of this tag. * * @param string $name The new name of this tag. * * @return $this * @throws \InvalidArgumentException When an invalid tag name is provided. */ public function setName($name) { if (!preg_match('/^' . self::REGEX_TAGNAME . '$/u', $name)) { throw new \InvalidArgumentException( 'Invalid tag name supplied: ' . $name ); } $this->tag = $name; return $this; } /** * Gets the content of this tag. * * @return string */ public function getContent() { if (null === $this->content) { $this->content = $this->description; } return $this->content; } /** * Sets the content of this tag. * * @param string $content The new content of this tag. * * @return $this */ public function setContent($content) { $this->setDescription($content); $this->content = $content; return $this; } /** * Gets the description component of this tag. * * @return string */ public function getDescription() { return $this->description; } /** * Sets the description component of this tag. * * @param string $description The new description component of this tag. * * @return $this */ public function setDescription($description) { $this->content = null; $this->parsedDescription = null; $this->description = trim($description); return $this; } /** * Gets the parsed text of this description. * * @return array An array of strings and tag objects, in the order they * occur within the description. */ public function getParsedDescription() { if (null === $this->parsedDescription) { $description = new Description($this->description, $this->docblock); $this->parsedDescription = $description->getParsedContents(); } return $this->parsedDescription; } /** * Gets the docblock this tag belongs to. * * @return DocBlock The docblock this tag belongs to. */ public function getDocBlock() { return $this->docblock; } /** * Sets the docblock this tag belongs to. * * @param DocBlock $docblock The new docblock this tag belongs to. Setting * NULL removes any association. * * @return $this */ public function setDocBlock(DocBlock $docblock = null) { $this->docblock = $docblock; return $this; } /** * Gets the location of the tag. * * @return Location The tag's location. */ public function getLocation() { return $this->location; } /** * Sets the location of the tag. * * @param Location $location The new location of the tag. * * @return $this */ public function setLocation(Location $location = null) { $this->location = $location; return $this; } /** * If the given tags should be together or apart. * * @param Tag $tag * * @return bool */ public function inSameGroup(Tag $tag) { $firstName = $this->getName(); $secondName = $tag->getName(); if ($firstName === $secondName) { return true; } $groups = array( array('deprecated', 'link', 'see', 'since'), array('author', 'copyright', 'license'), array('category', 'package', 'subpackage'), array('property', 'property-read', 'property-write'), array('param', 'return'), ); foreach ($groups as $group) { if (in_array($firstName, $group, true) && in_array($secondName, $group, true)) { return true; } } return false; } /** * Builds a string representation of this object. * * @todo determine the exact format as used by PHP Reflection and implement it. * * @return void * @codeCoverageIgnore Not yet implemented */ public static function export() { throw new \Exception('Not yet implemented'); } /** * Returns the tag as a serialized string * * @return string */ public function __toString() { return "@{$this->getName()} {$this->getContent()}"; } } reflection-docblock/src/Barryvdh/Reflection/DocBlock.php000064400000033717152427540010017322 0ustar00 * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com) * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ namespace Barryvdh\Reflection; use Barryvdh\Reflection\DocBlock\Tag; use Barryvdh\Reflection\DocBlock\Context; use Barryvdh\Reflection\DocBlock\Location; /** * Parses the DocBlock for any structure. * * @author Mike van Riel * @license http://www.opensource.org/licenses/mit-license.php MIT * @link http://phpdoc.org */ class DocBlock implements \Reflector { /** @var string The opening line for this docblock. */ protected $short_description = ''; /** * @var DocBlock\Description The actual * description for this docblock. */ protected $long_description = null; /** * @var Tag[] An array containing all * the tags in this docblock; except inline. */ protected $tags = array(); /** @var Context Information about the context of this DocBlock. */ protected $context = null; /** @var Location Information about the location of this DocBlock. */ protected $location = null; /** @var bool Is this DocBlock (the start of) a template? */ protected $isTemplateStart = false; /** @var bool Does this DocBlock signify the end of a DocBlock template? */ protected $isTemplateEnd = false; /** * Parses the given docblock and populates the member fields. * * The constructor may also receive namespace information such as the * current namespace and aliases. This information is used by some tags * (e.g. @return, @param, etc.) to turn a relative Type into a FQCN. * * @param \Reflector|string $docblock A docblock comment (including * asterisks) or reflector supporting the getDocComment method. * @param Context $context The context in which the DocBlock * occurs. * @param Location $location The location within the file that this * DocBlock occurs in. * * @throws \InvalidArgumentException if the given argument does not have the * getDocComment method. */ public function __construct( $docblock, Context $context = null, Location $location = null ) { if (is_object($docblock)) { if (!method_exists($docblock, 'getDocComment')) { throw new \InvalidArgumentException( 'Invalid object passed; the given reflector must support ' . 'the getDocComment method' ); } $docblock = $docblock->getDocComment(); } $docblock = $this->cleanInput($docblock); list($templateMarker, $short, $long, $tags) = $this->splitDocBlock($docblock); $this->isTemplateStart = $templateMarker === '#@+'; $this->isTemplateEnd = $templateMarker === '#@-'; $this->short_description = $short; $this->long_description = new DocBlock\Description($long, $this); $this->parseTags($tags); $this->context = $context; $this->location = $location; } /** * Strips the asterisks from the DocBlock comment. * * @param string $comment String containing the comment text. * * @return string */ protected function cleanInput($comment) { $comment = trim( preg_replace( '#[ \t]*(?:\/\*\*|\*\/|\*)?[ \t]{0,1}(.*)?#u', '$1', $comment ) ); // reg ex above is not able to remove */ from a single line docblock if (substr($comment, -2) == '*/') { $comment = trim(substr($comment, 0, -2)); } // normalize strings $comment = str_replace(array("\r\n", "\r"), "\n", $comment); return $comment; } /** * Splits the DocBlock into a template marker, summary, description and block of tags. * * @param string $comment Comment to split into the sub-parts. * * @author Richard van Velzen (@_richardJ) Special thanks to Richard for the regex responsible for the split. * @author Mike van Riel for extending the regex with template marker support. * * @return string[] containing the template marker (if any), summary, description and a string containing the tags. */ protected function splitDocBlock($comment) { // Performance improvement cheat: if the first character is an @ then only tags are in this DocBlock. This // method does not split tags so we return this verbatim as the fourth result (tags). This saves us the // performance impact of running a regular expression if (strpos($comment, '@') === 0) { return array('', '', '', $comment); } // clears all extra horizontal whitespace from the line endings to prevent parsing issues $comment = preg_replace('/\h*$/Sum', '', $comment); /* * Splits the docblock into a template marker, short description, long description and tags section * * - The template marker is empty, #@+ or #@- if the DocBlock starts with either of those (a newline may * occur after it and will be stripped). * - The short description is started from the first character until a dot is encountered followed by a * newline OR two consecutive newlines (horizontal whitespace is taken into account to consider spacing * errors). This is optional. * - The long description, any character until a new line is encountered followed by an @ and word * characters (a tag). This is optional. * - Tags; the remaining characters * * Big thanks to RichardJ for contributing this Regular Expression */ preg_match( '/ \A # 1. Extract the template marker (?:(\#\@\+|\#\@\-)\n?)? # 2. Extract the summary (?: (?! @\pL ) # The summary may not start with an @ ( [^\n.]+ (?: (?! \. \n | \n{2} ) # End summary upon a dot followed by newline or two newlines [\n.] (?! [ \t]* @\pL ) # End summary when an @ is found as first character on a new line [^\n.]+ # Include anything else )* \.? )? ) # 3. Extract the description (?: \s* # Some form of whitespace _must_ precede a description because a summary must be there (?! @\pL ) # The description may not start with an @ ( [^\n]+ (?: \n+ (?! [ \t]* @\pL ) # End description when an @ is found as first character on a new line [^\n]+ # Include anything else )* ) )? # 4. Extract the tags (anything that follows) (\s+ [\s\S]*)? # everything that follows /ux', $comment, $matches ); array_shift($matches); while (count($matches) < 4) { $matches[] = ''; } return $matches; } /** * Creates the tag objects. * * @param string $tags Tag block to parse. * * @return void */ protected function parseTags($tags) { $result = array(); $tags = trim($tags); if ('' !== $tags) { if ('@' !== $tags[0]) { throw new \LogicException( 'A tag block started with text instead of an actual tag,' . ' this makes the tag block invalid: ' . $tags ); } foreach (explode("\n", $tags) as $tag_line) { if (isset($tag_line[0]) && ($tag_line[0] === '@')) { $result[] = $tag_line; } else { $result[count($result) - 1] .= "\n" . $tag_line; } } // create proper Tag objects foreach ($result as $key => $tag_line) { $result[$key] = Tag::createInstance(trim($tag_line), $this); } } $this->tags = $result; } /** * Gets the text portion of the doc block. * * Gets the text portion (short and long description combined) of the doc * block. * * @return string The text portion of the doc block. */ public function getText() { $short = $this->getShortDescription(); $long = $this->getLongDescription()->getContents(); if ($long) { return "{$short}\n\n{$long}"; } else { return $short; } } /** * Set the text portion of the doc block. * * Sets the text portion (short and long description combined) of the doc * block. * * @param string $docblock The new text portion of the doc block. * * @return $this This doc block. */ public function setText($comment) { list(,$short, $long) = $this->splitDocBlock($comment); $this->short_description = $short; $this->long_description = new DocBlock\Description($long, $this); return $this; } /** * Returns the opening line or also known as short description. * * @return string */ public function getShortDescription() { return $this->short_description; } /** * Returns the full description or also known as long description. * * @return DocBlock\Description */ public function getLongDescription() { return $this->long_description; } /** * Returns whether this DocBlock is the start of a Template section. * * A Docblock may serve as template for a series of subsequent DocBlocks. This is indicated by a special marker * (`#@+`) that is appended directly after the opening `/**` of a DocBlock. * * An example of such an opening is: * * ``` * /**#@+ * * My DocBlock * * / * ``` * * The description and tags (not the summary!) are copied onto all subsequent DocBlocks and also applied to all * elements that follow until another DocBlock is found that contains the closing marker (`#@-`). * * @see self::isTemplateEnd() for the check whether a closing marker was provided. * * @return boolean */ public function isTemplateStart() { return $this->isTemplateStart; } /** * Returns whether this DocBlock is the end of a Template section. * * @see self::isTemplateStart() for a more complete description of the Docblock Template functionality. * * @return boolean */ public function isTemplateEnd() { return $this->isTemplateEnd; } /** * Returns the current context. * * @return Context */ public function getContext() { return $this->context; } /** * Returns the current location. * * @return Location */ public function getLocation() { return $this->location; } /** * Returns the tags for this DocBlock. * * @return Tag[] */ public function getTags() { return $this->tags; } /** * Returns an array of tags matching the given name. If no tags are found * an empty array is returned. * * @param string $name String to search by. * * @return Tag[] */ public function getTagsByName($name) { $result = array(); /** @var Tag $tag */ foreach ($this->getTags() as $tag) { if ($tag->getName() != $name) { continue; } $result[] = $tag; } return $result; } /** * Checks if a tag of a certain type is present in this DocBlock. * * @param string $name Tag name to check for. * * @return bool */ public function hasTag($name) { /** @var Tag $tag */ foreach ($this->getTags() as $tag) { if ($tag->getName() == $name) { return true; } } return false; } /** * Appends a tag at the end of the list of tags. * * @param Tag $tag The tag to add. * * @return Tag The newly added tag. * * @throws \LogicException When the tag belongs to a different DocBlock. */ public function appendTag(Tag $tag) { if (null === $tag->getDocBlock()) { $tag->setDocBlock($this); } if ($tag->getDocBlock() === $this) { $this->tags[] = $tag; } else { throw new \LogicException( 'This tag belongs to a different DocBlock object.' ); } return $tag; } /** * Deletes a tag from the list of tags. * * @param Tag $tag The tag to be deleted. * * @return bool True if the tag was deleted. */ public function deleteTag(Tag $tag) { if (($key = array_search($tag, $this->tags)) !== false) { unset($this->tags[$key]); return true; } return false; } /** * Builds a string representation of this object. * * @todo determine the exact format as used by PHP Reflection and * implement it. * * @return string * @codeCoverageIgnore Not yet implemented */ public static function export() { throw new \Exception('Not yet implemented'); } /** * Returns the exported information (we should use the export static method * BUT this throws an exception at this point). * * @return string * @codeCoverageIgnore Not yet implemented */ public function __toString() { return 'Not yet implemented'; } } reflection-docblock/README.md000064400000003432152427540010011735 0ustar00The ReflectionDocBlock Component [![Build Status](https://secure.travis-ci.org/phpDocumentor/ReflectionDocBlock.png)](https://travis-ci.org/phpDocumentor/ReflectionDocBlock) ================================ Introduction ------------ The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser that is 100% compatible with the [PHPDoc standard](http://phpdoc.org/docs/latest). With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock. > **Note**: *this is a core component of phpDocumentor and is constantly being > optimized for performance.* Installation ------------ You can install the component in the following ways: * Use the official Github repository (https://github.com/phpDocumentor/ReflectionDocBlock) * Via Composer (http://packagist.org/packages/phpdocumentor/reflection-docblock) Usage ----- The ReflectionDocBlock component is designed to work in an identical fashion to PHP's own Reflection extension (http://php.net/manual/en/book.reflection.php). Parsing can be initiated by instantiating the `\phpDocumentor\Reflection\DocBlock()` class and passing it a string containing a DocBlock (including asterisks) or by passing an object supporting the `getDocComment()` method. > *Examples of objects having the `getDocComment()` method are the > `ReflectionClass` and the `ReflectionMethod` classes of the PHP > Reflection extension* Example: $class = new ReflectionClass('MyClass'); $phpdoc = new \phpDocumentor\Reflection\DocBlock($class); or $docblock = <<=5.3.3" }, "autoload": { "psr-0": {"Barryvdh": ["src/"]} }, "require-dev": { "phpunit/phpunit": "^8.5.14|^9" }, "suggest": { "dflydev/markdown": "~1.0", "erusev/parsedown": "~1.0" }, "extra": { "branch-alias": { "dev-master": "2.0.x-dev" } } } reflection-docblock/LICENSE000064400000002070152427540010011460 0ustar00The MIT License (MIT) Copyright (c) 2010 Mike van Riel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. laravel-debugbar/database/migrations/2014_12_01_120000_create_phpdebugbar_storage_table.php000064400000002020152427540010025141 0ustar00string('id'); $table->longText('data'); $table->string('meta_utime'); $table->dateTime('meta_datetime'); $table->string('meta_uri'); $table->string('meta_ip'); $table->string('meta_method'); $table->primary('id'); $table->index('meta_utime'); $table->index('meta_datetime'); $table->index('meta_uri'); $table->index('meta_ip'); $table->index('meta_method'); }); } /** * Reverse the migrations. */ public function down() { Schema::drop('phpdebugbar'); } }; laravel-debugbar/src/Resources/queries/widget.js000064400000043274152427540010016014 0ustar00(function($) { let css = PhpDebugBar.utils.makecsscls('phpdebugbar-'); let csscls = PhpDebugBar.utils.makecsscls('phpdebugbar-widgets-'); /** * Widget for displaying sql queries. * * Options: * - data */ const QueriesWidget = PhpDebugBar.Widgets.LaravelQueriesWidget = PhpDebugBar.Widget.extend({ className: csscls('sqlqueries'), duplicateQueries: new Set(), hiddenConnections: new Set(), copyToClipboard: function (code) { if (document.selection) { const range = document.body.createTextRange(); range.moveToElementText(code); range.select(); } else if (window.getSelection) { const range = document.createRange(); range.selectNodeContents(code); window.getSelection().removeAllRanges(); window.getSelection().addRange(range); } var isCopied = false; try { isCopied = document.execCommand('copy'); console.log('Query copied to the clipboard'); } catch (err) { alert('Oops, unable to copy'); } window.getSelection().removeAllRanges(); return isCopied; }, explainMysql: function ($element, statement, rows, visual) { const headings = []; for (const key in rows[0]) { headings.push($('').text(key)); } const values = []; for (const row of rows) { const $tr = $(''); for (const key in row) { $tr.append($('').text(row[key])); } values.push($tr); } const $table = $('
').addClass(csscls('explain')); $table.find('thead').append($('').append(headings)); $table.find('tbody').append(values); $element.append($table); if (visual) { $element.append(this.explainVisual(statement, visual.confirm)); } }, explainPgsql: function ($element, statement, rows, visual) { const $ul = $('