PrintCatalogExtension.php

<?php

/**
 * Studio1 Kommunikation GmbH
 *
 * This source file is available under following license:
 * - GNU General Public License v3.0 (GNU GPLv3)
 *
 *  @copyright  Copyright (c) Studio1 Kommunikation GmbH (http://www.studio1.de)
 *  @license    https://www.gnu.org/licenses/gpl-3.0.txt
 */

namespace Studio1\Web2PrintBricksBundle\Twig\Extension;

use Pimcore\Model\Asset\Image;
use Pimcore\Model\DataObject\ClassDefinition\Data\Hotspotimage;
use Pimcore\Model\DataObject\ClassDefinition\Data\ImageGallery;
use Pimcore\Model\DataObject\ClassDefinition\Data\ManyToManyObjectRelation;
use Pimcore\Model\DataObject\ClassDefinition\Data\ManyToOneRelation;
use Pimcore\Model\DataObject\ClassDefinition\Data\Multiselect;
use Pimcore\Model\DataObject\ClassDefinition\Data\Select;
use Pimcore\Model\Element\AbstractElement;
use Pimcore\Translation\Translator;
use Pimcore\Twig\Extension\Templating\Placeholder;
use Studio1\UtilityBundle\Utility\String\StringUtils;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

class PrintCatalogExtension extends AbstractExtension
{
    /**
     * @var Translator
     */
    protected $translator;

    /**
     * @var Placeholder
     */
    protected $placeholderHelper;

    /**
     * PrintCatalogExtension constructor.
     *
     * @param Translator $translator
     * @param Placeholder $placeholderHelper
     */
    public function __construct(Translator $translator, Placeholder $placeholderHelper)
    {
        $this->translator = $translator;
        $this->placeholderHelper = $placeholderHelper;
    }

    /**
     * @return TwigFunction[]
     */
    public function getFunctions()
    {
        return [
            new TwigFunction('app_print_output_spec_value', [$this, 'getSpecValue']),
            new TwigFunction('app_print_create_register', [$this, 'createRegisterTitleStyling']),
            new TwigFunction('app_print_get_register_name', [$this, 'getRegisterName'])
        ];
    }

    public function getSpecValue(\stdClass $outputElement, string $thumbnailName = null): string
    {
        if ($outputElement->value instanceof Image) {
            return $this->printImage($outputElement->value, $thumbnailName);
        } elseif (($outputElement->def ?? null) instanceof ImageGallery) {
            return $this->printImageGallery($outputElement->value, $thumbnailName);
        } elseif (($outputElement->def ?? null) instanceof Hotspotimage) {
            return $this->printHotspotImage($outputElement->value, $thumbnailName);
        } elseif (($outputElement->def ?? null) instanceof Select) {
            return $this->printSelectValue($outputElement->value);
        } elseif (($outputElement->def ?? null) instanceof Multiselect) {
            return $this->printMultiSelectValue($outputElement->value);
        } elseif (($outputElement->def ?? null) instanceof ManyToOneRelation) {
            return $this->printManyToOne($outputElement->value);
        } elseif (($outputElement->def ?? null) instanceof ManyToManyObjectRelation) {
            return $this->printManyToManyObjects($outputElement->value);
        } else {
            return (string)$outputElement->value;
        }
    }

    /**
     * @param Image $image
     * @param string $thumbnailName
     *
     * @return string
     */
    protected function printImage(Image $image, string $thumbnailName): string
    {
        $src = $thumbnailName ? $image->getThumbnail($thumbnailName) : $image->getFullPath();

        return "<img src='$src' alt='image' />";
    }

    /**
     * @param \Pimcore\Model\DataObject\Data\ImageGallery $imageGallery
     * @param string $thumbnailName
     *
     * @return string
     */
    protected function printImageGallery(\Pimcore\Model\DataObject\Data\ImageGallery $imageGallery, string $thumbnailName): string
    {
        $firstItem = $imageGallery->current();
        if ($firstItem && $firstItem->getImage()) {
            return $this->printImage($firstItem->getImage(), $thumbnailName);
        }

        return '';
    }

    /**
     * @param \Pimcore\Model\DataObject\Data\Hotspotimage $hotspotimage
     * @param string $thumbnailName
     *
     * @return string
     */
    protected function printHotspotImage(\Pimcore\Model\DataObject\Data\Hotspotimage $hotspotimage, string $thumbnailName): string
    {
        $image = $hotspotimage->getImage();
        if ($image) {
            return "<img src='{$hotspotimage->getThumbnail($thumbnailName)}' alt='image' />";
        }
    }

    /**
     * @param string $value
     *
     * @return string
     */
    protected function printSelectValue(string $value): string
    {
        return $this->translator->trans('attribute.' . strtolower($value));
    }

    /**
     * @param array|null $value
     *
     * @return string
     */
    protected function printMultiSelectValue(?array $value = null): string
    {
        $result = [];
        if ($value) {
            foreach ($value as $v) {
                $result[] = $this->translator->trans('attribute.' . strtolower($v));
            }
        }

        return implode(', ', $result);
    }

    /**
     * @param array $value
     *
     * @return string
     */
    protected function printManyToManyObjects(array $value): string
    {
        $result = [];
        if ($value) {
            foreach ($value as $v) {
                if (method_exists($v, 'getName')) {
                    $result[] = $v->getName();
                }
            }
        }

        return implode(', ', $result);
    }

    /**
     * @param AbstractElement|null $element
     *
     * @return string
     */
    protected function printManyToOne(?AbstractElement $element = null): string
    {
        if ($element && method_exists($element, 'getName')) {
            return $element->getName();
        }

        return '';
    }

    /**
     * @param string|null $name
     * @param string|null $registerType
     */
    public function createRegisterTitleStyling(?string $name, ?string $registerType = '')
    {
        $key = $this->getRegisterName($name);

        if ($name) {
            $this->placeholderHelper->__invoke('register-title-definition')->append("

                @page $key:right {
                    @left-top {
                        content: xhtml(\"<div class='register left register-$registerType'>$name</div>\");
                        z-index: 2000;
                    }
                }

                @page $key:left {
                    @right-top {
                        content: xhtml(\"<div class='register register-$registerType'>$name</div>\");
                        z-index: 2000;
                    }
                }

                .page.$key {
                    page: $key;
                }

        ");
        }
    }

    /**
     * @param string|null $name
     *
     * @return string
     */
    public function getRegisterName(?string $name)
    {
        return StringUtils::toUrl((string)$name);
    }
}