alphadevx / alpha

Alpha/Model/ActiveRecord.php

Doc Comments +4 added lines, -4 removed lines

@@ -1156,7 +1156,7 @@ 
     /**
      * Gets the ID for the object in zero-padded format (same as getID()).
      *
-     * @return int 11 digit zero-padded ID value.
+     * @return string 11 digit zero-padded ID value.
      *
      * @since 1.0
      */
@@ -2153,7 +2153,7 @@ 
     /**
      * Starts a new database transaction.
      *
-     * @param $Record The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
+     * @param ActiveRecord $Record The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
      *
      * @since 1.0
      *
@@ -2186,7 +2186,7 @@ 
     /**
      * Commits the current database transaction.
      *
-     * @param $Record The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
+     * @param ActiveRecord $Record The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
      *
      * @since 1.0
      *
@@ -2219,7 +2219,7 @@ 
     /**
      * Aborts the current database transaction.
      *
-     * @param $Record The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
+     * @param ActiveRecord $Record The ActiveRecord instance to pass to the database provider. Leave empty to have a new Person passed.
      *
      * @since 1.0
      *

Alpha/Model/ActiveRecordProviderInterface.php

Doc Comments +28 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($ID, $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 records 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 records 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 records 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 records that will be generated and returned.  Supports a maximum of 5 arguements.
      *
      * @return array An array containing objects of this type of record object.
      *
@@ -214,6 +217,7 @@ 
      * @throws \Alpha\Exception\FailedSaveException
      * @throws \Alpha\Exception\LockingException
      * @throws \Alpha\Exception\ValidationException
+     * @return void
      */
     public function save();
 
@@ -229,6 +233,7 @@ 
      * @throws \Alpha\Exception\IllegalArguementException
      * @throws \Alpha\Exception\FailedSaveException
      * @throws \Alpha\Exception\LockingException
+     * @return void
      */
     public function saveAttribute($attribute, $value);
 
@@ -238,6 +243,7 @@ 
      * @since 1.2
      *
      * @throws \Alpha\Exception\FailedSaveException
+     * @return void
      */
     public function saveHistory();
 
@@ -247,6 +253,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedDeleteException
+     * @return void
      */
     public function delete();
 
@@ -267,6 +274,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function makeTable();
 
@@ -276,6 +284,7 @@ 
      * @since 1.2
      *
      * @throws \AlphaException
+     * @return void
      */
     public function makeHistoryTable();
 
@@ -285,6 +294,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function rebuildTable();
 
@@ -296,6 +306,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);
 
@@ -308,6 +319,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function addProperty($propName);
 
@@ -325,7 +337,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
@@ -354,6 +366,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function setEnumOptions();
 
@@ -427,12 +440,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);
 
@@ -446,6 +459,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedIndexCreateException
+     * @return void
      */
     public function createUniqueIndex($attribute1Name, $attribute2Name = '', $attribute3Name = '');
 
@@ -455,6 +469,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public function reload();
 
@@ -490,6 +505,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public static function begin();
 
@@ -499,6 +515,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\FailedSaveException
+     * @return void
      */
     public static function commit();
 
@@ -508,6 +525,7 @@ 
      * @since 1.1
      *
      * @throws \Alpha\Exception\AlphaException
+     * @return void
      */
     public static function rollback();
 
@@ -517,6 +535,7 @@ 
      * @param \Alpha\Model\ActiveRecord $Record
      *
      * @since 1.1
+     * @return void
      */
     public function setRecord($Record);
 
@@ -549,6 +568,7 @@ 
      * @throws \Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function createDatabase();
 
@@ -558,6 +578,7 @@ 
      * @throws \Alpha\Exception\AlphaException
      *
      * @since 2.0
