Cecil\Collection\Page\PrefixSuffix

Complexity

Total Complexity

17

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	has()	0	4	1
A	hasPrefix()	0	4	1
A	hasSuffix()	0	4	1
A	get()	0	14	4
A	getPrefix()	0	4	1
A	getSuffix()	0	4	1
A	sub()	0	15	3
A	subPrefix()	0	10	2
A	getPattern()	0	11	3

<?php
/*
 * Copyright (c) Arnaud Ligny <arnaud@ligny.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Collection\Page;

/**
 * Class PrefixSuffix.
 */
class PrefixSuffix

PrefixSuffix does not seem to conform to the naming convention (Utils?$).

{
    // https://regex101.com/r/tJWUrd/6
    // ie: "blog/2017-10-19-post-1.md" prefix is "2017-10-19"
    // ie: "projet/1-projet-a.md" prefix is "1"
    const PREFIX_PATTERN = '^(|.*\/)(([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])|[0-9]+)(-|_|\.)(.*)$';
    // https://regex101.com/r/GlgBdT/7
    // ie: "blog/2017-10-19-post-1.en.md" suffix is "en"
    // ie: "projet/1-projet-a.fr-FR.md" suffix is "fr-FR"
    const SUFFIX_PATTERN = '^(.*)\.([a-z]{2}(-[A-Z]{2})?)$';

    /**
     * Return true if the string contains a prefix or a suffix.
     *
     * @param string $string
     * @param string $type
     *
     * @return bool
     */
    protected static function has(string $string, string $type): bool
    {
        return (bool) preg_match('/'.self::getPattern($type).'/', $string);
    }

    /**
     * Return true if the string contains a prefix.
     *
     * @param string $string
     *
     * @return bool
     */
    public static function hasPrefix(string $string): bool
    {
        return self::has($string, 'prefix');
    }

    /**
     * Return true if the string contains a suffix.
     *
     * @param string $string
     *
     * @return bool
     */
    public static function hasSuffix(string $string): bool
    {
        return self::has($string, 'suffix');
    }

    /**
     * Return the prefix or the suffix if exists.
     *
     * @param string $string
     * @param string $type
     *
     * @return string[]|null

Should the return type not be string|null?

     */
    protected static function get(string $string, string $type): ?string
    {
        if (self::has($string, $type)) {
            preg_match('/'.self::getPattern($type).'/', $string, $matches);
            switch ($type) {
                case 'prefix':
                    return $matches[2];
                case 'suffix':
                    return $matches[2];
            }
        }

        return null;
    }

    /**
     * Return the prefix if exists.
     *
     * @param string $string
     *
     * @return string[]|null

Should the return type not be string|null?

     */
    public static function getPrefix(string $string): ?string
    {
        return self::get($string, 'prefix');
    }

    /**
     * Return the suffix if exists.
     *
     * @param string $string
     *
     * @return string[]|null

Should the return type not be string|null?

     */
    public static function getSuffix(string $string): ?string
    {
        return self::get($string, 'suffix');
    }

    /**
     * Return string without the prefix and the suffix (if exists).
     *
     * @param string $string
     *
     * @return string
     */
    public static function sub(string $string): string
    {
        if (self::hasPrefix($string)) {
            preg_match('/'.self::getPattern('prefix').'/', $string, $matches);

            $string = $matches[1].$matches[7];
        }
        if (self::hasSuffix($string)) {
            preg_match('/'.self::getPattern('suffix').'/', $string, $matches);

            $string = $matches[1];
        }

        return $string;
    }

    /**
     * Return string without the prefix (if exists).
     *
     * @param string $string
     *
     * @return string
     */
    public static function subPrefix(string $string): string
    {
        if (self::hasPrefix($string)) {
            preg_match('/'.self::getPattern('prefix').'/', $string, $matches);

            return $matches[1].$matches[7];
        }

        return $string;
    }

    /**
     * Return expreg pattern by $type.
     *
     * @param string $type
     *
     * @return string
     */
    protected static function getPattern(string $type): string
    {
        switch ($type) {
            case 'prefix':
                return self::PREFIX_PATTERN;
            case 'suffix':
                return self::SUFFIX_PATTERN;
            default:
                throw new Exception(\sprintf('%s must be "prefix" or "suffix"', $type));
        }
    }
}