DavideCasiraghi\ResponsiveGallery\ResponsiveGalleryFactory

Complexity

Total Complexity

30

Size/Duplication

Total Lines	309
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	prepareGallery()	0	22	4
A	getImageFiles()	0	5	1
A	get_files()	0	15	5
A	get_file_extension()	0	3	1
A	getPhotoDatasFromDb()	0	5	1
A	generateThumbs()	0	22	6
A	getGallery()	0	32	4
A	generate_single_thumb_file()	0	28	2
A	getGalleryParameters()	0	27	1
A	createImagesArray()	0	22	3
A	getGallerySnippetOccurrences()	0	13	2

<?php

namespace DavideCasiraghi\ResponsiveGallery;

use DavideCasiraghi\ResponsiveGallery\Models\GalleryImage;

class ResponsiveGalleryFactory
{
    /************************************************************************/

    /**
     *  Returns the plugin parameters.
     *  @param array $matches       result from the regular expression on the string from the article
     *  @return array $ret          the array containing the parameters
     **/
    public static function getGalleryParameters($matches, $publicPath)
    {
        $ret = [];

        // Get Paths
        $sitePath = '/';

The assignment to $sitePath is dead and can be removed.

        $siteUrl = $publicPath;

The assignment to $siteUrl is dead and can be removed.

        // Get activation string parameters (from article)
        $ret['token'] = $matches[0];
        $subDir = $matches[2];
        $ret['column_width'] = $matches[4];
        $ret['gutter'] = $matches[6];

        // Directories
        $ret['images_dir'] = $publicPath.'/'.$subDir.'/';
        $ret['thumbs_dir'] = $publicPath.'/'.$subDir.'/thumb/';

        // Thumbnails size
        $ret['thumbs_size']['width'] = 300;
        $ret['thumbs_size']['height'] = 300;

        // URL variables
        $ret['gallery_url'] = $subDir.'/';
        $ret['thumb_url'] = $subDir.'/thumbs/';

        return $ret;
    }

    /************************************************************************/

    /**
     *  Generate a single thumbnail file from an image.
     *  @param array $src               path of the original image
     *  @param array $dest              path of the generated thumbnail
     *  @param array $desired_width     width of the thumbnail
     *  @return create a file

The type DavideCasiraghi\ResponsiveGallery\create was not found. Maybe you did not declare it correctly or list all dependencies?

     **/
    public function generate_single_thumb_file($src, $dest, $desired_width, $desired_height)

The parameter $desired_width is not used and could be removed.

The parameter $desired_height is not used and could be removed.

    {
        // Read the source image
        $source_image = imagecreatefromjpeg($src);

$src of type array is incompatible with the type string expected by parameter $filename of imagecreatefromjpeg().

        // Get width and height of the original image
        $width = imagesx($source_image);
        $height = imagesy($source_image);

        // Horizontal image
        if ($width > $height) {
            $desired_width = 400;
            $desired_height = floor($height * ($desired_width / $width));
        }
        // Vertical image
        else {
            $desired_height = 500;
            $desired_width = floor($width * ($desired_height / $height));
        }

        // Create a new, "virtual" image
        $virtual_image = imagecreatetruecolor($desired_width, $desired_height);

It seems like $desired_height can also be of type double; however, parameter $height of imagecreatetruecolor() does only seem to accept integer, maybe add an additional type check?

It seems like $desired_width can also be of type double; however, parameter $width of imagecreatetruecolor() does only seem to accept integer, maybe add an additional type check?

        // Copy source image at a resized size
        imagecopyresampled($virtual_image, $source_image, 0, 0, 0, 0, $desired_width, $desired_height, $width, $height);

It seems like $desired_width can also be of type double; however, parameter $dst_w of imagecopyresampled() does only seem to accept integer, maybe add an additional type check?

It seems like $desired_height can also be of type double; however, parameter $dst_h of imagecopyresampled() does only seem to accept integer, maybe add an additional type check?

        //Create the physical thumbnail image to its destination
        imagejpeg($virtual_image, $dest);

$dest of type array is incompatible with the type string expected by parameter $filename of imagejpeg().

    }

    /************************************************************************/

