Passed
Branch decouple-schema-constructors (7e448c)
by Caen
02:54
created

DocumentationPageSchema::getDocumentationPageCategory()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 9
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 3
c 0
b 0
f 0
nc 2
nop 0
dl 0
loc 9
rs 10
1
<?php
2
3
namespace Hyde\Framework\Concerns\FrontMatter\Schemas;
4
5
use Hyde\Framework\Hyde;
6
7
/**
8
 * These are the front matter properties that are supported for Hyde documentation pages.
9
 */
10
trait DocumentationPageSchema
11
{
12
    /**
13
     * The sidebar category group, if any.
14
     *
15
     * Can be overridden in front matter, or by putting the
16
     * source file in a subdirectory of the same category name.
17
     */
18
    public ?string $category = null;
19
20
    /**
21
     * The label for the page shown in the sidebar.
22
     */
23
    public ?string $label = null;
24
25
    /**
26
     * Hides the page from the sidebar.
27
     */
28
    public ?bool $hidden = null;
29
30
    /**
31
     * The priority of the page used for ordering the sidebar.
32
     */
33
    public ?int $priority = null;
34
}
35