alphadevx / alpha

Alpha/Model/ActiveRecordProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
      *
      * @throws Alpha\Exception\IllegalArguementException
      *
-     * @return Alpha\Model\ActiveRecordProviderInterface
+     * @return ActiveRecordProviderInterface|null
      *
      * @since 1.1
      */

Alpha/Model/ActiveRecordProviderInterface.php

Doc Comments +26 added lines, -8 removed lines

@@ -60,6 +60,7 @@ 
      * Disconnects the current database connection if one exists (self::$connection is set).
      *
      * @since 1.1
+     * @return void
      */
     public static function disconnect();
 
@@ -100,7 +101,7 @@ 
     /**
      * Populates the record object from the database table by the given attribute value.
      *
-     * @param string $atribute        The name of the attribute to load the record by.
+     * @param string $attribute        The name of the attribute to load the record by.
      * @param string $value           The value of the attribute to load the record by.
      * @param bool   $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
      * @param array  $loadAttributes  The attributes to load from the database to this object (leave blank to load all attributes)
@@ -131,14 +132,14 @@ 
     /**
      * Loads all of the objects of this class by the specified attribute into an array which is returned.
      *
-     * @param string $atribute        The attribute to load the objects by.
+     * @param string $attribute        The attribute to load the objects by.
      * @param string $value           The value of the attribute to load the objects by.
      * @param int    $start           The start of the SQL LIMIT clause, useful for pagination.
      * @param int    $limit           The amount (limit) of objects to load, useful for pagination.
      * @param string $orderBy         The name of the field to sort the objects by.
      * @param string $order           The order to sort the objects by.
      * @param bool   $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type.
-     * @param array  $constructorArgs An optional array of contructor arguements to pass to the BOs that will be generated and returned.  Supports a maximum of 5 arguements.
+     * @param string[]  $constructorArgs An optional array of contructor arguements to pass to the BOs that will be generated and returned.  Supports a maximum of 5 arguements.
      *
      * @return array An array containing objects of this type of business object.
      *
@@ -152,14 +153,14 @@ 
     /**
      * Loads all of the record objects of this class by the specified attributes into an array which is returned.
      *
-     * @param array  $atributes       The attributes to load the records by.
+     * @param array  $attributes       The attributes to load the records by.
      * @param array  $values          The values of the attributes to load the records by.
      * @param int    $start           The start of the SQL LIMIT clause, useful for pagination.
      * @param int    $limit           The amount (limit) of records to load, useful for pagination.
      * @param string $orderBy         The name of the field to sort the records by.
      * @param string $order           The order to sort the records by.
      * @param bool   $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
-     * @param array  $constructorArgs An optional array of contructor arguements to pass to the BOs that will be generated and returned.  Supports a maximum of 5 arguements.
+     * @param string[]  $constructorArgs An optional array of contructor arguements to pass to the BOs that will be generated and returned.  Supports a maximum of 5 arguements.
      *
      * @return array An array containing objects of this type of record object.
      *
@@ -228,6 +229,7 @@ 
      *
      * @throws Alpha\Exception\IllegalArguementException
      * @throws Alpha\Exception\FailedSaveException
+     * @return void
      */
     public function saveAttribute($attribute, $value);
 
@@ -237,6 +239,7 @@ 
      * @since 1.2
      *
      * @throws Alpha\Exception\FailedSaveException
+     * @return void
      */
     public function saveHistory();
 
@@ -246,6 +249,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\FailedDeleteException
+     * @return void
      */
     public function delete();
 
@@ -266,6 +270,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public function makeTable();
 
@@ -275,6 +280,7 @@ 
      * @since 1.2
      *
      * @throws AlphaException
+     * @return void
      */
     public function makeHistoryTable();
 
@@ -284,6 +290,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public function rebuildTable();
 
@@ -295,6 +302,7 @@ 
      * @param string $tableName Optional table name, leave blank for the defined table for this class to be dropped
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public function dropTable($tableName = null);
 
@@ -307,6 +315,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public function addProperty($propName);
 
