vendor/nellapp/sdk-bundle/src/Entity/AbstractCustomView.php line 13

Open in your IDE?
  1. <?php
  3. namespace Nellapp\Bundle\SDKBundle\Entity;
  5. use Doctrine\ORM\Mapping as ORM;
  6. use Doctrine\ORM\Mapping\MappedSuperclass;
  7. use Nellapp\Bundle\SDKBundle\CustomizableView\AbstractCustomizableViewManager;
  8. use Nellapp\Bundle\SDKBundle\CustomizableView\Model\AbstractColumnDefinition;
  9. use Nellapp\Bundle\SDKBundle\CustomizableView\Model\Column;
  10. use Symfony\Component\Validator\Constraints as Assert;
  12. #[MappedSuperclass]
  13. abstract class AbstractCustomView
  14. {
  15. const DEFAULT_VIEW_NAME = '__DEFAULT__';
  17. #[ORM\Column(type: 'string', nullable: false)]
  18. #[Assert\NotBlank()]
  19. private ?string $name = null;
  21. /** @var Column[] $columns */
  22. #[ORM\Column(type: "json", nullable: true)]
  23. private array $columns = [];
  25. /** @var ?array $filters */
  26. #[ORM\Column(type: 'json', nullable: true)]
  27. private ?array $filters = null;
  29. #[ORM\Column(type: 'boolean', nullable: false)]
  30. private ?bool $active = false;
  32. #[ORM\Column(type: 'string', nullable: true)]
  33. private ?string $sortKey = null;
  35. #[ORM\Column(type: 'string', nullable: true)]
  36. #[Assert\Choice(choices: ['asc', 'desc'])]
  37. private ?string $sortDirection = null;
  39. /**
  40. * @param bool $active
  41. * @param AbstractColumnDefinition[] $columnsDef
  42. */
  43. public function __construct(
  44. array $columnsDef,
  45. bool $active = true,
  46. )
  47. {
  48. $count = 0;
  49. foreach ($columnsDef as $def) {
  50. $this->columns[$def->getKey()] = new Column($def, $count, $active);
  51. $count++;
  52. }
  54. $this->orderColumns();
  55. }
  57. abstract function getId();
  59. /**
  60. * @return Column[]
  61. */
  62. public function getActiveColumns(): array
  63. {
  64. if ($this->hasColumnDeserialized()) {
  65. $activeColumns = [];
  66. foreach ($this->getColumns() as $column) {
  67. if ($column->isActive()) {
  68. $activeColumns[$column->getColumnDefinition()->getKey()] = $column;
  69. }
  70. }
  72. return $activeColumns;
  73. }
  74. throw new \LogicException(
  75. 'You must deserialize Columns before accessing it. Use ' .
  76. AbstractCustomizableViewManager::class .
  77. ' for deserialization.'
  78. );
  79. }
  81. /**
  82. * @return AbstractColumnDefinition[]
  83. */
  84. public function getActiveColumnsDefs(): array
  85. {
  86. if ($this->hasColumnDeserialized()) {
  87. $activeColumnsDefs = [];
  88. foreach ($this->getColumns() as $column) {
  89. if ($column->isActive()) {
  90. $activeColumnsDefs[] = $column->getColumnDefinition();
  91. }
  92. }
  94. return $activeColumnsDefs;
  95. }
  96. throw new \LogicException(
  97. 'You must deserialize Columns before accessing it. Use ' .
  98. AbstractCustomizableViewManager::class .
  99. ' for deserialization.'
  100. );
  101. }
  103. public function getColumnDefByKey(string $key): ?AbstractColumnDefinition
  104. {
  105. if ($this->hasColumnDeserialized()) {
  106. foreach ($this->columns as $column) {
  107. if ($column->getColumnDefinition()->getKey() === $key) {
  108. return $column->getColumnDefinition();
  109. }
  110. }
  112. return null;
  113. }
  114. throw new \LogicException(
  115. 'You must deserialize Columns before accessing it. Use ' .
  116. AbstractCustomizableViewManager::class .
  117. ' for deserialization.'
  118. );
  119. }
  121. private function orderColumns(): void
  122. {
  123. if ($this->hasColumnDeserialized()) {
  124. uasort($this->columns, function (Column $columnA, Column $columnB): int {
  125. if ($columnA->getOrder() > $columnB->getOrder()) {
  126. return 1;
  127. } else if ($columnA->getOrder() < $columnB->getOrder()) {
  128. return -1;
  129. }
  130. return 0;
  131. });
  132. return;
  133. }
  134. throw new \LogicException(
  135. 'You must deserialize Columns before accessing it. Use ' .
  136. AbstractCustomizableViewManager::class .
  137. ' for deserialization.'
  138. );
  139. }
  141. public function isNewView(): bool
  142. {
  143. if ($this->name === self::DEFAULT_VIEW_NAME) {
  144. return true;
  145. }
  146. return false;
  147. }
  149. public function setNewView(): self
  150. {
  151. $this->name = self::DEFAULT_VIEW_NAME;
  152. return $this;
  153. }
  155. /**
  156. * @return array
  157. */
  158. public function getColumns(): array
  159. {
  160. return $this->columns;
  161. }
  163. public function hasColumnDeserialized(): bool
  164. {
  165. if (!empty($this->columns) && !$this->columns[array_key_first($this->columns)] instanceof Column) {
  166. return false;
  167. }
  169. return true;
  170. }
  172. /**
  173. * @param Column[] $columns
  174. * @return $this
  175. */
  176. public function setColumns(array $columns): self
  177. {
  178. $this->columns = $columns;
  179. return $this;
  180. }
  182. public function getName(): ?string
  183. {
  184. return $this->name;
  185. }
  187. public function setName(?string $name): AbstractCustomView
  188. {
  189. $this->name = $name;
  190. return $this;
  191. }
  193. public function getActive(): ?bool
  194. {
  195. return $this->active;
  196. }
  198. public function setActive(?bool $active): AbstractCustomView
  199. {
  200. $this->active = $active;
  201. return $this;
  202. }
  204. public function getFilters(): ?array
  205. {
  206. return $this->filters;
  207. }
  209. public function setFilters(?array $filters): AbstractCustomView
  210. {
  211. $this->filters = $filters;
  212. return $this;
  213. }
  215. public function getSortKey(): ?string
  216. {
  217. return $this->sortKey;
  218. }
  220. public function setSortKey(?string $sortKey): AbstractCustomView
  221. {
  222. $this->sortKey = $sortKey;
  223. return $this;
  224. }
  226. public function getSortDirection(): ?string
  227. {
  228. return $this->sortDirection;
  229. }
  231. public function setSortDirection(?string $sortDirection): AbstractCustomView
  232. {
  233. $this->sortDirection = $sortDirection;
  234. return $this;
  235. }
  236. }