namibia
df0489e1eeeeab5a9bd44e1d84fce49924fe1bac
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 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
<?php namespace Utility\Service; /** * Base reporting functionality. * @author andre.fourie * */ abstract class Report { /** * @var \Doctrine\ORM\EntityManager */ protected $em; /** * Report title. * @var string */ protected $_title = null; /** * Report subject. * @var string */ protected $_subject = null; /** * Report description. * @var string */ protected $_description = null; /** * @var string */ protected $_format = null; /** * Queries applied to the report. * @var array */ protected $_queries = array(); /** * Column headers. * @var array */ protected $_headers = array(); /** * Fields to pull from dataset. * @var array */ protected $_fields = array(); /** * Columns to provide totals for. * @var array */ protected $_totals = array(); /** * Columns for currency format. * @var array */ protected $_currencyFields = array(); /** * Notes to display at end of report. * @var array */ protected $_notes = array(); /** * Chart from report data. * @var array */ protected $_chart = array(); /** * @var array */ protected $_data = array(); /** * Request object. * @var Struct_ActionRequest */ protected $_request = null; /** * Options to passed. * @var object */ protected $_options = array(); /** * Data passed. * @var array */ protected $_input = array(); /* ---------------------------------------------------------------------- *\ * Standard Interface \* ---------------------------------------------------------------------- */ /** * Process standard format request. * @param array $input * @param array|object $options */ public function process(array $input, $options, $data = null) { $this->em = \Utility\Registry::getEntityManager(); $this->_input = $input; $this->_options = $options; is_array($data) && $this->_data = $data; $this->build(); return $this; } /** * Build the dataset. */ public function build() {} /* ---------------------------------------------------------------------- *\ * Specifically cater for Excel Report requirements. \* ---------------------------------------------------------------------- */ /** * Retrieve report title. * @return string */ public function getTitle() { return $this->_title; } /** * Retrieve report subject. * @return string */ public function getSubject() { return $this->_subject; } /** * Retrieve report description. * @return string */ public function getDescription() { return $this->_description; } /** * Retrieve report format. * @return string */ public function getFormat() { return $this->_format; } /** * Retrieve queries to display at beginning of report. * @return array */ public function getQueries() { return $this->_queries; } /** * Retrieve report column headers. * @return array */ public function getHeaders() { return $this->_headers; } /** * Retrieve report fields. * @return array */ public function getFields() { return $this->_fields; } /** * Retrieve report fields to receive total value at end of report. * @return array */ public function getTotalFields() { return $this->_totals; } /** * Retrieve report fields to receive currency formatting. * @return array */ public function getCurrencyFields() { return $this->_currencyFields; } /** * Retrieve notes to be added to end of report. * @return array */ public function getNotes() { return $this->_notes; } /** * Retrieve chart specifications. * @return array */ public function getChart() { return $this->_chart; } /** * Retrieve report data. * @return array */ public function getData() { return $this->_data; } /** * Retrieve report data. * @return array */ public function getDataIntersection() { $fields = array_flip($this->_fields); foreach ($this->_data as $id => $row) { $this->_data[$id] = array_intersect_key($row, $fields); } return $this->_data; } } |
Commits for namibiamodule/Utility/src/Utility/Service/Report.php
Revision | Author | Commited | Message |
---|---|---|---|
df0489 ... | Mark | Fri 14 Oct, 2016 10:01:00 +0000 | initial commit |