App\Services\Snippets\GalleryMasonryService

Complexity

Total Complexity

20

Size/Duplication

Total Lines	182
Duplicated Lines	0 %

Test Coverage

Coverage

8.2%

Importance

Changes	3
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getGalleryImages()	0	9	3
A	getGalleryNames()	0	7	2
A	prepareGalleryHtml()	0	27	6
A	postHasGallery()	0	6	2
A	createImagesArray()	0	19	2
A	snippetsToHTML()	0	30	4
A	getParameters()	0	13	1

<?php


namespace App\Services\Snippets;

/*
    This class show a Masonry (Pinterest like) responsive gallery.

    Example of snippet that evoke the plugin:
    {# gallery name=[pere] hover_animate=[true] #}

    The snippet can be placed in any blog post.

    The gallery is using this javascript plugin:
        // https://www.npmjs.com/package/justifiedGallery
        // http://miromannino.github.io/Justified-Gallery/
        // Options: http://miromannino.github.io/Justified-Gallery/options-and-events/
*/

use App\Helpers\Helper;
use App\Models\Post;

class GalleryMasonryService
{

  /**
   *  Substitute gallery snippets with the related HTML
   *
   * @param  string  $postBody
   * @param  \App\Models\Post  $post
   *
   * @return string
   */
    public function snippetsToHTML(string $postBody, Post $post): string
    {
        // Find snippet occurrences
        //$ptn = '/{# +gallery +(name|width)=\[(.*)\] +(name|width)=\[(.*)\] +(name|width)=\[(.*)\] +#}/';
        $ptn = '/{# +gallery +(name|hover_animate)=\[(.*)\] +(name|hover_animate)=\[(.*)\] +#}/';

        if (preg_match_all($ptn, $postBody, $matches)) {
            // Transform the matches array in a way that can be used
            $matches = Helper::turnArray($matches);

            foreach ($matches as $key => $single_gallery_matches) {
                $parameters = $this->getParameters($single_gallery_matches);

                if (self::postHasGallery($post, $parameters['gallery_name'])) {

The method App\Services\Snippets\GalleryMasonryService::postHasGallery() is not static, but was called statically.

                    $images = $this->createImagesArray($post, $parameters['gallery_name']);
                    $galleryHtml = $this->prepareGalleryHtml($images, $parameters['hover_animate']);
                } else {
                    $galleryHtml = "<div class='p-4 bg-yellow-200' role='alert'>A gallery with this name not available for this element</div>";
                }

                $galleryHtml .= "</div>";

                // Replace the TOKEN found in the article with the generatd gallery HTML
                $postBody = str_replace($parameters['token'], $galleryHtml, $postBody);
            }
        } else {
            $postBody = $postBody;
        }

        return $postBody;
    }

    /**
     *  Returns the plugin parameters.
     *
     * @param array $matches
     *
     * @return array $ret
     */
    public function getParameters(array $matches): array
    {
        $ret = [];
        //ray($matches);

        // Get activation string parameters (from article)
        $ret['token'] = $matches[0];

        $ret['gallery_name'] = $matches[2];
        $ret['hover_animate'] = filter_var($matches[4], FILTER_VALIDATE_BOOLEAN);

        //ray($ret);
        return $ret;
    }

    /**
     *  Returns true if the post has the specified gallery.
     *
     * @param \App\Models\Post $post
     * @param string $galleryName
     *
     * @return bool $ret
     */
    public function postHasGallery(Post $post, string $galleryName): bool
    {
        if (in_array($galleryName, self::getGalleryNames($post))) {

The method App\Services\Snippets\GalleryMasonryService::getGalleryNames() is not static, but was called statically.

            return true;
        }
        return false;
    }

    /**
     * Return the array with the gallery names.
     * The gallery names are set as an image property.
     *
     * @param \App\Models\Post $post
     *
     * @return array
     */
    public function getGalleryNames(Post $post): array
    {
        $galleries = [];
        foreach ($post->getMedia('images') as $image) {
            $galleries[$image->getCustomProperty('image_gallery')] = $image->getCustomProperty('image_gallery');
        }
        return array_values($galleries);
    }

    /**
     * Return the array with the gallery images.
     *
     * @param \App\Models\Post $post
     * @param string $galleryName
     *
     * @return array
     */
    public function getGalleryImages(Post $post, string $galleryName): array
    {
        $galleryImages = [];
        foreach ($post->getMedia('images') as $image) {
            if ($image->getCustomProperty('image_gallery') == $galleryName) {
                $galleryImages[] = $image;
            }
        }
        return $galleryImages;
    }


    /**
     *  Create images array.
     *
     * @param \App\Models\Post $post
     * @param string $galleryName
     *
     * @return array $ret    array with the images datas
     */
    public function createImagesArray(Post $post, string $galleryName): array
    {
        $images = self::getGalleryImages($post, $galleryName);

The method App\Services\Snippets\GalleryMasonryService::getGalleryImages() is not static, but was called statically.

        // Order by image name
        //sort($image_files);

        $ret = [];

        foreach ($images as $k => $image) {
            $ret[$k]['file_path'] = $image->getUrl();
            $ret[$k]['thumb_path'] = $image->getUrl('thumb');

            $ret[$k]['description'] = $image->getCustomProperty('image_description');
            $ret[$k]['video_link'] = $image->getCustomProperty('image_video_url');
            $ret[$k]['caption'] = $image->getCustomProperty('image_caption');
        }

        return $ret;
    }

    /**
     *  Prepare the gallery HTML.
     *
     * @param array $images
     * @param bool $hoverAnimate
     *
     * @return string $ret
     */
    public function prepareGalleryHtml(array $images, bool $hoverAnimate): string
    {
        // Animate item on hover
        $itemClass = ($hoverAnimate) ? 'transform transition hover:scale-110 motion-reduce:transform-none duration-500' : '';

        // Create Grid—A—Licious grid (id=devices) and print images
        $ret = "<div class='lifeGallery'>";

        foreach ($images as $k => $image) {
            // Get item link
            $imageLink = ($image['video_link'] == null) ? $image['file_path'] : $image['video_link'];
            $videoPlayIcon = ($image['video_link'] == null) ? '' : "<svg class='absolute w-14 fill-current text-white inset-center opacity-80' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'><path d='M371.7 238l-176-107c-15.8-8.8-35.7 2.5-35.7 21v208c0 18.4 19.8 29.8 35.7 21l176-101c16.4-9.1 16.4-32.8 0-42zM504 256C504 119 393 8 256 8S8 119 8 256s111 248 248 248 248-111 248-248zm-448 0c0-110.5 89.5-200 200-200s200 89.5 200 200-89.5 200-200 200S56 366.5 56 256z'/></svg>";

            $ret .= "<div class='item " . $itemClass . "'>";
            $ret .= "<a href='" . $imageLink . "' data-fancybox='images' data-caption='" . $image['description'] . "'>";
            $ret .= "<img src='" . asset($image['thumb_path']) . "' />";
            $ret .= $videoPlayIcon;
            $ret .= "</a>";
            if ($image['caption']) {
                $ret .= "<div class='jg-caption'>" . $image['caption'] . "</div>";
            }
            $ret .= "</div>";
        }

        $ret .= '</div>';

        return $ret;
    }

}