more exceptions docblocks

src/AnalogueServiceProvider.php

@@ -35,7 +35,7 @@ public function boot()
      */
     public function register()
     {
-        $this->app->singleton('analogue', function($app) {
+        $this->app->singleton('analogue', function ($app) {
 
             $db = $app['db'];
 

src/Commands/Command.php

@@ -24,7 +24,7 @@ abstract class Command
     /**
      * Command constructor.
      * @param Aggregate $aggregate
-     * @param QueryAdapter $query
+     * @param QueryAdapter|\Analogue\ORM\Drivers\IlluminateQueryAdapter $query
      */
     public function __construct(Aggregate $aggregate, QueryAdapter $query)
     {

src/Commands/Store.php

@@ -17,6 +17,7 @@ class Store extends Command
     /**
      * Persist the entity in the database
      *
+     * @throws \InvalidArgumentException
      * @return false|mixed
      */
     public function execute()
@@ -69,6 +70,7 @@ public function execute()
      * Run all operations that have to occur before actually
      * storing the entity
      *
+     * @throws \InvalidArgumentException
      * @return void
      */
     protected function preStoreProcess()
@@ -83,6 +85,7 @@ protected function preStoreProcess()
      * Check for existence and create non-existing related entities
      *
      * @param  array
+     * @throws \InvalidArgumentException
      * @return void
      */
     protected function createRelatedEntities($relations)
@@ -112,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()

src/Drivers/DBAdapter.php

@@ -7,7 +7,7 @@ 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();
 

src/EntityCollection.php

@@ -33,6 +33,7 @@ public function __construct(array $entities = null)
      *
      * @param  mixed $key
      * @param  mixed $default
+     * @throws MappingException
      * @return \Analogue\ORM\Entity
      */
     public function find($key, $default = null)
@@ -63,6 +64,7 @@ public function add($entity)
      * Remove an entity from the collection
      *
      * @param $entity
+     * @throws MappingException
      * @return mixed
      */
     public function remove($entity)
@@ -184,6 +186,7 @@ public function getSubsetByHashes(array $hashes)
      * Merge the collection with the given items.
      *
      * @param  array $items
+     * @throws MappingException
      * @return self
      */
     public function merge($items)
@@ -222,6 +225,7 @@ public function diff($items)
      * Intersect the collection with the given items.
      *
      * @param  \ArrayAccess|array $items
+     * @throws MappingException
      * @return self
      */
     public function intersect($items)
@@ -269,6 +273,7 @@ public function except($keys)
      * Get a dictionary keyed by primary keys.
      *
      * @param  \ArrayAccess|array $items
+     * @throws MappingException
      * @return array
      */
     public function getDictionary($items = null)
@@ -285,6 +290,7 @@ public function getDictionary($items = null)
     }
 
     /**
+     * @throws MappingException
      * @return array
      */
     public function getEntityKeys()
@@ -310,6 +316,7 @@ protected function getEntityKey($entity)
      * Get the max value of a given key.
      *
      * @param  string|null $key
+     * @throws MappingException
      * @return mixed
      */
     public function max($key = null)
@@ -326,6 +333,7 @@ public function max($key = null)
      * Get the min value of a given key.
      *
      * @param  string|null $key
+     * @throws MappingException
      * @return mixed
      */
     public function min($key = null)
@@ -366,6 +374,7 @@ public function lists($value, $key = null)
      * Return only unique items from the collection.
      *
      * @param  string|null $key
+     * @throws MappingException
      * @return self
      */
     public function unique($key = null)

src/EntityMap.php

@@ -929,10 +929,7 @@ public function morphToMany($entity, $related, $name, $table = null, $foreignKey
 
         $table = $table ?: str_plural($name);
 
-        return new MorphToMany(
-            $relatedMapper, $entity, $name, $table, $foreignKey,
-            $otherKey, $caller, $inverse
-        );
+        return new MorphToMany($relatedMapper, $entity, $name, $table, $foreignKey, $otherKey, $caller, $inverse);
     }
 
     /**

src/Plugins/AnaloguePlugin.php

@@ -13,6 +13,10 @@ abstract class AnaloguePlugin implements AnaloguePluginInterface
      */
     protected $manager;
 
+    /**
+     * AnaloguePlugin constructor.
+     * @param Manager $manager
+     */
     public function __construct(Manager $manager)
     {
         $this->manager = $manager;

src/Plugins/SoftDeletes/SoftDeletesPlugin.php

@@ -16,6 +16,7 @@ class SoftDeletesPlugin extends AnaloguePlugin
     /**
      * Register the plugin
      *
+     * @throws \Exception
      * @return void
      */
     public function register()
@@ -38,6 +39,7 @@ public function register()
      * with the softDelete capacity.
      *
      * @param  \Analogue\ORM\System\Mapper $mapper
+     * @throws \Analogue\ORM\Exceptions\MappingException
      * @return bool|void
      */
     protected function registerSoftDelete(Mapper $mapper)

src/Plugins/SoftDeletes/SoftDeletingScope.php

@@ -32,7 +32,7 @@ public function apply(Query $query)
     /**
      * Remove the scope from the given Analogue query builder.
      *
-     * @param  \Analogue\ORM\System\Query $query
+     * @param  mixed $query
      * @return void
      */
     public function remove(Query $query)

src/Plugins/Timestamps/TimestampsPlugin.php

@@ -15,6 +15,7 @@ class TimestampsPlugin extends AnaloguePlugin
     /**
      * Register the plugin
      *
+     * @throws \Exception
      * @return void
      */
     public function register()

src/Relationships/BelongsTo.php

@@ -57,7 +57,8 @@ public function __construct(Mapper $mapper, $parent, $foreignKey, $otherKey, $re
     }
 
     /**
-     * @param $related
+     * @param  $related
+     * @return mixed
      */
     public function attachTo($related)
     {

src/Relationships/BelongsToMany.php

@@ -10,10 +10,6 @@
 use Analogue\ORM\System\InternallyMappable;
 use Analogue\ORM\Exceptions\EntityNotFoundException;
 
-/**
- * @method where
- * @method take
- */
 class BelongsToMany extends Relationship
 {
     /**
@@ -79,14 +75,16 @@ public function __construct(Mapper $mapper, $parent, $table, $foreignKey, $other
     }
 
     /**
-     * @param $related
+     * @param  $related
+     * @return mixed
      */
     public function attachTo($related)
     {
     }
 
     /**
-     * @param $related
+     * @param  $related
+     * @return mixed
      */
     public function detachFrom($related)
     {
@@ -574,6 +572,7 @@ public function createPivots($relatedEntities)
      *
      * @param  mixed $id
      * @param  array $attributes
+     * @throws \InvalidArgumentException
      * @return integer
      */
     public function updateExistingPivot($id, array $attributes)
@@ -762,6 +761,7 @@ protected function getModelKeysFromCollection(EntityCollection $entities)
      * Detach models from the relationship.
      *
      * @param  int|array $ids
+     * @throws \InvalidArgumentException
      * @return int
      */
     public function detach($ids = [])
@@ -790,7 +790,7 @@ public function detach($ids = [])
     /**
      * Create a new query builder for the pivot table.
      *
-     * @throws  \InvalidArgumentException
+     * @throws \InvalidArgumentException
      *
      * @return \Illuminate\Database\Query\Builder
      */

src/Relationships/HasManyThrough.php

@@ -45,6 +45,7 @@ class HasManyThrough extends Relationship
      * @param \Analogue\ORM\EntityMap $parentMap
      * @param string                  $firstKey
      * @param string                  $secondKey
+     * @throws \Analogue\ORM\Exceptions\MappingException
      */
     public function __construct(Mapper $mapper, $farParent, $parentMap, $firstKey, $secondKey)
     {
@@ -61,6 +62,7 @@ public function __construct(Mapper $mapper, $farParent, $parentMap, $firstKey, $
 
     /**
      * @param $related
+     * @return mixed
      */
     public function attachTo($related)
     {
@@ -69,6 +71,7 @@ public function attachTo($related)
 
     /**
      * @param $related
+     * @return mixed
      */
     public function detachFrom($related)
     {

src/Relationships/HasOneOrMany.php

@@ -39,6 +39,7 @@ public function __construct(Mapper $mapper, $parentEntity, $foreignKey, $localKe
 
     /**
      * @param \Analogue\ORM\Entity|EntityCollection $entity
+     * @return void
      */
     public function attachTo($entity)
     {
@@ -96,6 +97,7 @@ protected function detachOne($entityHash)
     /**
      * Attach ids that are passed as arguments, and detach any other
      * @param  mixed $entities
+     * @throws \InvalidArgumentException
      * @return void
      */
     public function sync(array $entities)
@@ -104,7 +106,8 @@ public function sync(array $entities)
     }
 
     /**
-     * @param $entities
+     * @param  $entities
+     * @throws \InvalidArgumentException
      */
     protected function detachExcept($entities)
     {

src/Relationships/MorphOneOrMany.php

@@ -24,11 +24,12 @@ abstract class MorphOneOrMany extends HasOneOrMany
     /**
      * Create a new has many relationship instance.
      *
-     * @param Mapper                 $mapper
-     * @param \Analogue\ORM\Mappable $parent
-     * @param string                 $type
-     * @param string                 $id
-     * @param string                 $localKey
+     * @param  Mapper                 $mapper
+     * @param  \Analogue\ORM\Mappable $parent
+     * @param  string                 $type
+     * @param  string                 $id
+     * @param  string                 $localKey
+     * @throws \Analogue\ORM\Exceptions\MappingException
      */
     public function __construct(Mapper $mapper, $parent, $type, $id, $localKey)
     {

src/Relationships/MorphTo.php

@@ -102,6 +102,7 @@ public function match(array $entities, EntityCollection $results, $relation)
     /**
      * Get the results of the relationship.
      *
+     * @throws \Analogue\ORM\Exceptions\MappingException
      * @return EntityCollection
      */
     public function getEager()
@@ -135,6 +136,7 @@ protected function matchToMorphParents($type, EntityCollection $results)
      * Get all of the relation results for a type.
      *
      * @param  string $type
+     * @throws \Analogue\ORM\Exceptions\MappingException
      * @return EntityCollection
      */
     protected function getResultsByType($type)

src/Relationships/Relationship.php

@@ -97,8 +97,9 @@ abstract class Relationship
     /**
      * Create a new relation instance.
      *
-     * @param Mapper   $mapper
-     * @param Mappable $parent
+     * @param  Mapper   $mapper
+     * @param  Mappable $parent
+     * @throws \Analogue\ORM\Exceptions\MappingException
      */
     public function __construct(Mapper $mapper, $parent)
     {

src/Repository.php

@@ -102,6 +102,8 @@ public function paginate($perPage = null)
      * Delete an entity or an entity collection from the database
      *
      * @param  Mappable|EntityCollection $entity
+     * @throws MappingException
+     * @throws \InvalidArgumentException
      * @return \Illuminate\Support\Collection|null
      */
     public function delete($entity)
@@ -113,6 +115,8 @@ public function delete($entity)
      * Persist an entity or an entity collection in the database.
      *
      * @param  Mappable|EntityCollection|array $entity
+     * @throws MappingException
+     * @throws \InvalidArgumentException
      * @return Mappable|EntityCollection|array
      */
     public function store($entity)

src/System/Aggregate.php

@@ -79,6 +79,7 @@ class Aggregate implements InternallyMappable
      * @param Aggregate|null $parent
      * @param string         $parentRelationship
      * @param Aggregate|null $root
+     * @throws MappingException
      */
     public function __construct($entity, Aggregate $parent = null, $parentRelationship = null, Aggregate $root = null)
     {
@@ -102,6 +103,7 @@ public function __construct($entity, Aggregate $parent = null, $parentRelationsh
     /**
      * Parse Every relationships defined on the entity
      *
+     * @throws MappingException
      * @return void
      */
     protected function parseRelationships()
@@ -295,7 +297,8 @@ protected function createSubAggregates($entities, $relation)
      * Create a related subAggregate
      *
      * @param  mixed $entity
-     * @param string $relation
+     * @param  string $relation
+     * @throws MappingException
      * @return self
      */
     protected function createSubAggregate($entity, $relation)
@@ -577,6 +580,7 @@ protected function flattenEmbeddables($attributes)
      * Return's entity raw attributes in the state they were at last
      * query.
      *
+     * @param  array|null $columns
      * @return array
      */
     protected function getCachedRawAttributes(array $columns = null)