src/Products/NotificationsBundle/Util/ListBuilder/AbstractListBuilder.php line 87

Open in your IDE?
  1. <?php
  3. namespace Products\NotificationsBundle\Util\ListBuilder;
  5. use App\Model\Query\ConditionQuery\ConditionConfig;
  6. use Cms\CoreBundle\Util\Doctrine\EntityManager;
  7. use Doctrine\ORM\QueryBuilder;
  8. use Products\NotificationsBundle\Entity\AbstractList;
  9. use Products\NotificationsBundle\Entity\AbstractRecipient;
  10. use Products\NotificationsBundle\Entity\AutomationRecord;
  11. use Products\NotificationsBundle\Entity\NotificationsConfig;
  12. use Products\NotificationsBundle\Entity\Profile;
  13. use Products\NotificationsBundle\Entity\ProfileContact;
  14. use Products\NotificationsBundle\Entity\ProfileRelationship;
  15. use Products\NotificationsBundle\Entity\Recipients\AppRecipient;
  16. use Products\NotificationsBundle\Entity\Recipients\EmailRecipient;
  17. use Products\NotificationsBundle\Entity\Recipients\PhoneRecipient;
  18. use Products\NotificationsBundle\Entity\Student;
  20. /**
  21.  *
  22.  */
  23. abstract class AbstractListBuilder
  24. {
  25.     public const ENTITY_MAPPING = [
  26.         Profile::class => self::ENTITIES__PROFILES,
  27.         AbstractRecipient::class => self::ENTITIES__RECIPIENTS,
  28.         EmailRecipient::class => self::ENTITIES__RECIPIENTS,
  29.         PhoneRecipient::class => self::ENTITIES__RECIPIENTS,
  30.         AppRecipient::class => self::ENTITIES__RECIPIENTS,
  31.         Student::class => self::ENTITIES__STUDENTS,
  32.         ProfileContact::class => self::ENTITIES__PROFILE_CONTACTS,
  33.         ProfileRelationship::class => self::ENTITIES__PROFILE_RELATIONSHIPS,
  34.         AutomationRecord::class => self::ENTITIES__PROFILE_AUTOMATION_RECORDS,
  35.     ];
  36.     public const ENTITIES__PROFILES = 'profiles';
  37.     public const ENTITIES__RECIPIENTS = 'contacts';
  38.     public const ENTITIES__STUDENTS = 'students';
  39.     public const ENTITIES__PROFILE_CONTACTS = 'xrefs';
  40.     public const ENTITIES__PROFILE_RELATIONSHIPS = 'relationships';
  42.     public const ENTITIES__PROFILE_AUTOMATION_RECORDS = 'automations';
  44.     // DI
  45.     protected EntityManager $em;
  47.     /**
  48.      * The specific list for which this ListBuilder is working with.
  49.      *
  50.      * @var AbstractList|null
  51.      */
  52.     private ?AbstractList $list;
  54.     /**
  55.      * @param EntityManager $em
  56.      * @param AbstractList|null $list
  57.      */
  58.     public function __construct(
  59.         EntityManager $em,
  60.         ?AbstractList $list = null
  61.     )
  62.     {
  63.         $this->em = $em;
  64.         $this->list = $list;
  65.     }
  67.     /**
  68.      * @param AbstractList|string $list
  69.      * @return bool
  70.      */
  71.     abstract public static function supports($list): bool;
  73.     /**
  74.      * @return AbstractList
  75.      */
  76.     public function getList(): AbstractList
  77.     {
  78.         if ( ! $this->list) {
  79.             throw new \Exception();
  80.         }
  81.         return $this->list;
  82.     }
  84.     /**
  85.      * @return ConditionConfig
  86.      */
  87.     public function getConfig(): ConditionConfig
  88.     {
  89.         // TODO: need to find a way to cache this or something; maybe use resolvers???
  90.         $config = $this->em->getRepository(NotificationsConfig::class)->findOneBy([
  91.             'tenant' => $this->getList()->getTenant(),
  92.         ]);
  93.         if ( ! $config instanceof NotificationsConfig) {
  94.             return new ConditionConfig();
  95.         }
  96.         return $config->getConfig();
  97.     }
  99.     /**
  100.      * @return QueryBuilder
  101.      */
  102.     abstract public function build(): QueryBuilder;
  104.     /**
  105.      * @param AbstractList|null $list
  106.      * @return array
  107.      */
  108.     abstract public function serialize(?AbstractList $list = null): array;
  110.     /**
  111.      * @param array $serialized
  112.      * @return AbstractList
  113.      */
  114.     abstract public function unserialize(array $serialized): AbstractList;
  116.     /**
  117.      * @return QueryBuilder
  118.      */
  119.     public function subquery(): QueryBuilder
  120.     {
  121.         return ($qb = $this->build())
  122.             // overwrite the select to just pick the ids
  123.             ->select($qb->getRootAliases()[0].'.id')
  124.             // speed this up by removing the ordering
  125.             ->resetDQLPart('orderBy');
  126.     }
  128.     /**
  129.      * @return string
  130.      */
  131.     protected function identify(): string
  132.     {
  133.         if ($this->list->getId()) {
  134.             return strval($this->list->getId());
  135.         }
  136.         return spl_object_hash($this->list);
  137.     }
  139.     /**
  140.      * @param string $alias
  141.      * @return string
  142.      */
  143.     protected function alias(string $alias): string
  144.     {
  145.         return sprintf(
  146.             '%s%s',
  147.             $alias,
  148.             $this->identify(),
  149.         );
  150.     }
  152.     /**
  153.      * @param string $param
  154.      * @return string
  155.      */
  156.     protected function param(string $param): string
  157.     {
  158.         return sprintf(
  159.             '%s_%s',
  160.             $param,
  161.             $this->identify(),
  162.         );
  163.     }
  165.     /**
  166.      * @param string $alias
  167.      * @param string $prop
  168.      * @return string
  169.      */
  170.     protected function prop(string $alias, string $prop): string
  171.     {
  172.         return sprintf(
  173.             '%s.%s',
  174.             $this->alias($alias),
  175.             $prop,
  176.         );
  177.     }
  178. }