vendor/pimcore/pimcore/models/Dependency.php line 112

Open in your IDE?
  1. <?php
  3. /**
  4. * Pimcore
  5. *
  6. * This source file is available under two different licenses:
  7. * - GNU General Public License version 3 (GPLv3)
  8. * - Pimcore Commercial License (PCL)
  9. * Full copyright and license information is available in
  10. * LICENSE.md which is distributed with this source code.
  11. *
  12. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13. * @license http://www.pimcore.org/license GPLv3 and PCL
  14. */
  16. namespace Pimcore\Model;
  18. /**
  19. * @internal
  20. *
  21. * @method Dependency\Dao getDao()
  22. * @method void save()
  23. */
  24. class Dependency extends AbstractModel
  25. {
  26. /**
  27. * The ID of the object to get dependencies for
  28. *
  29. * @var int
  30. */
  31. protected $sourceId;
  33. /**
  34. * The type of the object to get dependencies for
  35. *
  36. * @var string
  37. */
  38. protected $sourceType;
  40. /**
  41. * Contains the ID/type of objects which are required for the given source object (sourceId/sourceType)
  42. *
  43. * @var array
  44. */
  45. protected $requires = [];
  47. /**
  48. * Static helper to get the dependencies for the given sourceId & type
  49. *
  50. * @param int $id
  51. * @param string $type
  52. *
  53. * @return Dependency
  54. */
  55. public static function getBySourceId($id, $type)
  56. {
  57. $d = new self();
  58. $d->getDao()->getBySourceId($id, $type);
  60. return $d;
  61. }
  63. /**
  64. * Add a requirement to the source object
  65. *
  66. * @param int $id
  67. * @param string $type
  68. */
  69. public function addRequirement($id, $type)
  70. {
  71. $this->requires[] = [
  72. 'type' => $type,
  73. 'id' => $id,
  74. ];
  75. }
  77. /**
  78. * Used when element gets deleted. Removes entries (by source = element) and
  79. * schedules a sanity check for the affected targets.
  80. *
  81. * @param Element\ElementInterface $element
  82. */
  83. public function cleanAllForElement($element)
  84. {
  85. $this->getDao()->cleanAllForElement($element);
  86. }
  88. /**
  89. * Cleanup the dependencies for current source id.
  90. * Can be used for updating the dependencies.
  91. */
  92. public function clean()
  93. {
  94. $this->requires = [];
  95. $this->getDao()->clear();
  96. }
  98. /**
  99. * @return int
  100. */
  101. public function getSourceId()
  102. {
  103. return $this->sourceId;
  104. }
  106. /**
  107. * @param int|null $offset
  108. * @param int|null $limit
  109. *
  110. * @return array
  111. */
  112. public function getRequires($offset = null, $limit = null)
  113. {
  114. return array_slice($this->requires, $offset, $limit);
  115. }
  117. /**
  118. * @param int|null $offset
  119. * @param int|null $limit
  120. *
  121. * @return array
  122. */
  123. public function getRequiredBy($offset = null, $limit = null)
  124. {
  125. return $this->getDao()->getRequiredBy($offset, $limit);
  126. }
  128. /**
  129. * @param string|null $orderBy
  130. * @param string|null $orderDirection
  131. * @param int|null $offset
  132. * @param int|null $limit
  133. *
  134. * @return array
  135. */
  136. public function getRequiredByWithPath($offset = null, $limit = null, $orderBy = null, $orderDirection = null)
  137. {
  138. return $this->getDao()->getRequiredByWithPath($offset, $limit, $orderBy, $orderDirection);
  139. }
  141. /**
  142. * @param int $sourceId
  143. *
  144. * @return $this
  145. */
  146. public function setSourceId($sourceId)
  147. {
  148. $this->sourceId = (int) $sourceId;
  150. return $this;
  151. }
  153. /**
  154. * @param array $requires
  155. *
  156. * @return $this
  157. */
  158. public function setRequires($requires)
  159. {
  160. $this->requires = $requires;
  162. return $this;
  163. }
  165. /**
  166. * @return string
  167. */
  168. public function getSourceType()
  169. {
  170. return $this->sourceType;
  171. }
  173. /**
  174. * @param string $sourceType
  175. *
  176. * @return $this
  177. */
  178. public function setSourceType($sourceType)
  179. {
  180. $this->sourceType = $sourceType;
  182. return $this;
  183. }
  185. /**
  186. * @return int
  187. */
  188. public function getRequiresTotalCount()
  189. {
  190. return count($this->requires);
  191. }
  193. /**
  194. * @return int
  195. */
  196. public function getRequiredByTotalCount()
  197. {
  198. return $this->getDao()->getRequiredByTotalCount();
  199. }
  201. /**
  202. * Check if the source object is required by an other object (an other object depends on this object)
  203. *
  204. * @return bool
  205. */
  206. public function isRequired()
  207. {
  208. return $this->getRequiredByTotalCount() > 0;
  209. }
  210. }