modules/CSI/AccountNotes/src/Model/AccountNotes.php line 27

Open in your IDE?
  1. <?php
  2. /* vim: set ts=4 sw=4 sts=4 et: */
  4. /**
  5.  * Account Notes Module
  6.  *
  7.  * @category  X-Cart_5_5_Module
  8.  * @package   AccountNotes
  9.  * @author    CFL Systems, Inc. <support@cflsystems.com>
  10.  * @copyright 2022 CFL Systems, Inc. All rights reserved.
  11.  * @license   License Agreement - https://www.cflsystems.com/software-license-agreement.html
  12.  * @link      https://www.cflsystems.com/account-notes-for-x-cart-5.html
  13.  */
  15. namespace CSI\AccountNotes\Model;
  17. use XLite\Model\Profile;
  18. use Doctrine\ORM\Mapping as ORM;
  20. /**
  21.  * The "account notes" model class
  22.  *
  23.  * @ORM\Entity
  24.  *
  25.  * @ORM\Table (name="csi_account_notes")
  26.  */
  27. class AccountNotes extends \XLite\Model\AEntity
  28. {
  29.     /**
  30.      * Account Note unique ID
  31.      *
  32.      * @var integer
  33.      *
  34.      * @ORM\Id
  35.      * @ORM\GeneratedValue (strategy="AUTO")
  36.      * @ORM\Column         (type="integer")
  37.      */
  38.     protected $id;
  40.     /**
  41.      * The profile id account note applies to
  42.      *
  43.      * @var Profile
  44.      *
  45.      * @ORM\ManyToOne  (targetEntity="XLite\Model\Profile", inversedBy="accountNotes")
  46.      * @ORM\JoinColumn (name="profile_id", referencedColumnName="profile_id")
  47.      */
  48.     protected $profile;
  50.     /**
  51.      * Account Note creator profile id
  52.      *
  53.      * @var integer
  54.      *
  55.      * @ORM\Column (type="integer")
  56.      */
  57.     protected $ownerId;
  59.     /**
  60.      * Account Note title
  61.      *
  62.      * @var string
  63.      *
  64.      * @ORM\Column (type="string", length=255)
  65.      */
  66.     protected $noteTitle = '';
  68.     /**
  69.      * Account Note text
  70.      *
  71.      * @var string
  72.      *
  73.      * @ORM\Column (type="text")
  74.      */
  75.     protected $noteText = '';
  77.     /**
  78.      * Timestamp of Account Note creation date
  79.      *
  80.      * @var integer
  81.      *
  82.      * @ORM\Column (type="integer")
  83.      */
  84.     protected $dateAdded = 0;
  86.     /**
  87.      * Account Note flag
  88.      *
  89.      * @var string
  90.      *
  91.      * @ORM\Column (type="string", length=6)
  92.      */
  93.     protected $noteFlag = 'none';
  95.     /**
  96.      * Allow account to see note
  97.      *
  98.      * @var boolean
  99.      *
  100.      * @ORM\Column (type="boolean")
  101.      */
  102.     protected $customerEnabled = false;
  104.     /**
  105.      * Allow other admins to modify note
  106.      *
  107.      * @var boolean
  108.      *
  109.      * @ORM\Column (type="boolean")
  110.      */
  111.     protected $adminEnabled = true;
  113.     /**
  114.      * Get id
  115.      *
  116.      * @return integer
  117.      */
  118.     public function getId()
  119.     {
  120.         return $this->id;
  121.     }
  123.     /**
  124.      * Set ownerId
  125.      *
  126.      * @param integer $ownerId Note owner Id
  127.      *
  128.      * @return self
  129.      */
  130.     public function setOwnerId(int $ownerId)
  131.     {
  132.         $this->ownerId = $ownerId;
  134.         return $this;
  135.     }
  137.     /**
  138.      * Get ownerId
  139.      *
  140.      * @return integer
  141.      */
  142.     public function getOwnerId()
  143.     {
  144.         return $this->ownerId;
  145.     }
  147.     /**
  148.      * Set noteTitle
  149.      *
  150.      * @param string $noteTitle Note title
  151.      *
  152.      * @return self
  153.      */
  154.     public function setNoteTitle(string $noteTitle)
  155.     {
  156.         $this->noteTitle = $noteTitle;
  158.         return $this;
  159.     }
  161.     /**
  162.      * Get noteTitle
  163.      *
  164.      * @return string
  165.      */
  166.     public function getNoteTitle()
  167.     {
  168.         return $this->noteTitle;
  169.     }
  171.     /**
  172.      * Set noteText
  173.      *
  174.      * @param text $noteText Note content
  175.      *
  176.      * @return self
  177.      */
  178.     public function setNoteText(string $noteText)
  179.     {
  180.         $this->noteText = $noteText;
  182.         return $this;
  183.     }
  185.     /**
  186.      * Get noteText
  187.      *
  188.      * @return text
  189.      */
  190.     public function getNoteText()
  191.     {
  192.         return $this->noteText;
  193.     }
  195.     /**
  196.      * Set dateAdded
  197.      *
  198.      * @param integer $dateAdded date note is added
  199.      *
  200.      * @return self
  201.      */
  202.     public function setDateAdded(int $dateAdded)
  203.     {
  204.         $this->dateAdded = $dateAdded;
  206.         return $this;
  207.     }
  209.     /**
  210.      * Get dateAdded
  211.      *
  212.      * @return integer
  213.      */
  214.     public function getDateAdded()
  215.     {
  216.         return $this->dateAdded;
  217.     }
  219.     /**
  220.      * Set noteFlag
  221.      *
  222.      * @param string $noteFlag Note flag
  223.      *
  224.      * @return self
  225.      */
  226.     public function setNoteFlag(string $noteFlag)
  227.     {
  228.         $this->noteFlag = $noteFlag;
  230.         return $this;
  231.     }
  233.     /**
  234.      * Get noteFlag
  235.      *
  236.      * @return string
  237.      */
  238.     public function getNoteFlag()
  239.     {
  240.         return $this->noteFlag;
  241.     }
  243.     /**
  244.      * Set customerEnabled
  245.      *
  246.      * @param boolean $customerEnabled Can customer see the note
  247.      *
  248.      * @return self
  249.      */
  250.     public function setCustomerEnabled(bool $customerEnabled)
  251.     {
  252.         $this->customerEnabled = $customerEnabled;
  254.         return $this;
  255.     }
  257.     /**
  258.      * Get customerEnabled
  259.      *
  260.      * @return boolean
  261.      */
  262.     public function getCustomerEnabled()
  263.     {
  264.         return $this->customerEnabled;
  265.     }
  267.     /**
  268.      * Set adminEnabled
  269.      *
  270.      * @param boolean $adminEnabled Can non-owner admin modify the note
  271.      *
  272.      * @return self
  273.      */
  274.     public function setAdminEnabled(bool $adminEnabled)
  275.     {
  276.         $this->adminEnabled = $adminEnabled;
  278.         return $this;
  279.     }
  281.     /**
  282.      * Get adminEnabled
  283.      *
  284.      * @return boolean
  285.      */
  286.     public function getAdminEnabled()
  287.     {
  288.         return $this->adminEnabled;
  289.     }
  291.     /**
  292.      * Set profile
  293.      *
  294.      * @param Profile $profile Customer profile the note applies to
  295.      *
  296.      * @return self
  297.      */
  298.     public function setProfile(Profile $profile = null)
  299.     {
  300.         $this->profile = $profile;
  302.         return $this;
  303.     }
  305.     /**
  306.      * Get profile
  307.      *
  308.      * @return Profile
  309.      */
  310.     public function getProfile()
  311.     {
  312.         return $this->profile;
  313.     }
  314. }