    /**
     *  Generate all the thumbnails of the gallery.
     *  @param string $images_dir        images dir on the server
     *  @param string $thumbs_dir        thumb dir on the server
     *  @param string $$thumbs_size
     *  @param array $image_files
     *  @return generate thumbnail files

The type DavideCasiraghi\ResponsiveGallery\generate was not found. Maybe you did not declare it correctly or list all dependencies?

     **/
    public function generateThumbs($images_dir, $thumbs_dir, $thumbs_size, $image_files)
    {
        // Thumbnails size
        $thumbs_width = $thumbs_size['width'];
        $thumbs_height = $thumbs_size['height'];

        //  Create thumbs dir
        if (! is_dir($thumbs_dir)) {
            mkdir($thumbs_dir);
        }

        // Generate missing thumbs
        if (count($image_files)) {
            $index = 0;

The assignment to $index is dead and can be removed.

            foreach ($image_files as $index=>$file) {
                $index++;
                $thumbnail_image = $thumbs_dir.$file;
                if (! file_exists($thumbnail_image)) {
                    $extension = self::get_file_extension($thumbnail_image);
                    if ($extension) {
                        //echo $images_dir." ".$file." ".$thumbnail_image." ".$thumbs_width;
                        $this->generate_single_thumb_file($images_dir.$file, $thumbnail_image, $thumbs_width, $thumbs_height);

$thumbnail_image of type string is incompatible with the type array expected by parameter $dest of DavideCasiraghi\ResponsiveGallery\ResponsiveGalleryFactory::generate_single_thumb_file().

$images_dir . $file of type string is incompatible with the type array expected by parameter $src of DavideCasiraghi\ResponsiveGallery\ResponsiveGalleryFactory::generate_single_thumb_file().

                    }
                }
            }
        }
    }

    /************************************************************************/

    /**
     *  Create images array.
     *  @param array $image_files           array with all the image names
     *  @param $gallery_url
     *  @return $ret    array with the images datas

The doc comment $ret at position 0 could not be parsed: Unknown type name '$ret' at position 0 in $ret.

     **/
    public function createImagesArray($image_file_names, $gallery_url, $dbImageDatas)
    {
        sort($image_file_names);  // Order by image name

        $ret = [];

        foreach ($image_file_names as $k => $image_file_name) {
            $ret[$k]['file_name'] = $image_file_name;
            $ret[$k]['file_path'] = $gallery_url.$image_file_name;
            $ret[$k]['thumb_path'] = $gallery_url.'thumb/'.$image_file_name;
            $ret[$k]['description'] = '';
            $ret[$k]['alt'] = '';
            $ret[$k]['video_link'] = null;
            
            if (! empty($dbImageDatas[$image_file_name])) {
                $ret[$k]['description'] = $dbImageDatas[$image_file_name]->description;
                $ret[$k]['alt'] = $dbImageDatas[$image_file_name]->alt;
                $ret[$k]['video_link'] = $dbImageDatas[$image_file_name]->video_link;
            }
        }

        return $ret;
    }

    /************************************************************************/

    /**
     *  Get images file names array.
     *  @param $images_dir           the images dir on the server

The type DavideCasiraghi\ResponsiveGallery\the was not found. Maybe you did not declare it correctly or list all dependencies?

     *  @return array $ret           array containing all the images file names
     **/
    public function getImageFiles($images_dir)
    {
        $ret = $this->get_files($images_dir);

        return $ret;
    }

    /************************************************************************/

    /**
     *  Prepare the gallery HTML.
     *  @param array $images                        Images array [file_path, short_desc, long_desc]
     *  @param array $bootstrapDeviceImageWidth     array that contain the sizes of the images
     *                                              for the four kind of bootrap devices classes ()
     *                                              xs (phones), sm (tablets), md (desktops), and lg (larger desktops)
     *  @param ****array $desired_width     width of the thumbnail

The doc comment $desired_width at position 0 could not be parsed: Unknown type name '$desired_width' at position 0 in $desired_width.

     *  @return string $ret             the HTML to print on screen
     **/
    public function prepareGallery($images, $parameters)
    {
        // Animate box on hover
        $itemClass = 'animated';

        // The gallery HTML
        $ret = "<div class='responsiveGallery bricklayer' id='my-bricklayer' data-column-width='".$parameters['column_width']."' data-gutter='".$parameters['gutter']."'>";
        foreach ($images as $k => $image) {
            // Get item link
            $imageLink = ($image['video_link'] == null) ? $image['file_path'] : $image['video_link'];
            $videoPlayIcon = ($image['video_link'] == null) ? '' : "<i class='far fa-play-circle'></i>";

            $ret .= "<div class='box ".$itemClass."'>";
            $ret .= "<a href='".$imageLink."' data-fancybox='images' data-caption='".$image['description']."'>";
            $ret .= "<img src='".$image['thumb_path']."' alt='".$image['alt']."'/>";
            $ret .= $videoPlayIcon;
            $ret .= '</a>';
            $ret .= '</div>';
        }
        $ret .= '</div>';

        return $ret;
    }

