Issues in Extension.php (release/5.x) - Issues in release/5.x - zicht/framework-extra-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Issues (92)

Bundle/FrameworkExtraBundle/Twig/Extension.php (20 issues)

Labels

Severity

<?php
/**
 * @author Gerard van Helden <[email protected]>
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Bundle\FrameworkExtraBundle\Twig;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Collections\Criteria;
use Doctrine\Common\Collections\ExpressionBuilder;
use Doctrine\Common\Util\Debug as DoctrineUtilDebug;
use Doctrine\ORM\PersistentCollection;
use DOMDocument;
use SimpleXMLElement;
use Symfony\Component\Form\FormError;
use Symfony\Component\Form\FormView;
use Symfony\Component\Security\Acl\Voter\FieldVote;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
use Symfony\Component\Translation\TranslatorInterface;
use Traversable;
use Twig_Extension;
use Twig_SimpleFilter;
use Twig_SimpleFunction;
use Zicht\Bundle\FrameworkExtraBundle\Helper\AnnotationRegistry;
use Zicht\Bundle\FrameworkExtraBundle\Helper\EmbedHelper;
use Zicht\Itertools as iter;
use Zicht\Util\Debug;
use Zicht\Util\Str as StrUtil;

/**
 * Class Extension
 *
 * @package Zicht\Bundle\FrameworkExtraBundle\Twig
 */
class Extension extends Twig_Extension implements \Twig_Extension_GlobalsInterface
{
    public static $RELATIVE_DATE_PART_MAP = array(
        'y' => array('year', 'years'),
        'm' => array('month', 'months'),
        'd' => array('day', 'days'),
        'w' => array('week', 'weeks'),
        'h' => array('hour', 'hours'),
        'i' => array('minute', 'minutes'),
        's' => array('second', 'seconds')
    );

    /**
     * @var EmbedHelper
     */
    protected $embedHelper;

    /**
     * @var array
     */
    protected $globals;

    /**
     * @var AnnotationRegistry
     */
    protected $annotationRegistry;

    /**
     * @var TranslatorInterface
     */
    protected $translator;

    /**
     * @var AuthorizationCheckerInterface
     */
    protected $authChecker;

    /**
     * Extension constructor.
     *
     * @param EmbedHelper $embedHelper
     * @param AnnotationRegistry $annotationRegistry
     * @param TranslatorInterface|null $translator
     * @param AuthorizationCheckerInterface|null $authChecker
     */
    public function __construct(
        EmbedHelper $embedHelper,
        AnnotationRegistry $annotationRegistry,
        TranslatorInterface $translator = null,
        AuthorizationCheckerInterface $authChecker = null
    )
    {
        $this->globals = [];
        $this->embedHelper = $embedHelper;
        $this->annotationRegistry = $annotationRegistry;
        $this->translator = $translator;
        $this->authChecker = $authChecker;
    }

    /**
     * Set global
     *
     * @param string $name
     * @param mixed $value
     */
    public function setGlobal($name, $value)
    {
        $this->globals[$name] = $value;
    }

    /**
     * @return array
     */
    public function getGlobals()
    {
        return $this->globals;
    }

    /**
     * @return array
     */
    public function getFilters()
    {
        return array(
            new Twig_SimpleFilter('dump', array($this, 'dump'), array('is_safe' => array('html'))),
            new Twig_SimpleFilter('xml', array($this, 'xml')),
            new Twig_SimpleFilter('regex_replace', array($this, 'regexReplace')),
            new Twig_SimpleFilter('re_replace', array($this, 'regexReplace')),
            new Twig_SimpleFilter('str_uscore', array($this, 'strUscore')),
            new Twig_SimpleFilter('str_dash', array($this, 'strDash')),
            new Twig_SimpleFilter('str_camel', array($this, 'strCamel')),
            new Twig_SimpleFilter('str_humanize', array($this, 'strHumanize')),
            new Twig_SimpleFilter('date_format', array($this, 'dateFormat')),
            new Twig_SimpleFilter('relative_date', array($this, 'relativeDate')),
            new Twig_SimpleFilter('ga_trackevent', array($this, 'gaTrackEvent')),

            new Twig_SimpleFilter('prefix_multiple', array($this, 'prefixMultiple')),
            new Twig_SimpleFilter('trans_multiple', array($this, 'transMultiple')),
            new Twig_SimpleFilter('truncate_html', array($this, 'truncateHtml')),

            new Twig_SimpleFilter('with', array($this, 'with')),
            new Twig_SimpleFilter('without', array($this, 'without')),

            new Twig_SimpleFilter('where', array($this, 'where')),
            new Twig_SimpleFilter('not_where', array($this, 'notWhere')),
            new Twig_SimpleFilter('where_split', array($this, 'whereSplit')),
            new Twig_SimpleFilter('url_to_form_params', array($this, 'urlToFormParameters')),
            new Twig_SimpleFilter('url_strip_query', array($this, 'urlStripQuery')),

            new Twig_SimpleFilter('ceil', 'ceil'),
            new Twig_SimpleFilter('floor', 'floor'),
            new Twig_SimpleFilter('groups', array($this, 'groups')),
            new Twig_SimpleFilter('sort_by_type', array($this, 'sortByType')),
            new Twig_SimpleFilter('html2text', array($this, 'htmlToText')),
            new Twig_SimpleFilter('replace_recursive', 'array_replace_recursive'),
            new Twig_SimpleFilter('json_decode', array($this, 'jsonDecode')),
            new Twig_SimpleFilter('sha1', array($this, 'shaOne')),

            new Twig_SimpleFilter('form_root', array($this, 'formRoot')),
            new Twig_SimpleFilter('form_has_errors', array($this, 'formHasErrors')),
        );
    }

