locomotivemtl / charcoal-core

src/Charcoal/Source/StorableTrait.php

Doc Comments +7 added lines, -7 removed lines

@@ -41,7 +41,7 @@ 
      *
      * @param mixed $id The object id (identifier / primary key value).
      * @throws InvalidArgumentException If the argument is not scalar.
-     * @return StorableInterface Chainable
+     * @return StorableTrait Chainable
      */
     public function setId($id)
     {
@@ -85,7 +85,7 @@ 
      *
      * @param string $key The object key, or identifier "name".
      * @throws InvalidArgumentException If the argument is not scalar.
-     * @return StorableInterface Chainable
+     * @return StorableTrait Chainable
      */
     public function setKey($key)
     {
@@ -121,7 +121,7 @@ 
 
     /**
      * @param FactoryInterface $factory The source factory, which is useful to create source.
-     * @return StorableInterface Chainable
+     * @return StorableTrait Chainable
      */
     protected function setSourceFactory(FactoryInterface $factory)
     {
@@ -147,7 +147,7 @@ 
      * Set the object's source.
      *
      * @param SourceInterface $source The storable object's source.
-     * @return StorableInterface Chainable
+     * @return StorableTrait Chainable
      * @todo This method needs to go protected.
      */
     public function setSource(SourceInterface $source)
@@ -180,7 +180,7 @@ 
      * Load an object from the database from its ID.
      *
      * @param mixed $id The identifier to load.
-     * @return StorableInterface Chainable
+     * @return StorableTrait Chainable
      */
     public function load($id = null)
     {
@@ -196,7 +196,7 @@ 
      *
      * @param string $key   Key pointing a column's name.
      * @param mixed  $value Value of said column.
-     * @return StorableInterface Chainable.
+     * @return StorableTrait Chainable.
      */
     public function loadFrom($key = null, $value = null)
     {
@@ -209,7 +209,7 @@ 
      *
      * @param string $query The SQL query.
      * @param array  $binds Optional. The SQL query parameters.
-     * @return StorableInterface Chainable.
+     * @return StorableTrait Chainable.
      */
     public function loadFromQuery($query, array $binds = [])
     {

src/Charcoal/Source/DatabaseSource.php

Spacing +1 added lines, -1 removed lines

@@ -281,7 +281,7 @@
             $properties = array_keys($model->metadata()->properties());
         } else {
             // Ensure the key is always in the required fields.
-            $properties = array_merge($properties, [ $model->key() ]);
+            $properties = array_merge($properties, [$model->key()]);
         }
 
         $fields = [];

src/Charcoal/Validator/ValidatableInterface.php

Spacing +1 added lines, -1 removed lines

@@ -27,5 +27,5 @@
      * @param ValidatorInterface $v Optional. A custom validator object to use for validation. If null, use object's.
      * @return boolean
      */
-    public function validate(ValidatorInterface &$v = null);
+    public function validate(ValidatorInterface&$v = null);
 }

src/Charcoal/Validator/ValidatableTrait.php

Spacing +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
      * @param ValidatorInterface $v Optional. A custom validator object to use for validation. If null, use object's.
      * @return boolean
      */
-    public function validate(ValidatorInterface &$v = null)
+    public function validate(ValidatorInterface&$v = null)
     {
         if ($v !== null) {
             $this->setValidator($v);

src/Charcoal/Loader/CollectionLoader.php

Doc Comments +5 added lines, -5 removed lines

@@ -153,7 +153,7 @@ 
      * Retrieve the source to load objects from.
      *
      * @throws RuntimeException If no source has been defined.
-     * @return mixed
+     * @return SourceInterface
      */
     public function source()
     {
@@ -200,7 +200,7 @@ 
      * Retrieve the object model.
      *
      * @throws RuntimeException If no model has been defined.
-     * @return Model
+     * @return ModelInterface
      */
     public function model()
     {
@@ -361,7 +361,7 @@ 
      * Alias of {@see SourceInterface::setFilters()}
      *
      * @param  array $filters An array of filters.
-     * @return Collection Chainable
+     * @return CollectionLoader Chainable
      */
     public function setFilters(array $filters)
     {
@@ -426,7 +426,7 @@ 
     /**
      * Alias of {@see SourceInterface::pagination()}
      *
-     * @return Pagination
+     * @return \Charcoal\Source\PaginationInterface
      */
     public function pagination()
     {
@@ -712,7 +712,7 @@ 
      *
      * @param  string $className The class name of the collection.
      * @throws InvalidArgumentException If the class name is not a string.
-     * @return AbstractPropertyDisplay Chainable
+     * @return CollectionLoader Chainable
      */
     public function setCollectionClass($className)
     {

Spacing +3 added lines, -3 removed lines

@@ -631,7 +631,7 @@ 
      */
     protected function processCollection($results, callable $before = null, callable $after = null)
     {
-        $collection   = $this->createCollection();
+        $collection = $this->createCollection();
         foreach ($results as $objData) {
             $obj = $this->processModel($objData, $before, $after);
 
@@ -662,13 +662,13 @@ 
         $obj = $this->factory()->create($objType);
 
         if ($before !== null) {
-            call_user_func_array($before, [ &$obj ]);
+            call_user_func_array($before, [&$obj]);
         }
 
         $obj->setFlatData($objData);
 
         if ($after !== null) {
-            call_user_func_array($after, [ &$obj ]);
+            call_user_func_array($after, [&$obj]);
         }
 
         return $obj;

src/Charcoal/Model/Service/ModelBuilder.php

Doc Comments +4 added lines, -4 removed lines

@@ -86,7 +86,7 @@ 
 
     /**
      * @param FactoryInterface $factory The factory to use to create models.
-     * @return ModelLoaderBuilder Chainable
+     * @return ModelBuilder Chainable
      */
     private function setFactory(FactoryInterface $factory)
     {
@@ -96,7 +96,7 @@ 
 
     /**
      * @param MetadataLoader $loader The loader instance, used to load metadata.
-     * @return DescribableInterface Chainable
+     * @return ModelBuilder Chainable
      */
     private function setMetadataLoader(MetadataLoader $loader)
     {
@@ -106,7 +106,7 @@ 
 
     /**
      * @param FactoryInterface $factory The factory to use to create models.
-     * @return ModelLoaderBuilder Chainable
+     * @return ModelBuilder Chainable
      */
     private function setSourceFactory(FactoryInterface $factory)
     {
@@ -119,7 +119,7 @@ 
      *     (A class name or object identifier).
      * @param string|null $metadataIdent Optional. The metadata identifier to load.
      *     If NULL, it will be implied from objType.
-     * @return MetadataInterface
+     * @return \Charcoal\Model\MetadataInterface
      */
     private function createMetadata($objType, $metadataIdent = null)
     {