Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 namespace Drupal\Core\Entity;
|
Chris@0
|
4
|
Chris@0
|
5 /**
|
Chris@0
|
6 * Provides a trait for managing an object's dependencies.
|
Chris@0
|
7 */
|
Chris@0
|
8 trait DependencyTrait {
|
Chris@0
|
9
|
Chris@0
|
10 /**
|
Chris@0
|
11 * The object's dependencies.
|
Chris@0
|
12 *
|
Chris@0
|
13 * @var array
|
Chris@0
|
14 */
|
Chris@0
|
15 protected $dependencies = [];
|
Chris@0
|
16
|
Chris@0
|
17 /**
|
Chris@0
|
18 * Adds a dependency.
|
Chris@0
|
19 *
|
Chris@0
|
20 * @param string $type
|
Chris@0
|
21 * Type of dependency being added: 'module', 'theme', 'config', 'content'.
|
Chris@0
|
22 * @param string $name
|
Chris@0
|
23 * If $type is 'module' or 'theme', the name of the module or theme. If
|
Chris@0
|
24 * $type is 'config' or 'content', the result of
|
Chris@0
|
25 * EntityInterface::getConfigDependencyName().
|
Chris@0
|
26 *
|
Chris@0
|
27 * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
|
Chris@0
|
28 *
|
Chris@0
|
29 * @return $this
|
Chris@0
|
30 */
|
Chris@0
|
31 protected function addDependency($type, $name) {
|
Chris@0
|
32 if (empty($this->dependencies[$type])) {
|
Chris@0
|
33 $this->dependencies[$type] = [$name];
|
Chris@0
|
34 if (count($this->dependencies) > 1) {
|
Chris@0
|
35 // Ensure a consistent order of type keys.
|
Chris@0
|
36 ksort($this->dependencies);
|
Chris@0
|
37 }
|
Chris@0
|
38 }
|
Chris@0
|
39 elseif (!in_array($name, $this->dependencies[$type])) {
|
Chris@0
|
40 $this->dependencies[$type][] = $name;
|
Chris@0
|
41 // Ensure a consistent order of dependency names.
|
Chris@0
|
42 sort($this->dependencies[$type], SORT_FLAG_CASE);
|
Chris@0
|
43 }
|
Chris@0
|
44 return $this;
|
Chris@0
|
45 }
|
Chris@0
|
46
|
Chris@0
|
47 /**
|
Chris@0
|
48 * Adds multiple dependencies.
|
Chris@0
|
49 *
|
Chris@0
|
50 * @param array $dependencies
|
Chris@0
|
51 * An array of dependencies keyed by the type of dependency. One example:
|
Chris@0
|
52 * @code
|
Chris@0
|
53 * array(
|
Chris@0
|
54 * 'module' => array(
|
Chris@0
|
55 * 'node',
|
Chris@0
|
56 * 'field',
|
Chris@0
|
57 * 'image',
|
Chris@0
|
58 * ),
|
Chris@0
|
59 * );
|
Chris@0
|
60 * @endcode
|
Chris@0
|
61 *
|
Chris@0
|
62 * @see \Drupal\Core\Entity\DependencyTrait::addDependency
|
Chris@0
|
63 */
|
Chris@0
|
64 protected function addDependencies(array $dependencies) {
|
Chris@0
|
65 foreach ($dependencies as $dependency_type => $list) {
|
Chris@0
|
66 foreach ($list as $name) {
|
Chris@0
|
67 $this->addDependency($dependency_type, $name);
|
Chris@0
|
68 }
|
Chris@0
|
69 }
|
Chris@0
|
70 }
|
Chris@0
|
71
|
Chris@0
|
72 }
|