alphadevx / alpha

Alpha/Controller/ListActiveRecordsController.php

Doc Comments +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
      *
      * @param alpha\Util\Http\Request $request
      *
-     * @return alpha\Util\Http\Response
+     * @return Response
      *
      * @since 1.0
      */
@@ -120,7 +120,7 @@ 
      *
      * @param alpha\Util\Http\Request $request
      *
-     * @return alpha\Util\Http\Response
+     * @return Response
      *
      * @since 1.0
      */

Alpha/Model/ActiveRecord.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use Alpha\Model\Type\Integer;
 use Alpha\Model\Type\Timestamp;
-use Alpha\Model\Type\Enum;
 use Alpha\Model\Type\Relation;
 use Alpha\Util\Config\ConfigProvider;
 use Alpha\Util\Logging\Logger;

Doc Comments +10 added lines, -11 removed lines

@@ -316,7 +316,7 @@ 
     /**
      * Populates the child object from the database table by the given attribute value.
      *
-     * @param string $atribute        The name of the attribute to load the object by.
+     * @param string $attribute        The name of the attribute to load the object by.
      * @param string $value           The value of the attribute to load the object 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)
@@ -392,7 +392,7 @@ 
     /**
      * 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.
@@ -433,7 +433,7 @@ 
     /**
      * Loads all of the objects of this class by the specified attributes into an array which is returned.
      *
-     * @param array  $atributes       The attributes to load the objects by.
+     * @param array  $attributes       The attributes to load the objects by.
      * @param array  $values          The values of the attributes 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.
@@ -1089,7 +1089,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
@@ -1162,7 +1162,7 @@ 
      * to be overridden in case you want to do something different with the ID of your objects outside
      * of the standard 11 digit OID sequence used internally in Alpha.
      *
-     * @return int 11 digit zero-padded OID value.
+     * @return string 11 digit zero-padded OID value.
      *
      * @since 1.0
      */
@@ -1179,7 +1179,7 @@ 
      * Gets the OID for the object in zero-padded format (same as getID()).  This version is final so cannot
      * be overridden.
      *
-     * @return int 11 digit zero-padded OID value.
+     * @return string 11 digit zero-padded OID value.
      *
      * @since 1.0
      */
@@ -1742,7 +1742,6 @@ 
      * @param string $attributeName         The name of the attribute to apply the index on.
      * @param string $relatedClass          The name of the related class in the format "NameObject".
      * @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).
      * @param string $indexName             The optional name for the index, will calculate if not provided.
      *
      * @since 1.0
@@ -2180,7 +2179,7 @@ 
     /**
      * Starts a new database transaction.
      *
-     * @param $BO The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
+     * @param ActiveRecord $BO The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
      *
      * @since 1.0
      *
@@ -2213,7 +2212,7 @@ 
     /**
      * Commits the current database transaction.
      *
-     * @param $BO The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
+     * @param ActiveRecord $BO The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
      *
      * @since 1.0
      *
@@ -2246,7 +2245,7 @@ 
     /**
      * Aborts the current database transaction.
      *
-     * @param $BO The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
+     * @param ActiveRecord $BO The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
      *
      * @since 1.0
      *
@@ -2417,7 +2416,7 @@ 
     /**
      * Check to see if an attribute exists on the BO.
      *
-     * @param $attribute The attribute name.
+     * @param string $attribute The attribute name.
      *
      * @return bool
      *

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
      */

Unused Use Statements -1 removed lines

@@ -8,7 +8,6 @@
 use Alpha\Model\Type\Boolean;
 use Alpha\Model\Type\Relation;
 use Alpha\Util\Logging\Logger;
-use Alpha\Util\Config\Configprovider;
 use Alpha\Util\Http\Session\SessionProviderFactory;
 use Alpha\Exception\ValidationException;
 use Alpha\Exception\FileNotFoundException;

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/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
      *

Alpha/Util/File/FileUtils.php

Doc Comments +2 added lines, -2 removed lines

@@ -541,7 +541,7 @@ 
      * @param string $sourceDir    The path to the source directory.
      * @param string $fileList     The HTML list of files generated (pass by reference).
      * @param int    $fileCount    The current file count (used in recursive calls).
-     * @param array  $excludeFiles An array of file names to exclude from the list rendered.
+     * @param string[]  $excludeFiles An array of file names to exclude from the list rendered.
      *
      * @return int The current filecount for the directory.
      *
@@ -578,7 +578,7 @@ 
      * Recursively deletes the contents of the directory indicated (the directory itself is not deleted).
      *
      * @param string $sourceDir    The path to the source directory.
-     * @param array  $excludeFiles An array of file names to exclude from the deletion.
+     * @param string[]  $excludeFiles An array of file names to exclude from the deletion.
      *
      * @throws Alpha\Exception\AlphaException
      *

Alpha/Util/Graph/GraphNode.php

Doc Comments +2 added lines, -2 removed lines

@@ -284,7 +284,7 @@ 
     /**
      * Get the node offset.
      *
-     * @return string
+     * @return integer
      *
      * @since 1.0
      */
@@ -460,7 +460,7 @@ 
     /**
      * Calculates and returns the midpoint X coordinate of the children of this node.
      *
-     * @return int
+     * @return double
      *
      * @since 1.0
      */

Alpha/Util/Http/Session/SessionProviderInterface.php

Doc Comments +5 added lines, -2 removed lines

@@ -50,6 +50,7 @@ 
      * Starts a new session, or resumes an existing session if there is already a session ID available.
      *
      * @since 2.0
+     * @return void
      */
     public function init();
 
@@ -57,13 +58,14 @@ 
      * Destroys the current session.
      *
      * @since 2.0
+     * @return void
      */
     public function destroy();
 
     /**
      * Get the key value from the session.  Returns false if nothing is found.
      *
-     * @param $key
+     * @param string $key
      *
      * @since 2.0
      *
@@ -78,6 +80,7 @@ 
      * @param mixed  $value
      *
      * @since 2.0
+     * @return void
      */
     public function set($key, $value);
 
@@ -85,9 +88,9 @@ 
      * Deletes the value provided at that key in the session.
      *
      * @param string $key
-     * @param mixed  $value
      *
      * @since 2.0
+     * @return void
      */
     public function delete($key);