@@ -324,7 +333,7 @@ 
     /**
      * Gets the count from the database for the amount of objects of this class.
      *
-     * @param array $atributes The attributes to count the objects by (optional).
+     * @param array $attributes The attributes to count the objects by (optional).
      * @param array $values    The values of the attributes to count the objects by (optional).
      *
      * @return int
@@ -353,6 +362,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public function setEnumOptions();
 
@@ -426,11 +436,11 @@ 
      * @param string $attributeName         The name of the attribute to apply the index on.
      * @param string $relatedClass          The fully-qualified name of the related class.
      * @param string $relatedClassAttribute The name of the field to relate to on the related class.
-     * @param bool   $allowNullValues       For foreign key indexes that don't allow null values, set this to false (default is true).
      *
      * @since 1.1
      *
      * @throws Alpha\Exception\FailedIndexCreateException
+     * @return void
      */
     public function createForeignIndex($attributeName, $relatedClass, $relatedClassAttribute);
 
@@ -444,6 +454,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\FailedIndexCreateException
+     * @return void
      */
     public function createUniqueIndex($attribute1Name, $attribute2Name = '', $attribute3Name = '');
 
@@ -453,6 +464,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public function reload();
 
@@ -488,6 +500,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public static function begin();
 
@@ -497,6 +510,7 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\FailedSaveException
+     * @return void
      */
     public static function commit();
 
@@ -506,15 +520,17 @@ 
      * @since 1.1
      *
      * @throws Alpha\Exception\AlphaException
+     * @return void
      */
     public static function rollback();
 
     /**
      * Provide the BO that we are going to map the data to from this provider.
      *
-     * @param Alpha\Model\ActiveRecord $BO
+     * @param ActiveRecord $BO
      *
      * @since 1.1
+     * @return void
      */
     public function setBO($BO);
 
@@ -547,6 +563,7 @@ 
      * @throws Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function createDatabase();
 
@@ -556,6 +573,7 @@ 
      * @throws Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function dropDatabase();
 }

Alpha/Model/ActiveRecordProviderMySQL.php

Doc Comments +1 added lines, -1 removed lines

@@ -2383,7 +2383,7 @@
      * parameters.  If arrays of attribute names and values are provided, only those will be bound to
      * the supplied statement.
      *
-     * @param mysqli_stmt $stmt The SQL statement to bind to.
+     * @param \mysqli_stmt $stmt The SQL statement to bind to.
      * @param array Optional array of BO attributes.
      * @param array Optional array of BO values.
      *

Alpha/Model/Article.php

Doc Comments +1 added lines, -1 removed lines

@@ -435,7 +435,7 @@
     /**
      * Method for returning the calculated score for this article.
      *
-     * @return float
+     * @return string
      *
      * @since 1.0
      */

Alpha/Model/Type/Relation.php

Doc Comments -1 removed lines

@@ -262,7 +262,6 @@
     /**
      * Get the name of the business object class that this class is related to.
      *
-     * @param string $RC
      *
      * @return string
      *

Alpha/Model/Type/Timestamp.php

Doc Comments +6 added lines, -6 removed lines

@@ -338,7 +338,7 @@ 
     /**
      * Getter for the year part.
      *
-     * @return string
+     * @return integer
      *
      * @since 1.0
      */
@@ -350,7 +350,7 @@ 
     /**
      * Getter for the month part.
      *
-     * @return string
+     * @return integer
      *
      * @since 1.0
      */
@@ -362,7 +362,7 @@ 
     /**
      * Getter for the day part.
      *
-     * @return string
+     * @return integer
      *
      * @since 1.0
      */
@@ -386,7 +386,7 @@ 
     /**
      * Getter for the hour part.
      *
-     * @return string
+     * @return integer
      *
      * @since 1.0
      */
@@ -398,7 +398,7 @@ 
     /**
      * Getter for the minute part.
      *
-     * @return string
+     * @return integer
      *
      * @since 1.0
      */
@@ -410,7 +410,7 @@ 
     /**
      * Getter for the second part.
      *
-     * @return string
+     * @return integer
      *
      * @since 1.0
      */

Alpha/Util/Cache/CacheProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
      *
      * @throws Alpha\Exception\IllegalArguementException
      *
-     * @return Alpha\Util\Cache\CacheProviderInterface
+     * @return CacheProviderInterface|null
      *
      * @since 1.1
      */

Alpha/Util/Code/Highlight/HighlightProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
      *
      * @throws Alpha\Exception\IllegalArguementException
      *
-     * @return Alpha\Util\Code\Highlight\HighlightProviderInterface
+     * @return HighlightProviderInterface|null
      *
      * @since 1.2
      */

Alpha/Util/Config/ConfigProvider.php

Doc Comments +1 added lines, -1 removed lines

@@ -115,7 +115,7 @@
     /**
      * Get config value.
      *
-     * @param $key string
+     * @param string $key string
      *
      * @return string
      *