vendor/sulu/sulu/src/Sulu/Bundle/PageBundle/Document/BasePageDocument.php line 266

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\PageBundle\Document;
  14. use Sulu\Component\Content\Document\Behavior\ExtensionBehavior;
  15. use Sulu\Component\Content\Document\Behavior\LocalizedAuditableBehavior;
  16. use Sulu\Component\Content\Document\Behavior\LocalizedAuthorBehavior;
  17. use Sulu\Component\Content\Document\Behavior\LocalizedStructureBehavior;
  18. use Sulu\Component\Content\Document\Behavior\NavigationContextBehavior;
  19. use Sulu\Component\Content\Document\Behavior\OrderBehavior;
  20. use Sulu\Component\Content\Document\Behavior\RedirectTypeBehavior;
  21. use Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior;
  22. use Sulu\Component\Content\Document\Behavior\SecurityBehavior;
  23. use Sulu\Component\Content\Document\Behavior\ShadowLocaleBehavior;
  24. use Sulu\Component\Content\Document\Behavior\WebspaceBehavior;
  25. use Sulu\Component\Content\Document\Behavior\WorkflowStageBehavior;
  26. use Sulu\Component\Content\Document\Extension\ExtensionContainer;
  27. use Sulu\Component\Content\Document\RedirectType;
  28. use Sulu\Component\Content\Document\Structure\Structure;
  29. use Sulu\Component\Content\Document\Structure\StructureInterface;
  30. use Sulu\Component\Content\Document\WorkflowStage;
  31. use Sulu\Component\DocumentManager\Behavior\Mapping\ChildrenBehavior;
  32. use Sulu\Component\DocumentManager\Behavior\Mapping\LocalizedTitleBehavior;
  33. use Sulu\Component\DocumentManager\Behavior\Mapping\NodeNameBehavior;
  34. use Sulu\Component\DocumentManager\Behavior\Mapping\PathBehavior;
  35. use Sulu\Component\DocumentManager\Behavior\Mapping\UuidBehavior;
  36. use Sulu\Component\DocumentManager\Behavior\VersionBehavior;
  37. use Sulu\Component\DocumentManager\Collection\ChildrenCollection;
  38. use Sulu\Component\DocumentManager\Version;
  40. /**
  41.  * Base document for Page-like documents (i.e. Page and Home documents).
  42.  */
  43. class BasePageDocument implements
  44.     NodeNameBehavior,
  45.     LocalizedStructureBehavior,
  46.     ResourceSegmentBehavior,
  47.     NavigationContextBehavior,
  48.     RedirectTypeBehavior,
  49.     WorkflowStageBehavior,
  50.     ShadowLocaleBehavior,
  51.     UuidBehavior,
  52.     ChildrenBehavior,
  53.     PathBehavior,
  54.     ExtensionBehavior,
  55.     OrderBehavior,
  56.     WebspaceBehavior,
  57.     SecurityBehavior,
  58.     LocalizedAuditableBehavior,
  59.     LocalizedTitleBehavior,
  60.     VersionBehavior,
  61.     LocalizedAuthorBehavior
  62. {
  63.     public const RESOURCE_KEY = 'pages';
  65.     /**
  66.      * The name of this node.
  67.      *
  68.      * @var string
  69.      */
  70.     protected $nodeName;
  72.     /**
  73.      * Datetime of create document.
  74.      *
  75.      * @var \DateTime
  76.      */
  77.     protected $created;
  79.     /**
  80.      * Changed date of page.
  81.      *
  82.      * @var \DateTime
  83.      */
  84.     protected $changed;
  86.     /**
  87.      * User ID of creator.
  88.      *
  89.      * @var int|null
  90.      */
  91.     protected $creator;
  93.     /**
  94.      * User ID of changer.
  95.      *
  96.      * @var int|null
  97.      */
  98.     protected $changer;
  100.     /**
  101.      * Title of document.
  102.      *
  103.      * @var string
  104.      */
  105.     protected $title;
  107.     /**
  108.      * Segment.
  109.      *
  110.      * @var string
  111.      */
  112.     protected $resourceSegment;
  114.     /**
  115.      * @var string[]
  116.      */
  117.     protected $navigationContexts = [];
  119.     /**
  120.      * Type of redirection.
  121.      *
  122.      * @var int
  123.      */
  124.     protected $redirectType;
  126.     /**
  127.      * The target of redirection.
  128.      *
  129.      * @var object|null
  130.      */
  131.     protected $redirectTarget;
  133.     /**
  134.      * The External redirect.
  135.      *
  136.      * @var string|null
  137.      */
  138.     protected $redirectExternal;
  140.     /**
  141.      * Workflow Stage currently Test or Published.
  142.      *
  143.      * @var int
  144.      */
  145.     protected $workflowStage;
  147.     /**
  148.      * Is Document is published.
  149.      *
  150.      * @var bool
  151.      */
  152.     protected $published;
  154.     /**
  155.      * Shadow locale is enabled.
  156.      *
  157.      * @var bool
  158.      */
  159.     protected $shadowLocaleEnabled = false;
  161.     /**
  162.      * Shadow locale.
  163.      *
  164.      * @var string|null
  165.      */
  166.     protected $shadowLocale;
  168.     /**
  169.      * Universal Identifier.
  170.      *
  171.      * @var string
  172.      */
  173.     protected $uuid;
  175.     /**
  176.      * Document's type of structure ie default, complex...
  177.      *
  178.      * @var string
  179.      */
  180.     protected $structureType;
  182.     /**
  183.      * Structure.
  184.      *
  185.      * @var StructureInterface
  186.      */
  187.     protected $structure;
  189.     /**
  190.      * Document's locale.
  191.      *
  192.      * @var string
  193.      */
  194.     protected $locale;
  196.     /**
  197.      * Document's original locale.
  198.      *
  199.      * @var string
  200.      */
  201.     protected $originalLocale;
  203.     /**
  204.      * Document's children.
  205.      *
  206.      * @var ChildrenCollection
  207.      */
  208.     protected $children;
  210.     /**
  211.      * Path of Document.
  212.      *
  213.      * @var string
  214.      */
  215.     protected $path;
  217.     /**
  218.      * Document's extensions ie seo, ...
  219.      *
  220.      * @var array<mixed[]>|ExtensionContainer
  221.      */
  222.     protected $extensions;
  224.     /**
  225.      * Document's webspace name.
  226.      *
  227.      * @var string
  228.      */
  229.     protected $webspaceName;
  231.     /**
  232.      * Document's order.
  233.      *
  234.      * @var int
  235.      */
  236.     protected $suluOrder;
  238.     /**
  239.      * List of permissions.
  240.      *
  241.      * @var array
  242.      */
  243.     protected $permissions = [];
  245.     /**
  246.      * List of versions.
  247.      *
  248.      * @var Version[]
  249.      */
  250.     protected $versions = [];
  252.     /**
  253.      * Date of authoring.
  254.      *
  255.      * @var \DateTime
  256.      */
  257.     protected $authored;
  259.     /**
  260.      * Id of author.
  261.      *
  262.      * @var int|null
  263.      */
  264.     protected $author;
  266.     public function __construct()
  267.     {
  268.         $this->workflowStage = WorkflowStage::TEST;
  269.         $this->redirectType = RedirectType::NONE;
  270.         $this->structure = new Structure();
  271.         $this->extensions = new ExtensionContainer();
  272.         $this->children = new \ArrayIterator();
  273.     }
  275.     public function getNodeName()
  276.     {
  277.         return $this->nodeName;
  278.     }
  280.     public function getTitle()
  281.     {
  282.         return $this->title;
  283.     }
  285.     public function setTitle($title)
  286.     {
  287.         $this->title = $title;
  288.     }
  290.     public function getCreated()
  291.     {
  292.         return $this->created;
  293.     }
  295.     /**
  296.      * @param \DateTime $created
  297.      *
  298.      * @return void
  299.      */
  300.     public function setCreated($created)
  301.     {
  302.         $this->created = $created;
  303.     }
  305.     public function getChanged()
  306.     {
  307.         return $this->changed;
  308.     }
  310.     public function getCreator()
  311.     {
  312.         return $this->creator;
  313.     }
  315.     /**
  316.      * @param int|null $userId
  317.      *
  318.      * @return void
  319.      */
  320.     public function setCreator($userId)
  321.     {
  322.         $this->creator = $userId;
  323.     }
  325.     public function getChanger()
  326.     {
  327.         return $this->changer;
  328.     }
  330.     public function getResourceSegment()
  331.     {
  332.         return $this->resourceSegment;
  333.     }
  335.     public function setResourceSegment($resourceSegment)
  336.     {
  337.         $this->resourceSegment = $resourceSegment;
  338.     }
  340.     public function getNavigationContexts()
  341.     {
  342.         return $this->navigationContexts;
  343.     }
  345.     public function setNavigationContexts(array $navigationContexts = [])
  346.     {
  347.         $this->navigationContexts = $navigationContexts;
  348.     }
  350.     public function getRedirectType()
  351.     {
  352.         return $this->redirectType;
  353.     }
  355.     public function setRedirectType($redirectType)
  356.     {
  357.         $this->redirectType = $redirectType;
  358.     }
  360.     public function getRedirectTarget()
  361.     {
  362.         return $this->redirectTarget;
  363.     }
  365.     public function setRedirectTarget($redirectTarget)
  366.     {
  367.         $this->redirectTarget = $redirectTarget;
  368.     }
  370.     public function getRedirectExternal()
  371.     {
  372.         return $this->redirectExternal;
  373.     }
  375.     public function setRedirectExternal($redirectExternal)
  376.     {
  377.         $this->redirectExternal = $redirectExternal;
  378.     }
  380.     public function getWorkflowStage()
  381.     {
  382.         return $this->workflowStage;
  383.     }
  385.     public function setWorkflowStage($workflowStage)
  386.     {
  387.         $this->workflowStage = $workflowStage;
  388.     }
  390.     public function getPublished()
  391.     {
  392.         return $this->published;
  393.     }
  395.     public function getShadowLocale()
  396.     {
  397.         return $this->shadowLocale;
  398.     }
  400.     public function setShadowLocale($shadowLocale)
  401.     {
  402.         $this->shadowLocale = $shadowLocale;
  403.     }
  405.     public function isShadowLocaleEnabled()
  406.     {
  407.         return $this->shadowLocaleEnabled;
  408.     }
  410.     public function setShadowLocaleEnabled($shadowLocaleEnabled)
  411.     {
  412.         $this->shadowLocaleEnabled = $shadowLocaleEnabled;
  413.     }
  415.     public function getUuid()
  416.     {
  417.         return $this->uuid;
  418.     }
  420.     public function getStructureType()
  421.     {
  422.         return $this->structureType;
  423.     }
  425.     public function getStructure()
  426.     {
  427.         return $this->structure;
  428.     }
  430.     public function setStructureType($structureType)
  431.     {
  432.         $this->structureType = $structureType;
  433.     }
  435.     public function getLocale()
  436.     {
  437.         return $this->locale;
  438.     }
  440.     public function setLocale($locale)
  441.     {
  442.         $this->locale = $locale;
  443.     }
  445.     public function getOriginalLocale()
  446.     {
  447.         return $this->originalLocale;
  448.     }
  450.     public function setOriginalLocale($originalLocale)
  451.     {
  452.         $this->originalLocale = $originalLocale;
  453.     }
  455.     public function getChildren()
  456.     {
  457.         return $this->children;
  458.     }
  460.     public function getPath()
  461.     {
  462.         return $this->path;
  463.     }
  465.     public function getExtensionsData()
  466.     {
  467.         return $this->extensions;
  468.     }
  470.     public function setExtensionsData($extensions)
  471.     {
  472.         $this->extensions = $extensions;
  473.     }
  475.     public function setExtension($name, $data)
  476.     {
  477.         $this->extensions[$name] = $data;
  478.     }
  480.     public function getWebspaceName()
  481.     {
  482.         return $this->webspaceName;
  483.     }
  485.     public function getSuluOrder()
  486.     {
  487.         return $this->suluOrder;
  488.     }
  490.     public function setSuluOrder($order)
  491.     {
  492.         $this->suluOrder = $order;
  493.     }
  495.     public function setPermissions(array $permissions)
  496.     {
  497.         $this->permissions = $permissions;
  498.     }
  500.     public function getPermissions()
  501.     {
  502.         return $this->permissions;
  503.     }
  505.     public function getVersions()
  506.     {
  507.         return $this->versions;
  508.     }
  510.     public function setVersions($versions)
  511.     {
  512.         $this->versions = $versions;
  513.     }
  515.     public function getAuthored()
  516.     {
  517.         return $this->authored;
  518.     }
  520.     /**
  521.      * @param \DateTime $authored
  522.      *
  523.      * @return void
  524.      */
  525.     public function setAuthored($authored)
  526.     {
  527.         $this->authored = $authored;
  528.     }
  530.     public function getAuthor()
  531.     {
  532.         return $this->author;
  533.     }
  535.     /**
  536.      * @param int|null $contactId
  537.      *
  538.      * @return void
  539.      */
  540.     public function setAuthor($contactId)
  541.     {
  542.         $this->author = $contactId;
  543.     }
  544. }