Merge pull request #84 from maxmirazh33/codestyle-fixes

Codestyle and phpdoc fixes
analogueorm · Jan 19, 2016 · c117841 · c117841
2 parents f727222 + aa7f8a8
commit c117841
Show file tree

Hide file tree

Showing 98 changed files with 1,620 additions and 1,253 deletions.
diff --git a/composer.json b/composer.json
@@ -1,8 +1,14 @@
 {
     "name": "analogue/orm",
     "description": "An intuitive Data Mapper ORM for PHP and Laravel",
-    "keywords": ["orm", "datamapper", "laravel", 
-    "entity", "repository", "mapper"],
+    "keywords": [
+        "orm",
+        "datamapper",
+        "laravel",
+        "entity",
+        "repository",
+        "mapper"
+    ],
     "homepage": "http://github.com/analogueorm/analogue",
     "license": "MIT",
     "authors": [
@@ -29,5 +35,5 @@
         }
     },
     "minimum-stability": "stable",
-    "prefer-stable":true
+    "prefer-stable": true
 }
diff --git a/src/Analogue.php b/src/Analogue.php
@@ -1,4 +1,6 @@
-<?php namespace Analogue\ORM;
+<?php
+
+namespace Analogue\ORM;
 
 use Analogue\ORM\System\Manager;
 use Illuminate\Events\Dispatcher;
