custom/plugins/CogiAffiliateAmbassador/src/CogiAffiliateAmbassador.php line 22

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Cogi\Affiliate\Ambassador;
  5. use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
  6. use Shopware\Core\Content\ImportExport\Exception\FileNotFoundException;
  7. use Shopware\Core\Content\MailTemplate\Aggregate\MailTemplateType\MailTemplateTypeEntity;
  8. use Shopware\Core\Defaults;
  9. use Shopware\Core\Framework\Context;
  10. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  11. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  14. use Shopware\Core\Framework\Plugin;
  15. use Shopware\Core\Framework\Plugin\Context\InstallContext;
  16. use Shopware\Core\Framework\Plugin\Context\UninstallContext;
  17. use Shopware\Core\Framework\Plugin\Context\UpdateContext;
  18. use Shopware\Core\Framework\Uuid\Uuid;
  19. use Shopware\Core\System\CustomField\CustomFieldTypes;
  20. use Shopware\Core\System\Language\LanguageEntity;
  22. class CogiAffiliateAmbassador extends Plugin
  23. {
  24.     // Mails
  25.     public const AFFILIATE_CONTRACT_PDF_TEMPLATE_TYPE_TECHNICAL_NAME = 'ca_ambassador_affiliate_contract_pdf';
  27.     /**
  28.      * Installs the plugin (Email templates, custom field set)
  29.      * @param InstallContext $installContext
  30.      * @return void
  31.      */
  32.     public function install(InstallContext $installContext): void
  33.     {
  34.         // Install custom field sets
  35.         $this->installCustomFieldSets($installContext->getContext());
  37.         // Install email templates
  38.         $this->installEmailTemplates($installContext->getContext());
  39.     }
  41.     /**
  42.      * postUpdate installs scheduled task, email templates and custom field sets, if not existent
  43.      * @param UpdateContext $updateContext
  44.      * @return void
  45.      */
  46.     public function postUpdate(UpdateContext $updateContext): void
  47.     {
  48.         parent::postUpdate($updateContext);
  50.         // Update custom field sets
  51.         $this->removeCustomFieldSets($updateContext->getContext());
  52.         $this->installCustomFieldSets($updateContext->getContext());
  54.         // Update email templates
  55.         $this->installEmailTemplates($updateContext->getContext());
  56.     }
  58.     /**
  59.      * Uninstalls the extension
  60.      * @param UninstallContext $uninstallContext
  61.      * @return void
  62.      */
  63.     public function uninstall(UninstallContext $uninstallContext): void
  64.     {
  65.         parent::uninstall($uninstallContext);
  67.         if ($uninstallContext->keepUserData()) {
  68.             return;
  69.         }
  71.         // Uninstall custom field sets
  72.         $this->removeCustomFieldSets($uninstallContext->getContext());
  74.         // Uninstall email templates
  75.         $this->removeEmailTemplate(self::AFFILIATE_CONTRACT_PDF_TEMPLATE_TYPE_TECHNICAL_NAME, $uninstallContext->getContext());
  76.     }
  78.     /**
  79.      * Installs the custom field sets
  80.      * @param Context $context
  81.      * @return void
  82.      */
  83.     public function installCustomFieldSets(Context $context) {
  84.         $customFieldSetRepository = $this->container->get('custom_field_set.repository');
  86.         $productFieldSetId = $this->getFieldSetId($customFieldSetRepository, 'cogi_affiliate_ambassador_product_set', $context);
  87.         if (!$productFieldSetId) {
  88.             $customFieldSetRepository->create([[
  89.                 'name' => 'cogi_affiliate_ambassador_product_set',
  90.                 'customFields' => [
  91.                     [
  92.                         'name' => 'ca_ambassador_provision_rate',
  93.                         'type' => 'number',
  94.                         'config' => [
  95.                             'label' => [
  96.                                 'en-GB' => 'Provision rate for ambassadors',
  97.                                 'de-DE' => 'Provisionsrate für Botschafter'
  98.                             ],
  99.                             'placeholder' => [
  100.                                 'en-GB' => 'In percent (0 - 100)',
  101.                                 'de-DE' => 'In Prozent (0 - 100)'
  102.                             ],
  103.                             'helpText' => [
  104.                                 'en-GB' => 'If an ambassador bought this product, he will receive the specified provision rate.',
  105.                                 'de-DE' => 'Wenn ein Botschafter dieses Produkt gekauft hat, erhält er die angegebene Provisionsrate.'
  106.                             ],
  107.                             'numberType' => CustomFieldTypes::FLOAT,
  108.                             'componentName' => 'sw-field',
  109.                             'customFieldType' => 'number',
  110.                             'max' => 100,
  111.                             'min' => 0,
  112.                             'step' => 0.1,
  113.                             'customFieldPosition' => 1,
  114.                             'translated' => false
  115.                         ]
  116.                     ]
  117.                 ],
  118.                 'relations' => [
  119.                     [
  120.                         'entityName' => 'product'
  121.                     ]
  122.                 ],
  123.                 'config' => [
  124.                     'label' => [
  125.                         'en-GB' => 'Affiliate Marketing Ambassador products',
  126.                         'de-DE' => 'Affiliate-Marketing Botschafter-Produkte'
  127.                     ],
  128.                     'translated' => true
  129.                 ],
  130.             ]], $context);
  131.         }
  133.         $affiliateFieldSetId = $this->getFieldSetId($customFieldSetRepository, 'cogi_affiliate_ambassador_customer_set', $context);
  134.         if (!$affiliateFieldSetId) {
  135.             $customFieldSetRepository->create([[
  136.                 'name' => 'cogi_affiliate_ambassador_customer_set',
  137.                 'customFields' => [
  138.                     [
  139.                         'name' => 'ca_ambassador_superior_affiliate_id',
  140.                         'type' => CustomFieldTypes::ENTITY,
  141.                         'config' => [
  142.                             'entity' => 'customer',
  143.                             'label' => [
  144.                                 'en-GB' => 'Assign superior ambassador',
  145.                                 'de-DE' => 'Übergeordneten Botschafter zuweisen'
  146.                             ],
  147.                             'placeholder' => [
  148.                                 'en-GB' => 'Superior ambassador',
  149.                                 'de-DE' => 'Übergeordneter Botschafter'
  150.                             ],
  151.                             'helpText' => [
  152.                                 'en-GB' => 'The superior ambassador benefits from the provision that this affiliate generates',
  153.                                 'de-DE' => 'Der übergeordnete Botschafter profitiert von der Provision, welche dieser Affiliate generiert'
  154.                             ],
  155.                             'componentName' => 'sw-entity-single-select',
  156.                             'customFieldType' => CustomFieldTypes::ENTITY,
  157.                             'customFieldPosition' => 1,
  158.                             'labelProperty' => ["firstName", "lastName"],
  159.                             'translated' => false
  160.                         ]
  161.                     ],[
  162.                         'name' => 'ca_ambassador_contract_id',
  163.                         'type' => CustomFieldTypes::MEDIA,
  164.                         'config' => [
  165.                             'label' => [
  166.                                 'en-GB' => 'Contract PDF',
  167.                                 'de-DE' => 'Vertrags-PDF'
  168.                             ],
  169.                             'helpText' => [
  170.                                 'en-GB' => 'Automatically generated during application, if activated in the configuration',
  171.                                 'de-DE' => 'Wird bei der Bewerbung automatisch generiert, falls in der Konfiguration aktiviert'
  172.                             ],
  173.                             'componentName' => 'sw-media-field',
  174.                             'customFieldType' => CustomFieldTypes::MEDIA,
  175.                             'customFieldPosition' => 2,
  176.                             'translated' => false
  177.                         ]
  178.                     ]
  179.                 ],
  180.                 'relations' => [
  181.                     [
  182.                         'entityName' => 'customer'
  183.                     ]
  184.                 ],
  185.                 'config' => [
  186.                     'label' => [
  187.                         'en-GB' => 'Affiliate Marketing Ambassador',
  188.                         'de-DE' => 'Affiliate-Marketing Botschafter'
  189.                     ],
  190.                     'translated' => true
  191.                 ],
  192.             ]], $context);
  193.         }
  194.     }
  196.     /**
  197.      * Removes the custom field sets
  198.      * @param Context $context
  199.      * @return void
  200.      */
  201.     public function removeCustomFieldSets(Context $context)
  202.     {
  203.         $customFieldSetRepository = $this->container->get('custom_field_set.repository');
  205.         $this->removeCustomFieldSet($customFieldSetRepository, 'cogi_affiliate_ambassador_product_set', $context);
  206.         $this->removeCustomFieldSet($customFieldSetRepository, 'cogi_affiliate_ambassador_customer_set', $context);
  207.     }
  209.     /**
  210.      * Removes a specific custom field set
  211.      * @param $customFieldSetRepository
  212.      * @param string $setName
  213.      * @param Context $context
  214.      * @return void
  215.      */
  216.     public function removeCustomFieldSet($customFieldSetRepository, string $setName, Context $context)
  217.     {
  218.         $fieldSetId = $this->getFieldSetId($customFieldSetRepository, $setName, $context);
  219.         if ($fieldSetId) {
  220.             $customFieldSetRepository->delete([["id" => $fieldSetId]], $context);
  221.         }
  222.     }
  224.     /**
  225.      * Gets a specific custom field set id
  226.      * @param $customFieldSetRepository
  227.      * @param string $setName
  228.      * @param Context $context
  229.      * @return string|null
  230.      */
  231.     public function getFieldSetId($customFieldSetRepository, string $setName, Context $context): ?string
  232.     {
  233.         $criteria = new Criteria();
  234.         $criteria->addFilter(new EqualsFilter('custom_field_set.name', $setName));
  236.         $customFieldSet = $customFieldSetRepository->search($criteria, $context)->first();
  238.         return (!$customFieldSet ? null : $customFieldSet->getId());
  239.     }
  241.     /**
  242.      * Installs all email templates
  243.      * @param Context $context
  244.      * @return void
  245.      */
  246.     public function installEmailTemplates(Context $context) {
  247.         // To affiliate: Contract PDF
  248.         $this->addEmailTemplate(
  249.             [
  250.                 'en-GB' => 'Affiliate Marketing Ambassador (Affiliate): Contract PDF',
  251.                 'de-DE' => 'Affiliate-Marketing Botschafter (Affiliate): Contract PDF'
  252.             ],
  253.             self::AFFILIATE_CONTRACT_PDF_TEMPLATE_TYPE_TECHNICAL_NAME,
  254.             [
  255.                 'en-GB' => 'Ambassador contract',
  256.                 'de-DE' => 'Botschafter-Vertrag'
  257.             ],
  258.             [
  259.                 'en-GB' => 'This template is sent if contract documents are enabled.',
  260.                 'de-DE' => 'Dieses Template wird gesendet, wenn Vertragsdokumente aktiviert sind.'
  261.             ],
  262.             [
  263.                 'customer' => 'customer'
  264.             ], $context);
  265.     }
  267.     /**
  268.      * Adds a single email template, if it does not already exist
  269.      * @param $templateTypeName
  270.      * @param $templateTypeTechnicalName
  271.      * @param $mailSubject
  272.      * @param $mailDescription
  273.      * @param $availableEntities
  274.      * @param Context $context
  275.      * @return void
  276.      */
  277.     public function addEmailTemplate($templateTypeName, $templateTypeTechnicalName, $mailSubject, $mailDescription, $availableEntities, Context $context)
  278.     {
  279.         /** @var EntityRepositoryInterface $mailTemplateTypeRepository */
  280.         $mailTemplateTypeRepository = $this->container->get('mail_template_type.repository');
  281.         /** @var EntityRepositoryInterface $mailTemplateRepository */
  282.         $mailTemplateRepository = $this->container->get('mail_template.repository');
  284.         $mailTemplateTypeId = Uuid::randomHex();
  285.         $mailTemplateType = [
  286.             [
  287.                 'id' => $mailTemplateTypeId,
  288.                 'name' => $templateTypeName,
  289.                 'technicalName' => $templateTypeTechnicalName,
  290.                 'availableEntities' => $availableEntities
  291.             ]
  292.         ];
  293.         // Add fallback
  294.         $defaultLocaleCode = $this->getDefaultLocaleCode($context);
  295.         if (!in_array($defaultLocaleCode, ['de-DE', 'en-GB'])) {
  296.             $mailTemplateType[0]['name'][$defaultLocaleCode] = $templateTypeName['en-GB'];
  297.         }
  299.         $mailTemplate = [
  300.             [
  301.                 'id' => Uuid::randomHex(),
  302.                 'mailTemplateTypeId' => $mailTemplateTypeId,
  303.                 'senderName' => [
  304.                     'en-GB' => '{{ salesChannel.translated.name }}',
  305.                     'de-DE' => '{{ salesChannel.translated.name }}'
  306.                 ],
  307.                 'subject' => $mailSubject,
  308.                 'description' => $mailDescription,
  309.                 'contentPlain' => [
  310.                     'en-GB' => $this->getMailContent('en-GB', $templateTypeTechnicalName, 'plain'),
  311.                     'de-DE' => $this->getMailContent('de-DE', $templateTypeTechnicalName, 'plain')
  312.                 ],
  313.                 'contentHtml' => [
  314.                     'en-GB' => $this->getMailContent('en-GB', $templateTypeTechnicalName, 'html'),
  315.                     'de-DE' => $this->getMailContent('de-DE', $templateTypeTechnicalName, 'html')
  316.                 ]
  317.             ]
  318.         ];
  320.         // Add fallback
  321.         if (!in_array($defaultLocaleCode, ['de-DE', 'en-GB'])) {
  322.             $mailTemplate[0]['senderName'][$defaultLocaleCode] = '{{ salesChannel.translated.name }}';
  323.             $mailTemplate[0]['subject'][$defaultLocaleCode] = $mailSubject['en-GB'];
  324.             $mailTemplate[0]['description'][$defaultLocaleCode] = $mailDescription['en-GB'];
  325.             $mailTemplate[0]['contentPlain'][$defaultLocaleCode] = $this->getMailContent('en-GB', $templateTypeTechnicalName, 'plain');
  326.             $mailTemplate[0]['contentHtml'][$defaultLocaleCode] = $this->getMailContent('en-GB', $templateTypeTechnicalName, 'html');
  327.         }
  329.         try {
  330.             $mailTemplateTypeRepository->create($mailTemplateType, $context);
  331.             $mailTemplateRepository->create($mailTemplate, $context);
  332.         } catch (UniqueConstraintViolationException $exception) {}
  333.     }
  335.     /**
  336.      * Gets the default locale code
  337.      * @param $context
  338.      * @return string
  339.      */
  340.     private function getDefaultLocaleCode($context): string {
  341.         /** @var EntityRepository $languageRepository */
  342.         $languageRepository = $this->container->get('language.repository');
  344.         $criteria = new Criteria();
  345.         $criteria->addAssociation('locale');
  346.         $criteria->addFilter(new EqualsFilter('id', Defaults::LANGUAGE_SYSTEM));
  348.         /** @var LanguageEntity $languageEntity */
  349.         $languageEntity = $languageRepository->search($criteria, $context)->get(Defaults::LANGUAGE_SYSTEM);
  351.         return $languageEntity->getLocale()->getCode();
  352.     }
  354.     /**
  355.      * Gets the content of a mail while considering the locale
  356.      * @param string $locale
  357.      * @param string $prefix
  358.      * @param string $type
  359.      * @return string
  360.      */
  361.     private function getMailContent(string $locale, string $prefix, string $type): string {
  362.         $path = $this->getPath() . '/Resources/email/' . $locale . '/';
  364.         switch ($type) {
  365.             case 'html':
  366.                 $ext = 'html';
  367.                 break;
  368.             case 'plain':
  369.                 $ext = 'txt';
  370.                 break;
  371.             default:
  372.                 $ext = 'txt';
  373.         }
  375.         $file = $path . $prefix . '.' . $ext;
  377.         if (!is_file($file)) {
  378.             throw new FileNotFoundException($file);
  379.         }
  381.         return file_get_contents($file);
  382.     }
  384.     /**
  385.      * Removes a specific email template by templateTypeTechnicalName
  386.      * @param $templateTypeTechnicalName
  387.      * @param Context $context
  388.      * @return void
  389.      */
  390.     public function removeEmailTemplate($templateTypeTechnicalName, Context $context) {
  391.         /** @var EntityRepositoryInterface $mailTemplateTypeRepository */
  392.         $mailTemplateTypeRepository = $this->container->get('mail_template_type.repository');
  393.         /** @var EntityRepositoryInterface $mailTemplateRepository */
  394.         $mailTemplateRepository = $this->container->get('mail_template.repository');
  396.         /** @var MailTemplateTypeEntity $customMailTemplateType */
  397.         $customMailTemplateType = $mailTemplateTypeRepository->search(
  398.             (new Criteria())
  399.                 ->addFilter(new EqualsFilter('technicalName', $templateTypeTechnicalName)),
  400.             $context
  401.         )->first();
  403.         if ($customMailTemplateType) {
  404.             $mailTemplateIds = $mailTemplateRepository->searchIds(
  405.                 (new Criteria())
  406.                     ->addFilter(new EqualsFilter('mailTemplateTypeId', $customMailTemplateType->getId())),
  407.                 $context
  408.             )->getIds();
  410.             $ids = array_map(static function ($id) {
  411.                 return ['id' => $id];
  412.             }, $mailTemplateIds);
  414.             $mailTemplateRepository->delete($ids, $context);
  416.             // Delete the TemplateType which were added by this Plugin
  417.             $mailTemplateTypeRepository->delete([
  418.                 ['id' => $customMailTemplateType->getId()]
  419.             ], $context);
  420.         }
  421.     }
  422. }