flack /
openpsa
| Total Complexity | 40 |
| Total Lines | 397 |
| Duplicated Lines | 0 % |
| Coverage | 85.39% |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like net_nehmer_blog_handler_archive often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use net_nehmer_blog_handler_archive, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 18 | class net_nehmer_blog_handler_archive extends midcom_baseclasses_components_handler |
||
| 19 | { |
||
| 20 | use net_nehmer_blog_handler; |
||
|
introduced
by
|
|||
| 21 | |||
| 22 | /** |
||
| 23 | * The articles to display |
||
| 24 | * |
||
| 25 | * @var array |
||
| 26 | */ |
||
| 27 | private $_articles; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * The start date of the Archive listing. |
||
| 31 | * |
||
| 32 | * @var DateTime |
||
| 33 | */ |
||
| 34 | private $_start; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * The end date of the Archive listing. |
||
| 38 | * |
||
| 39 | * @var DateTime |
||
| 40 | */ |
||
| 41 | private $_end; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Simple helper which references all important members to the request data listing |
||
| 45 | * for usage within the style listing. |
||
| 46 | */ |
||
| 47 | 3 | private function _prepare_request_data() |
|
| 51 | 3 | } |
|
| 52 | |||
| 53 | /** |
||
| 54 | * Shows the archive welcome page: A listing of years/months along with total post counts |
||
| 55 | * and similar stuff. |
||
| 56 | * |
||
| 57 | * The handler computes all necessary data and populates the request array accordingly. |
||
| 58 | */ |
||
| 59 | 1 | public function _handler_welcome() |
|
| 71 | 1 | } |
|
| 72 | |||
| 73 | /** |
||
| 74 | * Loads the first posting time from the DB. This is the base for all operations on the |
||
| 75 | * resultset. |
||
| 76 | * |
||
| 77 | * This is done under sudo if possible, to avoid problems arising if the first posting |
||
| 78 | * is hidden. This keeps up performance, as an execute_unchecked() can be made in this case. |
||
| 79 | * If sudo cannot be acquired, the system falls back to execute(). |
||
| 80 | */ |
||
| 81 | 1 | private function _compute_welcome_first_post() : ?DateTime |
|
| 82 | { |
||
| 83 | 1 | $qb = midcom_db_article::new_query_builder(); |
|
| 84 | 1 | $this->article_qb_constraints($qb); |
|
| 85 | 1 | $qb->add_constraint('metadata.published', '>', '1970-01-02 23:59:59'); |
|
| 86 | |||
| 87 | 1 | $qb->add_order('metadata.published'); |
|
| 88 | 1 | $qb->set_limit(1); |
|
| 89 | |||
| 90 | 1 | if (midcom::get()->auth->request_sudo($this->_component)) { |
|
| 91 | 1 | $result = $qb->execute_unchecked(); |
|
| 92 | 1 | midcom::get()->auth->drop_sudo(); |
|
| 93 | } else { |
||
| 94 | $result = $qb->execute(); |
||
| 95 | } |
||
| 96 | |||
| 97 | 1 | if (!empty($result)) { |
|
| 98 | 1 | return new DateTime(strftime('%Y-%m-%d %H:%M:%S', $result[0]->metadata->published)); |
|
| 99 | } |
||
| 100 | return null; |
||
| 101 | } |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Computes the number of postings in a given timeframe. |
||
| 105 | * |
||
| 106 | * @param DateTime $start Start of the timeframe (inclusive) |
||
| 107 | * @param DateTime $end End of the timeframe (exclusive) |
||
| 108 | */ |
||
| 109 | 1 | private function _compute_welcome_posting_count(DateTime $start, DateTime $end) : int |
|
| 118 | } |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Computes the data nececssary for the welcome screen. Automatically put into the request |
||
| 122 | * data array. |
||
| 123 | */ |
||
| 124 | 1 | private function _compute_welcome_data() |
|
| 190 | ]; |
||
| 191 | } |
||
| 192 | 1 | } |
|
| 193 | |||
| 194 | 1 | private function _get_month_names() : array |
|
| 203 | } |
||
| 204 | |||
| 205 | /** |
||
| 206 | * Displays the welcome page. |
||
| 207 | * |
||
| 208 | * Element sequence: |
||
| 209 | * |
||
| 210 | * - archive-welcome-start (Start of the archive welcome page) |
||
| 211 | * - archive-welcome-year (Display of a single year, may not be called when there are no postings) |
||
| 212 | * - archive-welcome-end (End of the archive welcome page) |
||
| 213 | * |
||
| 214 | * Context data for all elements: |
||
| 215 | * |
||
| 216 | * - int total_count (total number of postings w/o ACL restrictions) |
||
| 217 | * - DateTime first_post (the first posting date, may be null) |
||
| 218 | * - Array year_data (the year data, contains the year context info as outlined below) |
||
| 219 | * |
||
| 220 | * Context data for year elements: |
||
| 221 | * |
||
| 222 | * - int year (the year displayed) |
||
| 223 | * - string url (url to display the complete year) |
||
| 224 | * - int count (Number of postings in that year) |
||
| 225 | * - array month_data (the monthly data) |
||
| 226 | * |
||
| 227 | * month_data will contain an associative array containing the following array of data |
||
| 228 | * indexed by month number (1-12): |
||
| 229 | * |
||
| 230 | * - string 'url' => The URL to the month. |
||
| 231 | * - string 'name' => The localized name of the month. |
||
| 232 | * - int 'count' => The number of postings in that month. |
||
| 233 | * |
||
| 234 | * @param array $data The local request data. |
||
| 235 | */ |
||
| 236 | 1 | public function _show_welcome(string $handler_id, array &$data) |
|
| 249 | 1 | } |
|
| 250 | |||
| 251 | /** |
||
| 252 | * Shows the archive. Depending on the selected handler various constraints are added to |
||
| 253 | * the QB. See the add_*_constraint methods for details. |
||
| 254 | */ |
||
| 255 | 2 | public function _handler_list(string $handler_id, array $args, array &$data) |
|
| 313 | 2 | } |
|
| 314 | |||
| 315 | /** |
||
| 316 | * Computes the start/end dates to only query a given year. It will do validation |
||
| 317 | * before processing, throwing 404 in case of incorrectly formatted dates. |
||
| 318 | * |
||
| 319 | * This is used by the archive-year handler, which expects the year to be in $args[0]. |
||
| 320 | */ |
||
| 321 | 1 | private function _set_startend_from_year(int $year) |
|
| 322 | { |
||
| 323 | 1 | if (strlen($year) != 4) { |
|
| 324 | throw new midcom_error_notfound("The year '{$year}' is not valid."); |
||
| 325 | } |
||
| 326 | |||
| 327 | 1 | $now = new DateTime(); |
|
| 328 | 1 | if ($year > (int) $now->format('Y')) { |
|
| 329 | throw new midcom_error_notfound("The year '{$year}' is in the future, no archive available."); |
||
| 330 | } |
||
| 331 | |||
| 332 | 1 | $endyear = $year + 1; |
|
| 333 | 1 | $this->_start = new DateTime("{$year}-01-01 00:00:00"); |
|
| 334 | 1 | $this->_end = new DateTime("{$endyear}-01-01 00:00:00"); |
|
| 335 | 1 | } |
|
| 336 | |||
| 337 | /** |
||
| 338 | * Computes the start/end dates to only query a given month. It will do validation |
||
| 339 | * before processing, throwing 404 in case of incorrectly formatted dates. |
||
| 340 | * |
||
| 341 | * This is used by the archive-month handler, which expects the year to be in $args[0] |
||
| 342 | * and the month to be in $args[1]. |
||
| 343 | * |
||
| 344 | * @param int $year The year to query. |
||
| 345 | * @param int $month The month to query. |
||
| 346 | */ |
||
| 347 | 1 | private function _set_startend_from_month(int $year, int $month) |
|
| 373 | 1 | } |
|
| 374 | |||
| 375 | /** |
||
| 376 | * Displays the archive. |
||
| 377 | * |
||
| 378 | * @param array $data The local request data. |
||
| 379 | */ |
||
| 380 | 2 | public function _show_list(string $handler_id, array &$data) |
|
| 415 | 2 | } |
|
| 416 | } |
||
| 417 |
Loading history...
