vendor/kunstmaan/node-bundle/Entity/Node.php line 37

Open in your IDE?
  1. <?php
  3. namespace Kunstmaan\NodeBundle\Entity;
  5. use Doctrine\Common\Collections\ArrayCollection;
  6. use Doctrine\ORM\Mapping as ORM;
  7. use Gedmo\Mapping\Annotation as Gedmo;
  8. use Gedmo\Tree\Node as GedmoNode;
  9. use Kunstmaan\AdminBundle\Entity\AbstractEntity;
  10. use Kunstmaan\NodeBundle\Form\NodeAdminType;
  11. use Kunstmaan\NodeBundle\Repository\NodeRepository;
  12. use Kunstmaan\UtilitiesBundle\Helper\ClassLookup;
  13. use Symfony\Component\Validator\Constraints as Assert;
  15. /**
  16.  * @ORM\Entity(repositoryClass="Kunstmaan\NodeBundle\Repository\NodeRepository")
  17.  * @ORM\Table(
  18.  *      name="kuma_nodes",
  19.  *      indexes={
  20.  *          @ORM\Index(name="idx_node_internal_name", columns={"internal_name"}),
  21.  *          @ORM\Index(name="idx_node_ref_entity_name", columns={"ref_entity_name"}),
  22.  *          @ORM\Index(name="idx_node_tree", columns={"deleted", "hidden_from_nav", "lft", "rgt"})
  23.  *      }
  24.  * )
  25.  * @ORM\HasLifecycleCallbacks()
  26.  * @ORM\ChangeTrackingPolicy("DEFERRED_EXPLICIT")
  27.  * @Gedmo\Tree(type="nested")
  28.  */
  29. #[ORM\Entity(repositoryClass: NodeRepository::class)]
  30. #[ORM\Table(name: 'kuma_nodes')]
  31. #[ORM\Index(name: 'idx_node_internal_name', columns: ['internal_name'])]
  32. #[ORM\Index(name: 'idx_node_ref_entity_name', columns: ['ref_entity_name'])]
  33. #[ORM\Index(name: 'idx_node_tree', columns: ['deleted', 'hidden_from_nav', 'lft', 'rgt'])]
  34. #[ORM\HasLifecycleCallbacks]
  35. #[ORM\ChangeTrackingPolicy('DEFERRED_EXPLICIT')]
  36. #[Gedmo\Tree(type: 'nested')]
  37. class Node extends AbstractEntity implements GedmoNode
  38. {
  39.     /**
  40.      * @var Node
  41.      *
  42.      * @ORM\ManyToOne(targetEntity="Node", inversedBy="children")
  43.      * @ORM\JoinColumn(name="parent_id", referencedColumnName="id")
  44.      * @Gedmo\TreeParent
  45.      */
  46.     #[ORM\ManyToOne(targetEntity: Node::class, inversedBy: 'children')]
  47.     #[ORM\JoinColumn(name: 'parent_id', referencedColumnName: 'id')]
  48.     #[Gedmo\TreeParent]
  49.     protected $parent;
  51.     /**
  52.      * @var ArrayCollection
  53.      *
  54.      * @ORM\OneToMany(targetEntity="Node", mappedBy="parent")
  55.      */
  56.     #[ORM\OneToMany(targetEntity: Node::class, mappedBy: 'parent')]
  57.     protected $children;
  59.     /**
  60.      * @var int
  61.      *
  62.      * @ORM\Column(name="lft", type="integer", nullable=true)
  63.      * @Gedmo\TreeLeft
  64.      */
  65.     #[ORM\Column(name: 'lft', type: 'integer', nullable: true)]
  66.     #[Gedmo\TreeLeft]
  67.     protected $lft;
  69.     /**
  70.      * @var int
  71.      *
  72.      * @ORM\Column(name="lvl", type="integer", nullable=true)
  73.      * @Gedmo\TreeLevel
  74.      */
  75.     #[ORM\Column(name: 'lvl', type: 'integer', nullable: true)]
  76.     #[Gedmo\TreeLevel]
  77.     protected $lvl;
  79.     /**
  80.      * @var int
  81.      *
  82.      * @ORM\Column(name="rgt", type="integer", nullable=true)
  83.      * @Gedmo\TreeRight
  84.      */
  85.     #[ORM\Column(name: 'rgt', type: 'integer', nullable: true)]
  86.     #[Gedmo\TreeRight]
  87.     protected $rgt;
  89.     /**
  90.      * @var ArrayCollection
  91.      *
  92.      * @ORM\OneToMany(targetEntity="NodeTranslation", mappedBy="node")
  93.      */
  94.     #[ORM\OneToMany(targetEntity: NodeTranslation::class, mappedBy: 'node')]
  95.     #[Assert\Valid]
  96.     protected $nodeTranslations;
  98.     /**
  99.      * @var bool
  100.      *
  101.      * @ORM\Column(type="boolean")
  102.      */
  103.     #[ORM\Column(name: 'deleted', type: 'boolean')]
  104.     protected $deleted;
  106.     /**
  107.      * @var bool
  108.      *
  109.      * @ORM\Column(type="boolean", name="hidden_from_nav")
  110.      */
  111.     #[ORM\Column(name: 'hidden_from_nav', type: 'boolean')]
  112.     protected $hiddenFromNav;
  114.     /**
  115.      * @var string
  116.      *
  117.      * @ORM\Column(type="string", nullable=false, name="ref_entity_name")
  118.      */
  119.     #[ORM\Column(name: 'ref_entity_name', type: 'string', nullable: false)]
  120.     protected $refEntityName;
  122.     /**
  123.      * @var string
  124.      *
  125.      * @ORM\Column(type="string", nullable=true, name="internal_name")
  126.      */
  127.     #[ORM\Column(name: 'internal_name', type: 'string', nullable: true)]
  128.     protected $internalName;
  130.     /**
  131.      * @var GedmoNode|null
  132.      */
  133.     private $sibling;
  135.     public function __construct()
  136.     {
  137.         $this->children = new ArrayCollection();
  138.         $this->nodeTranslations = new ArrayCollection();
  139.         $this->deleted = false;
  140.         $this->hiddenFromNav = false;
  141.     }
  143.     /**
  144.      * @return bool
  145.      */
  146.     public function isHiddenFromNav()
  147.     {
  148.         return $this->hiddenFromNav;
  149.     }
  151.     /**
  152.      * @return bool
  153.      */
  154.     public function getHiddenFromNav()
  155.     {
  156.         return $this->hiddenFromNav;
  157.     }
  159.     /**
  160.      * @param bool $hiddenFromNav
  161.      *
  162.      * @return Node
  163.      */
  164.     public function setHiddenFromNav($hiddenFromNav)
  165.     {
  166.         $this->hiddenFromNav = $hiddenFromNav;
  168.         return $this;
  169.     }
  171.     /**
  172.      * @return ArrayCollection|Node[]
  173.      */
  174.     public function getChildren()
  175.     {
  176.         return $this->children->filter(
  177.             function (Node $entry) {
  178.                 if ($entry->isDeleted()) {
  179.                     return false;
  180.                 }
  182.                 return true;
  183.             }
  184.         );
  185.     }
  187.     /**
  188.      * @param ArrayCollection $children
  189.      *
  190.      * @return Node
  191.      */
  192.     public function setChildren($children)
  193.     {
  194.         $this->children = $children;
  196.         return $this;
  197.     }
  199.     /**
  200.      * Add children
  201.      *
  202.      * @return Node
  203.      */
  204.     public function addNode(Node $child)
  205.     {
  206.         $this->children[] = $child;
  207.         $child->setParent($this);
  209.         return $this;
  210.     }
  212.     /**
  213.      * @param bool $includeOffline
  214.      *
  215.      * @return ArrayCollection|NodeTranslation[]
  216.      */
  217.     public function getNodeTranslations($includeOffline = false)
  218.     {
  219.         return $this->nodeTranslations
  220.             ->filter(function (NodeTranslation $entry) use ($includeOffline) {
  221.                 return $includeOffline || $entry->isOnline();
  222.             }
  223.             );
  224.     }
  226.     /**
  227.      * @return Node
  228.      */
  229.     public function setNodeTranslations(ArrayCollection $nodeTranslations)
  230.     {
  231.         $this->nodeTranslations = $nodeTranslations;
  233.         return $this;
  234.     }
  236.     /**
  237.      * @param string $lang           The locale
  238.      * @param bool   $includeOffline Include offline pages or not
  239.      *
  240.      * @return NodeTranslation|null
  241.      */
  242.     public function getNodeTranslation($lang, $includeOffline = false)
  243.     {
  244.         $nodeTranslations = $this->getNodeTranslations($includeOffline);
  245.         /* @var NodeTranslation $nodeTranslation */
  246.         foreach ($nodeTranslations as $nodeTranslation) {
  247.             if ($lang == $nodeTranslation->getLang()) {
  248.                 return $nodeTranslation;
  249.             }
  250.         }
  252.         return null;
  253.     }
  255.     /**
  256.      * Add nodeTranslation
  257.      *
  258.      * @return Node
  259.      */
  260.     public function addNodeTranslation(NodeTranslation $nodeTranslation)
  261.     {
  262.         $this->nodeTranslations[] = $nodeTranslation;
  263.         $nodeTranslation->setNode($this);
  265.         return $this;
  266.     }
  268.     /**
  269.      * Set parent
  270.      *
  271.      * @param Node $parent
  272.      *
  273.      * @return Node
  274.      */
  275.     public function setParent($parent)
  276.     {
  277.         $this->parent = $parent;
  279.         return $this;
  280.     }
  282.     /**
  283.      * Get parent
  284.      *
  285.      * @return Node
  286.      */
  287.     public function getParent()
  288.     {
  289.         return $this->parent;
  290.     }
  292.     /**
  293.      * @return Node[]
  294.      */
  295.     public function getParents()
  296.     {
  297.         $parent = $this->getParent();
  298.         $parents = [];
  299.         while ($parent !== null) {
  300.             $parents[] = $parent;
  301.             $parent = $parent->getParent();
  302.         }
  304.         return array_reverse($parents);
  305.     }
  307.     /**
  308.      * @return bool
  309.      */
  310.     public function isDeleted()
  311.     {
  312.         return $this->deleted;
  313.     }
  315.     /**
  316.      * @param bool $deleted
  317.      *
  318.      * @return Node
  319.      */
  320.     public function setDeleted($deleted)
  321.     {
  322.         $this->deleted = $deleted;
  324.         return $this;
  325.     }
  327.     /**
  328.      * Set referenced entity
  329.      *
  330.      * @return Node
  331.      */
  332.     public function setRef(HasNodeInterface $entity)
  333.     {
  334.         $this->setRefEntityName(ClassLookup::getClass($entity));
  336.         return $this;
  337.     }
  339.     /**
  340.      * Set class name of referenced entity
  341.      *
  342.      * @param string $refEntityName
  343.      *
  344.      * @return Node
  345.      */
  346.     protected function setRefEntityName($refEntityName)
  347.     {
  348.         $this->refEntityName = $refEntityName;
  350.         return $this;
  351.     }
  353.     /**
  354.      * Get class name of referenced entity
  355.      *
  356.      * @return string
  357.      */
  358.     public function getRefEntityName()
  359.     {
  360.         return $this->refEntityName;
  361.     }
  363.     /**
  364.      * Set internal name
  365.      *
  366.      * @param string $internalName
  367.      *
  368.      * @return Node
  369.      */
  370.     public function setInternalName($internalName)
  371.     {
  372.         $this->internalName = $internalName;
  374.         return $this;
  375.     }
  377.     /**
  378.      * Get internal name
  379.      *
  380.      * @return string
  381.      */
  382.     public function getInternalName()
  383.     {
  384.         return $this->internalName;
  385.     }
  387.     /**
  388.      * @return string
  389.      */
  390.     public function getDefaultAdminType()
  391.     {
  392.         return NodeAdminType::class;
  393.     }
  395.     /**
  396.      * Get tree left
  397.      *
  398.      * @return int
  399.      */
  400.     public function getLeft()
  401.     {
  402.         return $this->lft;
  403.     }
  405.     /**
  406.      * Get tree right
  407.      *
  408.      * @return int
  409.      */
  410.     public function getRight()
  411.     {
  412.         return $this->rgt;
  413.     }
  415.     /**
  416.      * Get tree level
  417.      *
  418.      * @return int
  419.      */
  420.     public function getLevel()
  421.     {
  422.         return $this->lvl;
  423.     }
  425.     public function setSibling(GedmoNode $node): void
  426.     {
  427.         $this->sibling = $node;
  428.     }
  430.     public function getSibling(): ?GedmoNode
  431.     {
  432.         return $this->sibling;
  433.     }
  435.     /**
  436.      * @return string
  437.      */
  438.     public function __toString()
  439.     {
  440.         return 'node ' . $this->getId() . ', refEntityName: ' . $this->getRefEntityName();
  441.     }
  442. }