flack /
openpsa
| Total Complexity | 41 |
| Total Lines | 278 |
| Duplicated Lines | 0 % |
| Coverage | 61.48% |
| Changes | 0 | ||
Complex classes like net_nehmer_comments_handler_view 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_comments_handler_view, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 23 | class net_nehmer_comments_handler_view extends midcom_baseclasses_components_handler |
||
| 24 | { |
||
| 25 | use net_nehmer_comments_handler; |
||
|
introduced
by
|
|||
| 26 | |||
| 27 | /** |
||
| 28 | * The schema database to use. |
||
| 29 | * |
||
| 30 | * @var schemadb |
||
| 31 | */ |
||
| 32 | private $_schemadb; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * List of comments we are currently working with. |
||
| 36 | * |
||
| 37 | * @var Array |
||
| 38 | */ |
||
| 39 | private $_comments = []; |
||
| 40 | |||
| 41 | /** |
||
| 42 | * A new comment just created for posting. |
||
| 43 | * |
||
| 44 | * @var net_nehmer_comments_comment |
||
| 45 | */ |
||
| 46 | private $_new_comment; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * The GUID of the object we're bound to. |
||
| 50 | * |
||
| 51 | * @var string GUID |
||
| 52 | */ |
||
| 53 | private $_objectguid; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * The controller used to post a new comment. Only set if we have a valid user. |
||
| 57 | * |
||
| 58 | * @var controller |
||
| 59 | */ |
||
| 60 | private $_post_controller; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * This datamanager instance is used to display an existing comment. only set |
||
| 64 | * if there are actually comments to display. |
||
| 65 | * |
||
| 66 | * @var datamanager |
||
| 67 | */ |
||
| 68 | private $_display_datamanager; |
||
| 69 | |||
| 70 | /** |
||
| 71 | * Prepares the request data |
||
| 72 | */ |
||
| 73 | 2 | private function _prepare_request_data() |
|
| 74 | { |
||
| 75 | 2 | $this->_request_data['objectguid'] = $this->_objectguid; |
|
| 76 | 2 | $this->_request_data['post_controller'] = $this->_post_controller; |
|
| 77 | 2 | $this->_request_data['display_datamanager'] = $this->_display_datamanager; |
|
| 78 | 2 | } |
|
| 79 | |||
| 80 | /** |
||
| 81 | * Prepares the _display_datamanager member. |
||
| 82 | */ |
||
| 83 | private function _init_display_datamanager() |
||
| 84 | { |
||
| 85 | $this->_load_schemadb(); |
||
| 86 | $this->_display_datamanager = new datamanager($this->_schemadb); |
||
| 87 | } |
||
| 88 | |||
| 89 | /** |
||
| 90 | * Loads the schemadb (unless it has already been loaded). |
||
| 91 | */ |
||
| 92 | 2 | private function _load_schemadb() |
|
| 93 | { |
||
| 94 | 2 | if (!$this->_schemadb) { |
|
| 95 | 2 | $this->_schemadb = schemadb::from_path($this->_config->get('schemadb')); |
|
| 96 | |||
| 97 | 2 | if ( $this->_config->get('use_captcha') |
|
| 98 | 2 | || ( !midcom::get()->auth->user |
|
| 99 | 2 | && $this->_config->get('use_captcha_if_anonymous'))) { |
|
| 100 | $fields = $this->_schemadb->get('comment')->get('fields'); |
||
| 101 | $fields['captcha'] = [ |
||
| 102 | 'title' => $this->_l10n_midcom->get('captcha field title'), |
||
| 103 | 'storage' => null, |
||
| 104 | 'type' => 'captcha', |
||
| 105 | 'widget' => 'captcha', |
||
| 106 | 'widget_config' => $this->_config->get('captcha_config'), |
||
| 107 | ]; |
||
| 108 | $this->_schemadb->get('comment')->set('fields', $fields); |
||
| 109 | } |
||
| 110 | |||
| 111 | 2 | if ( $this->_config->get('ratings_enable') |
|
| 112 | 2 | && $this->_schemadb->get('comment')->has_field('rating')) { |
|
| 113 | $this->_schemadb->get('comment')->get_field('rating')['hidden'] = false; |
||
| 114 | } |
||
| 115 | } |
||
| 116 | 2 | } |
|
| 117 | |||
| 118 | /** |
||
| 119 | * Initializes a DM for posting. |
||
| 120 | * |
||
| 121 | * @param Request $request The request object |
||
| 122 | */ |
||
| 123 | 2 | private function _init_post_controller(Request $request) |
|
| 124 | { |
||
| 125 | 2 | $this->_load_schemadb(); |
|
| 126 | |||
| 127 | 2 | $defaults = []; |
|
| 128 | 2 | if (midcom::get()->auth->user) { |
|
| 129 | 2 | $defaults['author'] = midcom::get()->auth->user->name; |
|
| 130 | } |
||
| 131 | |||
| 132 | 2 | $this->_new_comment = new net_nehmer_comments_comment(); |
|
| 133 | 2 | $this->_new_comment->objectguid = $this->_objectguid; |
|
| 134 | 2 | $this->_new_comment->ip = $request->getClientIp(); |
|
| 135 | |||
| 136 | 2 | if (midcom::get()->auth->user) { |
|
| 137 | 2 | $this->_new_comment->status = net_nehmer_comments_comment::NEW_USER; |
|
| 138 | 2 | $this->_new_comment->author = midcom::get()->auth->user->name; |
|
| 139 | } else { |
||
| 140 | $this->_new_comment->status = net_nehmer_comments_comment::NEW_ANONYMOUS; |
||
| 141 | } |
||
| 142 | |||
| 143 | 2 | if ($this->_config->get('enable_notify')) { |
|
| 144 | 2 | $this->_new_comment->_send_notification = true; |
|
| 145 | } |
||
| 146 | |||
| 147 | 2 | $dm = new datamanager($this->_schemadb); |
|
| 148 | 2 | $this->_post_controller = $dm |
|
| 149 | 2 | ->set_defaults($defaults) |
|
| 150 | 2 | ->set_storage($this->_new_comment) |
|
| 151 | 2 | ->get_controller(); |
|
| 152 | 2 | } |
|
| 153 | |||
| 154 | /** |
||
| 155 | * Loads the comments, does any processing according to the state of the GET list. |
||
| 156 | * On successful processing we relocate once to ourself. |
||
| 157 | */ |
||
| 158 | 2 | public function _handler_comments(Request $request, string $handler_id, array &$data, string $guid, string $view = null) |
|
| 159 | { |
||
| 160 | 2 | $this->_objectguid = $guid; |
|
| 161 | 2 | midcom::get()->cache->content->register($this->_objectguid); |
|
| 162 | |||
| 163 | 2 | if ($handler_id == 'view-comments-nonempty') { |
|
| 164 | 1 | $this->_comments = net_nehmer_comments_comment::list_by_objectguid_filter_anonymous( |
|
| 165 | 1 | $this->_objectguid, |
|
| 166 | 1 | $this->_config->get('items_to_show'), |
|
| 167 | 1 | $this->_config->get('item_ordering'), |
|
| 168 | 1 | $this->_config->get('paging') |
|
| 169 | ); |
||
| 170 | } else { |
||
| 171 | 1 | $this->_comments = net_nehmer_comments_comment::list_by_objectguid( |
|
| 172 | 1 | $this->_objectguid, |
|
| 173 | 1 | $this->_config->get('items_to_show'), |
|
| 174 | 1 | $this->_config->get('item_ordering'), |
|
| 175 | 1 | $this->_config->get('paging') |
|
| 176 | ); |
||
| 177 | } |
||
| 178 | |||
| 179 | 2 | if ($this->_config->get('paging') !== false) { |
|
| 180 | $data['qb_pager'] = $this->_comments; |
||
| 181 | $this->_comments = $this->_comments->execute(); |
||
| 182 | } |
||
| 183 | |||
| 184 | 2 | if ( midcom::get()->auth->user |
|
| 185 | 2 | || $this->_config->get('allow_anonymous')) { |
|
| 186 | 2 | $this->_init_post_controller($request); |
|
| 187 | 2 | if ($response = $this->_process_post($request)) { |
|
| 188 | return $response; |
||
| 189 | } |
||
| 190 | } |
||
| 191 | 2 | if ($this->_comments) { |
|
| 192 | $this->_init_display_datamanager(); |
||
| 193 | } |
||
| 194 | |||
| 195 | 2 | if ($handler_id == 'view-comments-custom') { |
|
| 196 | midcom::get()->skip_page_style = true; |
||
| 197 | $data['custom_view'] = $view; |
||
| 198 | } |
||
| 199 | |||
| 200 | 2 | $this->_prepare_request_data(); |
|
| 201 | 2 | midcom::get()->metadata->set_request_metadata($this->_get_last_modified(), $this->_objectguid); |
|
| 202 | |||
| 203 | 2 | if ($request->isXmlHttpRequest()) { |
|
| 204 | midcom::get()->skip_page_style = true; |
||
| 205 | } |
||
| 206 | 2 | } |
|
| 207 | |||
| 208 | /** |
||
| 209 | * Checks if a new post has been submitted. |
||
| 210 | * |
||
| 211 | * @param Request $request The request object |
||
| 212 | */ |
||
| 213 | 2 | private function _process_post(Request $request) |
|
| 214 | { |
||
| 215 | 2 | if ( !midcom::get()->auth->user |
|
| 216 | 2 | && !midcom::get()->auth->request_sudo('net.nehmer.comments')) { |
|
| 217 | throw new midcom_error('We were anonymous but could not acquire SUDO privileges, aborting'); |
||
| 218 | } |
||
| 219 | |||
| 220 | 2 | switch ($this->_post_controller->handle($request)) { |
|
| 221 | 2 | case 'save': |
|
| 222 | // Check against comment spam |
||
| 223 | if ($this->_config->get('enable_spam_check')) { |
||
| 224 | $this->check_spam($this->_new_comment); |
||
| 225 | } |
||
| 226 | |||
| 227 | $formdata = $this->_post_controller->get_form_values(); |
||
| 228 | if ( $formdata['subscribe'] |
||
| 229 | && midcom::get()->auth->user) { |
||
| 230 | // User wants to subscribe to receive notifications about this comments thread |
||
| 231 | |||
| 232 | // Get the object we're commenting |
||
| 233 | $parent = midcom::get()->dbfactory->get_object_by_guid($this->_objectguid); |
||
| 234 | |||
| 235 | // Sudo so we can update the parent object |
||
| 236 | if (midcom::get()->auth->request_sudo($this->_component)) { |
||
| 237 | // Save the subscription |
||
| 238 | $parent->set_parameter('net.nehmer.comments:subscription', midcom::get()->auth->user->guid, time()); |
||
| 239 | |||
| 240 | // Return back from the sudo state |
||
| 241 | midcom::get()->auth->drop_sudo(); |
||
| 242 | } |
||
| 243 | } |
||
| 244 | |||
| 245 | midcom::get()->cache->invalidate($this->_objectguid); |
||
| 246 | // Fall-through intentional |
||
| 247 | |||
| 248 | 2 | case 'cancel': |
|
| 249 | if (!midcom::get()->auth->user) { |
||
| 250 | midcom::get()->auth->drop_sudo(); |
||
| 251 | } |
||
| 252 | return new midcom_response_relocate($request->getRequestUri()); |
||
| 253 | } |
||
| 254 | 2 | } |
|
| 255 | |||
| 256 | /** |
||
| 257 | * Determines the last modified timestamp. It is the max out of all revised timestamps |
||
| 258 | * of the comments (or 0 in case nothing was found). |
||
| 259 | */ |
||
| 260 | 2 | private function _get_last_modified() : int |
|
| 261 | { |
||
| 262 | return array_reduce($this->_comments, function ($carry, net_nehmer_comments_comment $item) { |
||
| 263 | return max($item->metadata->revised, $carry); |
||
| 264 | 2 | }, 0); |
|
| 265 | } |
||
| 266 | |||
| 267 | /** |
||
| 268 | * Display the comment list and the submit-comment form. |
||
| 269 | * |
||
| 270 | * @param array $data The local request data. |
||
| 271 | */ |
||
| 272 | 2 | public function _show_comments(string $handler_id, array &$data) |
|
| 301 | 2 | } |
|
| 302 | } |
||
| 303 |
Loading history...