26414009793

Committed 25 May 2026 06:15PM UTC coverage: 82.54%. First build

Build # 26414009793

Build Type

Pull #2383

github

Committed by

web-flow

Commit Message

Merge e6b723fa2 into 4904a42be

Pull Request Pull Request #2383: refactor: asset handling and add renderer extensions

Coverage Stats

282 of 358 new or added lines in 10 files covered. (78.77%)

3503 of 4244 relevant lines covered (82.54%)

0.83 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.7

/src/Renderer/Extension/Collection.php

<?php

/**
 * This file is part of Cecil.
 *
 * (c) Arnaud Ligny <arnaud@ligny.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cecil\Renderer\Extension;

use Cecil\Builder;
use Cecil\Collection\CollectionInterface;
use Cecil\Collection\Page\Collection as PagesCollection;
use Cecil\Collection\Page\Page;
use Cecil\Collection\Page\Type;
use Twig\Extension\AbstractExtension;

/**
 * Collection Twig extension.
 *
 * Provides filters for filtering and sorting page collections in Twig templates.
 */
class Collection extends AbstractExtension
{
    /** @var Builder */
    protected $builder;

    public function __construct(Builder $builder)
    {
        $this->builder = $builder;
    }

    public function getFilters(): array
    {
        return [
            new \Twig\TwigFilter('sort_by_title', [$this, 'sortByTitle']),
            new \Twig\TwigFilter('sort_by_date', [$this, 'sortByDate']),
            new \Twig\TwigFilter('sort_by_weight', [$this, 'sortByWeight']),
            new \Twig\TwigFilter('filter_by', [$this, 'filterBy']),
        ];
    }

    /**
     * Filters by Section.
     */
    public function filterBySection(PagesCollection $pages, string $section): CollectionInterface
    {
        return $this->filterBy($pages, 'section', $section);
    }

    /**
     * Filters a pages collection by variable's name/value.
     */
    public function filterBy(PagesCollection $pages, string $variable, string $value): CollectionInterface
    {
        $filteredPages = $pages->filter(function (Page $page) use ($variable, $value) {
            // is a dedicated getter exists?
            $method = 'get' . ucfirst($variable);
            if (method_exists($page, $method) && $page->$method() == $value) {
                return $page->getType() == Type::PAGE->value && !$page->isVirtual() && true;
            }
            // or a classic variable
            if ($page->getVariable($variable) == $value) {
                return $page->getType() == Type::PAGE->value && !$page->isVirtual() && true;
            }
        });

        return $filteredPages;
    }

    /**
     * Sorts a collection by title.
     */
    public function sortByTitle(\Traversable $collection): array
    {
        $sort = \SORT_ASC;

        $collection = iterator_to_array($collection);
        array_multisort(array_keys(/** @scrutinizer ignore-type */ $collection), $sort, \SORT_NATURAL | \SORT_FLAG_CASE, $collection);

        return $collection;
    }

    /**
     * Sorts a collection by weight.
     *
     * @param \Traversable|array $collection
     */
    public function sortByWeight($collection): array
    {
        $callback = function ($a, $b) {
            if (!isset($a['weight'])) {
                $a['weight'] = 0;
            }
            if (!isset($b['weight'])) {
                $b['weight'] = 0;
            }
            if ($a['weight'] == $b['weight']) {
                return 0;
            }

            return $a['weight'] < $b['weight'] ? -1 : 1;
        };

        if (!\is_array($collection)) {
            $collection = iterator_to_array($collection);
        }
        usort(/** @scrutinizer ignore-type */ $collection, $callback);

        return $collection;
    }

    /**
     * Sorts by creation date (or 'updated' date): the most recent first.
     */
    public function sortByDate(\Traversable $collection, string $variable = 'date', bool $descTitle = false): array
    {
        $callback = function ($a, $b) use ($variable, $descTitle) {
            if ($a[$variable] == $b[$variable]) {
                // if dates are equal and "descTitle" is true
                if ($descTitle && (isset($a['title']) && isset($b['title']))) {
                    return strnatcmp($b['title'], $a['title']);
                }

                return 0;
            }

            return $a[$variable] > $b[$variable] ? -1 : 1;
        };

        $collection = iterator_to_array($collection);
        usort(/** @scrutinizer ignore-type */ $collection, $callback);

        return $collection;
    }
}

