flack /
openpsa
| Total Complexity | 46 |
| Total Lines | 286 |
| Duplicated Lines | 0 % |
| Coverage | 29.13% |
| Changes | 0 | ||
Complex classes like net_nemein_wiki_parser 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_nemein_wiki_parser, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class net_nemein_wiki_parser extends midcom_baseclasses_components_purecode |
||
| 17 | { |
||
| 18 | /** |
||
| 19 | * The page we're working on |
||
| 20 | * |
||
| 21 | * @var net_nemein_wiki_wikipage |
||
| 22 | */ |
||
| 23 | private $_page; |
||
| 24 | |||
| 25 | 8 | public function __construct(net_nemein_wiki_wikipage $page) |
|
| 26 | { |
||
| 27 | 8 | $this->_page = $page; |
|
| 28 | 8 | parent::__construct(); |
|
| 29 | 8 | } |
|
| 30 | |||
| 31 | public function get_html() : string |
||
| 32 | { |
||
| 33 | return MarkdownExtra::defaultTransform($this->get_markdown($this->_page->content)); |
||
| 34 | } |
||
| 35 | |||
| 36 | 4 | public function get_markdown($input) : string |
|
| 37 | { |
||
| 38 | 4 | return preg_replace_callback($this->_config->get('wikilink_regexp'), [$this, 'replace_wikiwords'], $input); |
|
|
Bug
introduced
by
|
|||
| 39 | } |
||
| 40 | |||
| 41 | /** |
||
| 42 | * Abbreviation support [abbr: Abbreviation - Explanation] |
||
| 43 | */ |
||
| 44 | private function _run_macro_abbr(string $macro_content, string $fulltag, string $after) : string |
||
| 45 | { |
||
| 46 | if (preg_match("/^(.*?) \- (.*)/", $macro_content, $parts)) { |
||
| 47 | return "<abbr title=\"{$parts[2]}\">{$parts[1]}</abbr>{$after}"; |
||
| 48 | } |
||
| 49 | // Could not figure it out, return the tag as is |
||
| 50 | return $fulltag; |
||
| 51 | } |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Photo inclusion support [photo: GUID] |
||
| 55 | */ |
||
| 56 | private function _run_macro_photo(string $macro_content, string $fulltag, string $after) : string |
||
| 57 | { |
||
| 58 | $guid = trim($macro_content); |
||
| 59 | if (!mgd_is_guid($guid)) { |
||
| 60 | // value is not guid |
||
| 61 | return $fulltag; |
||
| 62 | } |
||
| 63 | |||
| 64 | try { |
||
| 65 | $attachment = new midcom_db_attachment($guid); |
||
| 66 | } catch (midcom_error $e) { |
||
| 67 | $e->log(); |
||
| 68 | return "<span class=\"missing_photo\" title=\"{$guid}\">{$fulltag}</span>{$after}"; |
||
| 69 | } |
||
| 70 | |||
| 71 | return '<img src="' . midcom_db_attachment::get_url($attachment) . '" class="wiki_photo">' . $after; |
||
| 72 | } |
||
| 73 | |||
| 74 | /** |
||
| 75 | * WikiPedia term search [wiki: search terms] |
||
| 76 | * |
||
| 77 | * @todo Switch to InterWiki format instead |
||
| 78 | */ |
||
| 79 | 4 | private function _run_macro_wiki(string $macro_content, string $fulltag, string $after) : string |
|
| 80 | { |
||
| 81 | 4 | $text = trim($macro_content); |
|
| 82 | 4 | if (empty($text)) { |
|
| 83 | return $fulltag; |
||
| 84 | } |
||
| 85 | 4 | $target = ucfirst(strtolower(preg_replace('/[\s\-,.\']+/', "_", $text))); |
|
| 86 | 4 | $url = "http://en.wikipedia.org/wiki/{$target}"; |
|
| 87 | 4 | return "<a href=\"{$url}\" class=\"wikipedia\">{$text}</a>{$after}"; |
|
| 88 | } |
||
| 89 | |||
| 90 | /** |
||
| 91 | * A notice macro (will display a classed DIV) |
||
| 92 | */ |
||
| 93 | private function _run_macro_note(string $macro_content, string $fulltag, string $after) : string |
||
| 96 | } |
||
| 97 | |||
| 98 | /** |
||
| 99 | * A tip macro (will display a classed DIV) |
||
| 100 | */ |
||
| 101 | private function _run_macro_tip(string $macro_content, string $fulltag, string $after) : string |
||
| 102 | { |
||
| 103 | return $this->_run__classed_div('tip', $macro_content, $fulltag, $after); |
||
| 104 | } |
||
| 105 | |||
| 106 | /** |
||
| 107 | * A warning macro (will display a classed DIV) |
||
| 108 | */ |
||
| 109 | private function _run_macro_warning(string $macro_content, string $fulltag, string $after) : string |
||
| 110 | { |
||
| 111 | return $this->_run__classed_div('warning', $macro_content, $fulltag, $after); |
||
| 112 | } |
||
| 113 | |||
| 114 | /** |
||
| 115 | * Creates a div with given CSS class(es) |
||
| 116 | * |
||
| 117 | * Used by the note, tip and warning macros |
||
| 118 | */ |
||
| 119 | private function _run__classed_div(string $css_class, string $macro_content, string $fulltag, string $after) : string |
||
| 123 | } |
||
| 124 | |||
| 125 | /** |
||
| 126 | * table of contents for the current pages node |
||
| 127 | */ |
||
| 128 | private function _run_macro_nodetoc(string $macro_content, string $fulltag, string $after) : string |
||
| 129 | { |
||
| 130 | $text = trim($macro_content); |
||
| 131 | $qb = net_nemein_wiki_wikipage::new_query_builder(); |
||
| 149 | } |
||
| 150 | |||
| 151 | /** |
||
| 152 | * Links to other wiki pages tagged with arbitrary tags |
||
| 153 | */ |
||
| 154 | private function _run_macro_tagged(string $macro_content, string $fulltag, string $after) : string |
||
| 186 | } |
||
| 187 | |||
| 188 | /** |
||
| 189 | * Code to sort array by values (which is object) property 'title' |
||
| 190 | * |
||
| 191 | * Used by $this->_run_macro_tagged() |
||
| 192 | */ |
||
| 193 | private function _code_sort_by_title($a, $b) |
||
| 194 | { |
||
| 195 | return strnatcmp($a->title, $b->title); |
||
| 196 | } |
||
| 197 | |||
| 198 | /** |
||
| 199 | * Replace wiki syntax in the document with HTML for display purposes |
||
| 200 | */ |
||
| 201 | 4 | private function replace_wikiwords(array $match) : string |
|
| 202 | { |
||
| 203 | // Refactored using code from the WordPress SimpleLink plugin |
||
| 204 | // http://warpedvisions.org/projects/simplelink |
||
| 205 | // Since then refactored again... |
||
| 206 | 4 | $fulltext = $match[1]; |
|
| 207 | 4 | $after = $match[2] ?: ''; |
|
| 208 | |||
| 209 | // See what kind of tag we have hit |
||
| 210 | switch (true) { |
||
| 211 | // Ignore markdown tags |
||
| 212 | 4 | case (preg_match("/[\(:\[]/", $after)): |
|
| 213 | // TODO: should by str match (array) instead |
||
| 214 | return $match[0]; |
||
| 215 | |||
| 216 | // Escaped tag [!!text] |
||
| 217 | 4 | case (preg_match("/^\!\!(.*)/", $fulltext, $parts)): |
|
| 218 | 4 | return "[{$parts[1]}]{$after}"; |
|
| 219 | |||
| 220 | // MediaWiki-style link [wikipage|label] |
||
| 221 | 4 | case (preg_match("/^(.*?)\|(.*?)$/i", $fulltext, $parts)): |
|
| 222 | return $this->render_link($parts[1], $parts[2]) . $after; |
||
| 223 | |||
| 224 | // Macro [something: <data>] (for example [abbr: BOFH - Bastard Operator From Hell] or [photo: <GUID>]) |
||
| 225 | 4 | case ( preg_match('/^(.*?): (.*)/', $fulltext, $macro_parts) |
|
| 226 | 4 | && method_exists($this, "_run_macro_{$macro_parts[1]}")): |
|
| 227 | 4 | $method = "_run_macro_{$macro_parts[1]}"; |
|
| 228 | 4 | return $this->$method($macro_parts[2], $match[0], $after); |
|
| 229 | |||
| 230 | // MediaWiki-style link [wikipage] (no text) |
||
| 231 | // TODO: it is possible that this wasn't originally intended to be default, but the if/elseif tree was complex and this ended up being resolved as the last else |
||
| 232 | default: |
||
| 233 | return $this->render_link($fulltext, $fulltext) . $after; |
||
| 234 | } |
||
| 235 | } |
||
| 236 | |||
| 237 | public function render_link(string $wikilink, $text = null) : string |
||
| 272 | } |
||
| 273 | |||
| 274 | 4 | public function find_links_in_content() : array |
|
| 304 |
Loading history...