Jelle-S / TheSportsDb

src/Entity/Entity.php

Doc Comments +4 added lines

@@ -90,6 +90,10 @@
     return $reversedEntities;
   }
 
+  /**
+   * @param string $entityType
+   * @param string $idName
+   */
   public static function transform($value, $context, EntityManagerInterface $entityManager, $entityType, $idName, array $contextPropertyMap = array()) {
     $data = static::transformHelper($value, $context, $idName, $contextPropertyMap);
     $entity = $entityManager->repository($entityType)->byId($data['id']);

src/Entity/EntityManager.php

Doc Comments +2 added lines, -1 removed lines

@@ -220,7 +220,8 @@
   /**
    * Gets the property map.
    *
-   * @return FastNorth\PropertyMapper\Map
+   * @param string $entityType
+   * @return \FastNorth\PropertyMapper\MapInterface
    *   The property map.
    */
   protected function getPropertyMap($entityType) {

src/Entity/Factory/Factory.php

Doc Comments +5 added lines, -8 removed lines

@@ -32,16 +32,10 @@ 
   /**
    * Creates a \TheSportsDb\Facotory\Factory object.
    *
-   * @param TheSportsDb\Http\TheSportsDbClientInterface $sportsDbClient
+   * @param TheSportsDbClientInterface $sportsDbClient
    *   The sports db client to make the requests.
-   * @param string $realClass
-   *   The fully qualified classname of the entity to create.
-   * @param string $proxyClass
-   *   The fully qualified classname of the proxy entity to create.
-   * @param TheSportsDb\Entity\EntityManagerInterface $entityManager
+   * @param EntityManagerInterface $entityManager
    *   The factory container.
-   * @param MapperInterface $propertyMapper
-   *   The property mapper.
    */
   public function __construct(TheSportsDbClientInterface $sportsDbClient, EntityManagerInterface $entityManager = NULL) {
     $this->sportsDbClient = $sportsDbClient;
@@ -76,6 +70,9 @@ 
     return $entity;
   }
 
+  /**
+   * @param string $entityType
+   */
   public function isFullObject(\stdClass $object, $entityType) {
     $reflection = new \ReflectionClass($this->entityManager->getClass($entityType));
     $defaultProperties = $reflection->getDefaultProperties();

src/Entity/Proxy/Proxy.php

Doc Comments -4 removed lines

@@ -44,10 +44,6 @@
    *
    * @param \stdClass $values
    *   The sport data.
-   * @param \TheSportsDb\Http\TheSportsDbClientInterface $sportsDbClient
-   *   A sports db client
-   * @param \TheSportsDb\Entity\Factory\FactoryInterface $factory
-   *   The sport factory.
    */
   public function __construct(\stdClass $values) {
     $this->properties = new \stdClass();

src/TheSportsDb.php

Doc Comments +1 added lines, -1 removed lines

@@ -51,7 +51,7 @@
   /**
    * Get a league by id.
    *
-   * @param int $league_id
+   * @param int $leagueId
    *   The league id.
    *
    * @return \TheSportsDb\Entity\LeagueInterface

src/Entity/EntityInterface.php

Doc Comments +10 added lines

@@ -12,12 +12,22 @@
  * @author Jelle Sebreghts
  */
 interface EntityInterface {
+
+  /**
+   * @return void
+   */
   public function __construct(\stdClass $values);
 
+  /**
+   * @return void
+   */
   public function update(\stdClass $values);
 
   public function raw();
 
+  /**
+   * @return string
+   */
   public static function getEntityType();
 
   public static function getPropertyMapDefinition();

src/Entity/Factory/FactoryContainerInterface.php

Doc Comments +4 added lines

@@ -18,6 +18,7 @@ 
    *
    * @param \TheSportsDb\Entity\Factory\FactoryInterface $factory
    *   The factory to add.
+   * @return void
    */
   public function addFactory(FactoryInterface $factory, $entityType);
 
@@ -35,5 +36,8 @@ 
    */
   public function getFactory($class);
 
+  /**
+   * @return void
+   */
   public function setDefaultFactory(FactoryInterface $factory);
 }

src/Entity/Proxy/ProxyInterface.php

Doc Comments +4 added lines

@@ -16,5 +16,9 @@
  * @author Jelle Sebreghts
  */
 interface ProxyInterface extends EntityInterface, EntityManagerConsumerInterface {
+
+  /**
+   * @return void
+   */
   public function setSportsDbClient(TheSportsDbClientInterface $sportsDbClient);
 }

src/Entity/Repository/RepositoryContainerInterface.php

Doc Comments +2 added lines, -1 removed lines

@@ -16,8 +16,9 @@
   /**
    * Add a repository for a class.
    *
-   * @param \TheSportsDb\Repository\RepositoryInterface $repository
+   * @param RepositoryInterface $repository
    *   The repository to add.
+   * @return void
    */
   public function addRepository(RepositoryInterface $repository);