modules/XC/MailChimp/src/Model/MailChimpGroupName.php line 18

Open in your IDE?
  1. <?php
  3. /**
  4.  * Copyright (c) 2011-present Qualiteam software Ltd. All rights reserved.
  5.  * See https://www.x-cart.com/license-agreement.html for license details.
  6.  */
  8. namespace XC\MailChimp\Model;
  10. use Doctrine\ORM\Mapping as ORM;
  12. /**
  13.  * MailChimp mail list
  14.  *
  15.  * @ORM\Entity
  16.  * @ORM\Table  (name="mailchimp_list_group_name")
  17.  */
  18. class MailChimpGroupName extends \XLite\Model\AEntity
  19. {
  20.     /**
  21.      * List ID
  22.      *
  23.      * @var string
  24.      *
  25.      * @ORM\Id
  26.      * @ORM\Column (type="string", length=32)
  27.      */
  28.     protected $id = '';
  30.     /**
  31.      * List name
  32.      *
  33.      * @var string
  34.      *
  35.      * @ORM\Column (type="string", length=128)
  36.      */
  37.     protected $name = '';
  39.     /**
  40.      * List name
  41.      *
  42.      * @var integer
  43.      *
  44.      * @ORM\Column (type="integer", options={ "unsigned": true })
  45.      */
  46.     protected $subscriberCount = 0;
  48.     /**
  49.      * MailChimp parent group
  50.      *
  51.      * @var \XC\MailChimp\Model\MailChimpGroup
  52.      *
  53.      * @ORM\ManyToOne (targetEntity="XC\MailChimp\Model\MailChimpGroup", inversedBy="names")
  54.      */
  55.     protected $group;
  57.     /**
  58.      * Profiles
  59.      *
  60.      * @var \Doctrine\Common\Collections\Collection
  61.      *
  62.      * @ORM\ManyToMany (targetEntity="XLite\Model\Profile", inversedBy="mail_chimp_interests")
  63.      * @ORM\JoinTable  (
  64.      *      name="mailchimp_profile_interests",
  65.      *      joinColumns={@ORM\JoinColumn(name="group_name_id", referencedColumnName="id", onDelete="CASCADE")},
  66.      *      inverseJoinColumns={@ORM\JoinColumn(name="profile_id", referencedColumnName="profile_id", onDelete="CASCADE")}
  67.      * )
  68.      */
  69.     protected $profiles;
  71.     /**
  72.      * Subscribed by default
  73.      *
  74.      * @var boolean
  75.      *
  76.      * @ORM\Column (type="boolean")
  77.      */
  78.     protected $subscribeByDefault = false;
  80.     /**
  81.      * Enabled
  82.      *
  83.      * @var boolean
  84.      *
  85.      * @ORM\Column (type="boolean")
  86.      */
  87.     protected $enabled = true;
  89.     /**
  90.      * Constructor
  91.      *
  92.      * @param array $data Entity properties OPTIONAL
  93.      */
  94.     public function __construct(array $data = [])
  95.     {
  96.         $this->profiles     = new \Doctrine\Common\Collections\ArrayCollection();
  98.         parent::__construct($data);
  99.     }
  101.     /**
  102.      * Set id
  103.      *
  104.      * @param string $id
  105.      * @return MailChimpGroupName
  106.      */
  107.     public function setId($id)
  108.     {
  109.         $this->id = $id;
  110.         return $this;
  111.     }
  113.     /**
  114.      * Get id
  115.      *
  116.      * @return string
  117.      */
  118.     public function getId()
  119.     {
  120.         return $this->id;
  121.     }
  123.     /**
  124.      * @return string
  125.      */
  126.     public function getName()
  127.     {
  128.         return $this->name;
  129.     }
  131.     /**
  132.      * @param string $name
  133.      *
  134.      * @return MailChimpGroupName
  135.      */
  136.     public function setName($name)
  137.     {
  138.         $this->name = $name;
  139.         return $this;
  140.     }
  142.     /**
  143.      * @return int
  144.      */
  145.     public function getSubscribersCount()
  146.     {
  147.         return $this->subscriberCount;
  148.     }
  150.     /**
  151.      * @param int $subscriberCount
  152.      *
  153.      * @return MailChimpGroupName
  154.      */
  155.     public function setSubscribersCount($subscriberCount)
  156.     {
  157.         $this->subscriberCount = $subscriberCount;
  158.         return $this;
  159.     }
  161.     /**
  162.      * @return MailChimpGroup
  163.      */
  164.     public function getGroup()
  165.     {
  166.         return $this->group;
  167.     }
  169.     /**
  170.      * @param MailChimpGroup $group
  171.      *
  172.      * @return MailChimpGroupName
  173.      */
  174.     public function setGroup($group)
  175.     {
  176.         $this->group = $group;
  177.         return $this;
  178.     }
  180.     /**
  181.      * @return int
  182.      */
  183.     public function getSubscriberCount()
  184.     {
  185.         return $this->subscriberCount;
  186.     }
  188.     /**
  189.      * @param int $subscriberCount
  190.      */
  191.     public function setSubscriberCount($subscriberCount)
  192.     {
  193.         $this->subscriberCount = $subscriberCount;
  194.     }
  196.     /**
  197.      * @return bool
  198.      */
  199.     public function getSubscribeByDefault()
  200.     {
  201.         return $this->subscribeByDefault;
  202.     }
  204.     /**
  205.      * @param boolean $subscribeByDefault
  206.      */
  207.     public function setSubscribeByDefault($subscribeByDefault)
  208.     {
  209.         $this->subscribeByDefault = $subscribeByDefault;
  210.         return $this;
  211.     }
  213.     /**
  214.      * @return boolean
  215.      */
  216.     public function getEnabled()
  217.     {
  218.         return $this->enabled;
  219.     }
  221.     /**
  222.      * @param boolean $enabled
  223.      */
  224.     public function setEnabled($enabled)
  225.     {
  226.         $this->enabled = (bool)$enabled;
  227.     }
  229.     /**
  230.      * Check if provided profile is subscribes to this list
  231.      *
  232.      * @param \XLite\Model\Profile|null $profile Profile
  233.      *
  234.      * @return boolean
  235.      */
  236.     public function isProfileChecked($profile)
  237.     {
  238.         return isset($profile)
  239.             ? $this->getRepository()->isProfileChecked($this, $profile)
  240.             : $this->getSubscribeByDefault();
  241.     }
  243.     /**
  244.      * Add profiles
  245.      *
  246.      * @param \XLite\Model\Profile $profiles
  247.      * @return MailChimpGroupName
  248.      */
  249.     public function addProfiles(\XLite\Model\Profile $profiles)
  250.     {
  251.         $this->profiles[] = $profiles;
  252.         return $this;
  253.     }
  255.     /**
  256.      * Get profiles
  257.      *
  258.      * @return \Doctrine\Common\Collections\Collection
  259.      */
  260.     public function getProfiles()
  261.     {
  262.         return $this->profiles;
  263.     }
  264. }