+     * @return void
      */
     public static function dropDatabase();
 }

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 = 'ID', $order = 'ASC', $ignoreClassType = false, $constructorArgs = array())
     {
@@ -312,7 +313,7 @@ 
     /**
      * Returns an array of the IDs of the related objects.
      *
-     * @return array
+     * @return integer[]
      *
      * @since 1.0
      */
@@ -325,7 +326,7 @@ 
      * Used to set the IDs of the related objects.  Pass a two-item array of IDs, the first
      * one being the left object ID, the second being the right.
      *
-     * @param array $IDs
+     * @param string[] $IDs
      *
      * @since 1.0
      *

Alpha/Model/ActiveRecordProviderSQLite.php

Spacing +4 added lines, -4 removed lines

@@ -969,8 +969,8 @@ 
                 $stmt->bindValue(':ID', $this->record->getID(), SQLITE3_INTEGER);
 
                 $temp = $this->record->getVersionNumber()->getValue();
-                $this->record->set('version_num', $temp + 1);
-                $stmt->bindValue(':version_num', $temp + 1, SQLITE3_INTEGER);
+                $this->record->set('version_num', $temp+1);
+                $stmt->bindValue(':version_num', $temp+1, SQLITE3_INTEGER);
 
                 $stmt->execute();
             } else {
@@ -1049,7 +1049,7 @@ 
         } else {
             // there has been an error, so decrement the version number back
             $temp = $this->record->getVersionNumber()->getValue();
-            $this->record->set('version_num', $temp - 1);
+            $this->record->set('version_num', $temp-1);
 
             throw new FailedSaveException('Failed to save object, SQLite error is ['.self::getLastDatabaseError().'], query ['.$this->record->getLastQuery().']');
         }
@@ -1093,7 +1093,7 @@ 
         $this->record->setLastQuery($sqlQuery);
         $stmt = self::getConnection()->prepare($sqlQuery);
 
-        $newVersionNumber = $this->record->getVersionNumber()->getValue() + 1;
+        $newVersionNumber = $this->record->getVersionNumber()->getValue()+1;
 
         if ($stmt instanceof SQLite3Stmt) {
             if ($this->record->getPropObject($attribute) instanceof Integer) {

Alpha/Controller/Front/FrontController.php

Spacing +26 added lines, -26 removed lines

@@ -175,145 +175,145 @@ 
             throw new BadRequestException('Request character encoding does not match expected UTF-8');
         }
 
-        $this->addRoute('/', function ($request) {
+        $this->addRoute('/', function($request) {
             $controller = new IndexController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/a/{title}/{view}', function ($request) {
+        $this->addRoute('/a/{title}/{view}', function($request) {
             $controller = new ArticleController();
 
             return $controller->process($request);
         })->value('title', null)->value('view', 'detailed');
 
-        $this->addRoute('/articles/{start}/{limit}', function ($request) {
+        $this->addRoute('/articles/{start}/{limit}', function($request) {
             $controller = new ArticleController();
 
             return $controller->process($request);
         })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));
 
-        $this->addRoute('/attach/{articleID}/{filename}', function ($request) {
+        $this->addRoute('/attach/{articleID}/{filename}', function($request) {
             $controller = new AttachmentController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/cache', function ($request) {
+        $this->addRoute('/cache', function($request) {
             $controller = new CacheController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/denum/{denumID}', function ($request) {
+        $this->addRoute('/denum/{denumID}', function($request) {
             $controller = new DEnumController();
 
             return $controller->process($request);
         })->value('denumID', null);
 
-        $this->addRoute('/excel/{ActiveRecordType}/{ActiveRecordID}', function ($request) {
+        $this->addRoute('/excel/{ActiveRecordType}/{ActiveRecordID}', function($request) {
             $controller = new ExcelController();
 
             return $controller->process($request);
         })->value('ActiveRecordID', null);
 
-        $this->addRoute('/feed/{ActiveRecordType}/{type}', function ($request) {
+        $this->addRoute('/feed/{ActiveRecordType}/{type}', function($request) {
             $controller = new FeedController();
 
             return $controller->process($request);
         })->value('type', 'Atom');
 
-        $this->addRoute('/gensecure', function ($request) {
+        $this->addRoute('/gensecure', function($request) {
             $controller = new GenSecureQueryStringController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/image/{source}/{width}/{height}/{type}/{quality}/{scale}/{secure}/{var1}/{var2}', function ($request) {
+        $this->addRoute('/image/{source}/{width}/{height}/{type}/{quality}/{scale}/{secure}/{var1}/{var2}', function($request) {
             $controller = new ImageController();
 
             return $controller->process($request);
         })->value('var1', null)->value('var2', null);
 
-        $this->addRoute('/listactiverecords', function ($request) {
+        $this->addRoute('/listactiverecords', function($request) {
             $controller = new ListActiveRecordsController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/log/{logPath}', function ($request) {
+        $this->addRoute('/log/{logPath}', function($request) {
             $controller = new LogController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/login', function ($request) {
+        $this->addRoute('/login', function($request) {
             $controller = new LoginController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/logout', function ($request) {
+        $this->addRoute('/logout', function($request) {
             $controller = new LogoutController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/metric', function ($request) {
+        $this->addRoute('/metric', function($request) {
             $controller = new MetricController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/recordselector/12m/{ActiveRecordID}/{field}/{relatedClass}/{relatedClassField}/{relatedClassDisplayField}/{relationType}', function ($request) {
+        $this->addRoute('/recordselector/12m/{ActiveRecordID}/{field}/{relatedClass}/{relatedClassField}/{relatedClassDisplayField}/{relationType}', function($request) {
             $controller = new RecordSelectorController();
 
             return $controller->process($request);
         })->value('relationType', 'ONE-TO-MANY');
 
-        $this->addRoute('/recordselector/m2m/{ActiveRecordID}/{field}/{relatedClassLeft}/{relatedClassLeftDisplayField}/{relatedClassRight}/{relatedClassRightDisplayField}/{accessingClassName}/{lookupIDs}/{relationType}', function ($request) {
+        $this->addRoute('/recordselector/m2m/{ActiveRecordID}/{field}/{relatedClassLeft}/{relatedClassLeftDisplayField}/{relatedClassRight}/{relatedClassRightDisplayField}/{accessingClassName}/{lookupIDs}/{relationType}', function($request) {
             $controller = new RecordSelectorController();
 
             return $controller->process($request);
         })->value('relationType', 'MANY-TO-MANY');
 
-        $this->addRoute('/search/{query}/{start}/{limit}', function ($request) {
+        $this->addRoute('/search/{query}/{start}/{limit}', function($request) {
             $controller = new SearchController();
 
             return $controller->process($request);
         })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));
 
-        $this->addRoute('/sequence/{start}/{limit}', function ($request) {
+        $this->addRoute('/sequence/{start}/{limit}', function($request) {
             $controller = new SequenceController();
 
             return $controller->process($request);
         })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));
 
-        $this->addRoute('/tag/{ActiveRecordType}/{ActiveRecordID}', function ($request) {
+        $this->addRoute('/tag/{ActiveRecordType}/{ActiveRecordID}', function($request) {
             $controller = new TagController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/install', function ($request) {
+        $this->addRoute('/install', function($request) {
             $controller = new InstallController();
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/record/{ActiveRecordType}/{ActiveRecordID}/{view}', function ($request) {
+        $this->addRoute('/record/{ActiveRecordType}/{ActiveRecordID}/{view}', function($request) {
             $controller = new ActiveRecordController();
 
             return $controller->process($request);
         })->value('ActiveRecordID', null)->value('view', 'detailed');
 
-        $this->addRoute('/records/{ActiveRecordType}/{start}/{limit}', function ($request) {
+        $this->addRoute('/records/{ActiveRecordType}/{start}/{limit}', function($request) {
             $controller = new ActiveRecordController();
 
             return $controller->process($request);
         })->value('start', 0)->value('limit', $config->get('app.list.page.amount'));
 
-        $this->addRoute('/tk/{token}', function ($request) {
+        $this->addRoute('/tk/{token}', function($request) {
             $params = self::getDecodeQueryParams($request->getParam('token'));
 
             if (isset($params['act'])) {
@@ -340,14 +340,14 @@ 
             return new Response(404, 'Resource not found');
         });
 
-        $this->addRoute('/alpha/service', function ($request) {
+        $this->addRoute('/alpha/service', function($request) {
             $controller = new LoginController();
             $controller->setUnitOfWork(array('Alpha\Controller\LoginController', 'Alpha\Controller\ListActiveRecordsController'));
 
             return $controller->process($request);
         });
 
-        $this->addRoute('/phpinfo', function ($request) {
+        $this->addRoute('/phpinfo', function($request) {
             $controller = new PhpinfoController();
 
             return $controller->process($request);