flack /
openpsa
| Total Complexity | 75 |
| Total Lines | 419 |
| Duplicated Lines | 0 % |
| Coverage | 34.78% |
| Changes | 3 | ||
| 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 extends midcom_baseclasses_components_purecode |
||
| 20 | { |
||
| 21 | /** |
||
| 22 | * Do we have our contact data ? |
||
| 23 | */ |
||
| 24 | private $_data_read_ok = false; |
||
| 25 | |||
| 26 | /** |
||
| 27 | * Contact information of the person being displayed |
||
| 28 | */ |
||
| 29 | public $contact_details = [ |
||
| 30 | 'guid' => '', |
||
| 31 | 'id' => '', |
||
| 32 | 'firstname' => '', |
||
| 33 | 'lastname' => '' |
||
| 34 | ]; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * Optional URI to person details |
||
| 38 | * |
||
| 39 | * @var string |
||
| 40 | */ |
||
| 41 | public $link; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Optional HTML to be placed into the card |
||
| 45 | * |
||
| 46 | * @var string |
||
| 47 | */ |
||
| 48 | public $extra_html; |
||
| 49 | |||
| 50 | /** |
||
| 51 | * Optional HTML to be placed into the card (before any other output in the DIV) |
||
| 52 | * |
||
| 53 | * @var string |
||
| 54 | */ |
||
| 55 | public $prefix_html; |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Whether to show person's groups in a list |
||
| 59 | * |
||
| 60 | * @var boolean |
||
| 61 | */ |
||
| 62 | public $show_groups = true; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Whether to generate links to the groups using NAP |
||
| 66 | * |
||
| 67 | * @var boolean |
||
| 68 | */ |
||
| 69 | var $link_contacts = true; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Default org.openpsa.contacts URL to be used for linking to groups. Will be autoprobed if not supplied. |
||
| 73 | * |
||
| 74 | * @var string |
||
| 75 | */ |
||
| 76 | private static $_contacts_url; |
||
| 77 | |||
| 78 | private $person; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Initializes the class and stores the selected person to be shown |
||
| 82 | */ |
||
| 83 | 8 | public function __construct(midcom_db_person $person = null) |
|
| 84 | { |
||
| 85 | 8 | parent::__construct(); |
|
| 86 | |||
| 87 | 8 | if (null === self::$_contacts_url) { |
|
|
introduced
by
|
|||
| 88 | 1 | $siteconfig = org_openpsa_core_siteconfig::get_instance(); |
|
| 89 | 1 | self::$_contacts_url = $siteconfig->get_node_full_url('org.openpsa.contacts'); |
|
| 90 | } |
||
| 91 | |||
| 92 | // Read properties of provided person object |
||
| 93 | // TODO: Handle groups as well |
||
| 94 | 8 | if ($person) { |
|
| 95 | 7 | $this->person = $person; |
|
| 96 | 7 | $this->_data_read_ok = $this->read_object($person); |
|
| 97 | } |
||
| 98 | 8 | } |
|
| 99 | |||
| 100 | 1 | public static function add_head_elements() |
|
| 101 | { |
||
| 102 | 1 | static $added = false; |
|
| 103 | 1 | if (!$added) { |
|
| 104 | 1 | midcom::get()->head->add_stylesheet(MIDCOM_STATIC_URL . "/org.openpsa.widgets/hcard.css"); |
|
| 105 | 1 | midcom::get()->head->add_stylesheet(MIDCOM_STATIC_URL . '/stock-icons/font-awesome-4.7.0/css/font-awesome.min.css'); |
|
| 106 | 1 | $added = true; |
|
| 107 | } |
||
| 108 | 1 | } |
|
| 109 | |||
| 110 | /** |
||
| 111 | * Retrieve an object, uses in-request caching |
||
| 112 | * |
||
| 113 | * @param mixed $src GUID of object (ids work but are discouraged) |
||
| 114 | */ |
||
| 115 | 10 | public static function get($src) : self |
|
| 136 | } |
||
| 137 | |||
| 138 | /** |
||
| 139 | * Read properties of a person object and populate local fields accordingly |
||
| 140 | */ |
||
| 141 | 7 | private function read_object(midcom_db_person $person) |
|
| 142 | { |
||
| 143 | // Database identifiers |
||
| 144 | 7 | $this->contact_details['guid'] = $person->guid; |
|
| 145 | 7 | $this->contact_details['id'] = $person->id; |
|
| 146 | |||
| 147 | 7 | if ($person->guid == "") { |
|
| 148 | $this->contact_details['lastname'] = $this->_l10n->get('no person'); |
||
| 149 | 7 | } elseif ($person->firstname == '' && $person->lastname == '') { |
|
| 150 | 7 | $this->contact_details['lastname'] = "Person #{$person->id}"; |
|
| 151 | } else { |
||
| 152 | $this->contact_details['firstname'] = $person->firstname; |
||
| 153 | $this->contact_details['lastname'] = $person->lastname; |
||
| 154 | } |
||
| 155 | |||
| 156 | 7 | foreach (['handphone', 'workphone', 'homephone', 'email', 'homepage'] as $property) { |
|
| 157 | 7 | if ($person->$property) { |
|
| 158 | $this->contact_details[$property] = $person->$property; |
||
| 159 | } |
||
| 160 | } |
||
| 161 | |||
| 162 | 7 | if ( $this->_config->get('jabber_enable_presence') |
|
| 163 | 7 | && $person->get_parameter('org.openpsa.jabber', 'jid')) { |
|
| 164 | $this->contact_details['jid'] = $person->get_parameter('org.openpsa.jabber', 'jid'); |
||
| 165 | } |
||
| 166 | |||
| 167 | 7 | if ( $this->_config->get('skype_enable_presence') |
|
| 168 | 7 | && $person->get_parameter('org.openpsa.skype', 'name')) { |
|
| 169 | $this->contact_details['skype'] = $person->get_parameter('org.openpsa.skype', 'name'); |
||
| 170 | } |
||
| 171 | 7 | } |
|
| 172 | |||
| 173 | private function _render_name(string $fallback_image) : string |
||
| 174 | { |
||
| 175 | $name = "<span class=\"given-name\">{$this->contact_details['firstname']}</span> <span class=\"family-name\">{$this->contact_details['lastname']}</span>"; |
||
| 176 | |||
| 177 | $url = false; |
||
| 178 | |||
| 179 | if ($this->link) { |
||
| 180 | $url = $this->link; |
||
| 181 | } elseif ($this->link_contacts && !empty($this->contact_details['guid'])) { |
||
| 182 | if (!self::$_contacts_url) { |
||
| 183 | $this->link_contacts = false; |
||
| 184 | } else { |
||
| 185 | $url = self::$_contacts_url . 'person/' . $this->contact_details['guid'] . '/'; |
||
| 186 | } |
||
| 187 | } |
||
| 188 | |||
| 189 | $name = $this->get_image('thumbnail', $fallback_image) . $name; |
||
| 190 | |||
| 191 | if ($url) { |
||
| 192 | $name = '<a href="' . $url . '">' . $name . '</a>'; |
||
| 193 | } |
||
| 194 | |||
| 195 | return $name; |
||
| 196 | } |
||
| 197 | |||
| 198 | 1 | public function get_image(string $type, string $fallback) : string |
|
| 199 | { |
||
| 200 | 1 | $attachments = blobs::get_attachments($this->person, 'photo'); |
|
| 201 | 1 | if (!empty($attachments[$type])) { |
|
| 202 | return '<img class="photo" src="' . midcom_db_attachment::get_url($attachments[$type]) . '">'; |
||
| 203 | } |
||
| 204 | 1 | if ( $this->_config->get('gravatar_enable') |
|
| 205 | 1 | && !empty($this->contact_details['email'])) { |
|
| 206 | $size = ($type == 'view') ? 500 : 32; |
||
| 207 | $gravatar_url = "https://www.gravatar.com/avatar/" . md5(strtolower(trim($this->contact_details['email']))) . "?s=" . $size . '&d=identicon'; |
||
| 208 | return "<img src=\"{$gravatar_url}\" class=\"photo\" />\n"; |
||
| 209 | } |
||
| 210 | 1 | return '<i class="fa fa-' . $fallback . '"></i>'; |
|
| 211 | } |
||
| 212 | |||
| 213 | /** |
||
| 214 | * Show selected person object inline. Outputs hCard XHTML. |
||
| 215 | */ |
||
| 216 | 9 | public function show_inline() : string |
|
| 217 | { |
||
| 218 | 9 | if (!$this->_data_read_ok) { |
|
| 219 | 9 | return ''; |
|
| 220 | } |
||
| 221 | self::add_head_elements(); |
||
| 222 | $inline_string = ''; |
||
| 223 | |||
| 224 | // Start the vCard |
||
| 225 | $inline_string .= "<span class=\"vcard\">"; |
||
| 226 | |||
| 227 | if (!empty($this->contact_details['guid'])) { |
||
| 228 | // Identifier |
||
| 229 | $inline_string .= "<span class=\"uid\" style=\"display: none;\">{$this->contact_details['guid']}</span>"; |
||
| 230 | } |
||
| 231 | |||
| 232 | // The name sequence |
||
| 233 | $inline_string .= "<span class=\"n\">"; |
||
| 234 | $inline_string .= $this->_render_name('address-card-o'); |
||
| 235 | $inline_string .= "</span>"; |
||
| 236 | |||
| 237 | $inline_string .= "</span>"; |
||
| 238 | |||
| 239 | return $inline_string; |
||
| 240 | } |
||
| 241 | |||
| 242 | /** |
||
| 243 | * Show the selected person. Outputs hCard XHTML. |
||
| 244 | */ |
||
| 245 | 2 | public function show() |
|
| 305 | } |
||
| 306 | |||
| 307 | private function _show_phone_number(string $field, string $type) |
||
| 308 | { |
||
| 309 | if (!empty($this->contact_details[$field])) { |
||
| 310 | 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"; |
||
| 311 | } |
||
| 312 | } |
||
| 313 | |||
| 314 | private function _show_groups() |
||
| 346 | } |
||
| 347 | } |
||
| 348 | |||
| 349 | /** |
||
| 350 | * Renderer for organization address cards |
||
| 351 | */ |
||
| 352 | 1 | public static function show_address_card($customer, array $cards) |
|
| 441 |
Loading history...
