|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* This file is part of Cecil. |
|
5
|
|
|
* |
|
6
|
|
|
* (c) Arnaud Ligny <[email protected]> |
|
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\Generator; |
|
15
|
|
|
|
|
16
|
|
|
use Cecil\Collection\Page\Collection as PagesCollection; |
|
17
|
|
|
use Cecil\Collection\Page\Page; |
|
18
|
|
|
use Cecil\Collection\Page\Type; |
|
19
|
|
|
use Cecil\Exception\RuntimeException; |
|
20
|
|
|
|
|
21
|
|
|
/** |
|
22
|
|
|
* Section generator class. |
|
23
|
|
|
* |
|
24
|
|
|
* This class is responsible for generating sections from the pages in the builder. |
|
25
|
|
|
* It identifies sections based on the 'section' variable in each page, and |
|
26
|
|
|
* creates a new page for each section. The generated pages are added to the |
|
27
|
|
|
* collection of generated pages. It also handles sorting of subpages and |
|
28
|
|
|
* adding navigation links (next and previous) to the section pages. |
|
29
|
|
|
*/ |
|
30
|
|
|
class Section extends AbstractGenerator implements GeneratorInterface |
|
31
|
|
|
{ |
|
32
|
|
|
/** |
|
33
|
|
|
* {@inheritdoc} |
|
34
|
|
|
*/ |
|
35
|
1 |
|
public function generate(): void |
|
36
|
|
|
{ |
|
37
|
1 |
|
$sections = []; |
|
38
|
|
|
|
|
39
|
|
|
// identifying sections from all pages |
|
40
|
|
|
/** @var Page $page */ |
|
41
|
1 |
|
foreach ($this->builder->getPages() ?? [] as $page) { |
|
42
|
|
|
// top level (root) sections |
|
43
|
1 |
|
if ($page->getSection()) { |
|
44
|
|
|
// do not add "not published" and "not excluded" pages to its section |
|
45
|
|
|
if ( |
|
46
|
1 |
|
$page->getVariable('published') !== true |
|
47
|
1 |
|
|| ($page->getVariable('excluded') || $page->getVariable('exclude')) |
|
48
|
|
|
) { |
|
49
|
1 |
|
continue; |
|
50
|
|
|
} |
|
51
|
1 |
|
$sections[$page->getSection()][$page->getVariable('language', $this->config->getLanguageDefault())][] = $page; |
|
52
|
|
|
} |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
// adds each section to pages collection |
|
56
|
1 |
|
if (\count($sections) > 0) { |
|
57
|
1 |
|
$menuWeight = 100; |
|
58
|
|
|
|
|
59
|
1 |
|
foreach ($sections as $section => $languages) { |
|
60
|
1 |
|
foreach ($languages as $language => $pagesAsArray) { |
|
61
|
1 |
|
$pageId = $path = Page::slugify($section); |
|
62
|
1 |
|
if ($language != $this->config->getLanguageDefault()) { |
|
63
|
1 |
|
$pageId = "$language/$pageId"; |
|
64
|
|
|
} |
|
65
|
1 |
|
$page = (new Page($pageId))->setVariable('title', ucfirst($section)) |
|
66
|
1 |
|
->setPath($path); |
|
67
|
1 |
|
if ($this->builder->getPages()->has($pageId)) { |
|
68
|
1 |
|
$page = clone $this->builder->getPages()->get($pageId); |
|
69
|
|
|
} |
|
70
|
1 |
|
$pages = new PagesCollection("section-$pageId", $pagesAsArray); |
|
71
|
|
|
// cascade variables |
|
72
|
1 |
|
if ($page->hasVariable('cascade')) { |
|
73
|
1 |
|
$cascade = $page->getVariable('cascade'); |
|
74
|
1 |
|
if (\is_array($cascade)) { |
|
75
|
1 |
|
$pages->map(function (Page $page) use ($cascade) { |
|
76
|
1 |
|
foreach ($cascade as $key => $value) { |
|
77
|
1 |
|
if (!$page->hasVariable($key)) { |
|
78
|
1 |
|
$page->setVariable($key, $value); |
|
79
|
|
|
} |
|
80
|
|
|
} |
|
81
|
1 |
|
}); |
|
82
|
|
|
} |
|
83
|
|
|
} |
|
84
|
|
|
// sorts pages |
|
85
|
1 |
|
$sortBy = $page->getVariable('sortby') ?? $this->config->get('pages.sortby'); |
|
86
|
1 |
|
$pages = $pages->sortBy($sortBy); |
|
87
|
|
|
// adds navigation links (excludes taxonomy pages) |
|
88
|
1 |
|
$sortBy = $page->getVariable('sortby')['variable'] ?? $page->getVariable('sortby') ?? $this->config->get('pages.sortby')['variable'] ?? $this->config->get('pages.sortby') ?? 'date'; |
|
89
|
1 |
|
if (!\in_array($page->getId(), array_keys((array) $this->config->get('taxonomies')))) { |
|
90
|
1 |
|
$this->addNavigationLinks($pages, $sortBy, $page->getVariable('circular') ?? false); |
|
91
|
|
|
} |
|
92
|
|
|
// creates page for each section |
|
93
|
1 |
|
$page->setType(Type::SECTION->value) |
|
94
|
1 |
|
->setSection($path) |
|
95
|
1 |
|
->setPages($pages) |
|
96
|
1 |
|
->setVariable('language', $language) |
|
97
|
1 |
|
->setVariable('date', $pages->first()->getVariable('date')) |
|
98
|
1 |
|
->setVariable('langref', $path); |
|
99
|
|
|
// human readable title |
|
100
|
1 |
|
if ($page->getVariable('title') == 'index') { |
|
101
|
1 |
|
$page->setVariable('title', $section); |
|
102
|
|
|
} |
|
103
|
|
|
// default menu |
|
104
|
1 |
|
if (!$page->getVariable('menu')) { |
|
105
|
1 |
|
$page->setVariable('menu', ['main' => ['weight' => $menuWeight]]); |
|
106
|
|
|
} |
|
107
|
|
|
|
|
108
|
|
|
try { |
|
109
|
1 |
|
$this->generatedPages->add($page); |
|
110
|
|
|
} catch (\DomainException) { |
|
111
|
|
|
$this->generatedPages->replace($page->getId(), $page); |
|
112
|
|
|
} |
|
113
|
|
|
} |
|
114
|
1 |
|
$menuWeight += 10; |
|
115
|
|
|
} |
|
116
|
|
|
} |
|
117
|
|
|
} |
|
118
|
|
|
|
|
119
|
|
|
/** |
|
120
|
|
|
* Adds navigation (next and prev) to each pages of a section. |
|
121
|
|
|
*/ |
|
122
|
1 |
|
protected function addNavigationLinks(PagesCollection $pages, string|null $sortBy = null, bool $circular = false): void |
|
123
|
|
|
{ |
|
124
|
1 |
|
$pagesAsArray = $pages->toArray(); |
|
125
|
1 |
|
if ($sortBy === null || $sortBy == 'date' || $sortBy == 'updated') { |
|
126
|
1 |
|
$pagesAsArray = array_reverse($pagesAsArray); |
|
127
|
|
|
} |
|
128
|
1 |
|
$count = \count($pagesAsArray); |
|
129
|
1 |
|
if ($count > 1) { |
|
130
|
1 |
|
foreach ($pagesAsArray as $position => $page) { |
|
131
|
|
|
switch ($position) { |
|
132
|
1 |
|
case 0: // first |
|
133
|
1 |
|
if ($circular) { |
|
134
|
1 |
|
$page->setVariables([ |
|
135
|
1 |
|
'prev' => $pagesAsArray[$count - 1], |
|
136
|
1 |
|
]); |
|
137
|
|
|
} |
|
138
|
1 |
|
$page->setVariables([ |
|
139
|
1 |
|
'next' => $pagesAsArray[$position + 1], |
|
140
|
1 |
|
]); |
|
141
|
1 |
|
break; |
|
142
|
1 |
|
case $count - 1: // last |
|
143
|
1 |
|
$page->setVariables([ |
|
144
|
1 |
|
'prev' => $pagesAsArray[$position - 1], |
|
145
|
1 |
|
]); |
|
146
|
1 |
|
if ($circular) { |
|
147
|
1 |
|
$page->setVariables([ |
|
148
|
1 |
|
'next' => $pagesAsArray[0], |
|
149
|
1 |
|
]); |
|
150
|
|
|
} |
|
151
|
1 |
|
break; |
|
152
|
|
|
default: |
|
153
|
1 |
|
$page->setVariables([ |
|
154
|
1 |
|
'prev' => $pagesAsArray[$position - 1], |
|
155
|
1 |
|
'next' => $pagesAsArray[$position + 1], |
|
156
|
1 |
|
]); |
|
157
|
1 |
|
break; |
|
158
|
|
|
} |
|
159
|
1 |
|
$this->generatedPages->add($page); |
|
160
|
|
|
} |
|
161
|
|
|
} |
|
162
|
|
|
} |
|
163
|
|
|
} |
|
164
|
|
|
|
Cecilapp /
Cecil
