1 | <?php |
||
14 | abstract class Entry { |
||
15 | |||
16 | /** |
||
17 | * @var string The identifier of the backend used for this entry. |
||
18 | * @api |
||
19 | * @since 2.0 |
||
20 | */ |
||
21 | public static $backend = null; |
||
22 | |||
23 | /** |
||
24 | * @var int The ID for this entry. |
||
25 | * |
||
26 | * @api |
||
27 | * @since 2.0 |
||
28 | */ |
||
29 | public $ID = null; |
||
30 | |||
31 | /** |
||
32 | * @var mixed The backing entry. |
||
33 | */ |
||
34 | protected $entry; |
||
35 | |||
36 | /** |
||
37 | * Adds the necessary rewrites for single Entries. |
||
38 | * |
||
39 | * @internal |
||
40 | * @return void |
||
41 | */ |
||
42 | 1 | public static function add_rewrite_endpoint() { |
|
54 | |||
55 | /** |
||
56 | * Return the endpoint name for a single Entry. |
||
57 | * |
||
58 | * Also used as the query_var for the time being. |
||
59 | * |
||
60 | * @internal |
||
61 | * @return string The name. Default: "entry" |
||
62 | */ |
||
63 | 25 | public static function get_endpoint_name() { |
|
72 | |||
73 | /** |
||
74 | * Construct a \GV\Entry instance by ID. |
||
75 | * |
||
76 | * @param int|string $entry_id The internal entry ID. |
||
77 | * |
||
78 | * @api |
||
79 | * @since 2.0 |
||
80 | * @return \GV\Entry|null An instance of this entry or null if not found. |
||
81 | */ |
||
82 | public static function by_id( $entry_id ) { |
||
85 | |||
86 | /** |
||
87 | * Return the backing entry object. |
||
88 | * |
||
89 | * @return array The backing entry object. |
||
90 | */ |
||
91 | 61 | public function as_entry() { |
|
94 | |||
95 | /** |
||
96 | * Return the link to this entry in the supplied context. |
||
97 | * |
||
98 | * @api |
||
99 | * @since 2.0 |
||
100 | * |
||
101 | * @param \GV\View|null $view The View context. |
||
102 | * @param \GV\Request $request The Request (current if null). |
||
103 | * @param boolean $track_directory Keep the housing directory arguments intact (used for breadcrumbs, for example). Default: true. |
||
104 | * |
||
105 | * @return string The permalink to this entry. |
||
106 | */ |
||
107 | 7 | public function get_permalink( \GV\View $view = null, \GV\Request $request = null, $track_directory = true ) { |
|
184 | } |
||
185 |
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.