src/FMT/Data/Entity/CampaignBook.php line 25

Open in your IDE?
  1. <?php
  3. namespace FMT\Data\Entity;
  5. use Doctrine\ORM\Mapping as ORM;
  6. use FMT\Data\Traits\EnumTrait;
  7. use Gedmo\Timestampable\Traits\TimestampableEntity;
  8. use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
  10. /**
  11.  * CampaignBook
  12.  *
  13.  * @ORM\Table(
  14.  *     name="campaign_book",
  15.  *     indexes={
  16.  *          @ORM\Index(name="IX_book_status", columns={"status"}),
  17.  *          @ORM\Index(name="IX_book_campaign", columns={"campaign_id"})
  18.  *     }
  19.  * )
  20.  * @ORM\Entity
  21.  * @SuppressWarnings(PHPMD.ExcessivePublicCount)
  22.  * @ORM\HasLifecycleCallbacks()
  23.  * @UniqueEntity(fields={"productFamilyId", "sku", "campaignId"})
  24.  */
  25. class CampaignBook implements EntityInterface, CampaignProductInterface
  26. {
  27.     use TimestampableEntity;
  28.     use EnumTrait;
  30.     // TODO: Combine with ProductInterface constants
  31.     const STATUS_AVAILABLE = 0;
  32.     const STATUS_OUT_OF_STOCK = 1;
  33.     const STATUS_ORDERED = 2;
  34.     const STATUS_UNAVAILABLE = 3;
  35.     const STATUS_RETURNED = 4;
  36.     // TODO: added new status? Check messages.en.yml!
  38.     const STATE_UNKNOWN = 0;
  39.     const STATE_NEW = 1;
  40.     const STATE_USED = 2;
  41.     // TODO: added new state? Check messages.en.yml!
  43.     /**
  44.      * @var integer
  45.      *
  46.      * @ORM\Column(name="id", type="integer")
  47.      * @ORM\Id
  48.      * @ORM\GeneratedValue(strategy="IDENTITY")
  49.      */
  50.     private $id;
  52.     /**
  53.      * @var \FMT\Data\Entity\Campaign
  54.      *
  55.      * @ORM\ManyToOne(targetEntity="FMT\Data\Entity\Campaign", inversedBy="books")
  56.      * @ORM\JoinColumns({
  57.      *   @ORM\JoinColumn(name="campaign_id", referencedColumnName="id")
  58.      * })
  59.      */
  60.     private $campaign;
  62.     /**
  63.      * @var string
  64.      *
  65.      * @ORM\Column(name="product_family_id", type="string", length=255, nullable=false)
  66.      */
  67.     private $productFamilyId;
  69.     /**
  70.      * @var string
  71.      *
  72.      * @ORM\Column(name="sku", type="string", length=255, nullable=false)
  73.      */
  74.     private $sku;
  76.     /**
  77.      * @var string
  78.      *
  79.      * @ORM\Column(name="title", type="string", length=255, nullable=false)
  80.      */
  81.     private $title;
  83.     /**
  84.      * @var string
  85.      *
  86.      * @ORM\Column(name="author", type="string", length=255, nullable=true)
  87.      */
  88.     private $author;
  90.     /**
  91.      * @var string
  92.      *
  93.      * @ORM\Column(name="class", type="string", length=255, nullable=true)
  94.      */
  95.     private $class;
  97.     /**
  98.      * @var string
  99.      *
  100.      * @ORM\Column(name="isbn", type="string", length=15, nullable=true)
  101.      */
  102.     private $isbn;
  104.     /**
  105.      * @var integer
  106.      *
  107.      * @ORM\Column(name="price", type="integer", nullable=false)
  108.      */
  109.     private $price;
  111.      /**
  112.      * @var integer
  113.      *
  114.      * @ORM\Column(name="fee", type="integer", nullable=false)
  115.      */
  116.     private $fee;
  118.     /**
  119.      * @var integer
  120.      *
  121.      * @ORM\Column(name="quantity", type="integer", nullable=false)
  122.      */
  123.     private $quantity = 1;
  125.     /**
  126.      * @var integer
  127.      *
  128.      * @ORM\Column(name="status", type="smallint", nullable=false)
  129.      */
  130.     private $status = self::STATUS_AVAILABLE;
  132.     /**
  133.      * @var integer
  134.      *
  135.      * @ORM\Column(name="state", type="smallint", nullable=false)
  136.      */
  137.     private $state = self::STATE_UNKNOWN;
  139.     /**
  140.      * @var int
  141.      *
  142.      * @ORM\Column(name="tax", type="integer", nullable=false)
  143.      */
  144.     private $tax;
  146.     /**
  147.      * @var int
  148.      *
  149.      * @ORM\Column(name="net", type="integer", nullable=false)
  150.      */
  151.     private $net;
  153.     /**
  154.      * @return int
  155.      */
  156.     public function getId()
  157.     {
  158.         return $this->id;
  159.     }
  161.     /**
  162.      * @return Campaign
  163.      */
  164.     public function getCampaign(): Campaign
  165.     {
  166.         return $this->campaign;
  167.     }
  169.     /**
  170.      * @param Campaign $campaign
  171.      * @return $this
  172.      */
  173.     public function setCampaign($campaign)
  174.     {
  175.         $this->campaign = $campaign;
  176.         return $this;
  177.     }
  179.     /**
  180.      * @return string
  181.      */
  182.     public function getProductFamilyId()
  183.     {
  184.         return $this->productFamilyId;
  185.     }
  187.     /**
  188.      * @param string $productFamilyId
  189.      * @return $this
  190.      */
  191.     public function setProductFamilyId($productFamilyId)
  192.     {
  193.         $this->productFamilyId = $productFamilyId;
  194.         return $this;
  195.     }
  197.     /**
  198.      * @return string
  199.      */
  200.     public function getSku()
  201.     {
  202.         return $this->sku;
  203.     }
  205.     /**
  206.      * @param string $sku
  207.      * @return $this
  208.      */
  209.     public function setSku($sku)
  210.     {
  211.         $this->sku = $sku;
  212.         return $this;
  213.     }
  215.     /**
  216.      * @return string
  217.      */
  218.     public function getTitle()
  219.     {
  220.         return $this->title;
  221.     }
  223.     /**
  224.      * @param string $title
  225.      * @return $this
  226.      */
  227.     public function setTitle($title)
  228.     {
  229.         $this->title = $title;
  230.         return $this;
  231.     }
  233.     /**
  234.      * @return string
  235.      */
  236.     public function getAuthor()
  237.     {
  238.         return $this->author;
  239.     }
  241.     /**
  242.      * @param string $author
  243.      * @return $this
  244.      */
  245.     public function setAuthor($author)
  246.     {
  247.         $this->author = $author;
  248.         return $this;
  249.     }
  251.     /**
  252.      * @return string
  253.      */
  254.     public function getClass()
  255.     {
  256.         return $this->class;
  257.     }
  259.     /**
  260.      * @param string $class
  261.      * @return $this
  262.      */
  263.     public function setClass($class)
  264.     {
  265.         $this->class = $class;
  266.         return $this;
  267.     }
  269.     /**
  270.      * @return string
  271.      */
  272.     public function getIsbn()
  273.     {
  274.         return $this->isbn;
  275.     }
  277.     /**
  278.      * @param string $isbn
  279.      * @return $this
  280.      */
  281.     public function setIsbn($isbn)
  282.     {
  283.         $this->isbn = $isbn;
  284.         return $this;
  285.     }
  287.     /**
  288.      * @return int
  289.      */
  290.     public function getPrice()
  291.     {
  292.         return $this->price;
  293.     }
  295.      /**
  296.      * @return int
  297.      */
  298.     public function getTotalPrice()
  299.     {
  300.         return $this->price + $this->fee + $this->tax;
  301.     }
  303.     /**
  304.      * @param int $price
  305.      * @return $this
  306.      */
  307.     public function setPrice($price)
  308.     {
  309.         $this->price = $price;
  310.         return $this;
  311.     }
  313.     /**
  314.      * @return int
  315.      */
  316.     public function getFee()
  317.     {
  318.         return $this->fee;
  319.     }
  321.     /**
  322.      * @param int $fee
  323.      * @return $this
  324.      */
  325.     public function setFee($fee)
  326.     {
  327.         $this->fee = $fee;
  328.         return $this;
  329.     }
  331.     /**
  332.      * @return int
  333.      */
  334.     public function getNet()
  335.     {
  336.         return $this->net;
  337.     }
  339.     /**
  340.      * @param $net
  341.      * @return $this
  342.      */
  343.     public function setNet($net)
  344.     {
  345.         $this->net = $net;
  346.         return $this;
  347.     }
  349.     /**
  350.      * @return int
  351.      */
  352.     public function getTax()
  353.     {
  354.         // Equitable Access = No Tax
  355.         if($this->sku == "2079144"){
  356.             $this->setTax(0);
  357.         }
  358.         return $this->tax;
  359.     }
  361.     /**
  362.      * @param $tax
  363.      * @return $this
  364.      */
  365.     public function setTax($tax)
  366.     {
  367.         $this->tax = $tax;
  368.         return $this;
  369.     }
  371.     /**
  372.      * @return int
  373.      */
  374.     public function getQuantity()
  375.     {
  376.         return $this->quantity;
  377.     }
  379.     /**
  380.      * @param int $quantity
  381.      * @return $this
  382.      */
  383.     public function setQuantity($quantity)
  384.     {
  385.         $this->quantity = $quantity;
  386.         return $this;
  387.     }
  389.     /**
  390.      * @return int
  391.      */
  392.     public function getStatus()
  393.     {
  394.         return $this->status;
  395.     }
  397.     /**
  398.      * @param int $status
  399.      * @return $this
  400.      */
  401.     public function setStatus($status)
  402.     {
  403.         $this->status = $status;
  404.         return $this;
  405.     }
  407.     /**
  408.      * @return string
  409.      */
  410.     public function getStatusName()
  411.     {
  412.         return array_search($this->status, self::getAllowedStatuses());
  413.     }
  415.     /**
  416.      * @return int
  417.      */
  418.     public function getState()
  419.     {
  420.         return $this->state;
  421.     }
  423.     /**
  424.      * @param int $state
  425.      * @return $this
  426.      */
  427.     public function setState($state)
  428.     {
  429.         $this->state = $state;
  430.         return $this;
  431.     }
  433.     /**
  434.      * @return string
  435.      */
  436.     public function getStateName()
  437.     {
  438.         if (!is_numeric($this->state)) {
  439.             return sprintf('STATE_%s', strtoupper($this->state));
  440.         }
  442.         return array_search($this->state, self::getConstants('STATE_'));
  443.     }
  445.     /**
  446.      * @return bool
  447.      */
  448.     public function isAvailable()
  449.     {
  450.         return $this->status == CampaignBook::STATUS_AVAILABLE;
  451.     }
  453.     /**
  454.      * @return bool
  455.      */
  456.     public function isOrdered()
  457.     {
  458.         return $this->status == CampaignBook::STATUS_ORDERED;
  459.     }
  460. }