Comment.php 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Sales\Model\Order\Creditmemo;
  7. use Magento\Framework\Api\AttributeValueFactory;
  8. use Magento\Sales\Api\Data\CreditmemoCommentInterface;
  9. use Magento\Sales\Model\AbstractModel;
  10. /**
  11. * @api
  12. * @since 100.0.2
  13. */
  14. class Comment extends AbstractModel implements CreditmemoCommentInterface
  15. {
  16. /**
  17. * Creditmemo instance
  18. *
  19. * @var \Magento\Sales\Model\Order\Creditmemo
  20. */
  21. protected $_creditmemo;
  22. /**
  23. * @var \Magento\Store\Model\StoreManagerInterface
  24. */
  25. protected $_storeManager;
  26. /**
  27. * @param \Magento\Framework\Model\Context $context
  28. * @param \Magento\Framework\Registry $registry
  29. * @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory
  30. * @param AttributeValueFactory $customAttributeFactory
  31. * @param \Magento\Store\Model\StoreManagerInterface $storeManager
  32. * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
  33. * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
  34. * @param array $data
  35. * @SuppressWarnings(PHPMD.ExcessiveParameterList)
  36. */
  37. public function __construct(
  38. \Magento\Framework\Model\Context $context,
  39. \Magento\Framework\Registry $registry,
  40. \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
  41. AttributeValueFactory $customAttributeFactory,
  42. \Magento\Store\Model\StoreManagerInterface $storeManager,
  43. \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
  44. \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
  45. array $data = []
  46. ) {
  47. parent::__construct(
  48. $context,
  49. $registry,
  50. $extensionFactory,
  51. $customAttributeFactory,
  52. $resource,
  53. $resourceCollection,
  54. $data
  55. );
  56. $this->_storeManager = $storeManager;
  57. }
  58. /**
  59. * Initialize resource model
  60. *
  61. * @return void
  62. */
  63. protected function _construct()
  64. {
  65. $this->_init(\Magento\Sales\Model\ResourceModel\Order\Creditmemo\Comment::class);
  66. }
  67. /**
  68. * Declare Creditmemo instance
  69. *
  70. * @codeCoverageIgnore
  71. *
  72. * @param \Magento\Sales\Model\Order\Creditmemo $creditmemo
  73. * @return $this
  74. */
  75. public function setCreditmemo(\Magento\Sales\Model\Order\Creditmemo $creditmemo)
  76. {
  77. $this->_creditmemo = $creditmemo;
  78. return $this;
  79. }
  80. /**
  81. * Retrieve Creditmemo instance
  82. *
  83. * @codeCoverageIgnore
  84. *
  85. * @return \Magento\Sales\Model\Order\Creditmemo
  86. */
  87. public function getCreditmemo()
  88. {
  89. return $this->_creditmemo;
  90. }
  91. /**
  92. * Get store object
  93. *
  94. * @return \Magento\Store\Model\Store
  95. */
  96. public function getStore()
  97. {
  98. if ($this->getCreditmemo()) {
  99. return $this->getCreditmemo()->getStore();
  100. }
  101. return $this->_storeManager->getStore();
  102. }
  103. //@codeCoverageIgnoreStart
  104. /**
  105. * Returns comment
  106. *
  107. * @return string
  108. */
  109. public function getComment()
  110. {
  111. return $this->getData(CreditmemoCommentInterface::COMMENT);
  112. }
  113. /**
  114. * Returns created_at
  115. *
  116. * @return string
  117. */
  118. public function getCreatedAt()
  119. {
  120. return $this->getData(CreditmemoCommentInterface::CREATED_AT);
  121. }
  122. /**
  123. * {@inheritdoc}
  124. */
  125. public function setCreatedAt($createdAt)
  126. {
  127. return $this->setData(CreditmemoCommentInterface::CREATED_AT, $createdAt);
  128. }
  129. /**
  130. * Returns is_customer_notified
  131. *
  132. * @return int
  133. */
  134. public function getIsCustomerNotified()
  135. {
  136. return $this->getData(CreditmemoCommentInterface::IS_CUSTOMER_NOTIFIED);
  137. }
  138. /**
  139. * Returns is_visible_on_front
  140. *
  141. * @return int
  142. */
  143. public function getIsVisibleOnFront()
  144. {
  145. return $this->getData(CreditmemoCommentInterface::IS_VISIBLE_ON_FRONT);
  146. }
  147. /**
  148. * Returns parent_id
  149. *
  150. * @return int
  151. */
  152. public function getParentId()
  153. {
  154. return $this->getData(CreditmemoCommentInterface::PARENT_ID);
  155. }
  156. /**
  157. * {@inheritdoc}
  158. */
  159. public function setParentId($id)
  160. {
  161. return $this->setData(CreditmemoCommentInterface::PARENT_ID, $id);
  162. }
  163. /**
  164. * {@inheritdoc}
  165. */
  166. public function setIsCustomerNotified($isCustomerNotified)
  167. {
  168. return $this->setData(CreditmemoCommentInterface::IS_CUSTOMER_NOTIFIED, $isCustomerNotified);
  169. }
  170. /**
  171. * {@inheritdoc}
  172. */
  173. public function setIsVisibleOnFront($isVisibleOnFront)
  174. {
  175. return $this->setData(CreditmemoCommentInterface::IS_VISIBLE_ON_FRONT, $isVisibleOnFront);
  176. }
  177. /**
  178. * {@inheritdoc}
  179. */
  180. public function setComment($comment)
  181. {
  182. return $this->setData(CreditmemoCommentInterface::COMMENT, $comment);
  183. }
  184. /**
  185. * {@inheritdoc}
  186. *
  187. * @return \Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface|null
  188. */
  189. public function getExtensionAttributes()
  190. {
  191. return $this->_getExtensionAttributes();
  192. }
  193. /**
  194. * {@inheritdoc}
  195. *
  196. * @param \Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface $extensionAttributes
  197. * @return $this
  198. */
  199. public function setExtensionAttributes(
  200. \Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface $extensionAttributes
  201. ) {
  202. return $this->_setExtensionAttributes($extensionAttributes);
  203. }
  204. //@codeCoverageIgnoreEnd
  205. }