@@ -10,21 +12,38 @@
 /**
  * This class is a proxy to the Manager class, which allows
  * using Analogue outside of the Laravel framework.
+ *
+ * @mixin Manager
  */
 class Analogue
 {
-
+    /**
+     * @var self
+     */
     protected static $instance;
 
+    /**
+     * @var Manager
+     */
     protected static $manager;
 
+    /**
+     * @var Capsule
+     */
     protected static $capsule;
 
+    /**
+     * @var bool
+     */
     protected static $booted = false;
 
+    /**
+     * Analogue constructor.
+     * @param array $connection
+     */
     public function __construct(array $connection)
     {
-        if (! static::$booted) {
+        if (!static::$booted) {
             static::$capsule = new Capsule;
 
             $this->addConnection($connection);
@@ -66,12 +85,12 @@ public function boot()
     /**
      * Add a connection array to Capsule
      *
-     * @param array     $config
-     * @param string    $name
+     * @param array  $config
+     * @param string $name
      */
     public function addConnection($config, $name = 'default')
     {
-        return static::$capsule->addConnection($config, $name);
+        static::$capsule->addConnection($config, $name);
     }
 
     /**
@@ -88,24 +107,24 @@ public function connection($name = null)
     /**
      * Dynamically handle static calls to the instance, Facade Style.
      *
-     * @param  string  $method
-     * @param  array   $parameters
+     * @param  string $method
+     * @param  array  $parameters
      * @return mixed
      */
     public static function __callStatic($method, $parameters)
     {
-        return call_user_func_array(array(static::$instance, $method), $parameters);
+        return call_user_func_array([static::$instance, $method], $parameters);
     }
 
     /**
      * Dynamically handle calls to the Analogue Manager instance.
      *
-     * @param  string  $method
-     * @param  array   $parameters
+     * @param  string $method
+     * @param  array  $parameters
      * @return mixed
      */
     public function __call($method, $parameters)
     {
-        return call_user_func_array(array(static::$manager, $method), $parameters);
+        return call_user_func_array([static::$manager, $method], $parameters);
     }
 }
diff --git a/src/AnalogueFacade.php b/src/AnalogueFacade.php
@@ -1,4 +1,6 @@
-<?php namespace Analogue\ORM;
+<?php
+
+namespace Analogue\ORM;
 
 use Illuminate\Support\Facades\Facade;
 
@@ -7,7 +9,6 @@
  */
 class AnalogueFacade extends Facade
 {
-
     /**
      * Get the registered name of the component.
      *

diff --git a/src/AnalogueServiceProvider.php b/src/AnalogueServiceProvider.php
@@ -1,4 +1,6 @@
-<?php namespace Analogue\ORM;
+<?php
+
+namespace Analogue\ORM;
 
 use Illuminate\Support\ServiceProvider;
 use Analogue\ORM\System\Manager;
@@ -11,7 +13,6 @@
  */
 class AnalogueServiceProvider extends ServiceProvider
 {
-
     /**
      * Indicates if loading of the provider is deferred.
      *

diff --git a/src/Commands/Command.php b/src/Commands/Command.php
@@ -7,7 +7,6 @@
 
 abstract class Command
 {
-
     /**
      * The aggregated entity on which the command is executed
      *
@@ -22,6 +21,11 @@ abstract class Command
      */
     protected $query;
 
+    /**
+     * Command constructor.
+     * @param Aggregate $aggregate
+     * @param QueryAdapter|\Analogue\ORM\Drivers\IlluminateQueryAdapter $query
+     */
     public function __construct(Aggregate $aggregate, QueryAdapter $query)
     {
         $this->aggregate = $aggregate;

diff --git a/src/Commands/Delete.php b/src/Commands/Delete.php
@@ -1,14 +1,17 @@
-<?php namespace Analogue\ORM\Commands;
+<?php
+
+namespace Analogue\ORM\Commands;
 
 use Analogue\ORM\Exceptions\MappingException;
 
 class Delete extends Command
 {
-
     /**
      * Execute the Delete Statement
      *
-     * @return void
+     * @throws MappingException
+     * @throws \InvalidArgumentException
+     * @return false|void
      */
     public function execute()
     {
@@ -27,7 +30,7 @@ public function execute()
         $id = $this->aggregate->getEntityId();
 
         if (is_null($id)) {
-            throw new MappingException("Executed a delete command on an entity with 'null' as primary key");
+            throw new MappingException('Executed a delete command on an entity with "null" as primary key');
         }
 
         $this->query->where($keyName, '=', $id)->delete();

diff --git a/src/Commands/Store.php b/src/Commands/Store.php
@@ -3,15 +3,9 @@
 namespace Analogue\ORM\Commands;
 
 use Analogue\ORM\Mappable;
-use Analogue\ORM\System\Mapper;
-use Analogue\ORM\System\Manager;
 use Analogue\ORM\EntityCollection;
-use Analogue\ORM\Drivers\QueryAdapter;
 use Analogue\ORM\System\Aggregate;
-use Analogue\ORM\System\InternallyMappable;
 use Analogue\ORM\System\Proxies\EntityProxy;
-use Analogue\ORM\Exceptions\MappingException;
-use Analogue\ORM\System\Proxies\ProxyInterface;
 use Analogue\ORM\System\Proxies\CollectionProxy;
 
 /**
@@ -20,11 +14,11 @@
  */
 class Store extends Command
 {
-
     /**
      * Persist the entity in the database
      *
-     * @return void
+     * @throws \InvalidArgumentException
+     * @return false|mixed
      */
     public function execute()
     {
@@ -42,11 +36,11 @@ public function execute()
          * We will test the entity for existence
          * and run a creation if it doesn't exists
          */
-        if (! $this->aggregate->exists()) {
+        if (!$this->aggregate->exists()) {
             if ($mapper->fireEvent('creating', $entity) === false) {
                 return false;
             }
-            
+
             $this->insert();
 
             $mapper->fireEvent('created', $entity, false);
@@ -70,33 +64,34 @@ public function execute()
         $mapper->fireEvent('stored', $entity, false);
 
         return $entity;
-        ;
     }
 
     /**
      * Run all operations that have to occur before actually
      * storing the entity
      *
+     * @throws \InvalidArgumentException
      * @return void
      */
     protected function preStoreProcess()
     {
         // Create any related object that doesn't exist in the database.
         $localRelationships = $this->aggregate->getEntityMap()->getLocalRelationships();
-        
+
         $this->createRelatedEntities($localRelationships);
     }
 
     /**
      * Check for existence and create non-existing related entities
      *
      * @param  array
+     * @throws \InvalidArgumentException
      * @return void
      */
     protected function createRelatedEntities($relations)
     {
         $entitiesToCreate = $this->aggregate->getNonExistingRelated($relations);
-                
+
         foreach ($entitiesToCreate as $aggregate) {
             $this->createStoreCommand($aggregate)->execute();
         }
@@ -106,7 +101,7 @@ protected function createRelatedEntities($relations)
      * Create a new store command
      *
      * @param  Aggregate $aggregate
-     * @return void
+     * @return Store
      */
     protected function createStoreCommand(Aggregate $aggregate)
     {
@@ -120,6 +115,7 @@ protected function createStoreCommand(Aggregate $aggregate)
      * Run all operations that have to occur after the entity
      * is stored.
      *
+     * @throws \InvalidArgumentException
      * @return void
      */
     protected function postStoreProcess()
@@ -147,7 +143,7 @@ protected function postStoreProcess()
         // This should be move to the wrapper class
         // so it's the same code for the entity builder
         $aggregate->setProxies();
-        
+
         // Update Entity Cache
         $aggregate->getMapper()->getEntityCache()->refresh($aggregate);
     }
@@ -164,7 +160,7 @@ protected function updateDirtyRelated()
         $attributes = $this->getAttributes();
 
         foreach ($relations as $relation) {
-            if (! array_key_exists($relation, $attributes)) {
+            if (!array_key_exists($relation, $attributes)) {
                 continue;
             }
 
@@ -181,7 +177,7 @@ protected function updateDirtyRelated()
             if ($value instanceof CollectionProxy && $value->isLoaded()) {
                 $value = $value->getUnderlyingCollection();
             }
-            if ($value instanceof CollectionProxy && ! $value->isLoaded()) {
+            if ($value instanceof CollectionProxy && !$value->isLoaded()) {
                 foreach ($value->getAddedItems() as $entity) {
                     $this->updateEntityIfDirty($entity);
                 }
@@ -190,7 +186,7 @@ protected function updateDirtyRelated()
 
             if ($value instanceof EntityCollection) {
                 foreach ($value as $entity) {
-                    if (! $this->createEntityIfNotExists($entity)) {
+                    if (!$this->createEntityIfNotExists($entity)) {
                         $this->updateEntityIfDirty($entity);
                     }
                 }
@@ -231,6 +227,8 @@ protected function insert()
     /**
      * Run an update statement on the entity
      *
+     * @throws \InvalidArgumentException
+     *
      * @return void
      */
     protected function update()
@@ -242,7 +240,7 @@ protected function update()
         $query = $query->where($keyName, '=', $this->aggregate->getEntityId());
 
         $dirtyAttributes = $this->aggregate->getDirtyRawAttributes();
-                
+
         if (count($dirtyAttributes) > 0) {
             $query->update($dirtyAttributes);
         }

diff --git a/src/Drivers/CapsuleConnectionProvider.php b/src/Drivers/CapsuleConnectionProvider.php
@@ -1,12 +1,20 @@
-<?php namespace Analogue\ORM\Drivers;
+<?php
+
+namespace Analogue\ORM\Drivers;
 
 use Illuminate\Database\Capsule\Manager as Capsule;
 
 class CapsuleConnectionProvider
 {
-
+    /**
+     * @var Capsule
+     */
     protected $capsule;
 
+    /**
+     * CapsuleConnectionProvider constructor.
+     * @param Capsule $capsule
+     */
     public function __construct(Capsule $capsule)
     {
         $this->capsule = $capsule;

diff --git a/src/Drivers/DBAdapter.php b/src/Drivers/DBAdapter.php
@@ -1,15 +1,15 @@
-<?php namespace Analogue\ORM\Drivers;
+<?php
+
+namespace Analogue\ORM\Drivers;
 
 interface DBAdapter
 {
-
     /**
      * Return's Driver specific Query Implementation
      *
-     * @return \Analogue\ORM\Drivers\QueryAdapter
+     * @return \Analogue\ORM\Drivers\QueryAdapter|\Analogue\ORM\Drivers\IlluminateQueryAdapter
      */
     public function getQuery();
-
 
     /**
      * Return the Date format used on this adapter