flack /
openpsa
| Total Complexity | 75 |
| Total Lines | 410 |
| Duplicated Lines | 0 % |
| Coverage | 72.31% |
| Changes | 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 $contact_details = [ |
||
| 27 | 'guid' => '', |
||
| 28 | 'id' => '', |
||
| 29 | 'firstname' => '', |
||
| 30 | 'lastname' => '' |
||
| 31 | ]; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * Optional URI to person details |
||
| 35 | * |
||
| 36 | * @var string |
||
| 37 | */ |
||
| 38 | public $link; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Optional HTML to be placed into the card |
||
| 42 | * |
||
| 43 | * @var string |
||
| 44 | */ |
||
| 45 | public $extra_html; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Optional HTML to be placed into the card (before any other output in the DIV) |
||
| 49 | * |
||
| 50 | * @var string |
||
| 51 | */ |
||
| 52 | public $prefix_html; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Whether to show person's groups in a list |
||
| 56 | * |
||
| 57 | * @var boolean |
||
| 58 | */ |
||
| 59 | public $show_groups = true; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Whether to generate links to the groups using NAP |
||
| 63 | * |
||
| 64 | * @var boolean |
||
| 65 | */ |
||
| 66 | var $link_contacts = true; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * @var string |
||
| 70 | */ |
||
| 71 | private static $_contacts_url; |
||
| 72 | |||
| 73 | private $person; |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Initializes the class and stores the selected person to be shown |
||
| 77 | */ |
||
| 78 | 8 | public function __construct(midcom_db_person $person) |
|
| 79 | { |
||
| 80 | 8 | $this->_component = 'org.openpsa.widgets'; |
|
| 81 | |||
| 82 | 8 | if (null === self::$_contacts_url) { |
|
| 83 | 1 | $siteconfig = org_openpsa_core_siteconfig::get_instance(); |
|
| 84 | 1 | self::$_contacts_url = $siteconfig->get_node_full_url('org.openpsa.contacts'); |
|
| 85 | } |
||
| 86 | |||
| 87 | // Read properties of provided person object |
||
| 88 | // TODO: Handle groups as well |
||
| 89 | 8 | $this->person = $person; |
|
| 90 | 8 | $this->read_object($person); |
|
| 91 | } |
||
| 92 | |||
| 93 | 10 | public static function add_head_elements() |
|
| 94 | { |
||
| 95 | static $added = false; |
||
| 96 | 10 | if (!$added) { |
|
| 97 | 1 | midcom::get()->head->add_stylesheet(MIDCOM_STATIC_URL . "/org.openpsa.widgets/hcard.css"); |
|
| 98 | 1 | midcom::get()->head->add_stylesheet(MIDCOM_STATIC_URL . '/stock-icons/font-awesome-4.7.0/css/font-awesome.min.css'); |
|
| 99 | 1 | $added = true; |
|
| 100 | } |
||
| 101 | } |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Retrieve an object, uses in-request caching |
||
| 105 | * |
||
| 106 | * @param mixed $src GUID of object (ids work but are discouraged) |
||
| 107 | */ |
||
| 108 | 10 | public static function get($src) : self |
|
| 109 | { |
||
| 110 | 10 | static $cache = []; |
|
| 111 | |||
| 112 | 10 | if (isset($cache[$src])) { |
|
| 113 | 4 | return $cache[$src]; |
|
| 114 | } |
||
| 115 | |||
| 116 | try { |
||
| 117 | 7 | $person = midcom_db_person::get_cached($src); |
|
| 118 | 1 | } catch (midcom_error $e) { |
|
| 119 | 1 | return $cache[$src] = new self(new midcom_db_person); |
|
| 120 | } |
||
| 121 | |||
| 122 | 6 | $cache[$person->guid] = new self($person); |
|
| 123 | 6 | $cache[$person->id] = $cache[$person->guid]; |
|
| 124 | 6 | return $cache[$person->guid]; |
|
| 125 | } |
||
| 126 | |||
| 127 | /** |
||
| 128 | * Read properties of a person object and populate local fields accordingly |
||
| 129 | */ |
||
| 130 | 8 | private function read_object(midcom_db_person $person) |
|
| 131 | { |
||
| 132 | // Database identifiers |
||
| 133 | 8 | $this->contact_details['guid'] = $person->guid; |
|
| 134 | 8 | $this->contact_details['id'] = $person->id; |
|
| 135 | |||
| 136 | 8 | if ($person->guid == "") { |
|
| 137 | 1 | $this->contact_details['lastname'] = $this->_l10n->get('no person'); |
|
| 138 | 7 | } elseif ($person->firstname == '' && $person->lastname == '') { |
|
| 139 | $this->contact_details['lastname'] = "Person #{$person->id}"; |
||
| 140 | } else { |
||
| 141 | 7 | $this->contact_details['firstname'] = $person->firstname; |
|
| 142 | 7 | $this->contact_details['lastname'] = $person->lastname; |
|
| 143 | } |
||
| 144 | |||
| 145 | 8 | foreach (['handphone', 'workphone', 'homephone', 'email', 'homepage'] as $property) { |
|
| 146 | 8 | if ($person->$property) { |
|
| 147 | $this->contact_details[$property] = $person->$property; |
||
| 148 | } |
||
| 149 | } |
||
| 150 | |||
| 151 | 8 | if ( $this->_config->get('jabber_enable_presence') |
|
| 152 | 8 | && $person->get_parameter('org.openpsa.jabber', 'jid')) { |
|
| 153 | $this->contact_details['jid'] = $person->get_parameter('org.openpsa.jabber', 'jid'); |
||
| 154 | } |
||
| 155 | |||
| 156 | 8 | if ( $this->_config->get('skype_enable_presence') |
|
| 157 | 8 | && $person->get_parameter('org.openpsa.skype', 'name')) { |
|
| 158 | $this->contact_details['skype'] = $person->get_parameter('org.openpsa.skype', 'name'); |
||
| 159 | } |
||
| 160 | } |
||
| 161 | |||
| 162 | 8 | private function _render_name(string $fallback_image) : string |
|
| 163 | { |
||
| 164 | 8 | $name = "<span class=\"given-name\">{$this->contact_details['firstname']}</span> <span class=\"family-name\">{$this->contact_details['lastname']}</span>"; |
|
| 165 | |||
| 166 | 8 | $url = false; |
|
| 167 | |||
| 168 | 8 | if ($this->link) { |
|
| 169 | $url = $this->link; |
||
| 170 | 8 | } elseif ($this->link_contacts && !empty($this->contact_details['guid'])) { |
|
| 171 | 8 | if (!self::$_contacts_url) { |
|
| 172 | $this->link_contacts = false; |
||
| 173 | } else { |
||
| 174 | 8 | $url = self::$_contacts_url . 'person/' . $this->contact_details['guid'] . '/'; |
|
| 175 | } |
||
| 176 | } |
||
| 177 | |||
| 178 | 8 | $name = $this->get_image('thumbnail', $fallback_image) . $name; |
|
| 179 | |||
| 180 | 8 | if ($url) { |
|
| 181 | 8 | $name = '<a href="' . $url . '">' . $name . '</a>'; |
|
| 182 | } |
||
| 183 | |||
| 184 | 8 | return $name; |
|
| 185 | } |
||
| 186 | |||
| 187 | 9 | public function get_image(string $type, string $fallback) : string |
|
| 188 | { |
||
| 189 | 9 | $attachments = blobs::get_attachments($this->person, 'photo'); |
|
| 190 | 9 | if (!empty($attachments[$type])) { |
|
| 191 | return '<img class="photo" src="' . midcom_db_attachment::get_url($attachments[$type]) . '">'; |
||
| 192 | } |
||
| 193 | 9 | if ( $this->_config->get('gravatar_enable') |
|
| 194 | 9 | && !empty($this->contact_details['email'])) { |
|
| 195 | $size = ($type == 'view') ? 500 : 32; |
||
| 196 | $gravatar_url = "https://www.gravatar.com/avatar/" . md5(strtolower(trim($this->contact_details['email']))) . "?s=" . $size . '&d=identicon'; |
||
| 197 | return "<img src=\"{$gravatar_url}\" class=\"photo\" />\n"; |
||
| 198 | } |
||
| 199 | 9 | return '<i class="fa fa-' . $fallback . '"></i>'; |
|
| 200 | } |
||
| 201 | |||
| 202 | /** |
||
| 203 | * Show selected person object inline. Outputs hCard XHTML. |
||
| 204 | */ |
||
| 205 | 9 | public function show_inline() : string |
|
| 206 | { |
||
| 207 | 9 | if (!$this->person->id) { |
|
| 208 | 2 | return ''; |
|
| 209 | } |
||
| 210 | 7 | self::add_head_elements(); |
|
| 211 | 7 | $inline_string = ''; |
|
| 212 | |||
| 213 | // Start the vCard |
||
| 214 | 7 | $inline_string .= "<span class=\"vcard\">"; |
|
| 215 | |||
| 216 | 7 | if (!empty($this->contact_details['guid'])) { |
|
| 217 | // Identifier |
||
| 218 | 7 | $inline_string .= "<span class=\"uid\" style=\"display: none;\">{$this->contact_details['guid']}</span>"; |
|
| 219 | } |
||
| 220 | |||
| 221 | // The name sequence |
||
| 222 | 7 | $inline_string .= "<span class=\"n\">"; |
|
| 223 | 7 | $inline_string .= $this->_render_name('address-card-o'); |
|
| 224 | 7 | $inline_string .= "</span>"; |
|
| 225 | |||
| 226 | 7 | $inline_string .= "</span>"; |
|
| 227 | |||
| 228 | 7 | return $inline_string; |
|
| 229 | } |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Show the selected person. Outputs hCard XHTML. |
||
| 233 | */ |
||
| 234 | 2 | public function show() |
|
| 235 | { |
||
| 236 | 2 | if (!$this->person->id) { |
|
| 237 | return; |
||
| 238 | } |
||
| 239 | |||
| 240 | 2 | self::add_head_elements(); |
|
| 241 | // Start the vCard |
||
| 242 | 2 | echo "<div class=\"vcard\" id=\"org_openpsa_widgets_contact-{$this->contact_details['guid']}\">\n"; |
|
| 243 | 2 | if ($this->prefix_html) { |
|
| 244 | echo $this->prefix_html; |
||
| 245 | } |
||
| 246 | |||
| 247 | 2 | if (!empty($this->contact_details['guid'])) { |
|
| 248 | // Identifier |
||
| 249 | 2 | echo "<span class=\"uid\" style=\"display: none;\">{$this->contact_details['guid']}</span>"; |
|
| 250 | } |
||
| 251 | |||
| 252 | // The Name sequence |
||
| 253 | 2 | echo "<div class=\"n\">\n"; |
|
| 254 | 2 | echo $this->_render_name('user-o'); |
|
| 255 | 2 | echo "</div>\n"; |
|
| 256 | |||
| 257 | // Contact information sequence |
||
| 258 | 2 | echo "<ul class=\"contact_information\">\n"; |
|
| 259 | 2 | if ($this->extra_html) { |
|
| 260 | echo $this->extra_html; |
||
| 261 | } |
||
| 262 | |||
| 263 | 2 | $this->_show_groups(); |
|
| 264 | |||
| 265 | 2 | $this->_show_phone_number('handphone', 'mobile'); |
|
| 266 | 2 | $this->_show_phone_number('workphone', 'phone'); |
|
| 267 | 2 | $this->_show_phone_number('homephone', 'home'); |
|
| 268 | |||
| 269 | 2 | if (!empty($this->contact_details['email'])) { |
|
| 270 | echo "<li><a title=\"{$this->contact_details['email']}\" href=\"mailto:{$this->contact_details['email']}\"><i class=\"fa fa-envelope-o\"></i>{$this->contact_details['email']}</a></li>\n"; |
||
| 271 | } |
||
| 272 | |||
| 273 | 2 | if (!empty($this->contact_details['skype'])) { |
|
| 274 | echo "<li>"; |
||
| 275 | echo "<a href=\"skype:{$this->contact_details['skype']}?call\"><i class=\"fa fa-skype\"></i>{$this->contact_details['skype']}</a></li>\n"; |
||
| 276 | } |
||
| 277 | |||
| 278 | // Instant messaging contact information |
||
| 279 | 2 | if (!empty($this->contact_details['jid'])) { |
|
| 280 | echo "<li>"; |
||
| 281 | echo "<a href=\"xmpp:{$this->contact_details['jid']}\""; |
||
| 282 | $edgar_url = $this->_config->get('jabber_edgar_url'); |
||
| 283 | if (!empty($edgar_url)) { |
||
| 284 | echo " style=\"background-repeat: no-repeat;background-image: url('{$edgar_url}?jid={$this->contact_details['jid']}&type=image');\""; |
||
| 285 | } |
||
| 286 | echo "><i class=\"fa fa-comment-o\"></i>{$this->contact_details['jid']}</a></li>\n"; |
||
| 287 | } |
||
| 288 | |||
| 289 | 2 | if (!empty($this->contact_details['homepage'])) { |
|
| 290 | echo "<li><a title=\"{$this->contact_details['homepage']}\" href=\"{$this->contact_details['homepage']}\"><i class=\"fa fa-globe\"></i>{$this->contact_details['homepage']}</a></li>\n"; |
||
| 291 | } |
||
| 292 | |||
| 293 | 2 | echo "</ul>\n"; |
|
| 294 | 2 | echo "</div>\n"; |
|
| 295 | } |
||
| 296 | |||
| 297 | 2 | private function _show_phone_number(string $field, string $type) |
|
| 301 | } |
||
| 302 | } |
||
| 303 | |||
| 304 | 2 | private function _show_groups() |
|
| 336 | } |
||
| 337 | } |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Renderer for organization address cards |
||
| 341 | */ |
||
| 342 | 1 | public static function show_address_card($customer, array $cards) |
|
| 429 | } |
||
| 430 | } |
||
| 431 | } |
||
| 432 |
Loading history...
