rhosocial / yii2-base-models

traits/EntityQueryTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
     
     /**
      * Specify page condition.
-     * @param string|int $pageSize It will return all models if it is 'all',
+     * @param integer $pageSize It will return all models if it is 'all',
      * or it will be regarded as sum of models.
      * @param int $currentPage The current page number if it is integer begun with 0.
      * @return $this

traits/EntityTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
     public $queryClass;
     
     /**
-     * @return \static New self without any initializations.
+     * @return EntityTrait New self without any initializations.
      */
     public static function buildNoInitModel()
     {

traits/IdentityTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
     /**
      * Validate the auth key.
      * @param string $authKey
-     * @return string
+     * @return boolean
      */
     public function validateAuthKey($authKey)
     {

traits/IDTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
     
     /**
      * Check if $identity existed.
-     * @param mixed $identity
+     * @param integer $identity
      * @return boolean
      */
     public function checkIdExists($identity)

traits/IPTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
      * If you disable($this->enableIP = false) the IP feature, this method will
      * be skipped(return null).
      * @param string $ipAddress the significantly IP address.
-     * @return string|integer|null Integer when succeeded to convert.
+     * @return null|integer Integer when succeeded to convert.
      */
     public function setIPAddress($ipAddress)
     {

traits/MetaTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -134,7 +134,7 @@
      * Set values in batch.
      * @param array $keys meta key-value pairs.
      * @param string $createdBy
-     * @return false if $keys is not an array.
+     * @return false|null if $keys is not an array.
      */
     public static function sets($keys, $createdBy = null)
     {

traits/UserRelationTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -105,7 +105,7 @@
 
     /**
      * Get whether this relation is favorite or not.
-     * @return boolean
+     * @return boolean|null
      */
     public function getIsFavorite()
     {

models/BaseMongoEntityModel.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
     /**
      * @inheritdoc
      * You can override this method if enabled fields cannot meet you requirements.
-     * @return array
+     * @return string[]
      */
     public function attributes()
     {

traits/SelfBlameableTrait.php

Doc Comments +4 added lines, -4 removed lines

@@ -245,7 +245,7 @@ 
      * Add a child.
      * But if children limit reached, false will be given.
      * @param static $child
-     * @return boolean Whether adding child succeeded or not.
+     * @return false|string Whether adding child succeeded or not.
      */
     public function addChild($child)
     {
@@ -256,7 +256,7 @@ 
      * Event triggered before deleting itself.
      * Note: DO NOT call it directly unless you know the consequences.
      * @param ModelEvent $event
-     * @return boolean true if parentAttribute not specified.
+     * @return boolean|null true if parentAttribute not specified.
      * @throws IntegrityException throw if $throwRestrictException is true when $onDeleteType is on restrict.
      */
     public function onDeleteChildren($event)
@@ -290,7 +290,7 @@ 
      * Event triggered before updating itself.
      * Note: DO NOT call it directly unless you know the consequences.
      * @param ModelEvent $event
-     * @return boolean true if parentAttribute not specified.
+     * @return boolean|null true if parentAttribute not specified.
      * @throws IntegrityException throw if $throwRestrictException is true when $onUpdateType is on restrict.
      */
     public function onUpdateChildren($event)
@@ -618,7 +618,7 @@ 
      * Update children's parent attribute.
      * Event triggered before updating.
      * @param ModelEvent $event
-     * @return boolean
+     * @return boolean|null
      */
     public function onParentRefIdChanged($event)
     {