nystudio107\typogrify\variables\TypogrifyVariable

Complexity

Total Complexity

20

Size/Duplication

Total Lines	292
Duplicated Lines	0 %

Importance

Changes	18
Bugs	1	Features	2

16 Methods

Rating	Name	Duplication	Size	Complexity
A	typogrifyFeed()	0	4	1
A	truncateOnWord()	0	3	1
A	typogrify()	0	4	1
A	getPhpTypographySettings()	0	3	1
A	stringy()	0	3	1
A	truncate()	0	3	1
A	humanFileSize()	0	3	1
A	humanDuration()	0	3	1
A	smartypants()	0	4	1
A	humanRelativeTime()	0	3	1
A	transliterate()	0	3	1
A	ordinalize()	0	3	1
A	pluralize()	0	3	1
A	wordLimit()	0	3	1
A	singularize()	0	3	1
A	normalizeText()	0	36	5

<?php
/**
 * Typogrify plugin for Craft CMS
 *
 * Typogrify prettifies your web typography by preventing ugly quotes and 'widows' and more
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 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\typogrify\variables;

use Craft;
use craft\helpers\Template;
use DateInterval;
use DateTime;
use nystudio107\typogrify\Typogrify;
use PHP_Typography\Settings;
use Stringy\Stringy;
use Twig\Markup;

/**

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   Typogrify

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 TypogrifyVariable
{
    // Public Methods
    // =========================================================================

    /**
     * Typogrify applies a veritable kitchen sink of typographic treatments to
     * beautify your web typography
     *
     * @param string|int|float|null $text The text or HTML fragment to process

Expected 4 spaces after parameter name; 1 found

     * @param bool $isTitle Optional. If the HTML fragment is a title.

Expected 18 spaces after parameter type; 1 found

     *                        Default false

Parameter comment not aligned correctly; expected 22 spaces but found 24

     *
     * @return Markup
     */
    public function typogrify(string|int|float|null $text, bool $isTitle = false): Markup
    {
        $text = $this->normalizeText($text);
        return Template::raw(Typogrify::$plugin->typogrify->typogrify($text, $isTitle));
    }

    /**
     * Typogrify applies a veritable kitchen sink of typographic treatments to
     * beautify your web typography but in a way that is appropriate for RSS
     * (or similar) feeds -- i.e. excluding processes that may cause issues in
     * contexts with limited character set intelligence.
     *
     * @param string|int|float|null $text The text or HTML fragment to process

Expected 4 spaces after parameter name; 1 found

     * @param bool $isTitle Optional. If the HTML fragment is a title.

Expected 18 spaces after parameter type; 1 found

     *                        Default false

Parameter comment not aligned correctly; expected 22 spaces but found 24

     *
     * @return Markup
     */
    public function typogrifyFeed(string|int|float|null $text, bool $isTitle = false): Markup
    {
        $text = $this->normalizeText($text);
        return Template::raw(Typogrify::$plugin->typogrify->typogrifyFeed($text, $isTitle));
    }

    /**

Missing short description in doc comment

     * @param string|int|float|null $text

Missing parameter comment

     *
     * @return Markup
     */
    public function smartypants(string|int|float|null $text): Markup
    {
        $text = $this->normalizeText($text);
        return Template::raw(Typogrify::$plugin->typogrify->smartypants($text));
    }

    /**

Missing short description in doc comment

     * @return Settings
     */
    public function getPhpTypographySettings(): Settings
    {
        return Typogrify::$plugin->typogrify->phpTypographySettings;

The expression return nystudio107\typogrify\Typogrify::plugin->typogrify->phpTypographySettings could return the type null which is incompatible with the type-hinted return PHP_Typography\Settings. Consider adding an additional type-check to rule them out.

    }

    /**
     * Truncates the string to a given length. If $substring is provided, and
     * truncating occurs, the string is further truncated so that the substring
     * may be appended without exceeding the desired length.
     *
     * @param string|int|float|null $string The string to truncate

Expected 4 spaces after parameter name; 1 found

     * @param int $length Desired length of the truncated string

Expected 19 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     * @param string $substring The substring to append if it can fit

Expected 16 spaces after parameter type; 1 found

     *
     * @return string with the resulting $str after truncating
     */
    public function truncate(string|int|float|null $string, int $length, string $substring = '…'): string
    {
        return Typogrify::$plugin->typogrify->truncate($string, $length, $substring);
    }

    /**
     * Truncates the string to a given length, while ensuring that it does not
     * split words. If $substring is provided, and truncating occurs, the
     * string is further truncated so that the substring may be appended without
     * exceeding the desired length.
     *
     * @param string|int|float|null $string The string to truncate

Expected 4 spaces after parameter name; 1 found

     * @param int $length Desired length of the truncated string

Expected 19 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     * @param string $substring The substring to append if it can fit

Expected 16 spaces after parameter type; 1 found

     *
     * @return string with the resulting $str after truncating
     */
    public function truncateOnWord(string|int|float|null $string, int $length, string $substring = '…'): string
    {
        return Typogrify::$plugin->typogrify->truncateOnWord($string, $length, $substring);
    }

    /**
     * Creates a Stringy object and assigns both string and encoding properties
     * the supplied values. $string is cast to a string prior to assignment, and if
     * $encoding is not specified, it defaults to mb_internal_encoding(). It
     * then returns the initialized object. Throws an InvalidArgumentException
     * if the first argument is an array or object without a __toString method.
     *
     * @param string|int|float|null $string The string initialize the Stringy object with

Expected 3 spaces after parameter name; 1 found

     * @param null|string $encoding The character encoding

Expected 11 spaces after parameter type; 1 found

     *
     * @return Stringy
     */
    public function stringy(string|int|float|null $string = '', ?string $encoding = null): Stringy
    {
        return Typogrify::$plugin->typogrify->stringy($string, $encoding);
    }

    /**
     * Formats the value in bytes as a size in human readable form for example `12 KB`.
     *
     * This is the short form of [[asSize]].
     *
     * If [[sizeFormatBase]] is 1024, [binary prefixes](http://en.wikipedia.org/wiki/Binary_prefix)
     * (e.g. kibibyte/KiB, mebibyte/MiB, ...) are used in the formatting result.
     *
     * @param string|int|float $bytes value in bytes to be formatted.

Expected 4 spaces after parameter name; 1 found

     * @param int $decimals the number of digits after the decimal point.

Expected 14 spaces after parameter type; 1 found

     *
     * @return string the formatted result.
     */
    public function humanFileSize(string|int|float $bytes, int $decimals = 1): string
    {
        return Typogrify::$plugin->typogrify->humanFileSize($bytes, $decimals);
    }

    /**
     * Represents the value as duration in human readable format.
     *
     * @param DateInterval|string|int $value the value to be formatted. Acceptable formats:
     *  - [DateInterval object](http://php.net/manual/ru/class.dateinterval.php)

Parameter comment not aligned correctly; expected 39 spaces but found 2

     *  - integer - number of seconds. For example: value `131` represents `2 minutes, 11 seconds`

Parameter comment not aligned correctly; expected 39 spaces but found 2

     *  - ISO8601 duration format. For example, all of these values represent `1 day, 2 hours, 30 minutes` duration:

Parameter comment not aligned correctly; expected 39 spaces but found 2

     *    `2015-01-01T13:00:00Z/2015-01-02T13:30:00Z` - between two datetime values

Parameter comment not aligned correctly; expected 39 spaces but found 4

     *    `2015-01-01T13:00:00Z/P1D2H30M` - time interval after datetime value

Parameter comment not aligned correctly; expected 39 spaces but found 4

     *    `P1D2H30M/2015-01-02T13:30:00Z` - time interval before datetime value

Parameter comment not aligned correctly; expected 39 spaces but found 4

     *    `P1D2H30M` - simply a date interval

Parameter comment not aligned correctly; expected 39 spaces but found 4

     *    `P-1D2H30M` - a negative date interval (`-1 day, 2 hours, 30 minutes`)

Parameter comment not aligned correctly; expected 39 spaces but found 4

     *
     * @return string the formatted duration.
     */
    public function humanDuration(DateInterval|string|int $value): string
    {
        return Typogrify::$plugin->typogrify->humanDuration($value);
    }

    /**
     * Formats the value as the time interval between a date and now in human readable form.
     *
     * This method can be used in three different ways:
     *
     * 1. Using a timestamp that is relative to `now`.
     * 2. Using a timestamp that is relative to the `$referenceTime`.
     * 3. Using a `DateInterval` object.
     *
     * @param int|string|DateTime|DateInterval $value the value to be formatted. The following

Expected 9 spaces after parameter name; 1 found

     * types of value are supported:

Parameter comment not aligned correctly; expected 48 spaces but found 1

     *
     * - an integer representing a UNIX timestamp

Parameter comment not aligned correctly; expected 48 spaces but found 1

     * - a string that can be [parsed to create a DateTime object](http://php.net/manual/en/datetime.formats.php).

Parameter comment not aligned correctly; expected 48 spaces but found 1

     *   The timestamp is assumed to be in [[defaultTimeZone]] unless a time zone is explicitly given.

Parameter comment not aligned correctly; expected 48 spaces but found 3

     * - a PHP [DateTime](http://php.net/manual/en/class.datetime.php) object

Parameter comment not aligned correctly; expected 48 spaces but found 1

     * - a PHP DateInterval object (a positive time interval will refer to the past, a negative one to the future)

Parameter comment not aligned correctly; expected 48 spaces but found 1

     *
     * @param null|int|string|DateTime $referenceTime if specified the value is used as a reference time instead of `now`

Parameter tags must be grouped together in a doc comment

Expected 9 spaces after parameter type; 1 found

     * when `$value` is not a `DateInterval` object.

Parameter comment not aligned correctly; expected 48 spaces but found 1

     *
     * @return string the formatted result.
     */
    public function humanRelativeTime(int|string|DateTime|DateInterval $value, null|int|string|DateTime $referenceTime = null): string
    {
        return Typogrify::$plugin->typogrify->humanRelativeTime($value, $referenceTime);
    }

    /**
     * Converts number to its ordinal English form
     * For example, converts 13 to 13th, 2 to 2nd
     *
     * @param int $number

Missing parameter comment

     *
     * @return string
     */
    public function ordinalize(int $number): string
    {
        return Typogrify::$plugin->typogrify->ordinalize($number);
    }

    /**
     * Converts a word to its plural form
     * For example, 'apple' will become 'apples', and 'child' will become 'children'
     *
     * @param string $word

Missing parameter comment

     * @param int $number

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function pluralize(string $word, int $number = 2): string
    {
        return Typogrify::$plugin->typogrify->pluralize($word, $number);
    }

    /**
     * Converts a word to its singular form
     * For example, 'apples' will become 'apple', and 'children' will become 'child'
     *
     * @param string $word

Missing parameter comment

     * @param int $number

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function singularize(string $word, int $number = 1): string
    {
        return Typogrify::$plugin->typogrify->singularize($word, $number);
    }

    /**
     * Returns transliterated version of a string
     * For example, 获取到 どちら Українська: ґ,є, Српска: ђ, њ, џ! ¿Español?
     * will be transliterated to huo qu dao dochira Ukrainsʹka: g,e, Srpska: d, n, d! ¿Espanol?
     *
     * @param string $string

Missing parameter comment

     * @param null $transliterator

Are you sure the doc-type for parameter $transliterator is correct as it would always require null to be passed?

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function transliterate(string $string, $transliterator = null): string
    {
        return Typogrify::$plugin->typogrify->transliterate($string, $transliterator);
    }

    /**
     * Limits a string by word count. If $substring is provided, and truncating occurs, the
     * string is further truncated so that the substring may be appended without
     * exceeding the desired length.
     *
     * @param string $string

Missing parameter comment

     * @param int $length

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param string $substring

Missing parameter comment

     *
     * @return string
     */
    public function wordLimit(string $string, int $length, string $substring = '…'): string
    {
        return Typogrify::$plugin->typogrify->wordLimit($string, $length, $substring);
    }

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

    /**
     * Normalize the passed in text to ensure that untrusted strings are escaped
     *
     * @param $text

Missing parameter comment

     *
     * @return string
     */
    private function normalizeText($text): string

