Complex classes like Wordlift_Entity_Service 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 Wordlift_Entity_Service, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | class Wordlift_Entity_Service { |
||
| 9 | |||
| 10 | /** |
||
| 11 | * The Log service. |
||
| 12 | * |
||
| 13 | * @since 3.2.0 |
||
| 14 | * @access private |
||
| 15 | * @var \Wordlift_Log_Service $log_service The Log service. |
||
| 16 | */ |
||
| 17 | private $log_service; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * The UI service. |
||
| 21 | * |
||
| 22 | * @since 3.2.0 |
||
| 23 | * @access private |
||
| 24 | * @var \Wordlift_UI_Service $ui_service The UI service. |
||
| 25 | */ |
||
| 26 | private $ui_service; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * The Schema service. |
||
| 30 | * |
||
| 31 | * @since 3.3.0 |
||
| 32 | * @access private |
||
| 33 | * @var \Wordlift_Schema_Service $schema_service The Schema service. |
||
| 34 | */ |
||
| 35 | private $schema_service; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * The Notice service. |
||
| 39 | * |
||
| 40 | * @since 3.3.0 |
||
| 41 | * @access private |
||
| 42 | * @var \Wordlift_Notice_Service $notice_service The Notice service. |
||
| 43 | */ |
||
| 44 | private $notice_service; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * The entity post type name. |
||
| 48 | * |
||
| 49 | * @since 3.1.0 |
||
| 50 | */ |
||
| 51 | const TYPE_NAME = 'entity'; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Entity rating max. |
||
| 55 | * |
||
| 56 | * @since 3.3.0 |
||
| 57 | */ |
||
| 58 | const RATING_MAX = 7; |
||
| 59 | |||
| 60 | /** |
||
| 61 | * Entity rating score meta key. |
||
| 62 | * |
||
| 63 | * @since 3.3.0 |
||
| 64 | */ |
||
| 65 | const RATING_RAW_SCORE_META_KEY = '_wl_entity_rating_raw_score'; |
||
| 66 | |||
| 67 | /** |
||
| 68 | * Entity rating warnings meta key. |
||
| 69 | * |
||
| 70 | * @since 3.3.0 |
||
| 71 | */ |
||
| 72 | const RATING_WARNINGS_META_KEY = '_wl_entity_rating_warnings'; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * Entity warning has related post identifier. |
||
| 76 | * |
||
| 77 | * @since 3.3.0 |
||
| 78 | */ |
||
| 79 | const RATING_WARNING_HAS_RELATED_POSTS = 'There are no related posts for the current entity.'; |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Entity warning has content post identifier. |
||
| 83 | * |
||
| 84 | * @since 3.3.0 |
||
| 85 | */ |
||
| 86 | const RATING_WARNING_HAS_CONTENT_POST = 'This entity has not description.'; |
||
| 87 | |||
| 88 | /** |
||
| 89 | * Entity warning has related entities identifier. |
||
| 90 | * |
||
| 91 | * @since 3.3.0 |
||
| 92 | */ |
||
| 93 | const RATING_WARNING_HAS_RELATED_ENTITIES = 'There are no related entities for the current entity.'; |
||
| 94 | |||
| 95 | /** |
||
| 96 | * Entity warning is published identifier. |
||
| 97 | * |
||
| 98 | * @since 3.3.0 |
||
| 99 | */ |
||
| 100 | const RATING_WARNING_IS_PUBLISHED = 'This entity is not published. It will not appear within analysis results.'; |
||
| 101 | |||
| 102 | /** |
||
| 103 | * Entity warning has thumbnail identifier. |
||
| 104 | * |
||
| 105 | * @since 3.3.0 |
||
| 106 | */ |
||
| 107 | const RATING_WARNING_HAS_THUMBNAIL = 'This entity has no featured image yet.'; |
||
| 108 | |||
| 109 | /** |
||
| 110 | * Entity warning has same as identifier. |
||
| 111 | * |
||
| 112 | * @since 3.3.0 |
||
| 113 | */ |
||
| 114 | const RATING_WARNING_HAS_SAME_AS = 'There are no sameAs configured for this entity.'; |
||
| 115 | |||
| 116 | /** |
||
| 117 | * Entity warning has completed metadata identifier. |
||
| 118 | * |
||
| 119 | * @since 3.3.0 |
||
| 120 | */ |
||
| 121 | const RATING_WARNING_HAS_COMPLETED_METADATA = 'Schema.org metadata for this entity are not completed.'; |
||
| 122 | |||
| 123 | /** |
||
| 124 | * The alternative label meta key. |
||
| 125 | * |
||
| 126 | * @since 3.2.0 |
||
| 127 | */ |
||
| 128 | const ALTERNATIVE_LABEL_META_KEY = '_wl_alt_label'; |
||
| 129 | |||
| 130 | /** |
||
| 131 | * The alternative label input template. |
||
| 132 | * |
||
| 133 | * @since 3.2.0 |
||
| 134 | */ |
||
| 135 | // TODO: this should be moved to a class that deals with HTML code. |
||
| 136 | const ALTERNATIVE_LABEL_INPUT_TEMPLATE = '<div class="wl-alternative-label"> |
||
| 137 | <label class="screen-reader-text" id="wl-alternative-label-prompt-text" for="wl-alternative-label">Enter alternative label here</label> |
||
| 138 | <input name="wl_alternative_label[]" size="30" value="%s" id="wl-alternative-label" type="text"> |
||
| 139 | <button class="button wl-delete-button">%s</button> |
||
| 140 | </div>'; |
||
| 141 | |||
| 142 | /** |
||
| 143 | * A singleton instance of the Entity service. |
||
| 144 | * |
||
| 145 | * @since 3.2.0 |
||
| 146 | * @access private |
||
| 147 | * @var \Wordlift_Entity_Service $instance A singleton instance of the Entity service. |
||
| 148 | */ |
||
| 149 | private static $instance; |
||
| 150 | |||
| 151 | /** |
||
| 152 | * Create a Wordlift_Entity_Service instance. |
||
| 153 | * |
||
| 154 | * @since 3.2.0 |
||
| 155 | * |
||
| 156 | * @param \Wordlift_UI_Service $ui_service The UI service. |
||
| 157 | */ |
||
| 158 | public function __construct( $ui_service, $schema_service, $notice_service ) { |
||
| 159 | |||
| 160 | $this->log_service = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Service' ); |
||
| 161 | |||
| 162 | // Set the UI service. |
||
| 163 | $this->ui_service = $ui_service; |
||
| 164 | |||
| 165 | // Set the Schema service. |
||
| 166 | $this->schema_service = $schema_service; |
||
| 167 | |||
| 168 | // Set the Schema service. |
||
| 169 | $this->notice_service = $notice_service; |
||
| 170 | |||
| 171 | // Set the singleton instance. |
||
| 172 | self::$instance = $this; |
||
| 173 | |||
| 174 | } |
||
| 175 | |||
| 176 | /** |
||
| 177 | * Get the singleton instance of the Entity service. |
||
| 178 | * |
||
| 179 | * @since 3.2.0 |
||
| 180 | * @return \Wordlift_Entity_Service The singleton instance of the Entity service. |
||
| 181 | */ |
||
| 182 | public static function get_instance() { |
||
| 186 | |||
| 187 | /** |
||
| 188 | * Get rating max |
||
| 189 | * |
||
| 190 | * @since 3.3.0 |
||
| 191 | * |
||
| 192 | * @return int Max rating according to performed checks. |
||
| 193 | */ |
||
| 194 | public static function get_rating_max() { |
||
| 197 | |||
| 198 | /** |
||
| 199 | * Get the entities related to the last 50 posts published on this blog (we're keeping a long function name due to |
||
| 200 | * its specific function). |
||
| 201 | * |
||
| 202 | * @since 3.1.0 |
||
| 203 | * |
||
| 204 | * @return array An array of post IDs. |
||
| 205 | */ |
||
| 206 | public function get_all_related_to_last_50_published_posts() { |
||
| 207 | |||
| 208 | // Global timeline. Get entities from the latest posts. |
||
| 209 | $latest_posts_ids = get_posts( array( |
||
| 210 | 'numberposts' => 50, |
||
| 211 | 'fields' => 'ids', //only get post IDs |
||
| 212 | 'post_type' => 'post', |
||
| 213 | 'post_status' => 'publish' |
||
| 214 | ) ); |
||
| 215 | |||
| 216 | if ( empty( $latest_posts_ids ) ) { |
||
| 217 | // There are no posts. |
||
| 218 | return array(); |
||
| 219 | } |
||
| 220 | |||
| 221 | // Collect entities related to latest posts |
||
| 222 | $entity_ids = array(); |
||
| 223 | foreach ( $latest_posts_ids as $id ) { |
||
| 224 | $entity_ids = array_merge( $entity_ids, wl_core_get_related_entity_ids( $id, array( |
||
| 225 | 'status' => 'publish' |
||
| 226 | ) ) ); |
||
| 227 | } |
||
| 228 | |||
| 229 | return $entity_ids; |
||
| 230 | } |
||
| 231 | |||
| 232 | /** |
||
| 233 | * Determines whether a post is an entity or not. |
||
| 234 | * |
||
| 235 | * @since 3.1.0 |
||
| 236 | * |
||
| 237 | * @param int $post_id A post id. |
||
| 238 | * |
||
| 239 | * @return bool Return true if the post is an entity otherwise false. |
||
| 240 | */ |
||
| 241 | public function is_entity( $post_id ) { |
||
| 245 | |||
| 246 | /** |
||
| 247 | * Build an entity uri for a given title |
||
| 248 | * The uri is composed using a given post_type and a title |
||
| 249 | * If already exists an entity e2 with a given uri a numeric suffix is added |
||
| 250 | * If a schema type is given entities with same label and same type are overridden |
||
| 251 | * |
||
| 252 | * @since 3.5.0 |
||
| 253 | * |
||
| 254 | * @param string $title A post title. |
||
| 255 | * @param string $post_type A post type. Default value is 'entity' |
||
| 256 | * @param string $schema_type A schema org type. |
||
| 257 | * @param integer $increment_digit A digit used to call recursively the same function. |
||
| 258 | * |
||
| 259 | * @return string Returns an uri. |
||
| 260 | */ |
||
| 261 | public function build_uri( $title, $post_type, $schema_type = NULL, $increment_digit = 0 ) { |
||
| 307 | |||
| 308 | public function is_used( $post_id ) { |
||
| 350 | |||
| 351 | /** |
||
| 352 | * Determines whether a given uri is an internal uri or not. |
||
| 353 | * |
||
| 354 | * @since 3.3.2 |
||
| 355 | * |
||
| 356 | * @param int $uri An uri. |
||
| 357 | * |
||
| 358 | * @return true if the uri internal to the current dataset otherwise false. |
||
| 359 | */ |
||
| 360 | public function is_internal_uri( $uri ) { |
||
| 364 | |||
| 365 | /** |
||
| 366 | * Find entity posts by the entity URI. Entity as searched by their entity URI or same as. |
||
| 367 | * |
||
| 368 | * @since 3.2.0 |
||
| 369 | * |
||
| 370 | * @param string $uri The entity URI. |
||
| 371 | * |
||
| 372 | * @return WP_Post|null A WP_Post instance or null if not found. |
||
| 373 | */ |
||
| 374 | public function get_entity_post_by_uri( $uri ) { |
||
| 415 | |||
| 416 | /** |
||
| 417 | * Fires once a post has been saved. |
||
| 418 | * |
||
| 419 | * @since 3.2.0 |
||
| 420 | * |
||
| 421 | * @param int $post_id Post ID. |
||
| 422 | * @param WP_Post $post Post object. |
||
| 423 | * @param bool $update Whether this is an existing post being updated or not. |
||
| 424 | */ |
||
| 425 | public function save_post( $post_id, $post, $update ) { |
||
| 439 | |||
| 440 | /** |
||
| 441 | * Set the alternative labels. |
||
| 442 | * |
||
| 443 | * @since 3.2.0 |
||
| 444 | * |
||
| 445 | * @param int $post_id The post id. |
||
| 446 | * @param array $alt_labels An array of labels. |
||
| 447 | */ |
||
| 448 | public function set_alternative_labels( $post_id, $alt_labels ) { |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Retrieve the alternate labels. |
||
| 471 | * |
||
| 472 | * @since 3.2.0 |
||
| 473 | * |
||
| 474 | * @param int $post_id Post id. |
||
| 475 | * |
||
| 476 | * @return mixed An array of alternative labels. |
||
| 477 | */ |
||
| 478 | public function get_alternative_labels( $post_id ) { |
||
| 482 | |||
| 483 | /** |
||
| 484 | * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0). |
||
| 485 | * |
||
| 486 | * @since 3.2.0 |
||
| 487 | * |
||
| 488 | * @param WP_Post $post Post object. |
||
| 489 | */ |
||
| 490 | public function edit_form_before_permalink( $post ) { |
||
| 511 | |||
| 512 | /** |
||
| 513 | * Add admin notices for the current entity depending on the current rating. |
||
| 514 | * |
||
| 515 | * @since 3.3.0 |
||
| 516 | * |
||
| 517 | * @param WP_Post $post Post object. |
||
| 518 | */ |
||
| 519 | public function in_admin_header() { |
||
| 551 | |||
| 552 | /** |
||
| 553 | * Set rating for a given entity |
||
| 554 | * |
||
| 555 | * @since 3.3.0 |
||
| 556 | * |
||
| 557 | * @param int $post_id The entity post id. |
||
| 558 | * |
||
| 559 | * @return int An array representing the rating obj. |
||
| 560 | */ |
||
| 561 | public function set_rating_for( $post_id ) { |
||
| 578 | /** |
||
| 579 | * Get or calculate rating for a given entity |
||
| 580 | * |
||
| 581 | * @since 3.3.0 |
||
| 582 | * |
||
| 583 | * @param int $post_id The entity post id. |
||
| 584 | * @param $force_reload $warnings_needed If true, detailed warnings collection is provided with the rating obj. |
||
| 585 | * |
||
| 586 | * @return int An array representing the rating obj. |
||
| 587 | */ |
||
| 588 | public function get_rating_for( $post_id, $force_reload = false ) { |
||
| 613 | /** |
||
| 614 | * Calculate rating for a given entity |
||
| 615 | * Rating depends from following criteria |
||
| 616 | * |
||
| 617 | * 1. Is the current entity related to at least 1 post? |
||
| 618 | * 2. Is the current entity content post not empty? |
||
| 619 | * 3. Is the current entity related to at least 1 entity? |
||
| 620 | * 4. Is the entity published? |
||
| 621 | * 5. There is a a thumbnail associated to the entity? |
||
| 622 | * 6. Has the entity a sameas defined? |
||
| 623 | * 7. Are all schema.org required metadata compiled? |
||
| 624 | * |
||
| 625 | * Each positive check means +1 in terms of rating score |
||
| 626 | * |
||
| 627 | * @since 3.3.0 |
||
| 628 | * |
||
| 629 | * @param int $post_id The entity post id. |
||
| 630 | * |
||
| 631 | * @return int An array representing the rating obj. |
||
| 632 | */ |
||
| 633 | public function calculate_rating_for( $post_id ) { |
||
| 708 | |||
| 709 | /** |
||
| 710 | * Get as rating as input and convert in a traffic-light rating |
||
| 711 | * |
||
| 712 | * @since 3.3.0 |
||
| 713 | * |
||
| 714 | * @param int $score The rating score for a given entity. |
||
| 715 | * |
||
| 716 | * @return string The input HTML code. |
||
| 717 | */ |
||
| 718 | private function convert_raw_score_to_traffic_light( $score ) { |
||
| 726 | |||
| 727 | /** |
||
| 728 | * Get as rating as input and convert in a traffic-light rating |
||
| 729 | * |
||
| 730 | * @since 3.3.0 |
||
| 731 | * |
||
| 732 | * @param int $score The rating score for a given entity. |
||
| 733 | * |
||
| 734 | * @return string The input HTML code. |
||
| 735 | */ |
||
| 736 | public function convert_raw_score_to_percentage( $score ) { |
||
| 740 | |||
| 741 | /** |
||
| 742 | * Get the alternative label input HTML code. |
||
| 743 | * |
||
| 744 | * @since 3.2.0 |
||
| 745 | * |
||
| 746 | * @param string $value The input value. |
||
| 747 | * |
||
| 748 | * @return string The input HTML code. |
||
| 749 | */ |
||
| 750 | private function get_alternative_label_input( $value = '' ) { |
||
| 754 | } |
||
| 755 |
Instead of relying on
globalstate, we recommend one of these alternatives:1. Pass all data via parameters
2. Create a class that maintains your state