vendor/pimcore/pimcore/lib/Document/Editable/Block/BlockName.php line 28

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6.  * Pimcore
  7.  *
  8.  * This source file is available under two different licenses:
  9.  * - GNU General Public License version 3 (GPLv3)
  10.  * - Pimcore Commercial License (PCL)
  11.  * Full copyright and license information is available in
  12.  * LICENSE.md which is distributed with this source code.
  13.  *
  14.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  16.  */
  18. namespace Pimcore\Document\Editable\Block;
  20. use Pimcore\Model\Document\Editable;
  22. /**
  23.  * @internal
  24.  *
  25.  * Simple value object containing both name and real name of
  26.  * a block.
  27.  */
  28. final class BlockName implements \JsonSerializable
  29. {
  30.     /**
  31.      * @var string
  32.      */
  33.     private $name;
  35.     /**
  36.      * @var string
  37.      */
  38.     private $realName;
  40.     /**
  41.      * @param string $name
  42.      * @param string $realName
  43.      */
  44.     public function __construct(string $name, string $realName)
  45.     {
  46.         $this->name = $name;
  47.         $this->realName = $realName;
  48.     }
  50.     /**
  51.      * Factory method to create an instance from strings
  52.      *
  53.      * @param string $name
  54.      * @param string $realName
  55.      *
  56.      * @return BlockName
  57.      */
  58.     public static function createFromNames(string $name, string $realName): BlockName
  59.     {
  60.         return new self($name, $realName);
  61.     }
  63.     /**
  64.      * Create an instance from a document editable
  65.      *
  66.      * @param Editable $editable
  67.      *
  68.      * @return BlockName
  69.      */
  70.     public static function createFromEditable(Editable $editable): BlockName
  71.     {
  72.         return new self($editable->getName(), $editable->getRealName());
  73.     }
  75.     /**
  76.      * @return string
  77.      */
  78.     public function getName(): string
  79.     {
  80.         return $this->name;
  81.     }
  83.     /**
  84.      * @return string
  85.      */
  86.     public function getRealName(): string
  87.     {
  88.         return $this->realName;
  89.     }
  91.     /**
  92.      * {@inheritdoc}
  93.      */
  94.     public function jsonSerialize()
  95.     {
  96.         return [
  97.             'name' => $this->name,
  98.             'realName' => $this->realName,
  99.         ];
  100.     }
  101. }