Fix some style

BigZ · Jul 15, 2018 · ef71be9 · ef71be9
1 parent e0faaa1
commit ef71be9
Show file tree

Hide file tree

Showing 17 changed files with 82 additions and 61 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 vendor/
 bin/
 composer.lock
+.php_cs.cache
diff --git a/src/Halapi/Annotation/Embeddable.php b/src/Halapi/Annotation/Embeddable.php
@@ -6,6 +6,7 @@
  * Tell the serializer if a property embeddable in a representation.
  *
  * @Annotation
+ *
  * @Target({"PROPERTY", "CLASS"})
  */
 class Embeddable
@@ -74,5 +75,4 @@ public function setCollectionRouteName($collectionRouteName)
     {
         $this->collectionRouteName = $collectionRouteName;
     }
-
 }
diff --git a/src/Halapi/AnnotationReader/AnnotationReaderInterface.php b/src/Halapi/AnnotationReader/AnnotationReaderInterface.php
@@ -3,7 +3,8 @@
 namespace Halapi\AnnotationReader;
 
 /**
- * Reads annotations
+ * Reads annotations.
+ *
  * @author Romain Richard
  */
 interface AnnotationReaderInterface
@@ -38,7 +39,7 @@ public function getResourceCollectionRouteName(\ReflectionClass $resource);
     /**
      * Does an entity's property have the @embeddable annotation ?
      *
-     * @param $property
+     * @param $property \ReflectionProperty property
      *
      * @return bool
      */

diff --git a/src/Halapi/AnnotationReader/DoctrineAnnotationReader.php b/src/Halapi/AnnotationReader/DoctrineAnnotationReader.php
@@ -6,7 +6,8 @@
 use Doctrine\Common\Annotations\Reader;
 
 /**
- * Reads annotations
+ * Reads annotations.
+ *
  * @author Romain Richard
  */
 class DoctrineAnnotationReader implements AnnotationReaderInterface
@@ -16,20 +17,26 @@ class DoctrineAnnotationReader implements AnnotationReaderInterface
      */
     protected $annotationReader;
 
+    /**
+     * DoctrineAnnotationReader constructor.
+     * @param Reader $annotationReader
+     */
     public function __construct(Reader $annotationReader)
     {
         $this->annotationReader = $annotationReader;
     }
 
     /**
      * @param \ReflectionProperty $property
+     *
      * @return mixed
+     *
      * @throws \ReflectionException
      */
