Symfony Profiler

<?php
/*
* This file is part of Sulu.
*
* (c) Sulu GmbH
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace Sulu\Component\Content\Document\Subscriber;
use PHPCR\NodeInterface;
use Sulu\Bundle\DocumentManagerBundle\Bridge\DocumentInspector;
use Sulu\Component\Content\Compat\Structure\LegacyPropertyFactory;
use Sulu\Component\Content\ContentTypeManagerInterface;
use Sulu\Component\Content\Document\Behavior\LocalizedStructureBehavior;
use Sulu\Component\Content\Document\Behavior\ShadowLocaleBehavior;
use Sulu\Component\Content\Document\Behavior\StructureBehavior;
use Sulu\Component\Content\Document\LocalizationState;
use Sulu\Component\Content\Document\Structure\ManagedStructure;
use Sulu\Component\Content\Document\Structure\Structure;
use Sulu\Component\Content\Document\Structure\StructureInterface;
use Sulu\Component\Content\Document\Subscriber\PHPCR\SuluNode;
use Sulu\Component\Content\Exception\MandatoryPropertyException;
use Sulu\Component\DocumentManager\Event\AbstractMappingEvent;
use Sulu\Component\DocumentManager\Event\ConfigureOptionsEvent;
use Sulu\Component\DocumentManager\Event\PersistEvent;
use Sulu\Component\DocumentManager\Events;
use Sulu\Component\DocumentManager\PropertyEncoder;
use Sulu\Component\Webspace\Manager\WebspaceManagerInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
class StructureSubscriber implements EventSubscriberInterface
{
public const STRUCTURE_TYPE_FIELD = 'template';
/**
* @var ContentTypeManagerInterface
*/
private $contentTypeManager;
/**
* @var DocumentInspector
*/
private $inspector;
/**
* @var LegacyPropertyFactory
*/
private $legacyPropertyFactory;
/**
* @var PropertyEncoder
*/
private $encoder;
/**
* @var WebspaceManagerInterface
*/
private $webspaceManager;
/**
* @var array
*/
private $defaultTypes;
/**
* @param array $defaultTypes
*/
public function __construct(
PropertyEncoder $encoder,
ContentTypeManagerInterface $contentTypeManager,
DocumentInspector $inspector,
LegacyPropertyFactory $legacyPropertyFactory,
WebspaceManagerInterface $webspaceManager,
$defaultTypes
) {
$this->encoder = $encoder;
$this->contentTypeManager = $contentTypeManager;
$this->inspector = $inspector;
$this->legacyPropertyFactory = $legacyPropertyFactory;
$this->webspaceManager = $webspaceManager;
$this->defaultTypes = $defaultTypes;
}
public static function getSubscribedEvents()
{
return [
Events::PERSIST => [
// persist should happen before content is mapped
['saveStructureData', 0],
// staged properties must be commited before title subscriber
['handlePersistStagedProperties', 50],
// setting the structure should happen very early
['handlePersistStructureType', 100],
],
Events::PUBLISH => 'saveStructureData',
// hydrate should happen afterwards
Events::HYDRATE => ['handleHydrate', 0],
Events::CONFIGURE_OPTIONS => 'configureOptions',
];
}
public function configureOptions(ConfigureOptionsEvent $event)
{
$options = $event->getOptions();
$options->setDefaults(
[
'load_ghost_content' => true,
'clear_missing_content' => false,
'ignore_required' => false,
'structure_type' => null,
]
);
$options->setAllowedTypes('load_ghost_content', 'bool');
$options->setAllowedTypes('clear_missing_content', 'bool');
$options->setAllowedTypes('ignore_required', 'bool');
}
/**
* Set the structure type early so that subsequent subscribers operate
* upon the correct structure type.
*/
public function handlePersistStructureType(PersistEvent $event)
{
$document = $event->getDocument();
if (!$this->supportsBehavior($document)) {
return;
}
$structureMetadata = $this->inspector->getStructureMetadata($document);
$structure = $document->getStructure();
if ($structure instanceof ManagedStructure) {
$structure->setStructureMetadata($structureMetadata);
}
}
/**
* Commit the properties, which are only staged on the structure yet.
*/
public function handlePersistStagedProperties(PersistEvent $event)
{
$document = $event->getDocument();
if (!$this->supportsBehavior($document)) {
return;
}
$document->getStructure()->commitStagedData($event->getOption('clear_missing_content'));
}
public function handleHydrate(AbstractMappingEvent $event)
{
$document = $event->getDocument();
if (!$this->supportsBehavior($document)) {
return;
}
$rehydrate = $event->getOption('rehydrate');
$structureType = $this->getStructureType($event, $document, $rehydrate);
$document->setStructureType($structureType);
if (false === $event->getOption('load_ghost_content', false)) {
if (LocalizationState::GHOST === $this->inspector->getLocalizationState($document)) {
$structureType = null;
}
}
$structure = $this->getStructure($document, $structureType, $rehydrate);
// Set the property container
$event->getAccessor()->set(
'structure',
$structure
);
}
public function saveStructureData(AbstractMappingEvent $event)
{
// Set the structure type
$document = $event->getDocument();
if (!$this->supportsBehavior($document)) {
return;
}
if (!$document->getStructureType()) {
return;
}
if (!$event->getLocale()) {
return;
}
$node = $event->getNode();
$locale = $event->getLocale();
$options = $event->getOptions();
$this->mapContentToNode($document, $node, $locale, $options['ignore_required']);
$node->setProperty(
$this->getStructureTypePropertyName($document, $locale),
$document->getStructureType()
);
}
/**
* @param bool $rehydrate
*
* @return string
*/
private function getStructureType(AbstractMappingEvent $event, StructureBehavior $document, $rehydrate)
{
$structureType = $event->getOption('structure_type');
if ($structureType) {
return $structureType;
}
$node = $event->getNode();
$locale = $event->getLocale();
if ($document instanceof ShadowLocaleBehavior && $document->isShadowLocaleEnabled()) {
$locale = $document->getOriginalLocale();
}
$propertyName = $this->getStructureTypePropertyName($document, $locale);
$structureType = $node->getPropertyValueWithDefault($propertyName, null);
if (!$structureType && $rehydrate) {
return $this->getDefaultStructureType($document);
}
return $structureType;
}
/**
* Return the default structure for the given StructureBehavior implementing document.
*
* @return string
*/
private function getDefaultStructureType(StructureBehavior $document)
{
$alias = $this->inspector->getMetadata($document)->getAlias();
$webspace = $this->webspaceManager->findWebspaceByKey($this->inspector->getWebspace($document));
if (!$webspace) {
return $this->getDefaultStructureTypeFromConfig($alias);
}
return $webspace->getDefaultTemplate($alias);
}
/**
* Returns configured "default_type".
*
* @param string $alias
*
* @return string
*/
private function getDefaultStructureTypeFromConfig($alias)
{
if (!\array_key_exists($alias, $this->defaultTypes)) {
return;
}
return $this->defaultTypes[$alias];
}
private function supportsBehavior($document)
{
return $document instanceof StructureBehavior;
}
private function getStructureTypePropertyName($document, $locale)
{
if ($document instanceof LocalizedStructureBehavior) {
return $this->encoder->localizedSystemName(self::STRUCTURE_TYPE_FIELD, $locale);
}
// TODO: This is the wrong namespace, it should be the system namespcae, but we do this for initial BC
return $this->encoder->contentName(self::STRUCTURE_TYPE_FIELD);
}
/**
* @return ManagedStructure
*/
private function createStructure($document)
{
return new ManagedStructure(
$this->contentTypeManager,
$this->legacyPropertyFactory,
$this->inspector,
$document
);
}
/**
* Map to the content properties to the node using the content types.
*
* @param string $locale
* @param bool $ignoreRequired
*
* @throws MandatoryPropertyException
* @throws \RuntimeException
*/
private function mapContentToNode($document, NodeInterface $node, $locale, $ignoreRequired)
{
$structure = $document->getStructure();
$webspaceName = $this->inspector->getWebspace($document);
$metadata = $this->inspector->getStructureMetadata($document);
if (!$metadata) {
throw new \RuntimeException(
\sprintf(
'Metadata for Structure Type "%s" was not found, does the file "%s.xml" exists?',
$document->getStructureType(),
$document->getStructureType()
)
);
}
foreach ($metadata->getProperties() as $propertyName => $structureProperty) {
if (TitleSubscriber::PROPERTY_NAME === $propertyName) {
continue;
}
$realProperty = $structure->getProperty($propertyName);
$value = $realProperty->getValue();
if (false === $ignoreRequired && $structureProperty->isRequired() && null === $value) {
throw new MandatoryPropertyException(
\sprintf(
'Property "%s" in structure "%s" is required but no value was given. Loaded from "%s"',
$propertyName,
$metadata->getName(),
$metadata->getResource()
)
);
}
$contentTypeName = $structureProperty->getType();
$contentType = $this->contentTypeManager->get($contentTypeName);
// TODO: Only write if the property has been modified.
$legacyProperty = $this->legacyPropertyFactory->createTranslatedProperty($structureProperty, $locale);
$legacyProperty->setValue($value);
$contentType->write(
new SuluNode($node),
$legacyProperty,
null,
$webspaceName,
$locale,
null
);
}
}
/**
* Return the a structure for the document.
*
* - If the Structure already exists on the document, use that.
* - If the Structure type is given, then create a ManagedStructure - this
* means that the structure is already persisted on the node and it has data.
* - If none of the above applies then create a new, empty, Structure.
*
* @param object $document
* @param string $structureType
* @param bool $rehydrate
*
* @return StructureInterface
*/
private function getStructure($document, $structureType, $rehydrate)
{
if ($structureType) {
return $this->createStructure($document);
}
if (!$rehydrate && $document->getStructure()) {
return $document->getStructure();
}
return new Structure();
}
}

vendor/sulu/sulu/src/Sulu/Component/Content/Document/Subscriber/StructureSubscriber.php line 175