DocumentTrait::parseDocumentTitleParts() - Code Metrics - Inspection of "Created an abstract template for web pages (displa..." - locomotivemtl/charcoal-cms - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#9)

unknown

created 2019-09-16 20:21 UTC

DocumentTrait::parseDocumentTitleParts() A

↳ Parent: DocumentTrait

Complexity

Conditions	6
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.0444
c	0
b	0
f	0
cc	6
nc	5
nop	1

<?php

namespace Charcoal\Cms\Support;

use InvalidArgumentException;

/**
 * Additional utilities for the HTML document.
 */
trait DocumentTrait
{
    /**
     * Parse the document title parts.
     *
     * @return string[]
     */
    protected function documentTitleParts()
    {
        return [
            'title' => $this->title(),
            'site'  => $this->siteName(),
        ];
    }

    /**
     * Retrieve the document title separator.
     *
     * @return string
     */
    protected function documentTitleSeparator()
    {
        return '—';
    }

    /**
     * Parse the document title separator.
     *
     * @return string
     */
    protected function parseDocumentTitleSeparator()
    {
        $delim = trim($this->documentTitleSeparator());
        if (empty($delim)) {
            return '';
        }

        return sprintf(' %s ', $delim);
    }

    /**
     * Parse the document title.
     *
     * @param  array $parts The document title parts.
     * @return string The concatenated title.
     */
    protected function parseDocumentTitle(array $parts)
    {
        $parts = $this->parseDocumentTitleParts($parts);
        $delim = $this->parseDocumentTitleSeparator();
        $title = implode($delim, $parts);

        return $title;
    }

    /**
     * Parse the document title segments.
     *
     * Iterates over each value in $parts passing them to
     * {@see DocumentTrait::filterDocumentTitlePart}.
     * If the method returns TRUE, the current value from $parts
     * is concatenated into the title.
     *
     * @param  array $parts The document title parts.
     * @return array The parsed and filtered segments.
     */
    protected function parseDocumentTitleParts(array $parts)
    {
        $segments = [];
        foreach ($parts as $key => $value) {
            $value = $this->parseDocumentTitlePart($value, $key, $parts);
            if ($value === true) {
                $value = $parts[$key];
            }

            if (is_bool($value) || (empty($value) && !is_numeric($value))) {
                continue;
            }

            $segments[$key] = (string)$value;
        }

        return $segments;
    }

    /**
     * Parse the document title part.
     *
     * If you want to exclude the site name ("site") from the document title
     * if it is present in other parts, you can use the following snippet:
     *
     * ```php
     * if ($key === 'site') {
     *     foreach ($parts as $k => $v) {
     *         if ($k !== $key && strpos($v, $value) !== false) {
     *             return null;
     *         }
     *     }
     * }
     * ```
     *
     * @param  string $value The value of the current iteration.
     * @param  string $key   The key/index of the current iteration.
     * @param  array  $parts The document title parts.
     * @return mixed  The mutated value of the current iteration.
     *     If $value is equal to FALSE (converted to boolean; excluding "0"), it is excluded from the document title.
     *     If the method returns TRUE, the original $value is included into the document title.
     */
    protected function parseDocumentTitlePart($value, $key, array $parts)

    {
        return $value;
    }

    /**
     * Retrieve the document title.
     *
     * @throws InvalidArgumentException If the document title structure is invalid.
     * @return string
     */
    final public function documentTitle()
    {
        $parts = $this->documentTitleParts();
        if (array_diff_key([ 'title' => true, 'site' => true ], $parts)) {
            throw new InvalidArgumentException(
                'The document title parts requires at least a "title" and a "site"'
            );
        }

        return $this->parseDocumentTitle($parts);
    }

    /**
     * Retrieve the site name.
     *
     * @return string|null
     */
    abstract public function siteName();

    /**
     * Retrieve the title of the page (from the context).
     *
     * @return string|null
     */
    abstract public function title();

    /**
     * Retrieve the current object relative to the context.
     *
     * @return \Charcoal\Model\ModelInterface
     */
    abstract public function contextObject();
}