    /**
     * Prefix multiple
     *
     * @param array $values
     * @param string $prefix
     * @return iter\lib\MapIterator
     */
    public function prefixMultiple($values, $prefix)
    {
        return iter\map(
        return /** @scrutinizer ignore-call */ iter\map(
            function ($value) use ($prefix) {
                return sprintf('%s%s', $prefix, $value);
            },
            $values
        );
    }

    /**
     * Translate multiple strings
     *
     * @param array $messages
     * @param array $parameters
     * @param null $domain

     * @param null $locale

     * @return iter\lib\MapIterator
     */
    public function transMultiple($messages, $parameters = [], $domain = null, $locale = null)
    {
        $translator = $this->translator;
        return iter\map(
        return /** @scrutinizer ignore-call */ iter\map(
            function ($message) use ($translator, $parameters, $domain, $locale) {

                return $this->translator->trans($message, $parameters, $domain, $locale);
            },
            $messages
        );
    }

    /**
     * Returns the root of the form
     *
     * @param FormView $formView
     * @return FormView
     */
    public function formRoot(FormView $formView)
    {
        return EmbedHelper::getFormRoot($formView);
    }

    /**
     * Returns true when the form, or any of its children, has one or more errors.
     *
     * @param FormView $form
     *
     * @return bool
     */
    public function formHasErrors(FormView $form)
    {
        if ($form->vars['errors']->count()) {
            return true;
        }

        foreach ($form->children as $child) {
            if ($this->formHasErrors($child)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Call the php json_decode
     *
     * @param string $string
     * @param bool $assoc
     * @return mixed|null
     */
    public function jsonDecode($string, $assoc = false)
    {
        if (is_string($string)) {

            return json_decode($string, $assoc);
        }
        return null;
    }

    /**
     * Returns a 40 byte string representing the sha1 digest of the input string.
     *
     * @param string|\Twig_Markup $string
     * @return string
     */
    public function shaOne($string)
    {

        if (is_string($string) || $string instanceof \Twig_Markup) {

            return sha1($string);
        }
        return '';
    }

    /**
     * Filter a collection based on properties of the collection's items
     *
     * @param array|Collection $items
     * @param array $keyValuePairs
     * @param string $comparator
     * @param string $booleanOperator
     * @return \Doctrine\Common\Collections\Collection
     */
    public function where($items, array $keyValuePairs, $comparator = 'eq', $booleanOperator = 'and')
    {
        if (is_array($items)) {
            $items = new ArrayCollection($items);
        }
        if ($items instanceof PersistentCollection && !$items->isInitialized()) {
            $items->initialize();
        }

        $whereMethod = $booleanOperator . 'Where';

        $eb = new ExpressionBuilder();
        $criteria = new Criteria();
        foreach ($keyValuePairs as $key => $value) {
            if (is_array($value)) {
                if ($comparator === 'eq') {
                    $criteria->$whereMethod($eb->in($key, $value));
                    continue;
                } elseif ($comparator === 'neq') {
                    $criteria->$whereMethod($eb->notIn($key, $value));
                    continue;
                }
            }
            $criteria->$whereMethod($eb->$comparator($key, $value));
        }

        return $items->matching($criteria);
        return $items->/** @scrutinizer ignore-call */ matching($criteria);
    }

    /**
     * Inverse of where, i.e. get all items that are NOT matching the criteria.
     *
     * @param array|Collection $items
     * @param array $keyValuePairs
     * @return Collection
     */
    public function notWhere($items, $keyValuePairs)
    {
        return $this->where($items, $keyValuePairs, 'neq');
    }

    /**
     * Splits a list in two collections, one matching the criteria, and the rest
     *
     * @param array|Collection $items
     * @param array $keyValuePairs
     * @return array
     */
    public function whereSplit($items, $keyValuePairs)
    {
        return array(
            $this->notWhere($items, $keyValuePairs),
            $this->where($items, $keyValuePairs)
        );
    }

    /**
     * Removes the query string from a form.
     *
     * Used as follows in conjunction with url_parse_query()
     *
     * <form method="get" action="{{ url|url_strip_query }}">
     *     {% for k, value in url|url_to_form_params %}
     *          <input type="hidden" name="{{ k }}" value="{{ value }}">
     *     {% endfor %}
     * </form>
     *
     * @param string $url
     * @return array
     */
    public function urlStripQuery($url)
    {
        $query = parse_url($url, PHP_URL_QUERY);
        return str_replace('?' . $query, '', $url);

    }

    /**
     * Url to form parameters
     *
     * @param string $url
     * @return array
     */
    public function urlToFormParameters($url)
    {
        $query = parse_url($url, PHP_URL_QUERY);
        $vars = array();
        parse_str($query, $vars);
        return $this->valuesToFormParameters($vars, null);
    }

    /**
     * Prepares a nested array for use in form fields.
     *
     * @param mixed[] $values
     * @param string $parent
     * @return array
     */
    private function valuesToFormParameters($values, $parent)
    {
        $ret = array();
        foreach ($values as $key => $value) {
            if (null !== $parent) {
                $keyName = sprintf('%s[%s]', $parent, $key);
            } else {
                $keyName = $key;
            }
            if (is_scalar($value)) {
                $ret[$keyName] = $value;
            } else {
                $ret = array_merge($ret, $this->valuesToFormParameters($value, $keyName));
            }
        }
        return $ret;
    }

    /**
     * @return array
     */
    public function getFunctions()
    {
        return array(
            'trans_form_errors' => new Twig_SimpleFunction('trans_form_errors', [$this, 'transFormErrors']),
            'embed_params' => new Twig_SimpleFunction('embed_params', [$this, 'getEmbedParams']),
            'defaults' => new Twig_SimpleFunction('defaults', [$this, 'getDefaultOf']),
            'embed' => new Twig_SimpleFunction('embed', [$this, 'embed']),
            'is_granted' => new Twig_SimpleFunction('is_granted', [$this, 'isGranted']),
            'embedded_image' => new Twig_SimpleFunction('embedded_image', [$this, 'embeddedImage']),
        );
    }

    /**
     * Given an existing file, returns an embedded data stream, or null when the file does not exist
     *
     * For example
     * {{ embedded_image('foo.jpg') }}
     *  --> "data:image/jpg;base64,BLABLABLA"
     *
     * @param string $filename
     * @return null|string
     */
    public function embeddedImage($filename)
    {
        if (is_file($filename) && preg_match('/[.](?P<extension>[a-zA-Z0-9]+)$/', $filename, $matches)) {
            return sprintf('data:image/%s;base64,%s', $matches['extension'], base64_encode(file_get_contents($filename)));
        }

        return null;
    }

    /**
     * The template may assume that the role will be denied when there is no security context, therefore we override
     * the default behaviour here.
     *
     * @param string $role
     * @param mixed $object
     * @param mixed $field
     * @return bool
     */
    public function isGranted($role, $object = null, $field = null)
    {
        if (null !== $field) {
            $object = new FieldVote($object, $field);
        }
        return $this->authChecker->isGranted($role, $object);
    }

    /**
     * Groups
     *
     * @param array|object $list
     * @param int $numGroups
     * @return array
     */
    public function groups($list, $numGroups)
    {
        $items = ($list instanceof Traversable ? iterator_to_array($list) : $list);

        $groups = array();
        $i = 0;
        foreach ($items as $item) {
            $groups[$i++ % $numGroups][] = $item;
        }
        return $groups;
    }

    /**
     * Formats some values as an 'onclick' attribute for Google Analytics
     *
     * @param null $values

     * @return string
     */
    public function gaTrackEvent($values = null)
    {
        $values = func_get_args();
        array_unshift($values, '_trackEvent');

        return sprintf(
            ' onclick="_gaq.push(%s);"',
            htmlspecialchars(json_encode(array_values($values)))
        );
    }

    /**
     * Sort by type
     *
     * @param array|object $collection
     * @param array $types
     * @return array
     */
    public function sortByType($collection, $types)
    {
        if ($collection instanceof Traversable) {
            $collection = iterator_to_array($collection);
        }

        // store a map of the original sorting, so the usort can use this to keep the original sorting if the types are
        // equal
        $idToIndexMap = array();
        foreach ($collection as $index => $item) {
            $idToIndexMap[$item->getId()] = $index;
        }

        $numTypes = count($types);

        usort(
            $collection,
            /** @scrutinizer ignore-type */ $collection,
            function ($left, $right) use ($types, $idToIndexMap, $numTypes) {
                $localClassNameLeft = Str::classname(get_class($left));
filter:
    dependency_paths: ["lib/*"]
                $localClassNameRight = Str::classname(get_class($right));

                // if same type, use original sorting
                if ($localClassNameRight === $localClassNameLeft) {
                    $indexLeft = $idToIndexMap[$left->getId()];
                    $indexRight = $idToIndexMap[$right->getId()];
                } else {
                    $indexLeft = array_search($localClassNameLeft, $types);
                    $indexRight = array_search($localClassNameRight, $types);

                    // assume that types that aren't defined, should come last.
                    if (false === $indexLeft) {
                        $indexLeft = $numTypes + 1;
                    }
                    if (false === $indexRight) {
                        $indexRight = $numTypes + 1;
                    }
                }

                if ($indexLeft < $indexRight) {
                    return -1;
                }
                if ($indexLeft > $indexRight) {
                    return 1;
                }
                return 0;
            }
        );

        return $collection;
    }

    /**
     * Dash to CamelCase
     *
     * @param string $str
     * @param bool $camelFirst
     * @return string
     */
    public function strDash($str, $camelFirst = true)
    {
        if ($camelFirst) {
            $str = StrUtil::camel($str);
        }
        return StrUtil::dash($str);
    }

    /**
     * CamelCased to under_score
     *
     * @param string $str
     * @param bool $camelFirst
     * @return string
     */
    public function strUscore($str, $camelFirst = true)
    {
        if ($camelFirst) {
            $str = StrUtil::camel($str);
        }
        return StrUtil::uscore($str);
    }

    /**
     * Camelcase
     *
     * @param String $str
     * @return string
     */
    public function strCamel($str)
    {
        return StrUtil::camel($str);
    }

    /**
     * Humanize
     *
     * @param string $str
     * @return string
     */
    public function strHumanize($str)
    {
        return StrUtil::humanize($str);
    }

    /**
     * Format Date
     *
     * @param string|object|int $date
     * @param string $format
     * @return string
     */
    public function dateFormat($date, $format = '%e %b %Y')
    {
        if ($date instanceof \DateTime) {
            $ts = $date->getTimestamp();
        } elseif (is_numeric($date)) {
            $ts = $date;
        } elseif (preg_match('/^[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}T[0-9]{2,2}:[0-9]{2,2}.*/', $date)) {
        } elseif (preg_match('/^[0-9]{4,4}-[0-9]{2,2}-[0-9]{2,2}T[0-9]{2,2}:[0-9]{2,2}.*/', /** @scrutinizer ignore-type */ $date)) {
            // timestamp format 2013-01-01T00:00:00
            $ts = new \DateTime($date);
            $ts = new \DateTime(/** @scrutinizer ignore-type */ $date);
            $ts = $ts->getTimestamp();
        } else {
            throw new \InvalidArgumentException(sprintf("Cannot format %s as a date", $date));
            throw new \InvalidArgumentException(sprintf("Cannot format %s as a date", /** @scrutinizer ignore-type */ $date));
        }

        return strftime($format, $ts);
        return strftime($format, /** @scrutinizer ignore-type */ $ts);
    }

    /**
     * Relative date
     *
     * @param string|object $date
     * @return string
     */
    public function relativeDate($date)
    {
        $now = new \DateTime();
        $diff = $date->diff($now);
        // natively, diff doesn't contain 'weeks'.
        $diff->w = round($diff->d / 7);
        $message = '';
        foreach (array('y', 'm', 'w', 'd', 'h', 'i', 's') as $part) {
            if ($diff->$part > 0) {
                list($singular, $plural) = self::$RELATIVE_DATE_PART_MAP[$part];
                if ($diff->$part > 1) {
                    $denominator = $plural;
                } else {
                    $denominator = $singular;
                }

                if (null !== $this->translator) {
                    $message = $this->translator->trans(
                        '%count% ' . $denominator . ' ago',
                        array('%count%' => $diff->$part)
                    );
                } else {
                    $message = sprintf('%d %s ago', $diff->$part, $denominator);
                }
                break;
            }
        }

        return $message;
    }

    /**
     * Filter implementation for regular expression replacement
     *
     * @param string $subject
     * @param string $pattern
     * @param string $replacement
     * @return string
     */
    public function regexReplace($subject, $pattern, $replacement)
    {
        return preg_replace($pattern, $replacement, $subject);
    }

    /**
     * Truncate text at a maximum length, splitting by words, and add an ellipsis "...".
     *
     * @param string $str
     * @param int $length
     * @param string $ellipsis
     * @return string
     */
    public function truncate($str, $length, $ellipsis = '...')
    {
        $result = '';
        foreach (preg_split('/\b/U', $str) as $part) {
            if (strlen($result . $part) > $length) {
                $result = rtrim($result) . $ellipsis;
                break;
            } else {
                $result .= $part;
            }
        }

        return $result;
    }

    /**
     * Truncates html as text
     *
     * @param string $html
     * @param int $length
     * @param string $ellipsis
     * @return string
     */
    public function truncateHtml($html, $length, $ellipsis = '...')
    {
        return $this->truncate(html_entity_decode(strip_tags($html), null, 'UTF-8'), $length, $ellipsis);
    }

    /**
     * @return array|\Twig_NodeVisitorInterface[]
     */
    public function getNodeVisitors()
    {
        return array(
            'zicht_render_add_embed_params' => new RenderAddEmbedParamsNodeVisitor()
        );
    }

    /**
     * @return array
     */
    public function getTokenParsers()
    {
        return array(
            'zicht_switch' => new ControlStructures\SwitchTokenParser(),
            'zicht_strict' => new ControlStructures\StrictTokenParser(),
            'zicht_meta_annotate' => new Meta\AnnotateTokenParser(),
            'zicht_meta_annotations' => new Meta\AnnotationsTokenParser()
        );
    }

    /**
     * @return AnnotationRegistry
     */
    public function getAnnotationRegistry()
    {
        return $this->annotationRegistry;
    }

    /**
     * Embed
     *
     * @param array|string $urlOrArray
     * @return array|mixed|string
     */
    public function embed($urlOrArray)
    {
        $embedParams = array_filter($this->embedHelper->getEmbedParams());
        if (!$embedParams) {

            return $urlOrArray;
        }
        if (is_array($urlOrArray)) {
            return $urlOrArray + $embedParams;
        } elseif (is_string($urlOrArray)) {

            $query = parse_url($urlOrArray, PHP_URL_QUERY);
            $urlOrArray = str_replace($query, '', $urlOrArray);
            $currentParams = array();
            parse_str($query, $currentParams);
            $currentParams += $embedParams;

            return preg_replace('/\?$/', '', $urlOrArray) . '?' . http_build_query($currentParams);
        } else {
            throw new \InvalidArgumentException("Only supports arrays or strings");
        }
    }

    /**
     * @return array
     */
    public function getEmbedParams()
    {
        return array_filter($this->embedHelper->getEmbedParams());
    }

    /**
     * @return string
     */
    public function getName()
    {
        return 'zicht_framework_extra';
    }

    /**
     * @return mixed|null
     */
    public function getDefaultOf()
    {
        $items = func_get_args();
        $items = array_filter($items);
        if (count($items)) {
            return current($items);
        }

        return null;
    }

    /**
     * Dumps given variable in styled format
     *
     * @param mixed $var
     * @param string $mode
     * @return mixed
     */
    public function dump($var, $mode = null)
    {
        if (null === $mode && class_exists('Zicht\Util\Debug')) {
            return htmlspecialchars(Debug::dump($var));
        } else {
            switch ($mode) {
                case 'export':
                    DoctrineUtilDebug::dump($var, 5);
                    break;
                default:
                    var_dump($var);

                    break;
            }
        }
        return null;
    }

    /**
     * XML
     *
     * @param object $data
     * @return string
     */
    public function xml($data)
    {
        if ($data instanceof SimpleXMLElement) {
            $data = $data->saveXML();
        }
        $dom = new DOMDocument();
        $dom->loadXml($data);
        $dom->loadXml(/** @scrutinizer ignore-type */ $data);
        $dom->formatOutput = true;
        return $dom->saveXML();
    }

    /**
     * Strips tags
     *
     * @param string $html
     * @return string
     */
    public function htmlToText($html)
    {
        return strip_tags($html);
    }

    /**
     * Transforms errors
     *
     * @param FormError[] $formErrorList
     * @param string $translationDomain
     * @return array
     */
    public function transFormErrors($formErrorList, $translationDomain)
    {
        $ret = [];
        foreach ($formErrorList as $k => $formError) {
            $ret[$k] = $this->translator->trans($formError->getMessage(), $formError->getMessageParameters(), $translationDomain);
        }
        return $ret;
    }
}

zicht / framework-extra-bundle

Issues (92)

Bundle/FrameworkExtraBundle/Twig/Extension.php (20 issues)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like
