Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?php declare(strict_types=1);
// UTF-8 marker äöüÄÖÜ߀
/**
* Class PageTemplate for the exercises of the EWA lecture
* Demonstrates use of PHP including class and OO.
* Implements Zend coding standards.
* Generate documentation with Doxygen or phpdoc
*
* PHP Version 7.4
*
* @file PageTemplate.php
* @package Page Templates
* @author Bernhard Kreling, <bernhard.kreling@h-da.de>
* @author Ralf Hahn, <ralf.hahn@h-da.de>
* @version 3.1
*/
// to do: change name 'PageTemplate' throughout this file
require_once './Page.php';
/**
* This is a template for top level classes, which represent
* a complete web page and which are called directly by the user.
* Usually there will only be a single instance of such a class.
* The name of the template is supposed
* to be replaced by the name of the specific HTML page e.g. baker.
* The order of methods might correspond to the order of thinking
* during implementation.
* @author Bernhard Kreling, <bernhard.kreling@h-da.de>
* @author Ralf Hahn, <ralf.hahn@h-da.de>
*/
class PageTemplate extends Page
{
// to do: declare reference variables for members
// representing substructures/blocks
/**
* Instantiates members (to be defined above).
* Calls the constructor of the parent i.e. page class.
* So, the database connection is established.
* @throws Exception
*/
protected function __construct()
{
parent::__construct();
// to do: instantiate members representing substructures/blocks
}
/**
* Cleans up whatever is needed.
* Calls the destructor of the parent i.e. page class.
* So, the database connection is closed.
*/
public function __destruct()
{
parent::__destruct();
}
/**
* Fetch all data that is necessary for later output.
* Data is returned in an array e.g. as associative array.
* @return array An array containing the requested data.
* This may be a normal array, an empty array or an associative array.
*/
protected function getViewData():array
{
// to do: fetch data for this view from the database
// to do: return array containing data
}
/**
* First the required data is fetched and then the HTML is
* assembled for output. i.e. the header is generated, the content
* of the page ("view") is inserted and -if available- the content of
* all views contained is generated.
* Finally, the footer is added.
* @return void
*/
protected function generateView():void
{
$data = $this->getViewData(); //NOSONAR ignore unused $data
$this->generatePageHeader('to do: change headline'); //to do: set optional parameters
// to do: output view of this page
$this->generatePageFooter();
}
/**
* Processes the data that comes via GET or POST.
* If this page is supposed to do something with submitted
* data do it here.
* @return void
*/
protected function processReceivedData():void
{
parent::processReceivedData();
// to do: call processReceivedData() for all members
}
/**
* This main-function has the only purpose to create an instance
* of the class and to get all the things going.
* I.e. the operations of the class are called to produce
* the output of the HTML-file.
* The name "main" is no keyword for php. It is just used to
* indicate that function as the central starting point.
* To make it simpler this is a static function. That is you can simply
* call it without first creating an instance of the class.
* @return void
*/
public static function main():void
{
try {
$page = new PageTemplate();
$page->processReceivedData();
$page->generateView();
} catch (Exception $e) {
//header("Content-type: text/plain; charset=UTF-8");
header("Content-type: text/html; charset=UTF-8");
echo $e->getMessage();
}
}
}
// This call is starting the creation of the page.
// That is input is processed and output is created.
PageTemplate::main();
// Zend standard does not like closing php-tag!
// PHP doesn't require the closing tag (it is assumed when the file ends).
// Not specifying the closing ? > helps to prevent accidents
// like additional whitespace which will cause session
// initialization to fail ("headers already sent").
//? >