alphadevx / alpha

Alpha/Controller/Controller.php

Doc Comments +11 added lines, -3 removed lines

@@ -297,7 +297,7 @@ 
     /**
      * Get the record for this controller (if any).
      *
-     * @return mixed
+     * @return ActiveRecord
      *
      * @since 1.0
      */
@@ -632,7 +632,7 @@ 
     /**
      * Getter for the unit of work MAX duration.
      *
-     * @return int
+     * @return Integer
      *
      * @since 1.0
      */
@@ -1179,7 +1179,7 @@ 
     /**
      * Generates the two security fields to prevent remote form processing.
      *
-     * @return array An array containing the two fields
+     * @return string[] An array containing the two fields
      *
      * @since 1.0
      */
@@ -1432,6 +1432,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doHEAD($request)
     {
@@ -1444,6 +1445,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doGET($request)
     {
@@ -1456,6 +1458,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doPOST($request)
     {
@@ -1468,6 +1471,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doPUT($request)
     {
@@ -1480,6 +1484,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doPATCH($request)
     {
@@ -1492,6 +1497,7 @@ 
      * @since 2.0
      *
      * @throws \Alpha\Exception\NotImplementedException
+     * @param Request $request
      */
     public function doDELETE($request)
     {
@@ -1502,6 +1508,7 @@ 
      * {@inheritdoc}
      *
      * @since 2.0
+     * @param Request $request
      */
     public function doOPTIONS($request)
     {
@@ -1529,6 +1536,7 @@ 
      * {@inheritdoc}
      *
      * @since 2.0.2
+     * @param Request $request
      */
     public function doTRACE($request)
     {

Alpha/Controller/ControllerInterface.php

Doc Comments +6 added lines, -7 removed lines

@@ -60,37 +60,36 @@ 
     /**
      * Handles GET HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response|null
      */
     public function doGET($params);
 
     /**
      * Handles POST HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response|null
      */
     public function doPOST($params);
 
     /**
      * Handles PUT HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response
      */
     public function doPUT($params);
 
     /**
      * Handles PATCH HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
@@ -100,30 +99,30 @@ 
     /**
      * Handles DELETE HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response
      */
     public function doDELETE($params);
 
     /**
      * Handles OPTIONS HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 1.0
+     * @return \Alpha\Util\Http\Response
      */
     public function doOPTIONS($params);
 
     /**
      * Handles TRACE HTTP requests.
      *
-     * @param \Alpha\Util\Http\Request $request
      *
      * @since Alpha\Util\Http\Response
      * @since 2.0.2
+     * @return \Alpha\Util\Http\Response
      */
     public function doTRACE($params);
 }

Alpha/Controller/InstallController.php

Doc Comments +1 added lines, -1 removed lines

@@ -454,7 +454,7 @@
      * Custom version of the check rights method that only checks for a session for the config admin username/password,
      * when the system database is not set-up.
      *
-     * @return bool
+     * @return boolean|null
      *
      * @since 1.0
      */

Alpha/Model/ActiveRecordProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
      * A static method that attempts to return a ActiveRecordProviderInterface instance
      * based on the name of the provider class supplied.
      *
-     * @param $providerName The fully-qualified class name of the provider class.
+     * @param string $providerName The fully-qualified class name of the provider class.
      * @param $BO The (optional) active record instance to pass to the persistance provider for mapping.
      *
      * @throws \Alpha\Exception\IllegalArguementException

Alpha/Model/ActiveRecordProviderInterface.php

Doc Comments +25 added lines, -7 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,12 +436,12 @@ 
      * @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).
      * @param string $indexName             The optional name for the index, will calculate if not provided.
      *
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedIndexCreateException
+     * @return void
      */
     public function createForeignIndex($attributeName, $relatedClass, $relatedClassAttribute, $indexName = null);
 
@@ -445,6 +455,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedIndexCreateException
+     * @return void
      */
     public function createUniqueIndex($attribute1Name, $attribute2Name = '', $attribute3Name = '');
 
@@ -454,6 +465,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function reload();
 
@@ -489,6 +501,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public static function begin();
 
@@ -498,6 +511,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedSaveException
+     * @return void
      */
     public static function commit();
 
@@ -507,6 +521,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public static function rollback();
 
@@ -516,6 +531,7 @@ 
      * @param \Alpha\Model\ActiveRecord $BO
      *
      * @since 1.1
+     * @return void
      */
     public function setBO($BO);
 
@@ -548,6 +564,7 @@ 
      * @throws \Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function createDatabase();
 
@@ -557,6 +574,7 @@ 
      * @throws \Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function dropDatabase();
 }

Alpha/Model/Type/Relation.php

Doc Comments +2 added lines, -3 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
      *
@@ -512,7 +511,7 @@ 
     /**
      * Getter for the Relation value.
      *
-     * @return mixed
+     * @return string
      *
      * @since 1.0
      */
@@ -754,7 +753,7 @@ 
      * Set the taggedClass property to the name of the tagged class when building relations
      * to the TagObject BO.
      *
-     * @param $taggedClass
+     * @param string $taggedClass
      *
      * @since 1.0
      */

Alpha/Model/Type/RelationLookup.php

Doc Comments +3 added lines, -2 removed lines

@@ -222,6 +222,7 @@ 
      * (non-PHPdoc)
      *
      * @see Alpha\Model\ActiveRecord::loadAllByAttribute()
+     * @param string $attribute
      */
     public function loadAllByAttribute($attribute, $value, $start = 0, $limit = 0, $orderBy = 'OID', $order = 'ASC', $ignoreClassType = false, $constructorArgs = array())
     {
@@ -312,7 +313,7 @@ 
     /**
      * Returns an array of the OIDs of the related objects.
      *
-     * @return array
+     * @return integer[]
      *
      * @since 1.0
      */
@@ -325,7 +326,7 @@ 
      * Used to set the OIDs of the related objects.  Pass a two-item array of OIDs, the first
      * one being the left object OID, the second being the right.
      *
-     * @param array $OIDs
+     * @param string[] $OIDs
      *
      * @since 1.0
      *

Alpha/Util/Code/Highlight/HighlightProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
      * A static method that attempts to return a HighlightProviderInterface instance
      * based on the name of the provider class supplied.
      *
-     * @param $providerName The fully-qualified class name of the provider class, should implement Alpha\Util\Code\Highlight\HighlightProviderInterface
+     * @param string $providerName The fully-qualified class name of the provider class, should implement Alpha\Util\Code\Highlight\HighlightProviderInterface
      *
      * @throws \Alpha\Exception\IllegalArguementException
      *

Alpha/Util/Email/EmailProviderFactory.php

Doc Comments +2 added lines, -2 removed lines

@@ -63,11 +63,11 @@
      * A static method that attempts to return a EmailProviderInterface instance
      * based on the name of the provider class supplied.
      *
-     * @param $providerName The class name of the provider class (fully qualified).
+     * @param string $providerName The class name of the provider class (fully qualified).
      *
      * @throws \Alpha\Exception\IllegalArguementException
      *
-     * @return \Alpha\Util\Http\Email\EmailProviderInterface
+     * @return EmailProviderInterface|null
      *
      * @since 2.0
      */