alphadevx / alpha

Alpha/Util/Search/SearchProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

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

Alpha/Util/Cache/CacheProviderFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
      * A static method that attempts to return a SessionProviderInterface 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
      *

Alpha/Model/ActiveRecord.php

Doc Comments +6 added lines, -6 removed lines

@@ -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
      */
@@ -2176,7 +2176,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
      *
@@ -2209,7 +2209,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
      *
@@ -2242,7 +2242,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
      *
@@ -2413,7 +2413,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/Type/DEnum.php

Doc Comments +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
     /**
      * Getter for the name.
      *
-     * @return string
+     * @return SmallText
      *
      * @since 1.0
      */

Alpha/Model/ActiveRecordProviderInterface.php

Doc Comments +27 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();
 
@@ -81,6 +82,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\RecordFoundException
+     * @return void
      */
     public function load($OID, $version = 0);
 
@@ -100,7 +102,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)
@@ -108,6 +110,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\RecordFoundException
+     * @return void
      */
     public function loadByAttribute($attribute, $value, $ignoreClassType = false, $loadAttributes = array());
 
@@ -131,14 +134,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 +155,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 +231,7 @@ 
      *
      * @throws \Alpha\Exception\IllegalArguementException
      * @throws \Alpha\Exception\FailedSaveException
+     * @return void
      */
     public function saveAttribute($attribute, $value);
 
@@ -237,6 +241,7 @@ 
      * @since 1.2
      *
      * @throws \Alpha\Exception\FailedSaveException
+     * @return void
      */
     public function saveHistory();
 
@@ -246,6 +251,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedDeleteException
+     * @return void
      */
     public function delete();
 
@@ -266,6 +272,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function makeTable();
 
@@ -275,6 +282,7 @@ 
      * @since 1.2
      *
      * @throws \AlphaException
+     * @return void
      */
     public function makeHistoryTable();
 
@@ -284,6 +292,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function rebuildTable();
 
@@ -295,6 +304,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 +317,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function addProperty($propName);
 
@@ -324,7 +335,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 +364,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function setEnumOptions();
 
@@ -426,12 +438,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 +457,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedIndexCreateException
+     * @return void
      */
     public function createUniqueIndex($attribute1Name, $attribute2Name = '', $attribute3Name = '');
 
@@ -454,6 +467,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function reload();
 
@@ -489,6 +503,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public static function begin();
 
@@ -498,6 +513,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedSaveException
+     * @return void
      */
     public static function commit();
 
@@ -507,6 +523,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public static function rollback();
 
@@ -516,6 +533,7 @@ 
      * @param \Alpha\Model\ActiveRecord $BO
      *
      * @since 1.1
+     * @return void
      */
     public function setBO($BO);
 
@@ -548,6 +566,7 @@ 
      * @throws \Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function createDatabase();
 
@@ -557,6 +576,7 @@ 
      * @throws \Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function dropDatabase();
 }