get('pimcore.implementation_loader.document.tag');
/** @var Tag $tag */
$tag = $loader->build($type);
$tag->setName($name);
$tag->setDocumentId($documentId);
$tag->setController($controller);
if (!$view) {
// needed for the RESTImporter. For areabricks define a default implementation. Otherwise cannot find a tag handler.
$view = new ViewModel();
}
$tag->setView($view);
$tag->setEditmode($editmode);
$tag->setOptions($config);
return $tag;
}
/**
* @return string
*/
public function admin()
{
$options = $this->getEditmodeOptions();
$code = $this->outputEditmodeOptions($options, true);
$attributes = $this->getEditmodeElementAttributes($options);
$attributeString = HtmlUtils::assembleAttributeString($attributes);
$code .= ('');
return $code;
}
/**
* Builds options passed to editmode frontend as JSON config
*
* @return array
*/
protected function getEditmodeOptions(): array
{
$options = [
'id' => 'pimcore_editable_' . $this->getName(),
'name' => $this->getName(),
'realName' => $this->getRealName(),
'options' => $this->getOptions(),
'data' => $this->getEditmodeData(),
'type' => $this->getType(),
'inherited' => $this->getInherited()
];
return $options;
}
/**
* Builds data used for editmode
*
* @return mixed
*/
protected function getEditmodeData()
{
// get configuration data for admin
if (method_exists($this, 'getDataEditmode')) {
$data = $this->getDataEditmode();
} else {
$data = $this->getData();
}
return $data;
}
/**
* Builds attributes used on the editmode HTML element
*
* @param array $options
*
* @return array
*/
protected function getEditmodeElementAttributes(array $options): array
{
if (!isset($options['id'])) {
throw new \RuntimeException(sprintf('Expected an "id" option to be set on the "%s" editable options array', $this->getName()));
}
$attributes = array_merge($this->getEditmodeBlockStateAttributes(), [
'id' => $options['id'],
'class' => implode(' ', $this->getEditmodeElementClasses()),
]);
return $attributes;
}
protected function getEditmodeBlockStateAttributes(): array
{
$blockState = $this->getBlockState();
$blockNames = array_map(function (BlockName $blockName) {
return $blockName->getRealName();
}, $blockState->getBlocks());
$attributes = [
'data-name' => $this->getName(),
'data-real-name' => $this->getRealName(),
'data-type' => $this->getType(),
'data-block-names' => implode(', ', $blockNames),
'data-block-indexes' => implode(', ', $blockState->getIndexes())
];
return $attributes;
}
/**
* Builds classes used on the editmode HTML element
*
* @return array
*/
protected function getEditmodeElementClasses(): array
{
$classes = [
'pimcore_editable',
'pimcore_tag_' . $this->getType()
];
$editableOptions = $this->getOptions();
if (isset($editableOptions['class'])) {
if (is_array($editableOptions['class'])) {
$classes = array_merge($classes, $editableOptions['class']);
} else {
$classes[] = (string)$editableOptions['class'];
}
$classes[] = (string)$editableOptions['class'];
}
return $classes;
}
/**
* Sends data to the output stream
*
* @param string $value
*/
protected function outputEditmode($value)
{
if ($this->getEditmode()) {
echo $value . "\n";
}
}
/**
* Push editmode options into the JS config array
*
* @param array $options
* @param bool $return
*
* @return string
*/
protected function outputEditmodeOptions(array $options, $return = false)
{
$code = '
';
if ($return) {
return $code;
}
$this->outputEditmode($code);
}
/**
* @return mixed
*/
public function getValue()
{
return $this->getData();
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* @param string $name
*
* @return $this
*/
public function setName($name)
{
$this->name = $name;
return $this;
}
/**
* @param int $id
*
* @return $this
*/
public function setDocumentId($id)
{
$this->documentId = (int) $id;
return $this;
}
/**
* @return int
*/
public function getDocumentId()
{
return $this->documentId;
}
/**
* @return array
*/
public function getOptions()
{
return is_array($this->options) ? $this->options : [];
}
/**
* @param array $options
*
* @return $this
*/
public function setOptions($options)
{
$this->options = $options;
return $this;
}
/**
* @param \Pimcore\Controller\Action $controller
*
* @return $this
*/
public function setController($controller)
{
$this->controller = $controller;
return $this;
}
/**
* @return \Pimcore\Controller\Action
*/
public function getController()
{
return $this->controller;
}
/**
* @param ViewModelInterface|View $view
*
* @return $this
*/
public function setView($view)
{
$this->view = $view;
return $this;
}
/**
* @return ViewModelInterface|View
*/
public function getView()
{
return $this->view;
}
/**
* @return string
*/
public function getRealName()
{
return $this->realName;
}
/**
* @param string $realName
*/
public function setRealName($realName)
{
$this->realName = $realName;
}
final public function setParentBlockNames(array $parentNames)
{
$this->parentBlockNames = $parentNames;
}
final public function getParentBlockNames(): array
{
return $this->parentBlockNames;
}
/**
* Returns only the properties which should be serialized
*
* @return array
*/
public function __sleep()
{
// here the "normal" task of __sleep ;-)
$blockedVars = ['dao', 'controller', 'view', 'editmode', 'options'];
$vars = get_object_vars($this);
foreach ($vars as $key => $value) {
if (!in_array($key, $blockedVars)) {
$finalVars[] = $key;
}
}
return $finalVars;
}
/**
* direct output to the frontend
*
* @return string
*/
public function __toString()
{
$result = '';
try {
if ($this->editmode) {
$result = $this->admin();
} else {
$result = $this->frontend();
}
} catch (\Throwable $e) {
if (\Pimcore::inDebugMode()) {
// the __toString method isn't allowed to throw exceptions
$result = '' . $e->getMessage().'
'.$e->getTraceAsString();
return $result;
}
Logger::error('toString() returned an exception: {exception}', [
'exception' => $e
]);
return '';
}
if (is_string($result) || is_numeric($result)) {
// we have to cast to string, because int/float is not auto-converted and throws an exception
return (string) $result;
}
return '';
}
/**
* @return bool
*/
public function getEditmode()
{
return $this->editmode;
}
/**
* @param bool $editmode
*
* @return $this
*/
public function setEditmode($editmode)
{
$this->editmode = (bool) $editmode;
return $this;
}
/**
* @return $this
*/
public function getDataForResource()
{
$this->checkValidity();
return $this->getData();
}
/**
* @param $ownerDocument
* @param array $tags
*
* @return array
*/
public function getCacheTags($ownerDocument, $tags = [])
{
return $tags;
}
/**
* This is a dummy and is mostly implemented by relation types
*/
public function resolveDependencies()
{
return [];
}
/**
* Receives a standard class object from webservice import and fills the current tag's data
*
* @abstract
*
* @param Webservice\Data\Document\Element $wsElement
* @param $document
* @param array $params,
* @param $idMapper
* @param mixed $params
*
* @return Webservice\Data\Document\Element
*/
public function getFromWebserviceImport($wsElement, $document = null, $params = [], $idMapper = null)
{
return $wsElement;
}
/**
* Returns the current tag's data for web service export
*
* @param $document
* @param mixed $params
* @abstract
*
* @return array
*/
public function getForWebserviceExport($document = null, $params = [])
{
$keys = get_object_vars($this);
$el = [];
foreach ($keys as $key => $value) {
if ($value instanceof Model\Element\ElementInterface) {
$value = $value->getId();
}
$className = Webservice\Data\Mapper::findWebserviceClass($value, 'out');
$el[$key] = Webservice\Data\Mapper::map($value, $className, 'out');
}
unset($el['dao']);
unset($el['documentId']);
unset($el['controller']);
unset($el['view']);
unset($el['editmode']);
$el = Webservice\Data\Mapper::toObject($el);
return $el;
}
/**
* @return bool
*/
public function checkValidity()
{
return true;
}
/**
* @param $inherited
*
* @return $this
*/
public function setInherited($inherited)
{
$this->inherited = $inherited;
return $this;
}
/**
* @return bool
*/
public function getInherited()
{
return $this->inherited;
}
/**
* TODO inject block state via DI
*
* @return BlockState
*/
protected function getBlockState(): BlockState
{
return \Pimcore::getContainer()->get('pimcore.document.tag.block_state_stack')->getCurrentState();
}
/**
* Builds a tag name for an editable, taking current
* block state (block, index) and targeting into account.
*
* @param string $type
* @param string $name
* @param Document|null $document
*
* @return string
*
* @throws \Exception
*/
public static function buildTagName(string $type, string $name, Document $document = null)
{
// do NOT allow dots (.) and colons (:) here as they act as delimiters
// for block hierarchy in the new naming scheme (see #1467)!
if (!preg_match("@^[a-zA-Z0-9\-_]+$@", $name)) {
throw new \InvalidArgumentException(
'Only valid CSS class selectors are allowed as the name for an editable (which is basically [a-zA-Z0-9\-_]+). Your name was: ' . $name
);
}
// @todo add document-id to registry key | for example for embeded snippets
// set suffixes if the tag is inside a block
$container = \Pimcore::getContainer();
$blockState = $container->get('pimcore.document.tag.block_state_stack')->getCurrentState();
$namingStrategy = $container->get('pimcore.document.tag.naming.strategy');
// if element not nested inside a hierarchical element (e.g. block), add the
// targeting prefix if configured on the document. hasBlocks() determines if
// there are any parent blocks for the current element
if ($document && $document instanceof TargetingDocumentInterface && !$blockState->hasBlocks()) {
$name = $document->getTargetGroupElementName($name);
}
$tagName = $namingStrategy->buildTagName($name, $type, $blockState);
$event = new TagNameEvent($type, $name, $blockState, $tagName, $document);
\Pimcore::getEventDispatcher()->dispatch(DocumentEvents::TAG_NAME, $event);
$tagName = $event->getTagName();
if (strlen($tagName) > 750) {
throw new \Exception(sprintf(
'Composite name for editable "%s" is longer than 750 characters. Use shorter names for your editables or reduce amount of nesting levels. Name is: %s',
$name,
$tagName
));
}
return $tagName;
}
public static function buildTagRealName(string $name, Document $document): string
{
$container = \Pimcore::getContainer();
$blockState = $container->get('pimcore.document.tag.block_state_stack')->getCurrentState();
// if element not nested inside a hierarchical element (e.g. block), add the
// targeting prefix if configured on the document. hasBlocks() determines if
// there are any parent blocks for the current element
if ($document instanceof TargetingDocumentInterface && !$blockState->hasBlocks()) {
$name = $document->getTargetGroupElementName($name);
}
return $name;
}
}