1			<?php
2
3			namespace Charcoal\Cms\Support;
4
5			use InvalidArgumentException;
6
7			/**
8			* Additional utilities for the HTML document.
9			*/
10			trait DocumentTrait
11			{
12			/**
13			* Parse the document title parts.
14			*
15			* @return string[]
16			*/
17			protected function documentTitleParts()
18			{
19			return [
20			'title' => $this->title(),
21			'site' => $this->siteName(),
22			];
23			}
24
25			/**
26			* Retrieve the document title separator.
27			*
28			* @return string
29			*/
30			protected function documentTitleSeparator()
31			{
32			return '—';
33			}
34
35			/**
36			* Parse the document title separator.
37			*
38			* @return string
39			*/
40			protected function parseDocumentTitleSeparator()
41			{
42			$delim = trim($this->documentTitleSeparator());
43			if (empty($delim)) {
44			return '';
45			}
46
47			return sprintf(' %s ', $delim);
48			}
49
50			/**
51			* Parse the document title.
52			*
53			* @param array $parts The document title parts.
54			* @return string The concatenated title.
55			*/
56			protected function parseDocumentTitle(array $parts)
57			{
58			$parts = $this->parseDocumentTitleParts($parts);
59			$delim = $this->parseDocumentTitleSeparator();
60			$title = implode($delim, $parts);
61
62			return $title;
63			}
64
65			/**
66			* Parse the document title segments.
67			*
68			* Iterates over each value in $parts passing them to
69			* {@see DocumentTrait::filterDocumentTitlePart}.
70			* If the method returns TRUE, the current value from $parts
71			* is concatenated into the title.
72			*
73			* @param array $parts The document title parts.
74			* @return array The parsed and filtered segments.
75			*/
76			protected function parseDocumentTitleParts(array $parts)
77			{
78			$segments = [];
79			foreach ($parts as $key => $value) {
80			$value = $this->parseDocumentTitlePart($value, $key, $parts);
81			if ($value === true) {
82			$value = $parts[$key];
83			}
84
85			if (is_bool($value) \|\| (empty($value) && !is_numeric($value))) {
86			continue;
87			}
88
89			$segments[$key] = (string)$value;
90			}
91
92			return $segments;
93			}
94
95			/**
96			* Parse the document title part.
97			*
98			* If you want to exclude the site name ("site") from the document title
99			* if it is present in other parts, you can use the following snippet:
100			*
101			* ```php
102			* if ($key === 'site') {
103			* foreach ($parts as $k => $v) {
104			* if ($k !== $key && strpos($v, $value) !== false) {
105			* return null;
106			* }
107			* }
108			* }
109			* ```
110			*
111			* @param string $value The value of the current iteration.
112			* @param string $key The key/index of the current iteration.
113			* @param array $parts The document title parts.
114			* @return mixed The mutated value of the current iteration.
115			* If $value is equal to FALSE (converted to boolean; excluding "0"), it is excluded from the document title.
116			* If the method returns TRUE, the original $value is included into the document title.
117			*/
118			protected function parseDocumentTitlePart($value, $key, array $parts)
			0 ignored issues – show Unused Code introduced 2019-09-16 20:29 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2019-09-16 20:29 UTC by Report Bug Copy Issue Report The parameter `$parts` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
119			{
120			return $value;
121			}
122
123			/**
124			* Retrieve the document title.
125			*
126			* @throws InvalidArgumentException If the document title structure is invalid.
127			* @return string
128			*/
129			final public function documentTitle()
130			{
131			$parts = $this->documentTitleParts();
132			if (array_diff_key([ 'title' => true, 'site' => true ], $parts)) {
133			throw new InvalidArgumentException(
134			'The document title parts requires at least a "title" and a "site"'
135			);
136			}
137
138			return $this->parseDocumentTitle($parts);
139			}
140
141			/**
142			* Retrieve the site name.
143			*
144			* @return string\|null
145			*/
146			abstract public function siteName();
147
148			/**
149			* Retrieve the title of the page (from the context).
150			*
151			* @return string\|null
152			*/
153			abstract public function title();
154
155			/**
156			* Retrieve the current object relative to the context.
157			*
158			* @return \Charcoal\Model\ModelInterface
159			*/
160			abstract public function contextObject();
161			}
162

locomotivemtl / charcoal-cms

Pull Request — master (#9)

DocumentTrait::parseDocumentTitleParts() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like