local/modules/OpenApi/Model/Api/BaseApiModel.php line 123

  1. <?php
  3. namespace OpenApi\Model\Api;
  5. use Doctrine\Common\Annotations\AnnotationRegistry;
  6. use OpenApi\Events\ModelExtendDataEvent;
  7. use OpenApi\Events\ModelValidationEvent;
  8. use OpenApi\Exception\OpenApiException;
  9. use OpenApi\Normalizer\ModelApiNormalizer;
  10. use OpenApi\OpenApi;
  11. use Propel\Runtime\ActiveRecord\ActiveRecordInterface;
  12. use Propel\Runtime\Collection\Collection;
  13. use Symfony\Component\HttpFoundation\RequestStack;
  14. use Symfony\Component\Serializer\Serializer;
  15. use Symfony\Component\Validator\Validation;
  16. use Symfony\Component\Validator\Validator\ValidatorInterface;
  17. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  18. use Thelia\Core\HttpFoundation\Request;
  19. use Thelia\Core\Translation\Translator;
  20. use Thelia\Model\Country;
  21. use Thelia\Model\State;
  22. use Thelia\TaxEngine\TaxEngine;
  24. abstract class BaseApiModel implements \JsonSerializable
  25. {
  26.     /** @var ValidatorInterface */
  27.     protected $validator;
  29.     /** @var ModelFactory */
  30.     protected $modelFactory;
  32.     /** @var Request */
  33.     protected $request;
  35.     /** @var Country */
  36.     protected $country;
  38.     /** @var State|null */
  39.     protected $state;
  41.     /** @var EventDispatcherInterface */
  42.     protected $dispatcher;
  44.     protected $extendedData;
  46.     public function __construct(
  47.         ModelFactory $modelFactory,
  48.         RequestStack $requestStack,
  49.         TaxEngine $taxEngine,
  50.         EventDispatcherInterface $dispatcher,
  51.         ValidatorInterface $validator
  52.     ) {
  53.         $this->dispatcher = $dispatcher;
  54.         $this->validator = $validator;
  56.         $this->modelFactory = $modelFactory;
  57.         $this->request = $requestStack->getCurrentRequest();
  58.         $this->country = $taxEngine->getDeliveryCountry();
  59.         $this->state = $taxEngine->getDeliveryState();
  61.         if (method_exists($this, 'initI18n')) {
  62.             $this->initI18n($modelFactory);
  63.         }
  64.     }
  66.     public function getCurrentLocale()
  67.     {
  68.         return $this->request?->getSession()?->getLang(true)->getLocale();
  69.     }
  71.     /**
  72.      * @param $groups
  73.      *
  74.      * @return BaseApiModel
  75.      *
  76.      * @throws OpenApiException
  77.      */
  78.     public function validate($groups, $recursively = true)
  79.     {
  80.         $violations = $this->getViolations($groups, $recursively);
  82.         if (empty($violations)) {
  83.             return $this;
  84.         }
  86.         /** @var Error $error */
  87.         $error = $this->modelFactory->buildModel(
  88.             'Error',
  89.             ['title' => Translator::getInstance()->trans('Invalid data', [], OpenApi::DOMAIN_NAME)]
  90.         );
  92.         $error->setSchemaViolations($violations);
  94.         throw new OpenApiException($error);
  95.     }
  97.     public function getViolations($groups, $recursively = true, $propertyPatchPrefix = '')
  98.     {
  99.         $modelFactory = $this->modelFactory;
  100.         $violations = array_reduce(
  101.             iterator_to_array($this->validator->validate($this, null, $groups)),
  102.             function ($carry, $violation) use ($modelFactory, $propertyPatchPrefix) {
  103.                 $carry[$propertyPatchPrefix.$violation->getPropertyPath()] = $modelFactory->buildModel('SchemaViolation', ['message' => $violation->getMessage()]);
  104.                 return $carry;
  105.             },
  106.             []
  107.         );
  109.         if ($recursively === true) {
  110.             foreach (get_object_vars($this) as $key => $value) {
  111.                 if ($value instanceof self) {
  112.                     $violations = array_merge($violations, $value->getViolations('read', true, $propertyPatchPrefix.$key.'.'));
  113.                 }
  114.             }
  115.         }
  117.         $event = new ModelValidationEvent($this, $modelFactory, $groups, $propertyPatchPrefix);
  118.         $this->dispatcher->dispatch($event, ModelValidationEvent::MODEL_VALIDATION_EVENT_PREFIX.$this->snakeCaseName());
  120.         return array_merge($violations, $event->getViolations());
  121.     }
  123.     public function jsonSerialize()
  124.     {
  125.         $normalizer = new ModelApiNormalizer();
  126.         $serializer = new Serializer([$normalizer]);
  128.         return $serializer->normalize($this, null);
  129.     }
  131.     public function createOrUpdateFromData($data, $locale = null): void
  132.     {
  133.         if (null === $locale) {
  134.             $locale = $this->getCurrentLocale();
  135.         }
  137.         if (\is_object($data)) {
  138.             $this->createFromTheliaModel($data, $locale);
  139.         }
  141.         if (\is_string($data)) {
  142.             $data = json_decode($data, true);
  143.         }
  145.         if (\is_array($data) || $data instanceof \Traversable) {
  146.             foreach ($data as $key => $value) {
  147.                 $setMethodName = 'set'.ucfirst($key);
  148.                 $getMethodName = 'get'.ucfirst($key);
  149.                 if (method_exists($this, $setMethodName)) {
  150.                     if (\is_array($value)) {
  151.                         if (method_exists($this, $getMethodName) && $this->$getMethodName() instanceof self) {
  152.                             $this->$setMethodName($this->$getMethodName()->updateFromData($value));
  153.                             continue;
  154.                         }
  155.                         $openApiModel = $this->modelFactory->buildModel(ucfirst($key), $value);
  156.                         $value = null !== $openApiModel ? $openApiModel : $value;
  157.                     }
  158.                     $this->$setMethodName($value);
  159.                 }
  160.             }
  161.         }
  163.         $modelExtendEvent = (new ModelExtendDataEvent())
  164.             ->setData($data)
  165.             ->setLocale($locale)
  166.             ->setModel($this);
  168.         $this->dispatcher->dispatch(
  169.             $modelExtendEvent,
  170.             ModelExtendDataEvent::ADD_EXTEND_DATA_PREFIX.$this->snakeCaseName()
  171.         );
  173.         $this->setExtendData($modelExtendEvent->getExtendData());
  174.     }
  176.     /**
  177.      * Override to return the propel model associated with the OpenApi model instead of null.
  178.      *
  179.      * @return mixed
  180.      */
  181.     protected function getTheliaModel($propelModelName = null)
  182.     {
  183.         if (null === $propelModelName) {
  184.             $propelModelName = "Thelia\Model\\".basename(str_replace('\\', '/', static::class));
  185.         }
  187.         if (!class_exists($propelModelName)) {
  188.             return null;
  189.         }
  191.         if (method_exists($this, 'getId') && null !== $id = $this->getId()) {
  192.             $theliaModelQueryName = $propelModelName.'Query';
  194.             return $theliaModelQueryName::create()->filterById($id)->findOne();
  195.         }
  197.         /** @var ActiveRecordInterface $newTheliaModel */
  198.         $newTheliaModel = new $propelModelName();
  199.         $newTheliaModel->setNew(true);
  201.         return $newTheliaModel;
  202.     }
  204.     public function toTheliaModel($locale = null)
  205.     {
  206.         if (null === $theliaModel = $this->getTheliaModel()) {
  207.             throw new \Exception(Translator::getInstance()->trans('Propel model not found automatically for class %className%. Please override the getTheliaModel method to use the toTheliaModel method.', ['%className%' => basename(static::class)], OpenApi::DOMAIN_NAME));
  208.         }
  210.         // If model need locale, set it
  211.         if (method_exists($theliaModel, 'setLocale')) {
  212.             $theliaModel->setLocale($locale !== null ? $locale : $this->getCurrentLocale());
  213.         }
  215.         // Look all method of Open API model
  216.         foreach (get_class_methods($this) as $methodName) {
  217.             $getter = $methodName;
  218.             $setter = null;
  220.             // If it's not a getter skip it
  221.             if (0 === strncasecmp('get', $methodName, 3)) {
  222.                 // Build thelia setter name
  223.                 $setter = 'set'.substr($getter, 3);
  224.             }
  226.             // For boolean method like "isVisible"
  227.             if ($setter === null && 0 === strncasecmp('is', $methodName, 2)) {
  228.                 // Build thelia setter name
  229.                 $setter = 'set'.substr($getter, 2);
  230.             }
  232.             // Check if setter exist in Thelia model
  233.             if (null === $setter || !method_exists($theliaModel, $setter)) {
  234.                 continue;
  235.             }
  237.             $value = $this->$getter();
  239.             // If Values are the same skip this property
  240.             if (method_exists($theliaModel, $getter) && $theliaModel->$getter() === $value) {
  241.                 continue;
  242.             }
  244.             // if the property is another Api model
  245.             if ($value instanceof self) {
  246.                 // If it doesn't have a correspondant thelia model skip it
  247.                 if (null === $value->getTheliaModel()) {
  248.                     continue;
  249.                 }
  251.                 // Else try to set the model id
  252.                 $setModelIdMethod = $setter.'Id';
  253.                 if (!method_exists($theliaModel, $setModelIdMethod)) {
  254.                     continue;
  255.                 }
  256.                 $setter = $setModelIdMethod;
  257.                 $value = $value->getId();
  258.             }
  260.             // Todo transform array to collection
  261.             if (is_array($value)) {
  262.                 continue;
  263.             }
  265.             $theliaModel->$setter($value);
  266.         }
  268.         return $theliaModel;
  269.     }
  271.     public function createFromTheliaModel($theliaModel, $locale = null)
  272.     {
  273.         if (method_exists($theliaModel, 'setLocale')) {
  274.             $theliaModel->setLocale($locale !== null ? $locale : $this->getCurrentLocale());
  275.         }
  277.         foreach (get_class_methods($this) as $modelMethod) {
  278.             if (0 === strncasecmp('set', $modelMethod, 3)) {
  279.                 $property = ucfirst(substr($modelMethod, 3));
  280.                 $lowercaseProperty = ucfirst(strtolower($property));
  282.                 // List all possible getters for this property in propel
  283.                 $propelPossibleMethods = [                                                                                                       //  EXAMPLE :
  284.                     'get'.$property,                                                                                                           //  getProductSaleElements
  285.                     'get'.$property.'s',                                                                                                       //  getProductSaleElementss
  286.                     'get'.$lowercaseProperty,                                                                                                  //  getProductsaleelements
  287.                     'get'.$lowercaseProperty.'s',                                                                                              //  getProductsaleelementss
  288.                     'get'.$property.'Model',                                                                                                 //  getProductSaleElementsModel
  289.                     'get'.$lowercaseProperty.'Model',                                                                                        //  getProductsaleelementsModel
  290.                     'get'.substr(\get_class($theliaModel), strrpos(\get_class($theliaModel), '\\') + 1).$property,                //  getCartProductSaleElements
  291.                     'get'.substr(\get_class($theliaModel), strrpos(\get_class($theliaModel), '\\') + 1).$lowercaseProperty,        //  getCartProductsaleelements
  292.                 ];
  294.                 $availableMethods = array_filter(array_intersect($propelPossibleMethods, get_class_methods($theliaModel)));
  296.                 if (empty($availableMethods)) {
  297.                     continue;
  298.                 }
  300.                 $theliaValue = null;
  301.                 while (!empty($availableMethods) && ($theliaValue === null || empty($theliaValue))) {
  302.                     $theliaMethod = array_pop($availableMethods);
  304.                     $theliaValue = $theliaModel->$theliaMethod();
  306.                     if ($theliaValue instanceof Collection) {
  307.                         $theliaValue = array_filter(array_map(fn ($value) => $this->modelFactory->buildModel($property, $value), iterator_to_array($theliaValue)));
  308.                         continue;
  309.                     }
  311.                     if (\is_object($theliaValue) && $this->modelFactory->modelExists($property)) {
  312.                         $theliaValue = $this->modelFactory->buildModel($property, $theliaValue);
  313.                     }
  314.                 }
  316.                 $this->$modelMethod($theliaValue);
  317.             }
  318.         }
  320.         if (method_exists($this, 'sortImagesByPosition')) {
  321.             $this->sortImagesByPosition();
  322.         }
  324.         return $this;
  325.     }
  327.     public function setExtendData($extendedData)
  328.     {
  329.         $this->extendedData = $extendedData;
  331.         return $this;
  332.     }
  334.     public function extendedDataValue()
  335.     {
  336.         return $this->extendedData;
  337.     }
  339.     protected function snakeCaseName()
  340.     {
  341.         $name = basename(str_replace('\\', '/', static::class));
  343.         preg_match_all('!([A-Z][A-Z0-9]*(?=$|[A-Z][a-z0-9])|[A-Za-z][a-z0-9]+)!', $name, $matches);
  344.         $ret = $matches[0];
  345.         foreach ($ret as &$match) {
  346.             $match = $match == strtoupper($match) ? strtolower($match) : lcfirst($match);
  347.         }
  349.         return implode('_', $ret);
  350.     }
  351. }