tfboe / fm-lib

src/Service/LoadingService.php

<?php
declare(strict_types=1);

namespace Tfboe\FmLib\Service;

use Doctrine\Common\Collections\AbstractLazyCollection;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityManagerInterface;
use Tfboe\FmLib\Entity\CompetitionInterface;
use Tfboe\FmLib\Entity\GameInterface;
use Tfboe\FmLib\Entity\Helpers\IdAble;
use Tfboe\FmLib\Entity\MatchInterface;
use Tfboe\FmLib\Entity\PhaseInterface;
use Tfboe\FmLib\Entity\RankingInterface;
use Tfboe\FmLib\Entity\TeamInterface;
use Tfboe\FmLib\Entity\TeamMembershipInterface;
use Tfboe\FmLib\Entity\TournamentInterface;


/**
 * Class LoadingService
 * @package App\Service
 */
class LoadingService implements LoadingServiceInterface
{
//<editor-fold desc="Fields">
  /**
   * @var string
   */
  protected $defaultPropertiesToLoad;
  /**
   * @var EntityManager
   */
  private $em;
//</editor-fold desc="Fields">

//<editor-fold desc="Constructor">
  /**
   * LoadingService constructor.
   * @param EntityManagerInterface $em
   */
  public function __construct(
    EntityManagerInterface $em
  )
  {
    $this->em = $em;

$em is of type object<Doctrine\ORM\EntityManagerInterface>, but the property $em was declared to be of type object<Doctrine\ORM\EntityManager>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    $this->defaultPropertiesToLoad = [

It seems like array(\Tfboe\FmLib\Entity\TournamentInterface::class => array(array('competitions')), \Tfboe\FmLib\Entity\CompetitionInterface::class => array(array('teams'), array('phases')), \Tfboe\FmLib\Entity\TeamInterface::class => array(array('memberships')), \Tfboe\FmLib\Entity\TeamMembershipInterface::class => array(array('player', 'team')), \Tfboe\FmLib\Entity\PhaseInterface::class => array(array('preQualifications'), array('postQualifications'), array('rankings'), array('matches')), \Tfboe\FmLib\Entity\RankingInterface::class => array(array('teams')), \Tfboe\FmLib\Entity\MatchInterface::class => array(array('rankingsA', 'rankingsB'), array('games')), \Tfboe\FmLib\Entity\GameInterface::class => array(array('playersA', 'playersB'))) of type array<string|integer,array<integer,array<integer,string,{"0":"string"}>,{"0":"array<integer,string,{\"0\":\"string\"}>"}>> is incompatible with the declared type string of property $defaultPropertiesToLoad.

      TournamentInterface::class => [["competitions"]],
      CompetitionInterface::class => [["teams"], ["phases"]],
      TeamInterface::class => [["memberships"]],
      TeamMembershipInterface::class => [["player", "team"]],
      PhaseInterface::class => [["preQualifications"], ["postQualifications"], ["rankings"], ["matches"]],
      RankingInterface::class => [["teams"]],
      MatchInterface::class => [["rankingsA", "rankingsB"], ["games"]],
      GameInterface::class => [["playersA", "playersB"]],
    ];
  }
//</editor-fold desc="Constructor">


//<editor-fold desc="Public Methods">
  /**
   * @inheritDoc
   */
  public function loadEntities(array $entities, ?array $propertyMap = null)
  {
    if ($propertyMap === null) {
      $propertyMap = $this->defaultPropertiesToLoad;
    }
    //build groups for each type
    $toDoEntityIds = [];
    $done = [];
    foreach ($entities as $entity) {
      if (!array_key_exists($entity->getEntityId(), $done)) {
        $done[$entity->getEntityId()] = true;
        $class = $this->keyOfPropertyMap($entity, $propertyMap);

$propertyMap is of type string|array, but the function expects a array<integer,array<integer,array<integer,string>>>.

        if ($class !== null) {
          if (!array_key_exists($class, $toDoEntityIds)) {
            $toDoEntityIds[$class] = [];
          }
          $toDoEntityIds[$class][] = $entity;
          break;
        }
      }
    }
    while (count($toDoEntityIds) > 0) {
      $entities = reset($toDoEntityIds);

      $class = key($toDoEntityIds);
      unset($toDoEntityIds[$class]);
      foreach ($propertyMap[$class] as $properties) {
        //eliminate entities which have already loaded the properties
        $ids = array_map(function (IdAble $e) {
          return $e->getEntityId();
        }, array_filter($entities, function (IdAble $e) use ($properties) {
          foreach ($properties as $property) {
            $getter = "get" . ucfirst($property);
            $object = $e->$getter();
            if ($object === null) {
              return true;
            }
            if ($object instanceof AbstractLazyCollection) {
              /** @var $object AbstractLazyCollection */
              if (!$object->isInitialized()) {
                return true;
              }
            } else if (!property_exists($object, '__isInitialized__')) {
              return true;
            }
          }
          return false;
        }));
        if (count($ids) > 0) {
          $this->loadProperties($ids, $class, $properties);
        }
        //check loaded subproperties if they also have subproperties which need to get loaded
        foreach ($entities as $entity) {
          foreach ($properties as $property) {
            $getter = "get" . ucfirst($property);
            $object = $entity->$getter();
            if ($object !== null) {
              if (!$object instanceof Collection) {
                $object = new ArrayCollection([$object]);
              }
              /** @var $object Collection|IdAble[] */
              foreach ($object as $subObject) {
                if (!array_key_exists($subObject->getEntityId(), $done)) {
                  $done[$subObject->getEntityId()] = true;
                  $subClass = $this->keyOfPropertyMap($subObject, $propertyMap);

$propertyMap is of type string|array, but the function expects a array<integer,array<integer,array<integer,string>>>.

                  if ($subClass !== null) {
                    if (!array_key_exists($subClass, $toDoEntityIds)) {
                      $toDoEntityIds[$subClass] = [];
                    }
                    $toDoEntityIds[$subClass][] = $subObject;
                  }
                }
              }
            }
          }
        }
      }
    }
  }
//</editor-fold desc="Public Methods">

//<editor-fold desc="Private Methods">
  /**
   * Computes the key corresponding to the given entity in the given property map, or null if no key was found.
   * @param mixed $entity the entity to search the key for
   * @param string[][][] $propertyMap a property map which maps classes to lists of groups of properties to fetch
   * @return null|string
   */
  private function keyOfPropertyMap($entity, $propertyMap): ?string
  {
    foreach (array_keys($propertyMap) as $class) {
      if ($entity instanceof $class) {
        return $class;
      }
    }
    return null;
  }

  /**
   * @param string[] $ids a list of ids of entities to get the properties for
   * @param string $class the class of the entities
   * @param string[] $properties a list of properties to get for each entity
   */
  private function loadProperties(array $ids, string $class, array $properties): void
  {
    $builder = $this->em->createQueryBuilder()
      ->select("t1")
      ->from($class, "t1");
    $count = 1;
    foreach ($properties as $property) {
      $count++;
      $table = "t" . (string)$count;
      $builder->addSelect($table);
      $builder->leftJoin("t1." . $property, $table);
    }
    $builder->where($builder->expr()->in("t1.id", $ids));
    $builder->getQuery()->getResult();
  }
//</editor-fold desc="Private Methods">
}