nystudio107 / craft-pathtools

src/twigextensions/PathToolsTwigExtension.php

<?php
/**
 * PathTools plugin for Craft CMS 3.x
 *
 * This twig plugin for the Craft CMS brings convenient path & url manipulation functions & filters to your
 * Twig templates.
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\pathtools\twigextensions;

use Craft;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   PathTools

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class PathToolsTwigExtension extends \Twig_Extension

The class Twig_Extension has been deprecated: since Twig 2.7, use "Twig\Extension\AbstractExtension" instead

{
    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getName()
    {
        return 'PathTools';
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFilters()
    {
        return [
            new \Twig_SimpleFilter('pathinfo', [$this, 'pathInfoFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

            new \Twig_SimpleFilter('basename', [$this, 'baseNameFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

            new \Twig_SimpleFilter('dirname', [$this, 'dirNameFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

            new \Twig_SimpleFilter('parse_url', [$this, 'parseUrlFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

            new \Twig_SimpleFilter('parse_string', [$this, 'parseStringFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

            new \Twig_SimpleFilter('swap_extension', [$this, 'swapExtensionFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

            new \Twig_SimpleFilter('swap_directory', [$this, 'swapDirectoryFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

            new \Twig_SimpleFilter('append_suffix', [$this, 'appendSuffixFilter']),

The class Twig_SimpleFilter has been deprecated: since Twig 2.7, use "Twig\TwigFilter" instead

        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFunctions()
    {
        return [
            new \Twig_SimpleFunction('pathinfo', [$this, 'pathInfoFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

            new \Twig_SimpleFunction('basename', [$this, 'baseNameFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

            new \Twig_SimpleFunction('dirname', [$this, 'dirNameFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

            new \Twig_SimpleFunction('parse_url', [$this, 'parseUrlFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

            new \Twig_SimpleFunction('parse_string', [$this, 'parseStringFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

            new \Twig_SimpleFunction('swap_extension', [$this, 'swapExtensionFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

            new \Twig_SimpleFunction('swap_directory', [$this, 'swapDirectoryFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

            new \Twig_SimpleFunction('append_suffix', [$this, 'appendSuffixFilter']),

The class Twig_SimpleFunction has been deprecated: since Twig 2.7, use "Twig\TwigFunction" instead

        ];
    }


    /**
     * php pathinfo() wrapper -- http://php.net/manual/en/function.pathinfo.php

Doc comment short description must start with a capital letter

     *
     * @param $path

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @param bool $options

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function pathInfoFilter($path, $options = false)
    {
        if ($options) {
            $output = pathinfo($path, $options);

$options of type true is incompatible with the type integer expected by parameter $flags of pathinfo().

        } else {
            $output = pathinfo($path);
        }
        return $output;
    }

    /**
     * php basename() wrapper -- http://php.net/manual/en/function.basename.php

Doc comment short description must start with a capital letter

     *
     * @param $path

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @param bool $suffix

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function baseNameFilter($path, $suffix = false)
    {
        if ($suffix) {
            $output = basename($path, $suffix);

$suffix of type true is incompatible with the type string expected by parameter $suffix of basename().

        } else {
            $output = basename($path);
        }
        return $output;
    }

    /**
     * php dirname() wrapper -- http://php.net/manual/en/function.dirname.php

Doc comment short description must start with a capital letter

     *
     * @param $path

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function dirNameFilter($path)
    {
        $output = dirname($path);
        return $output;
    }

    /**
     * php parse_url() wrapper -- http://php.net/manual/en/function.parse-url.php

Doc comment short description must start with a capital letter

     *
     * @param $url

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @param int $component

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function parseUrlFilter($url, $component = -1)
    {
        $output = parse_url($url, $component);
        return $output;
    }

    /**
     * php parse_str() wrapper -- http://php.net/manual/en/function.parse-str.php

Doc comment short description must start with a capital letter

     *
     * @param $string

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return mixed

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function parseStringFilter($string)
    {
        parse_str($string, $output);
        return $output;
    }

    /**
     * Swap the file extension on a passed url or path
     *
     * @param $path_or_url

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @param $extension

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function swapExtensionFilter($path_or_url, $extension)
    {
        $path = $this->decomposeUrl($path_or_url);
        $path_parts = pathinfo($path['path']);
        $new_path = $path_parts['filename'] . "." . $extension;
        if (!empty($path_parts['dirname']) && $path_parts['dirname'] !== ".") {
            $new_path = $path_parts['dirname'] . DIRECTORY_SEPARATOR . $new_path;
            $new_path = preg_replace('#/+#', '/', $new_path);
        }
        $output = $path['prefix'] . $new_path . $path['suffix'];
        return $output;
    }

    /**
     * Swap the file directory on a passed url or path
     *
     * @param $path_or_url

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @param $directory

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function swapDirectoryFilter($path_or_url, $directory)
    {

        $path = $this->decomposeUrl($path_or_url);
        $path_parts = pathinfo($path['path']);
        $new_path = $directory . DIRECTORY_SEPARATOR . $path_parts['basename'];

        $output = $path['prefix'] . $new_path . $path['suffix'];
        return $output;
    }


    /**
     * Append a suffix a passed url or path
     *
     * @param $path_or_url

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @param $suffix

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public function appendSuffixFilter($path_or_url, $suffix)
    {
        $path = $this->decomposeUrl($path_or_url);
        $path_parts = pathinfo($path['path']);
        $new_path = $path_parts['filename'] . $suffix . "." . $path_parts['extension'];
        if (!empty($path_parts['dirname']) && $path_parts['dirname'] !== ".") {
            $new_path = $path_parts['dirname'] . DIRECTORY_SEPARATOR . $new_path;
            $new_path = preg_replace('#/+#', '/', $new_path);
        }
        $output = $path['prefix'] . $new_path . $path['suffix'];
        return $output;
    }

    // Private Methods
    // =========================================================================

    /**
     * Decompose a url into a prefix, path, and suffix
     *
     * @param $path_or_url

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @return array

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    private function decomposeUrl($path_or_url)

Private method name "PathToolsTwigExtension::decomposeUrl" must be prefixed with an underscore

    {
        $result = array();

        if (filter_var($path_or_url, FILTER_VALIDATE_URL)) {
            $url_parts = parse_url($path_or_url);
            $result['prefix'] = $url_parts['scheme'] . "://" . $url_parts['host'];
            $result['path'] = $url_parts['path'];
            $result['suffix'] = "";
            $result['suffix'] .= (empty($url_parts['query'])) ? "" : "?" . $url_parts['query'];
            $result['suffix'] .= (empty($url_parts['fragment'])) ? "" : "#" . $url_parts['fragment'];
        } else {
            $result['prefix'] = "";
            $result['path'] = $path_or_url;
            $result['suffix'] = "";
        }

        return $result;
    }
}