Completed
Pull Request — 1.5 (#768)
by Paweł
12:16
created

EmbeddedImageProcessor::supports()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
1
<?php
2
3
declare(strict_types=1);
4
5
/*
6
 * This file is part of the Superdesk Web Publisher Content Bundle.
7
 *
8
 * Copyright 2018 Sourcefabric z.ú. and contributors.
9
 *
10
 * For the full copyright and license information, please see the
11
 * AUTHORS and LICENSE files distributed with this source code.
12
 *
13
 * @copyright 2018 Sourcefabric z.ú
14
 * @license http://www.superdesk.org/license
15
 */
16
17
namespace SWP\Bundle\ContentBundle\Processor;
18
19
use SWP\Bundle\ContentBundle\File\FileExtensionCheckerInterface;
20
use SWP\Bundle\ContentBundle\Manager\MediaManagerInterface;
21
use SWP\Bundle\ContentBundle\Model\ArticleInterface;
22
use SWP\Bundle\ContentBundle\Model\ArticleMediaInterface;
23
use SWP\Bundle\ContentBundle\Model\ImageRendition;
24
use Symfony\Component\DomCrawler\Crawler;
25
26
class EmbeddedImageProcessor implements EmbeddedImageProcessorInterface
27
{
28
    private const DEFAULT_ARTICLE_BODY_IMAGE_RENDITION = 'original';
29
30
    /**
31
     * @var MediaManagerInterface
32
     */
33
    private $mediaManager;
34
35
    /**
36
     * @var FileExtensionCheckerInterface
37
     */
38
    private $fileExtensionChecker;
39
40
    /**
41
     * @var string
42
     */
43
    private $defaultImageRendition;
44
45
    public function __construct(MediaManagerInterface $mediaManager, FileExtensionCheckerInterface $fileExtensionChecker)
46
    {
47
        $this->mediaManager = $mediaManager;
48
        $this->fileExtensionChecker = $fileExtensionChecker;
49
    }
50
51
    public function process(ArticleInterface $article, ArticleMediaInterface $articleMedia): void
52
    {
53
        $body = $article->getBody();
54
        $mediaId = str_replace('/', '\\/', $articleMedia->getKey());
55
56
        preg_match(
57
            "/(<!-- ?EMBED START Image {id: \"$mediaId\"} ?-->)(.+?)(<!-- ?EMBED END Image {id: \"$mediaId\"} ?-->)/im",
58
            str_replace(PHP_EOL, '', $body),
59
            $embeds
60
        );
61
62
        if (empty($embeds)) {
63
            return;
64
        }
65
66
        $figureString = $embeds[2];
67
        $crawler = new Crawler($figureString);
68
        $images = $crawler->filter('figure img');
69
70
        /** @var \DOMElement $imageElement */
71
        foreach ($images as $imageElement) {
72
            /** @var ImageRendition $rendition */
73
            foreach ($articleMedia->getRenditions() as $rendition) {
74
                if ($this->getDefaultImageRendition() === $rendition->getName()) {
75
                    $this->processImageElement($imageElement, $rendition, $mediaId);
76
                }
77
            }
78
        }
79
80
        $figCaptionNode = $crawler->filter('figure figcaption')->getNode(0);
81
        if (null !== $figCaptionNode) {
82
            $this->appendImageByline($articleMedia, $figCaptionNode);
83
        }
84
85
        $article->setBody(str_replace($figureString, $crawler->filter('body')->html(), $body));
86
    }
87
88
    public function setDefaultImageRendition(string $renditionName): void
89
    {
90
        $this->defaultImageRendition = $renditionName;
91
    }
92
93
    public function supports(string $type): bool
94
    {
95
        return $this->fileExtensionChecker->isImage($type);
96
    }
97
98
    private function appendImageByline(ArticleMediaInterface $articleMedia, \DOMElement $figCaptionNode): void
99
    {
100
        $element = new \DOMElement('span');
101
        $figCaptionNode->appendChild($element);
102
103
        $authorDiv = $figCaptionNode->childNodes[1];
104
        $authorDiv->textContent = $this->applyByline($articleMedia);
105
    }
106
107
    public function applyByline(ArticleMediaInterface $articleMedia): string
108
    {
109
        return $articleMedia->getByLine();
110
    }
111
112
    protected function processImageElement(\DOMElement $imageElement, ImageRendition $rendition, string $mediaId): void
113
    {
114
        $attributes = $imageElement->attributes;
115
        $altAttribute = null;
116
        if ($imageElement->hasAttribute('alt')) {
117
            $altAttribute = $attributes->getNamedItem('alt');
118
        }
119
120
        while ($attributes->length) {
0 ignored issues
show
Bug introduced by
The property length does not seem to exist in DOMNamedNodeMap.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
121
            $imageElement->removeAttribute($attributes->item(0)->name);
0 ignored issues
show
Bug introduced by
The property name does not seem to exist in DOMNode.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
122
        }
123
124
        $imageElement->setAttribute('src', $this->mediaManager->getMediaUri($rendition->getImage()));
125
        $imageElement->setAttribute('data-media-id', $mediaId);
126
        $imageElement->setAttribute('data-image-id', $rendition->getImage()->getAssetId());
127
        $imageElement->setAttribute('data-rendition-name', $this->getDefaultImageRendition());
128
        $imageElement->setAttribute('width', (string) $rendition->getWidth());
129
        $imageElement->setAttribute('height', (string) $rendition->getHeight());
130
131
        if (null !== $altAttribute) {
132
            $imageElement->setAttribute('alt', $altAttribute->nodeValue);
133
        }
134
    }
135
136
    protected function getDefaultImageRendition(): string
137
    {
138
        if (null === $this->defaultImageRendition) {
139
            return self::DEFAULT_ARTICLE_BODY_IMAGE_RENDITION;
140
        }
141
142
        return $this->defaultImageRendition;
143
    }
144
}
145