1	<?php
2
3	/**
4	* This file is part of Cecil.
5	*
6	* (c) Arnaud Ligny <arnaud@ligny.fr>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace Cecil\Renderer\Extension;
15
16	use Cecil\Builder;
17	use Cecil\Collection\CollectionInterface;
18	use Cecil\Collection\Page\Collection as PagesCollection;
19	use Cecil\Collection\Page\Page;
20	use Cecil\Collection\Page\Type;
21	use Twig\Extension\AbstractExtension;
22
23	/**
24	* Collection Twig extension.
25	*
26	* Provides filters for filtering and sorting page collections in Twig templates.
27	*/
28	class Collection extends AbstractExtension
29	{
30	/** @var Builder */
31	protected $builder;
32
33	public function __construct(Builder $builder)
34	{
35	$this->builder = $builder;	1✔
36	}
37
38	public function getFilters(): array
39	{
40	return [	1✔
41	new \Twig\TwigFilter('sort_by_title', [$this, 'sortByTitle']),	1✔
42	new \Twig\TwigFilter('sort_by_date', [$this, 'sortByDate']),	1✔
43	new \Twig\TwigFilter('sort_by_weight', [$this, 'sortByWeight']),	1✔
44	new \Twig\TwigFilter('filter_by', [$this, 'filterBy']),	1✔
45	];	1✔
46	}
47
48	/**
49	* Filters by Section.
50	*/
51	public function filterBySection(PagesCollection $pages, string $section): CollectionInterface
52	{
NEW 53	return $this->filterBy($pages, 'section', $section);	×
54	}
55
56	/**
57	* Filters a pages collection by variable's name/value.
58	*/
59	public function filterBy(PagesCollection $pages, string $variable, string $value): CollectionInterface
60	{
61	$filteredPages = $pages->filter(function (Page $page) use ($variable, $value) {	1✔
62	// is a dedicated getter exists?
63	$method = 'get' . ucfirst($variable);	1✔
64	if (method_exists($page, $method) && $page->$method() == $value) {	1✔
NEW 65	return $page->getType() == Type::PAGE->value && !$page->isVirtual() && true;	×
66	}
67	// or a classic variable
68	if ($page->getVariable($variable) == $value) {	1✔
69	return $page->getType() == Type::PAGE->value && !$page->isVirtual() && true;	1✔
70	}
71	});	1✔
72
73	return $filteredPages;	1✔
74	}
75
76	/**
77	* Sorts a collection by title.
78	*/
79	public function sortByTitle(\Traversable $collection): array
80	{
81	$sort = \SORT_ASC;	1✔
82
83	$collection = iterator_to_array($collection);	1✔
84	array_multisort(array_keys(/** @scrutinizer ignore-type */ $collection), $sort, \SORT_NATURAL \| \SORT_FLAG_CASE, $collection);	1✔
85
86	return $collection;	1✔
87	}
88
89	/**
90	* Sorts a collection by weight.
91	*
92	* @param \Traversable\|array $collection
93	*/
94	public function sortByWeight($collection): array
95	{
96	$callback = function ($a, $b) {	1✔
97	if (!isset($a['weight'])) {	1✔
98	$a['weight'] = 0;	1✔
99	}
100	if (!isset($b['weight'])) {	1✔
NEW 101	$b['weight'] = 0;	×
102	}
103	if ($a['weight'] == $b['weight']) {	1✔
104	return 0;	1✔
105	}
106
107	return $a['weight'] < $b['weight'] ? -1 : 1;	1✔
108	};	1✔
109
110	if (!\is_array($collection)) {	1✔
111	$collection = iterator_to_array($collection);	1✔
112	}
113	usort(/** @scrutinizer ignore-type */ $collection, $callback);	1✔
114
115	return $collection;	1✔
116	}
117
118	/**
119	* Sorts by creation date (or 'updated' date): the most recent first.
120	*/
121	public function sortByDate(\Traversable $collection, string $variable = 'date', bool $descTitle = false): array
122	{
123	$callback = function ($a, $b) use ($variable, $descTitle) {	1✔
124	if ($a[$variable] == $b[$variable]) {	1✔
125	// if dates are equal and "descTitle" is true
126	if ($descTitle && (isset($a['title']) && isset($b['title']))) {	1✔
NEW 127	return strnatcmp($b['title'], $a['title']);	×
128	}
129
130	return 0;	1✔
131	}
132
133	return $a[$variable] > $b[$variable] ? -1 : 1;	1✔
134	};	1✔
135
136	$collection = iterator_to_array($collection);	1✔
137	usort(/** @scrutinizer ignore-type */ $collection, $callback);	1✔
138
139	return $collection;	1✔
140	}
141	}

Cecilapp / Cecil / 26414009793

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous