alphadevx / alpha

Alpha/Model/ActiveRecord.php

Doc Comments +2 added lines, -2 removed lines

@@ -1158,7 +1158,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
      */
@@ -1175,7 +1175,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
      */

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 $Record The (optional) active record instance to pass to the persistance provider for mapping.
      *
      * @throws \Alpha\Exception\IllegalArguementException

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($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 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/ActiveRecordProviderMySQL.php

Doc Comments +2 added lines, -2 removed lines

@@ -2340,11 +2340,11 @@
      * 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 Record attributes.
      * @param array Optional array of Record values.
      *
-     * @return mysqli_stmt
+     * @return \mysqli_stmt
      *
      * @since 1.1
      */

Spacing +4 added lines, -4 removed lines

@@ -1014,7 +1014,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);
 
             // check for unique violations
             if (self::getConnection()->errno == '1062') {
@@ -1063,7 +1063,7 @@ 
         $this->record->setLastQuery($sqlQuery);
         $stmt = self::getConnection()->stmt_init();
 
-        $newVersionNumber = $this->record->getVersionNumber()->getValue() + 1;
+        $newVersionNumber = $this->record->getVersionNumber()->getValue()+1;
 
         if ($stmt->prepare($sqlQuery)) {
             if ($this->record->getPropObject($attribute) instanceof Integer) {
@@ -2393,7 +2393,7 @@ 
 
                     if ($propName == 'version_num') {
                         $temp = $this->record->getVersionNumber()->getValue();
-                        $this->record->set('version_num', $temp + 1);
+                        $this->record->set('version_num', $temp+1);
                         $bindingsTypes .= 'i';
                         array_push($params, $this->record->getVersionNumber()->getValue());
                     }
@@ -2489,7 +2489,7 @@ 
         $singleQuote1 = mb_strpos($error, "'");
         $singleQuote2 = mb_strrpos($error, "'");
 
-        $value = mb_substr($error, $singleQuote1, ($singleQuote2 - $singleQuote1) + 1);
+        $value = mb_substr($error, $singleQuote1, ($singleQuote2-$singleQuote1)+1);
         self::$logger->debug('<<findOffendingValue ['.$value.'])');
 
         return $value;

Alpha/Model/Type/Relation.php

Doc Comments +2 added lines, -2 removed lines

@@ -508,7 +508,7 @@ 
     /**
      * Getter for the Relation value.
      *
-     * @return mixed
+     * @return string
      *
      * @since 1.0
      */
@@ -748,7 +748,7 @@ 
      * Set the taggedClass property to the name of the tagged class when building relations
      * to the TagObject record.
      *
-     * @param $taggedClass
+     * @param string $taggedClass
      *
      * @since 1.0
      */

Alpha/View/Renderer/Html/RendererProviderHTML.php

Spacing +3 added lines, -3 removed lines

@@ -225,7 +225,7 @@ 
         // work out how many columns will be in the table
         $reflection = new ReflectionClass(get_class($this->record));
         $properties = array_keys($reflection->getDefaultProperties());
-        $fields['colCount'] = 1 + count(array_diff($properties, $this->record->getDefaultAttributes(), $this->record->getTransientAttributes()));
+        $fields['colCount'] = 1+count(array_diff($properties, $this->record->getDefaultAttributes(), $this->record->getTransientAttributes()));
 
         // get the class attributes
         $properties = $reflection->getProperties();
@@ -246,7 +246,7 @@ 
                     $html .= '  <th>'.$this->record->getDataLabel($propName).'</th>';
                 }
             } else {
-                $fields['colCount'] = $fields['colCount'] - 1;
+                $fields['colCount'] = $fields['colCount']-1;
             }
         }
         $html .= '</tr><tr>';
@@ -1031,7 +1031,7 @@ 
                 if ($viewState->get('markdownTextBoxRows') == '') {
                     $text = new TextBox($this->record->getPropObject($name), $label, $name, 10);
                 } else {
-                    $text = new TextBox($this->record->getPropObject($name), $label, $name, (integer) $viewState->get('markdownTextBoxRows'));
+                    $text = new TextBox($this->record->getPropObject($name), $label, $name, (integer)$viewState->get('markdownTextBoxRows'));
                 }
 
                 $html .= $text->render();

Alpha/View/SequenceView.php

Spacing +2 added lines, -2 removed lines

@@ -103,7 +103,7 @@ 
         // work out how many columns will be in the table
         $reflection = new \ReflectionClass(get_class($this->record));
         $properties = array_keys($reflection->getDefaultProperties());
-        $fields['colCount'] = 1 + count(array_diff($properties, $this->record->getDefaultAttributes(), $this->record->getTransientAttributes()));
+        $fields['colCount'] = 1+count(array_diff($properties, $this->record->getDefaultAttributes(), $this->record->getTransientAttributes()));
 
         // get the class attributes
         $properties = $reflection->getProperties();
@@ -124,7 +124,7 @@ 
                     $html .= '  <th>'.$this->record->getDataLabel($propName).'</th>';
                 }
             } else {
-                $fields['colCount'] = $fields['colCount'] - 1;
+                $fields['colCount'] = $fields['colCount']-1;
             }
         }
         $html .= '</tr><tr>';

Alpha/View/ArticleView.php

Spacing +1 added lines, -1 removed lines

@@ -253,7 +253,7 @@
 
                     $html .= '<tr>';
 
-                    $html .= '<td>'.$file.' <em>('.number_format(filesize($this->record->getAttachmentsLocation().'/'.$file) / 1024).' KB)</em></td>';
+                    $html .= '<td>'.$file.' <em>('.number_format(filesize($this->record->getAttachmentsLocation().'/'.$file)/1024).' KB)</em></td>';
 
                     $js = "if(window.jQuery) {
                             BootstrapDialog.show({

Alpha/Model/ActiveRecordProviderSQLite.php

Spacing +4 added lines, -4 removed lines

@@ -969,8 +969,8 @@ 
                 $stmt->bindValue(':OID', $this->record->getOID(), 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) {