src/Cms/FileBundle/Entity/Node.php line 48

Open in your IDE?
  1. <?php
  3. namespace Cms\FileBundle\Entity;
  5. use Cms\ContainerBundle\Entity\Container;
  6. use Cms\CoreBundle\Model\Interfaces\Nestable\NestableInterface;
  7. use Cms\CoreBundle\Model\Interfaces\Nestable\NestableTrait;
  8. use Cms\FileBundle\Entity\Nodes\File;
  9. use Cms\FileBundle\Entity\Nodes\Files\DocumentFile;
  10. use Cms\FileBundle\Entity\Nodes\Files\GenericFile;
  11. use Cms\FileBundle\Entity\Nodes\Files\ImageFile;
  12. use Cms\FileBundle\Entity\Nodes\Folder;
  13. use Cms\TenantBundle\Entity\TenantedEntity;
  14. use Doctrine\Common\Collections\ArrayCollection;
  15. use Doctrine\ORM\Mapping as ORM;
  16. use Gedmo\Mapping\Annotation as Gedmo;
  18. /**
  19.  * Represents a "filesystem" object, like a folder or file.
  20.  * Nodes are stored as trees, just as a real filesystem would.
  21.  *
  22.  * Class Node
  23.  * @package Cms\FileBundle\Entity
  24.  *
  25.  * @ORM\Entity(repositoryClass = "Cms\FileBundle\Doctrine\NodeRepository")
  26.  * @ORM\InheritanceType("SINGLE_TABLE")
  27.  * @ORM\DiscriminatorColumn(name = "_discr", type = "string")
  28.  * @ORM\DiscriminatorMap({
  29.  *     "folder" = "Cms\FileBundle\Entity\Nodes\Folder",
  30.  *     "file" = "Cms\FileBundle\Entity\Nodes\File",
  31.  *     "generic" = "Cms\FileBundle\Entity\Nodes\Files\GenericFile",
  32.  *     "image" = "Cms\FileBundle\Entity\Nodes\Files\ImageFile",
  33.  *     "document" = "Cms\FileBundle\Entity\Nodes\Files\DocumentFile",
  34.  * })
  35.  * @ORM\Table(
  36.  *      name = "cms__file__node",
  37.  *      indexes = {
  38.  *          @ORM\Index(
  39.  *              name = "idx__name",
  40.  *              columns = {
  41.  *                  "name"
  42.  *              }
  43.  *          )
  44.  *      }
  45.  * )
  46.  * @Gedmo\Tree(type = "nested")
  47.  */
  48. abstract class Node extends TenantedEntity implements NestableInterface
  49. {
  50.     const DISCRS = [
  51.         Folder::DISCR => Folder::class,
  52.         File::DISCR => File::class,
  53.         GenericFile::DISCR => GenericFile::class,
  54.         ImageFile::DISCR => ImageFile::class,
  55.         DocumentFile::DISCR => DocumentFile::class,
  56.     ];
  57.     const DISCR = null;
  58.     const TYPE = null;
  60.     /**
  61.      * Basic tree-related fields.
  62.      */
  63.     use NestableTrait;
  65.     /**
  66.      * The Node that acts as the parent for this one.
  67.      * If no parent is given, then this Node is a "root" level node.
  68.      *
  69.      * @var Node
  70.      *
  71.      * @ORM\ManyToOne(targetEntity = "Node", inversedBy = "children")
  72.      * @ORM\JoinColumn(name = "parent", referencedColumnName = "id", onDelete = "CASCADE")
  73.      * @Gedmo\TreeParent
  74.      */
  75.     protected $parent;
  77.     /**
  78.      * The direct descendant Nodes of this one.
  79.      *
  80.      * @var ArrayCollection|Node[]
  81.      *
  82.      * @ORM\OneToMany(targetEntity = "Node", mappedBy = "parent")
  83.      */
  84.     protected $children;
  86.     /**
  87.      * The Container that this item is tied to.
  88.      * ALL Nodes MUST be tied to some Container in the system.
  89.      * This needs to be set on every Node.
  90.      * However, descendant Nodes MUST have the same Container as their "root".
  91.      *
  92.      * @var Container|null
  93.      *
  94.      * @ORM\ManyToOne(targetEntity = "Cms\ContainerBundle\Entity\Container")
  95.      * @ORM\JoinColumn(name = "container", referencedColumnName = "id", onDelete = "SET NULL")
  96.      */
  97.     protected $container;
  99.     /**
  100.      * @var string
  101.      *
  102.      * @ORM\Column(
  103.      *  type = "string",
  104.      *  nullable = false
  105.      * )
  106.      */
  107.     protected $name;
  109.     /**
  110.      * {@inheritdoc}
  111.      */
  112.     public function __construct()
  113.     {
  114.         $this->children = new ArrayCollection();
  115.     }
  117.     /**
  118.      * @return string
  119.      */
  120.     public function getType()
  121.     {
  122.         if (static::TYPE === null) {
  123.             throw new \Exception();
  124.         }
  125.         return static::TYPE;
  126.     }
  128.     /**
  129.      * {@inheritdoc}
  130.      * @return Node
  131.      */
  132.     public function getParent()
  133.     {
  134.         return $this->parent;
  135.     }
  137.     /**
  138.      * {@inheritdoc}
  139.      * @return ArrayCollection|Node[]
  140.      */
  141.     public function getChildren()
  142.     {
  143.         return $this->children;
  144.     }
  146.     /**
  147.      * @return Container|null
  148.      */
  149.     public function getContainer()
  150.     {
  151.         return $this->container;
  152.     }
  154.     /**
  155.      * {@inheritdoc}
  156.      * @param Node $value
  157.      */
  158.     public function setParent(NestableInterface $value = null)
  159.     {
  160.         $this->parent = $value;
  161.         return $this;
  162.     }
  164.     /**
  165.      * @param Container|null $value
  166.      * @return $this
  167.      */
  168.     public function setContainer(?Container $value)
  169.     {
  170.         $this->container = $value;
  171.         return $this;
  172.     }
  174.     /**
  175.      * {@inheritdoc}
  176.      */
  177.     public function getName()
  178.     {
  179.         return $this->name;
  180.     }
  182.     /**
  183.      * {@inheritdoc}
  184.      */
  185.     public function setName($value)
  186.     {
  187.         $this->name = $value;
  188.         return $this;
  189.     }
  191.     /**
  192.      * @return string
  193.      */
  194.     public function ui()
  195.     {
  196.         return $this->getName();
  197.     }
  198. }