Private method name "TypogrifyVariable::normalizeText" must be prefixed with an underscore

    {
        /* @TODO: try to resolve at a later date; Twig's `| raw` just returns a string, not `Markup` so we can't use that as a check
         * if ($text instanceof Markup) {
         * // Either came from a Redactor field (or the like) or they manually added a |raw tag. We can trust it
         * $text = (string)$text;
         * } else {
         * // We don't trust it, so escape any HTML
         * $twig = Craft::$app->view->twig;
         * try {
         * $text = twig_escape_filter($twig, $text);
         * } catch (\Twig_Error_Runtime $e) {
         * $error = $e->getMessage();
         * Craft::error($error, __METHOD__);
         * // We don't want unescaped text slipping through, so set the text to the error message
         * $text = $error;
         * }
         * }
         */
        // If it's null or otherwise empty, just return an empty string
        if (empty($text)) {
            $text = '';
        }
        $text = (string)$text;

        $settings = Typogrify::$plugin->getSettings();

The method getSettings() does not exist on null.

        if ($settings && $settings['default_escape'] === true) {
            $twig = Craft::$app->getView()->getTwig();
            $twig_escape_filter = $twig->getFilter('e');
            if ($twig_escape_filter) {
                $text = $twig_escape_filter->getCallable()($twig, $text);
            }
        }

        return $text;
    }
}