-    private function getAssociationRouteName(\ReflectionProperty $property)
+    public function getAssociationRouteName(\ReflectionProperty $property)
     {
         /**
-         * @var $annotation Embeddable
+         * @var Embeddable
          */
         $annotation = $this->annotationReader->getPropertyAnnotation($property, Embeddable::class);
 
@@ -49,10 +56,10 @@ private function getAssociationRouteName(\ReflectionProperty $property)
      *
      * @return string
      */
-    private function getResourceRouteName(\ReflectionClass $resource)
+    public function getResourceRouteName(\ReflectionClass $resource)
     {
         /**
-         * @var $annotation Embeddable
+         * @var Embeddable
          */
         $annotation = $this->annotationReader->getClassAnnotation($resource, Embeddable::class);
 
@@ -73,7 +80,7 @@ private function getResourceRouteName(\ReflectionClass $resource)
     public function getResourceCollectionRouteName(\ReflectionClass $resource)
     {
         /**
-         * @var $annotation Embeddable
+         * @var Embeddable
          */
         $annotation = $this->annotationReader->getClassAnnotation($resource, Embeddable::class);
 

diff --git a/src/Halapi/Factory/PaginationFactory.php b/src/Halapi/Factory/PaginationFactory.php
@@ -44,10 +44,11 @@ class PaginationFactory
 
     /**
      * PaginationFactory constructor.
-     * @param UrlGeneratorInterface $urlGenerator
-     * @param ObjectManagerInterface $objectManager
-     * @param ServerRequestInterface $request
-     * @param PagerInterface $pager
+     *
+     * @param UrlGeneratorInterface     $urlGenerator
+     * @param ObjectManagerInterface    $objectManager
+     * @param ServerRequestInterface    $request
+     * @param PagerInterface            $pager
      * @param AnnotationReaderInterface $annotationReader
      */
     public function __construct(
@@ -66,7 +67,8 @@ public function __construct(
 
     /**
      * Get a paginated representation of a collection of entities.
-     * Your repository for the object $className must implement the 'findAllSorted' method
+     * Your repository for the object $className must implement the 'findAllSorted' method.
+     *
      * @param string $className
      *
      * @return PaginatedRepresentation
@@ -133,14 +135,14 @@ private function addPaginationParams()
     }
 
     /**
-     * Return the url of a resource based on the 'get_entity' route name convention.
+     * @param $name string
+     * @param $limit int
+     * @param $page int
+     * @param $sorting string
      *
-     * @param string $name
-     * @param $limit
-     * @param $page
-     * @param $sorting
+     * @return string|null
      *
-     * @return string
+     * @throws \ReflectionException
      */
     private function getPaginatedRoute($name, $limit, $page, $sorting)
     {

diff --git a/src/Halapi/ObjectManager/DoctrineOrmObjectManager.php b/src/Halapi/ObjectManager/DoctrineOrmObjectManager.php
@@ -5,7 +5,8 @@
 use Doctrine\Common\Persistence\ObjectManager;
 
 /**
- * Interface ObjectManagerInterface
+ * Interface ObjectManagerInterface.
+ *
  * @author Romain Richard
  */
 class DoctrineOrmObjectManager implements ObjectManagerInterface
@@ -17,6 +18,7 @@ class DoctrineOrmObjectManager implements ObjectManagerInterface
 
     /**
      * DoctrineOrmObjectManager constructor.
+     *
      * @param ObjectManager $objectManager
      */
     public function __construct(ObjectManager $objectManager)
@@ -26,6 +28,7 @@ public function __construct(ObjectManager $objectManager)
 
     /**
      * @param object $resource
+     *
      * @return mixed
      */
     public function getIdentifierName($resource)
@@ -37,6 +40,7 @@ public function getIdentifierName($resource)
 
     /**
      * @param object $resource
+     *
      * @return mixed
      */
     public function getIdentifier($resource)
@@ -57,6 +61,7 @@ public function getIdentifier($resource)
 
     /**
      * @param string $className
+     *
      * @return \Doctrine\Common\Persistence\Mapping\ClassMetadata
      */
     public function getClassMetadata($className)
@@ -85,7 +90,7 @@ public function findAllSorted($className, array $sorting, array $filterValues, a
 
             foreach ($fields as $field) {
                 if (isset($sorting[$field])) {
-                    $direction = ($sorting[$field] === 'asc') ? 'asc' : 'desc';
+                    $direction = ('asc' === $sorting[$field]) ? 'asc' : 'desc';
                     $queryBuilder->addOrderBy('e.'.$field, $direction);
                 }
 

diff --git a/src/Halapi/ObjectManager/ObjectManagerInterface.php b/src/Halapi/ObjectManager/ObjectManagerInterface.php
@@ -3,19 +3,22 @@
 namespace Halapi\ObjectManager;
 
 /**
- * Interface ObjectManagerInterface
+ * Interface ObjectManagerInterface.
+ *
  * @author Romain Richard
  */
 interface ObjectManagerInterface
 {
     /**
      * @param object $resource
+     *
      * @return mixed
      */
     public function getIdentifier($resource);
 
     /**
      * @param object $resource
+     *
      * @return mixed
      */
     public function getIdentifierName($resource);
@@ -32,6 +35,7 @@ public function findAllSorted($className, array $sorting, array $filterValues, a
 
     /**
      * @param string $className
+     *
      * @return mixed
      */
     public function getClassMetadata($className);

diff --git a/src/Halapi/Pager/PagerFanta.php b/src/Halapi/Pager/PagerFanta.php
@@ -5,7 +5,8 @@
 use Pagerfanta\Adapter\AdapterInterface;
 
 /**
- * Class PagerFanta
+ * Class PagerFanta.
+ *
  * @author Romain Richard
  */
 class PagerFanta implements PagerInterface
@@ -22,7 +23,9 @@ class PagerFanta implements PagerInterface
 
     /**
      * PagerFanta constructor.
+     *
      * @param string $pagerStrategy
+     *
      * @return PagerFanta
      */
     public function __construct($pagerStrategy)
@@ -31,7 +34,8 @@ public function __construct($pagerStrategy)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @return array
      */
     public function getCurrentPageResults()
@@ -40,15 +44,16 @@ public function getCurrentPageResults()
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
      */
     public function getPageCount()
     {
         $this->pager->getNbPages();
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @param mixed $results
      */
     public function setResults($results)
@@ -58,7 +63,8 @@ public function setResults($results)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @param int $max
      */
     public function setMaxPerPage($max)
@@ -67,7 +73,8 @@ public function setMaxPerPage($max)
     }
 
     /**
-     * @inheritdoc
+     * {@inheritdoc}
+     *
      * @param int $page
      */
     public function setCurrentPage($page)
@@ -80,10 +87,11 @@ public function setCurrentPage($page)
      */
     public function setPagerStrategy($pagerStrategy)
     {
-        if (!class_exists('Pagerfanta\Adapter\\'.$pagerStrategy.'Adapter')) {
+        $pagerAdapter = sprintf('%sAdapter', $pagerStrategy);
+        if (!class_exists(sprintf('Pagerfanta\Adapter\\%s', $pagerAdapter))) {
             throw new \InvalidArgumentException(sprintf(
                 'No adapter named %s found in %s namespace',
-                $pagerStrategy.'Adapter',
+                $pagerAdapter,
                 'Pagerfanta\Adapter'
             ));
         }
@@ -98,7 +106,7 @@ public function setPagerStrategy($pagerStrategy)
      */
     private function getPagerAdapter($results)
     {
-        $adapterClassName = 'Pagerfanta\Adapter\\'.$this->pagerStrategy.'Adapter';
+        $adapterClassName = sprintf('Pagerfanta\Adapter\\%sAdapter', $this->pagerStrategy);
 
         return new $adapterClassName(...$results);
     }

diff --git a/src/Halapi/Pager/PagerInterface.php b/src/Halapi/Pager/PagerInterface.php
@@ -3,7 +3,8 @@
 namespace Halapi\Pager;
 
 /**
- * Class PagerInterface
+ * Class PagerInterface.
+ *
  * @author Romain Richard
  */
 interface PagerInterface
@@ -28,6 +29,7 @@ public function getPageCount();
      * depending on which adapter you use.
      *
      * @param mixed $results
+     *
      * @return mixed
      */
     public function setResults($results);
@@ -36,15 +38,13 @@ public function setResults($results);
      * Set the maximum number of results per page (aka limit).
      *
      * @param int $max
-     * @return void
      */
     public function setMaxPerPage($max);
 
     /**
      * Set the page to display.
      *
      * @param int $page
-     * @return void
      */
     public function setCurrentPage($page);
 }
diff --git a/src/Halapi/Relation/EmbeddedRelation.php b/src/Halapi/Relation/EmbeddedRelation.php
@@ -63,8 +63,7 @@ public function getRelation($resource)
         foreach ($reflectionClass->getProperties() as $property) {
             $propertyName = $property->getName();
 
-            if (
-                $this->annotationReader->isEmbeddable($property)
+            if ($this->annotationReader->isEmbeddable($property)
                 && $this->isEmbeddedRequested($propertyName, $requestedEmbedded)
             ) {
                 $embedded[$property->getName()] = $this->getEmbeddedContent($resource, $property);