ntentan / nibii

src/FilterCompiler.php

Doc Comments +4 added lines

@@ -204,6 +204,10 @@
         return $return;
     }
 
+    /**
+     * @param integer $level
+     * @param string $opr
+     */
     private function parseRightExpression($level, $opr)
     {
         switch ($opr) {

src/ModelDescription.php

Doc Comments +3 added lines

@@ -103,6 +103,9 @@
         return $relationshipDetails;
     }
 
+    /**
+     * @param string $type
+     */
     private function createRelationships($type, $relationships)
     {
         foreach ($relationships as $relationship) {

src/interfaces/ValidatorFactoryInterface.php

Doc Comments +3 added lines

@@ -17,5 +17,8 @@
  */
 interface ValidatorFactoryInterface
 {
+    /**
+     * @return \ntentan\nibii\DefaultValidator
+     */
     public function createModelValidator(RecordWrapper $model, $mode);
 }

src/ORMContext.php

Doc Comments +3 added lines

@@ -89,6 +89,9 @@
         return $this->config;
     }
 
+    /**
+     * @param RecordWrapper $model
+     */
     public function getModelDescription($model) : ModelDescription
     {
         return new ModelDescription($model);

Unused Use Statements +1 added lines, -1 removed lines

@@ -28,10 +28,10 @@
 
 use ntentan\atiaa\DbContext;
 use ntentan\kaikai\Cache;
+use ntentan\nibii\exceptions\NibiiException;
 use ntentan\nibii\interfaces\DriverAdapterFactoryInterface;
 use ntentan\nibii\interfaces\ModelFactoryInterface;
 use ntentan\nibii\interfaces\ValidatorFactoryInterface;
-use ntentan\nibii\exceptions\NibiiException;
 
 /**
  * A global class with information and utilities required by the rest of the ORM system.

src/interfaces/ModelFactoryInterface.php

Doc Comments +11 added lines

@@ -28,11 +28,22 @@
 
 interface ModelFactoryInterface
 {
+    /**
+     * @param string $name
+     */
     public function createModel($name, $context);
 
+    /**
+     * @param \ntentan\nibii\RecordWrapper $instance
+     *
+     * @return string
+     */
     public function getModelTable($instance);
 
     public function getClassName($model);
 
+    /**
+     * @return string
+     */
     public function getJunctionClassName($classA, $classB);
 }

src/Operations.php

Doc Comments +6 added lines

@@ -47,6 +47,9 @@ 
         'save', 'validate',
     ];
 
+    /**
+     * @param string $table
+     */
     public function __construct(RecordWrapper $wrapper, $table)
     {
         $this->wrapper = $wrapper;
@@ -56,6 +59,9 @@ 
         $this->queryOperations = new QueryOperations($wrapper, $this->dataOperations, $driver);
     }
 
+    /**
+     * @param string $name
+     */
     public function perform($name, $arguments)
     {
         //@todo Think of using a hash here in future

src/relationships/BelongsToRelationship.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -26,9 +26,9 @@
 
 namespace ntentan\nibii\relationships;
 
-use ntentan\nibii\exceptions\FieldNotFoundException;
 use ntentan\nibii\ORMContext;
 use ntentan\nibii\Relationship;
+use ntentan\nibii\exceptions\FieldNotFoundException;
 use ntentan\utils\Text;
 
 /**

Spacing +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 
     public function preSave(&$wrapper, $value)
     {
-        if(!$value->save()) {
+        if (!$value->save()) {
             $this->invalidFields = $value->getInvalidFields();
         }
         $wrapper[$this->options['local_key']] = $value[$this->options['foreign_key']];

src/DriverAdapter.php

Spacing +1 added lines, -1 removed lines

@@ -139,7 +139,7 @@
     public function describe($model, $relationships)
     {
         return new ModelDescription(
-            $this->driver->describeTable($table)[$table], $relationships, function ($type) {
+            $this->driver->describeTable($table)[$table], $relationships, function($type) {
                 return $this->mapDataTypes($type);
             }
         );

src/RecordWrapper.php

Doc Comments +5 added lines, -1 removed lines

@@ -497,7 +497,7 @@ 
      * Callback for when a new record has been created.
      * This callback can be most useful for obtaining the primary key of a newly created record.
      *
-     * @param $id
+     * @param string $id
      */
     public function postCreateCallback($id)
     {
@@ -538,6 +538,10 @@ 
         return $this->adapter;
     }
 
+    /**
+     * @param Relationship[] $relationships
+     * @param integer $depth
+     */
     private function expandArrayValue($array, $relationships, $depth, $expandableModels = [], $index = null)
     {
         $expandableModels = empty($expandableModels) ? array_keys($relationships) : $expandableModels;

Spacing +2 added lines, -2 removed lines

@@ -211,7 +211,7 @@ 
         $this->initialize();
 
         return $this->context->getCache()->read(
-            "{$this->className}::desc", function () {
+            "{$this->className}::desc", function() {
                 return $this->context->getModelDescription($this);
             }
         );
@@ -443,7 +443,7 @@ 
     {
         $data = $index ? $this->modelData[$index] : $this->modelData;
         $name = $relationship->getOptions()['name'];
-        if(isset($data[$name]))
+        if (isset($data[$name]))
         {
             return $data[$name];
         }