Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
|||
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | namespace Hyde\Markdown\Contracts\FrontMatter; |
| 6 | |
| 7 | /** |
| 8 | * Front matter schema interfaces are used by various Hyde components to |
| 9 | * specify what data they provide or contain. They also serve as a |
| 10 | * convenient way to see the supported front matter properties. |
| 11 | * |
| 12 | * Please note that while the array keys are directly connected to the supported |
| 13 | * front matter properties, they are covered by the backwards compatibility |
| 14 | * promise for HydePHP. However, the formats of the values are not. |
| 15 | * Furthermore, as interface implementations are just a guideline, a class may |
| 16 | * stop implementing an interface at any time, so you should not use |
| 17 | * the schema interfaces for type-hinting. |
| 18 | * |
| 19 | * Also note that if a root property value is an array, it means that either one of |
| 20 | * the types are supported. If a type within that array is an array, it means that |
| 21 | * the property is a sub-schema, which is an array of the supported types. |
| 22 | * |
| 23 | * All front matter properties are optional, unless otherwise specified. |
| 24 | */ |
| 25 | interface FrontMatterSchema |
| 26 | { |
| 27 | // |
| 28 | } |