    /************************************************************************/

    /**
     *  Returns files from dir.
     *  @param string $images_dir                 The images directory
     *  @param array $exts     the file types (actually doesn't work the thumb with png, it's to study why)
     *  @return array $files             the files array
     **/
    public function get_files($images_dir, $exts = ['jpg'])
    {
        $files = [];

        if ($handle = opendir($images_dir)) {
            while (false !== ($file = readdir($handle))) {
                $extension = strtolower($this->get_file_extension($file));
                if ($extension && in_array($extension, $exts)) {
                    $files[] = $file;
                }
            }
            closedir($handle);
        }

        return $files;
    }

    /************************************************************************/

    /**
     *  Returns a file's extension.
     *  @param string $file_name        the file name
     *  @return string                  the extension
     **/
    public static function get_file_extension($file_name)
    {
        return substr(strrchr($file_name, '.'), 1);
    }

    /************************************************************************/

    /**
     *  Find the gallery snippet occurances in the text.
     *  @param array $text        the text where to find the gallery snippets
     *  @return array $ret        the matches
     **/
    public function getGallerySnippetOccurrences($text)
    {
        $re = '/{\#
                \h+gallery
                \h+(src|column_width|gutter)=\[([^]]*)]
                \h+((?1))=\[([^]]*)]
                \h+((?1))=\[([^]]*)]
                \h*\#}/x';

        if (preg_match_all($re, $text, $matches, PREG_SET_ORDER, 0)) {

The call to preg_match_all() has too many arguments starting with DavideCasiraghi\ResponsiveGallery\PREG_SET_ORDER.

            return $matches;
        } else {
            return;
        }
    }

    /************************************************************************/

    /**
     *  Retrieve the datas from the package config file (published and edited by the user).
     *  @param none
     *  @return array $ret - the config parapeters
     **/
    public function getPhotoDatasFromDb()
    {
        $ret = GalleryImage::get()->keyBy('file_name');
        //dd($ret);
        return $ret;
    }

    /************************************************************************/

    /**
     *  Return the post body with the gallery HTML instead of the found snippet.
     *  @param array $file_name        the file name
     *  @return array $ret             the extension
     **/
    public function getGallery($postBody, $publicPath)
    {
        $matches = $this->getGallerySnippetOccurrences($postBody);

        foreach ($matches as $key => $single_gallery_matches) {
            $parameters = self::getGalleryParameters($single_gallery_matches, $publicPath);

            if (is_dir($parameters['images_dir'])) {
                // Get images file name array
                $image_files = $this->getImageFiles($parameters['images_dir']);

                if (! empty($image_files)) {
                    $this->generateThumbs($parameters['images_dir'], $parameters['thumbs_dir'], $parameters['thumbs_size'], $image_files);
                    $dbImageDatas = $this->getPhotoDatasFromDb();

                    // Create Images array [file_path, short_desc, long_desc]
                    $images = $this->createImagesArray($image_files, $parameters['gallery_url'], $dbImageDatas);

                    // Prepare Gallery HTML
                    $galleryHtml = $this->prepareGallery($images, $parameters);
                } else {
                    $galleryHtml = "<div class='alert alert-warning' role='alert'>The directory specified exist but it doesn't contain images</div>";
                }
            } else {
                $galleryHtml = "<div class='alert alert-warning' role='alert'>Image directory not found<br />".$parameters['images_dir'].'</div>';
            }

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

        return $postBody;
    }
}