flack /
openpsa
| Total Complexity | 75 |
| Total Lines | 398 |
| Duplicated Lines | 0 % |
| Coverage | 72.59% |
| Changes | 2 | ||
| Bugs | 0 | Features | 0 |
Complex classes like org_openpsa_widgets_contact 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 org_openpsa_widgets_contact, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 19 | class org_openpsa_widgets_contact |
||
| 20 | { |
||
| 21 | use midcom_baseclasses_components_base; |
||
|
introduced
by
|
|||
| 22 | |||
| 23 | /** |
||
| 24 | * Contact information of the person being displayed |
||
| 25 | */ |
||
| 26 | public array $contact_details = [ |
||
| 27 | 'guid' => '', |
||
| 28 | 'id' => '', |
||
| 29 | 'firstname' => '', |
||
| 30 | 'lastname' => '' |
||
| 31 | ]; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Optional URI to person details |
||
| 35 | */ |
||
| 36 | public ?string $link = null; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Optional HTML to be placed into the card |
||
| 40 | */ |
||
| 41 | public ?string $extra_html = null; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Optional HTML to be placed into the card (before any other output in the DIV) |
||
| 45 | */ |
||
| 46 | public ?string $prefix_html = null; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Whether to show person's groups in a list |
||
| 50 | */ |
||
| 51 | public bool $show_groups = true; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Whether to generate links to the groups using NAP |
||
| 55 | */ |
||
| 56 | var bool $link_contacts = true; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @var string |
||
| 60 | */ |
||
| 61 | private static $_contacts_url; |
||
| 62 | |||
| 63 | private midcom_db_person $person; |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Initializes the class and stores the selected person to be shown |
||
| 67 | */ |
||
| 68 | 8 | public function __construct(midcom_db_person $person) |
|
| 69 | { |
||
| 70 | 8 | $this->_component = 'org.openpsa.widgets'; |
|
| 71 | |||
| 72 | 8 | if (null === self::$_contacts_url) { |
|
| 73 | 1 | $siteconfig = org_openpsa_core_siteconfig::get_instance(); |
|
| 74 | 1 | self::$_contacts_url = $siteconfig->get_node_full_url('org.openpsa.contacts'); |
|
| 75 | } |
||
| 76 | |||
| 77 | // Read properties of provided person object |
||
| 78 | // TODO: Handle groups as well |
||
| 79 | 8 | $this->person = $person; |
|
| 80 | 8 | $this->read_object($person); |
|
| 81 | } |
||
| 82 | |||
| 83 | 10 | public static function add_head_elements() |
|
| 90 | } |
||
| 91 | } |
||
| 92 | |||
| 93 | /** |
||
| 94 | * Retrieve an object, uses in-request caching |
||
| 95 | */ |
||
| 96 | 10 | public static function get(string|int $src) : self |
|
| 113 | } |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Read properties of a person object and populate local fields accordingly |
||
| 117 | */ |
||
| 118 | 8 | private function read_object(midcom_db_person $person) |
|
| 119 | { |
||
| 120 | // Database identifiers |
||
| 121 | 8 | $this->contact_details['guid'] = $person->guid; |
|
| 122 | 8 | $this->contact_details['id'] = $person->id; |
|
| 123 | |||
| 124 | 8 | if ($person->guid == "") { |
|
| 125 | 1 | $this->contact_details['lastname'] = $this->_l10n->get('no person'); |
|
| 126 | 7 | } elseif ($person->firstname == '' && $person->lastname == '') { |
|
| 127 | $this->contact_details['lastname'] = "Person #{$person->id}"; |
||
| 128 | } else { |
||
| 129 | 7 | $this->contact_details['firstname'] = $person->firstname; |
|
| 130 | 7 | $this->contact_details['lastname'] = $person->lastname; |
|
| 131 | } |
||
| 132 | |||
| 133 | 8 | foreach (['handphone', 'workphone', 'homephone', 'email', 'homepage'] as $property) { |
|
| 134 | 8 | if ($person->$property) { |
|
| 135 | $this->contact_details[$property] = $person->$property; |
||
| 136 | } |
||
| 137 | } |
||
| 138 | |||
| 139 | 8 | if ( $this->_config->get('jabber_enable_presence') |
|
| 140 | 8 | && $person->get_parameter('org.openpsa.jabber', 'jid')) { |
|
| 141 | $this->contact_details['jid'] = $person->get_parameter('org.openpsa.jabber', 'jid'); |
||
| 142 | } |
||
| 143 | |||
| 144 | 8 | if ( $this->_config->get('skype_enable_presence') |
|
| 145 | 8 | && $person->get_parameter('org.openpsa.skype', 'name')) { |
|
| 146 | $this->contact_details['skype'] = $person->get_parameter('org.openpsa.skype', 'name'); |
||
| 147 | } |
||
| 148 | } |
||
| 149 | |||
| 150 | 8 | private function _render_name(string $fallback_image) : string |
|
| 151 | { |
||
| 152 | 8 | $name = "<span class=\"given-name\">{$this->contact_details['firstname']}</span> <span class=\"family-name\">{$this->contact_details['lastname']}</span>"; |
|
| 153 | |||
| 154 | 8 | $url = false; |
|
| 155 | |||
| 156 | 8 | if ($this->link) { |
|
| 157 | $url = $this->link; |
||
| 158 | 8 | } elseif ($this->link_contacts && !empty($this->contact_details['guid'])) { |
|
| 159 | 8 | if (!self::$_contacts_url) { |
|
| 160 | $this->link_contacts = false; |
||
| 161 | } else { |
||
| 162 | 8 | $url = self::$_contacts_url . 'person/' . $this->contact_details['guid'] . '/'; |
|
| 163 | } |
||
| 164 | } |
||
| 165 | |||
| 166 | 8 | $name = $this->get_image('thumbnail', $fallback_image) . $name; |
|
| 167 | |||
| 168 | 8 | if ($url) { |
|
| 169 | 8 | $name = '<a href="' . $url . '">' . $name . '</a>'; |
|
| 170 | } |
||
| 171 | |||
| 172 | 8 | return $name; |
|
| 173 | } |
||
| 174 | |||
| 175 | 9 | public function get_image(string $type, string $fallback) : string |
|
| 176 | { |
||
| 177 | 9 | $attachments = blobs::get_attachments($this->person, 'photo'); |
|
| 178 | 9 | if (!empty($attachments[$type])) { |
|
| 179 | return '<img class="photo" src="' . midcom_db_attachment::get_url($attachments[$type]) . '">'; |
||
| 180 | } |
||
| 181 | 9 | if ( $this->_config->get('gravatar_enable') |
|
| 182 | 9 | && !empty($this->contact_details['email'])) { |
|
| 183 | $size = ($type == 'view') ? 500 : 32; |
||
| 184 | $gravatar_url = "https://www.gravatar.com/avatar/" . md5(strtolower(trim($this->contact_details['email']))) . "?s=" . $size . '&d=identicon'; |
||
| 185 | return "<img src=\"{$gravatar_url}\" class=\"photo\" />\n"; |
||
| 186 | } |
||
| 187 | 9 | return '<i class="fa fa-' . $fallback . '"></i>'; |
|
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Show selected person object inline. Outputs hCard XHTML. |
||
| 192 | */ |
||
| 193 | 9 | public function show_inline() : string |
|
| 194 | { |
||
| 195 | 9 | if (!$this->person->id) { |
|
| 196 | 2 | return ''; |
|
| 197 | } |
||
| 198 | 7 | self::add_head_elements(); |
|
| 199 | 7 | $inline_string = ''; |
|
| 200 | |||
| 201 | // Start the vCard |
||
| 202 | 7 | $inline_string .= "<span class=\"vcard\">"; |
|
| 203 | |||
| 204 | 7 | if (!empty($this->contact_details['guid'])) { |
|
| 205 | // Identifier |
||
| 206 | 7 | $inline_string .= "<span class=\"uid\" style=\"display: none;\">{$this->contact_details['guid']}</span>"; |
|
| 207 | } |
||
| 208 | |||
| 209 | // The name sequence |
||
| 210 | 7 | $inline_string .= "<span class=\"n\">"; |
|
| 211 | 7 | $inline_string .= $this->_render_name('address-card-o'); |
|
| 212 | 7 | $inline_string .= "</span>"; |
|
| 213 | |||
| 214 | 7 | $inline_string .= "</span>"; |
|
| 215 | |||
| 216 | 7 | return $inline_string; |
|
| 217 | } |
||
| 218 | |||
| 219 | /** |
||
| 220 | * Show the selected person. Outputs hCard XHTML. |
||
| 221 | */ |
||
| 222 | 2 | public function show() |
|
| 283 | } |
||
| 284 | |||
| 285 | 2 | private function _show_phone_number(string $field, string $type) |
|
| 286 | { |
||
| 287 | 2 | if (!empty($this->contact_details[$field])) { |
|
| 288 | echo "<li><a title=\"Dial {$this->contact_details[$field]}\" href=\"tel:{$this->contact_details[$field]}\"><i class=\"fa fa-{$type}\"></i>{$this->contact_details[$field]}</a></li>\n"; |
||
| 289 | } |
||
| 290 | } |
||
| 291 | |||
| 292 | 2 | private function _show_groups() |
|
| 324 | } |
||
| 325 | } |
||
| 326 | |||
| 327 | /** |
||
| 328 | * Renderer for organization address cards |
||
| 329 | */ |
||
| 330 | 1 | public static function show_address_card($customer, array $cards) |
|
| 420 |
Loading history...
