vendor/ibexa/core/src/lib/Repository/Values/Content/Location.php line 19

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. declare(strict_types=1);
  9. namespace Ibexa\Core\Repository\Values\Content;
  11. use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo as APIContentInfo;
  12. use Ibexa\Contracts\Core\Repository\Values\Content\Location as APILocation;
  14. /**
  15.  * This class represents a location in the repository.
  16.  *
  17.  * @internal Meant for internal use by Repository, type hint against API object instead.
  18.  */
  19. class Location extends APILocation
  20. {
  21.     /**
  22.      * Content info of the content object of this location.
  23.      *
  24.      * @var \Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo
  25.      */
  26.     protected $contentInfo;
  28.     /** @var array */
  29.     protected $path;
  31.     /** @var \Ibexa\Contracts\Core\Repository\Values\Content\Location|null */
  32.     protected $parentLocation;
  34.     /**
  35.      * Returns the content info of the content object of this location.
  36.      *
  37.      * @return \Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo
  38.      */
  39.     public function getContentInfo(): APIContentInfo
  40.     {
  41.         return $this->contentInfo;
  42.     }
  44.     public function getParentLocation(): ?APILocation
  45.     {
  46.         return $this->parentLocation;
  47.     }
  49.     /**
  50.      * Function where list of properties are returned.
  51.      *
  52.      * Override to add dynamic properties
  53.      *
  54.      * @uses \parent::getProperties()
  55.      *
  56.      * @param array $dynamicProperties
  57.      *
  58.      * @return array
  59.      */
  60.     protected function getProperties($dynamicProperties = ['contentId'])
  61.     {
  62.         return parent::getProperties($dynamicProperties);
  63.     }
  65.     /**
  66.      * Magic getter for retrieving convenience properties.
  67.      *
  68.      * @param string $property The name of the property to retrieve
  69.      *
  70.      * @return mixed
  71.      */
  72.     public function __get($property)
  73.     {
  74.         switch ($property) {
  75.             case 'contentId':
  76.                 return $this->contentInfo->id;
  77.             case 'path':
  78.                 if ($this->path !== null) {
  79.                     return $this->path;
  80.                 }
  81.                 if (isset($this->pathString[1]) && $this->pathString[0] === '/') {
  82.                     return $this->path = explode('/', trim($this->pathString, '/'));
  83.                 }
  85.                 return $this->path = [];
  86.         }
  88.         return parent::__get($property);
  89.     }
  91.     /**
  92.      * Magic isset for signaling existence of convenience properties.
  93.      *
  94.      * @param string $property
  95.      *
  96.      * @return bool
  97.      */
  98.     public function __isset($property)
  99.     {
  100.         if ($property === 'contentId' || $property === 'path') {
  101.             return true;
  102.         }
  104.         return parent::__isset($property);
  105.     }
  106. }
  108. class_alias(Location::class, 'eZ\Publish\Core\Repository\Values\Content\Location');