Use type hints instead of using PHPDoc, where possible

Modules/Core/Traits/NamespacedEntity.php

@@ -6,21 +6,16 @@ trait NamespacedEntity
 {
     /**
      * Returns the entity namespace.
-     *
-     * @return string
      */
-    public static function getEntityNamespace()
+    public static function getEntityNamespace(): string
     {
         return isset(static::$entityNamespace) ? static::$entityNamespace : get_called_class();
     }
 
     /**
      * Sets the entity namespace.
-     *
-     * @param  string  $namespace
-     * @return void
      */
-    public static function setEntityNamespace($namespace)
+    public static function setEntityNamespace(string $namespace)
     {
         static::$entityNamespace = $namespace;
     }

Modules/Tag/Contracts/TaggableInterface.php

@@ -3,102 +3,88 @@
 namespace Modules\Tag\Contracts;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
 
 interface TaggableInterface
 {
     /**
      * The Eloquent tag entity name.
-     * @var string
      */
-    public static function getEntityNamespace();
+    public static function getEntityNamespace(): string;
 
     /**
      * Returns the Eloquent tags entity name.
-     * @return string
      */
-    public static function getTagsModel();
+    public static function getTagsModel(): string;
 
     /**
      * Sets the Eloquent tags entity name.
-     * @param string $model
-     * @return void
      */
-    public static function setTagsModel($model);
+    public static function setTagsModel(string $model);
 
     /**
      * Get all the entities with the given tag(s)
      * Optionally specify the column on which
      * to perform the search operation.
-     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
      * @param string|array $tags
-     * @param string $type
-     * @return \Illuminate\Database\Eloquent\Builder
      */
-    public function scopeWhereTag(Builder $query, $tags, $type = 'slug');
+    public function scopeWhereTag(Builder $query, $tags, string $type = 'slug'): Builder;
 
     /**
      * Get all the entities with one of the given tag(s)
      * Optionally specify the column on which
      * to perform the search operation.
-     * @param \Illuminate\Database\Eloquent\Builder $query
+     *
      * @param string|array $tags
-     * @param string $type
-     * @return \Illuminate\Database\Eloquent\Builder
      */
-    public function scopeWithTag(Builder $query, $tags, $type = 'slug');
+    public function scopeWithTag(Builder $query, $tags, string $type = 'slug'): Builder;
 
     /**
      * Define the eloquent morphMany relationship
-     * @return \Illuminate\Database\Eloquent\Relations\MorphToMany
      */
-    public function tags();
+    public function tags(): MorphToMany;
 
     /**
      * Returns all the tags under the current entity namespace.
-     * @return \Illuminate\Database\Eloquent\Builder
      */
-    public static function allTags();
+    public static function allTags(): Builder;
 
     /**
      * Creates a new model instance.
-     * @return \Illuminate\Database\Eloquent\Model
      */
-    public static function createTagsModel();
+    public static function createTagsModel(): Model;
 
     /**
      * Syncs the given tags.
+     *
      * @param  string|array $tags
-     * @param  string $type
-     * @return bool
      */
-    public function setTags($tags, $type = 'name');
+    public function setTags($tags, string $type = 'name'): bool;
 
     /**
      * Detaches multiple tags from the entity or if no tags are
      * passed, removes all the attached tags from the entity.
+     *
      * @param  string|array|null $tags
-     * @return bool
      */
-    public function untag($tags = null);
+    public function untag($tags = null): bool;
 
     /**
      * Detaches the given tag from the entity.
-     * @param  string  $name
-     * @return void
      */
-    public function removeTag($name);
+    public function removeTag(string $name);
 
     /**
      * Attaches multiple tags to the entity.
+     *
      * @param  string|array $tags
-     * @return bool
      */
-    public function tag($tags);
+    public function tag($tags): bool;
 
     /**
      * Attaches the given tag to the entity.
-     * @param  string $name
-     * @return void
      */
-    public function addTag($name);
+    public function addTag(string $name);
 }

Modules/Tag/Traits/TaggableTrait.php

@@ -3,35 +3,25 @@
 namespace Modules\Tag\Traits;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
 use Modules\Tag\Entities\Tag;
 
 trait TaggableTrait
 {
-    /**
-     * {@inheritdoc}
-     */
     protected static $tagsModel = Tag::class;
 
-    /**
-     * {@inheritdoc}
-     */
-    public static function getTagsModel()
+    public static function getTagsModel(): string
     {
         return static::$tagsModel;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function setTagsModel($model)
     {
         static::$tagsModel = $model;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function scopeWhereTag(Builder $query, $tags, $type = 'slug')
+    public function scopeWhereTag(Builder $query, $tags, string $type = 'slug'): Builder
     {
         if (is_string($tags) === true) {
             $tags = [$tags];
@@ -49,10 +39,7 @@ trait TaggableTrait
         return $query;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function scopeWithTag(Builder $query, $tags, $type = 'slug')
+    public function scopeWithTag(Builder $query, $tags, string $type = 'slug'): Builder
     {
         if (is_string($tags) === true) {
             $tags = [$tags];
@@ -66,36 +53,24 @@ trait TaggableTrait
         });
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function tags()
+    public function tags(): MorphToMany
     {
         return $this->morphToMany(static::$tagsModel, 'taggable', 'tag__tagged', 'taggable_id', 'tag_id');
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public static function createTagsModel()
+    public static function createTagsModel(): Model
     {
         return new static::$tagsModel;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public static function allTags()
+    public static function allTags(): Builder
     {
         $instance = new static;
 
         return $instance->createTagsModel()->with('translations')->whereNamespace($instance->getEntityClassName());
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function setTags($tags, $type = 'slug')
+    public function setTags($tags, string $type = 'slug'): bool
     {
         if (empty($tags)) {
             $tags = [];
@@ -121,10 +96,7 @@ trait TaggableTrait
         return true;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function tag($tags)
+    public function tag($tags): bool
     {
         foreach ($tags as $tag) {
             $this->addTag($tag);
@@ -133,10 +105,7 @@ trait TaggableTrait
         return true;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function addTag($name)
+    public function addTag(string $name)
     {
         $tag = $this->createTagsModel()->where('namespace', $this->getEntityClassName())
             ->with('translations')
@@ -162,10 +131,7 @@ trait TaggableTrait
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function untag($tags = null)
+    public function untag($tags = null): bool
     {
         $tags = $tags ?: $this->tags()->get()->pluck('name')->all();
 
@@ -176,10 +142,7 @@ trait TaggableTrait
         return true;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function removeTag($name)
+    public function removeTag(string $name)
     {
         $tag = $this->createTagsModel()
             ->where('namespace', $this->getEntityClassName())
@@ -193,10 +156,7 @@ trait TaggableTrait
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function getEntityClassName()
+    protected function getEntityClassName(): string
     {
         if (isset(static::$entityNamespace)) {
             return static::$entityNamespace;
@@ -205,10 +165,7 @@ trait TaggableTrait
         return $this->tags()->getMorphClass();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function generateTagSlug($name, $separator = '-')
+    public function generateTagSlug($name, $separator = '-'): string
     {
         // Convert all dashes/underscores into separator
         $flip = $separator == '-' ? '_' : '-';