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 ) { |
||
| 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() { |
||
| 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 | * Get the proper classification scope for a given entity post |
||
| 248 | * |
||
| 249 | * @since 3.5.0 |
||
| 250 | * |
||
| 251 | * @param integer $post_id An entity post id. |
||
| 252 | * |
||
| 253 | * @return string Returns an uri. |
||
| 254 | */ |
||
| 255 | public function get_classification_scope_for( $post_id ) { |
||
| 256 | |||
| 257 | if ( FALSE === $this->is_entity( $post_id ) ) { |
||
| 258 | return NULL; |
||
| 259 | } |
||
| 260 | // Retrieve the entity type |
||
| 261 | $entity_type_arr = wl_entity_type_taxonomy_get_type( $post_id ); |
||
| 262 | $entity_type = str_replace( 'wl-', '', $entity_type_arr['css_class'] ); |
||
| 263 | // Retrieve classification boxes configuration |
||
| 264 | $classification_boxes = unserialize( WL_CORE_POST_CLASSIFICATION_BOXES ); |
||
| 265 | foreach ( $classification_boxes as $cb ) { |
||
| 266 | if ( in_array( $entity_type, $cb['registeredTypes'] ) ) { |
||
| 267 | return $cb['id']; |
||
| 268 | } |
||
| 269 | } |
||
| 270 | |||
| 271 | // or null |
||
| 272 | return NULL; |
||
| 273 | |||
| 274 | } |
||
| 275 | |||
| 276 | /** |
||
| 277 | * Build an entity uri for a given title |
||
| 278 | * The uri is composed using a given post_type and a title |
||
| 279 | * If already exists an entity e2 with a given uri a numeric suffix is added |
||
| 280 | * If a schema type is given entities with same label and same type are overridden |
||
| 281 | * |
||
| 282 | * @since 3.5.0 |
||
| 283 | * |
||
| 284 | * @param string $title A post title. |
||
| 285 | * @param string $post_type A post type. Default value is 'entity' |
||
| 286 | * @param string $schema_type A schema org type. |
||
| 287 | * @param integer $increment_digit A digit used to call recursively the same function. |
||
| 288 | * |
||
| 289 | * @return string Returns an uri. |
||
| 290 | */ |
||
| 291 | public function build_uri( $title, $post_type, $schema_type = NULL, $increment_digit = 0 ) { |
||
| 292 | |||
| 293 | // Get the entity slug suffix digit |
||
| 294 | $suffix_digit = $increment_digit + 1; |
||
| 295 | // Get a sanitized uri for a given title |
||
| 296 | $entity_slug = ( 0 == $increment_digit ) ? |
||
| 297 | wl_sanitize_uri_path( $title ) : |
||
| 298 | wl_sanitize_uri_path( $title . '_' . $suffix_digit ); |
||
| 299 | |||
| 300 | // Compose a candidated uri |
||
| 301 | $new_entity_uri = sprintf( '%s/%s/%s', |
||
| 302 | wl_configuration_get_redlink_dataset_uri(), |
||
| 303 | $post_type, |
||
| 304 | $entity_slug |
||
| 305 | ); |
||
| 306 | |||
| 307 | $this->log_service->trace( "Going to check if uri is used [ new_entity_uri :: $new_entity_uri ] [ increment_digit :: $increment_digit ]" ); |
||
| 308 | |||
| 309 | global $wpdb; |
||
|
|
|||
| 310 | // Check if the candidated uri already is used |
||
| 311 | $stmt = $wpdb->prepare( |
||
| 312 | "SELECT post_id FROM $wpdb->postmeta WHERE meta_key = %s AND meta_value = %s LIMIT 1", |
||
| 313 | WL_ENTITY_URL_META_NAME, |
||
| 314 | $new_entity_uri |
||
| 315 | ); |
||
| 316 | |||
| 317 | // Perform the query |
||
| 318 | $post_id = $wpdb->get_var( $stmt ); |
||
| 319 | |||
| 320 | // If the post does not exist, then the new uri is returned |
||
| 321 | if ( ! is_numeric( $post_id ) ) { |
||
| 322 | $this->log_service->trace( "Going to return uri [ new_entity_uri :: $new_entity_uri ]" ); |
||
| 323 | |||
| 324 | return $new_entity_uri; |
||
| 325 | } |
||
| 326 | // If schema_type is equal to schema org type of post x, then the new uri is returned |
||
| 327 | $schema_post_type = wl_entity_type_taxonomy_get_type( $post_id ); |
||
| 328 | |||
| 329 | if ( $schema_type === $schema_post_type['css_class'] ) { |
||
| 330 | $this->log_service->trace( "An entity with the same title and type already exists! Return uri [ new_entity_uri :: $new_entity_uri ]" ); |
||
| 331 | |||
| 332 | return $new_entity_uri; |
||
| 333 | } |
||
| 334 | |||
| 335 | // Otherwise the same function is called recorsively |
||
| 336 | return $this->build_uri( $title, $post_type, $schema_type, ++ $increment_digit ); |
||
| 337 | } |
||
| 338 | |||
| 339 | public function is_used( $post_id ) { |
||
| 381 | |||
| 382 | /** |
||
| 383 | * Determines whether a given uri is an internal uri or not. |
||
| 384 | * |
||
| 385 | * @since 3.3.2 |
||
| 386 | * |
||
| 387 | * @param int $uri An uri. |
||
| 388 | * |
||
| 389 | * @return true if the uri internal to the current dataset otherwise false. |
||
| 390 | */ |
||
| 391 | public function is_internal_uri( $uri ) { |
||
| 395 | |||
| 396 | /** |
||
| 397 | * Find entity posts by the entity URI. Entity as searched by their entity URI or same as. |
||
| 398 | * |
||
| 399 | * @since 3.2.0 |
||
| 400 | * |
||
| 401 | * @param string $uri The entity URI. |
||
| 402 | * |
||
| 403 | * @return WP_Post|null A WP_Post instance or null if not found. |
||
| 404 | */ |
||
| 405 | public function get_entity_post_by_uri( $uri ) { |
||
| 451 | |||
| 452 | /** |
||
| 453 | * Fires once a post has been saved. This function uses the $_REQUEST, therefore |
||
| 454 | * we check that the post we're saving is the current post. |
||
| 455 | * |
||
| 456 | * @see https://github.com/insideout10/wordlift-plugin/issues/363 |
||
| 457 | * |
||
| 458 | * @since 3.2.0 |
||
| 459 | * |
||
| 460 | * @param int $post_id Post ID. |
||
| 461 | * @param WP_Post $post Post object. |
||
| 462 | * @param bool $update Whether this is an existing post being updated or not. |
||
| 463 | */ |
||
| 464 | public function save_post( $post_id, $post, $update ) { |
||
| 483 | |||
| 484 | /** |
||
| 485 | * Set the alternative labels. |
||
| 486 | * |
||
| 487 | * @since 3.2.0 |
||
| 488 | * |
||
| 489 | * @param int $post_id The post id. |
||
| 490 | * @param array $alt_labels An array of labels. |
||
| 491 | */ |
||
| 492 | public function set_alternative_labels( $post_id, $alt_labels ) { |
||
| 512 | |||
| 513 | /** |
||
| 514 | * Retrieve the alternate labels. |
||
| 515 | * |
||
| 516 | * @since 3.2.0 |
||
| 517 | * |
||
| 518 | * @param int $post_id Post id. |
||
| 519 | * |
||
| 520 | * @return mixed An array of alternative labels. |
||
| 521 | */ |
||
| 522 | public function get_alternative_labels( $post_id ) { |
||
| 526 | |||
| 527 | /** |
||
| 528 | * Fires before the permalink field in the edit form (this event is available in WP from 4.1.0). |
||
| 529 | * |
||
| 530 | * @since 3.2.0 |
||
| 531 | * |
||
| 532 | * @param WP_Post $post Post object. |
||
| 533 | */ |
||
| 534 | public function edit_form_before_permalink( $post ) { |
||
| 555 | |||
| 556 | /** |
||
| 557 | * Add admin notices for the current entity depending on the current rating. |
||
| 558 | * |
||
| 559 | * @since 3.3.0 |
||
| 560 | * |
||
| 561 | * @param WP_Post $post Post object. |
||
| 562 | */ |
||
| 563 | public function in_admin_header() { |
||
| 595 | |||
| 596 | /** |
||
| 597 | * Set rating for a given entity |
||
| 598 | * |
||
| 599 | * @since 3.3.0 |
||
| 600 | * |
||
| 601 | * @param int $post_id The entity post id. |
||
| 602 | * |
||
| 603 | * @return int An array representing the rating obj. |
||
| 604 | */ |
||
| 605 | public function set_rating_for( $post_id ) { |
||
| 622 | |||
| 623 | /** |
||
| 624 | * Get or calculate rating for a given entity |
||
| 625 | * |
||
| 626 | * @since 3.3.0 |
||
| 627 | * |
||
| 628 | * @param int $post_id The entity post id. |
||
| 629 | * @param $force_reload $warnings_needed If true, detailed warnings collection is provided with the rating obj. |
||
| 630 | * |
||
| 631 | * @return int An array representing the rating obj. |
||
| 632 | */ |
||
| 633 | public function get_rating_for( $post_id, $force_reload = FALSE ) { |
||
| 660 | |||
| 661 | /** |
||
| 662 | * Calculate rating for a given entity |
||
| 663 | * Rating depends from following criteria |
||
| 664 | * |
||
| 665 | * 1. Is the current entity related to at least 1 post? |
||
| 666 | * 2. Is the current entity content post not empty? |
||
| 667 | * 3. Is the current entity related to at least 1 entity? |
||
| 668 | * 4. Is the entity published? |
||
| 669 | * 5. There is a a thumbnail associated to the entity? |
||
| 670 | * 6. Has the entity a sameas defined? |
||
| 671 | * 7. Are all schema.org required metadata compiled? |
||
| 672 | * |
||
| 673 | * Each positive check means +1 in terms of rating score |
||
| 674 | * |
||
| 675 | * @since 3.3.0 |
||
| 676 | * |
||
| 677 | * @param int $post_id The entity post id. |
||
| 678 | * |
||
| 679 | * @return int An array representing the rating obj. |
||
| 680 | */ |
||
| 681 | public function calculate_rating_for( $post_id ) { |
||
| 756 | |||
| 757 | /** |
||
| 758 | * Get the URI for the entity with the specified post id. |
||
| 759 | * |
||
| 760 | * @since 3.6.0 |
||
| 761 | * |
||
| 762 | * @param int $post_id The entity post id. |
||
| 763 | * |
||
| 764 | * @return null|string The entity URI or NULL if not found or the dataset URI is not configured. |
||
| 765 | */ |
||
| 766 | public function get_uri( $post_id ) { |
||
| 789 | |||
| 790 | /** |
||
| 791 | * Get as rating as input and convert in a traffic-light rating |
||
| 792 | * |
||
| 793 | * @since 3.3.0 |
||
| 794 | * |
||
| 795 | * @param int $score The rating score for a given entity. |
||
| 796 | * |
||
| 797 | * @return string The input HTML code. |
||
| 798 | */ |
||
| 799 | private function convert_raw_score_to_traffic_light( $score ) { |
||
| 808 | |||
| 809 | /** |
||
| 810 | * Get as rating as input and convert in a traffic-light rating |
||
| 811 | * |
||
| 812 | * @since 3.3.0 |
||
| 813 | * |
||
| 814 | * @param int $score The rating score for a given entity. |
||
| 815 | * |
||
| 816 | * @return string The input HTML code. |
||
| 817 | */ |
||
| 818 | public function convert_raw_score_to_percentage( $score ) { |
||
| 822 | |||
| 823 | /** |
||
| 824 | * Get the alternative label input HTML code. |
||
| 825 | * |
||
| 826 | * @since 3.2.0 |
||
| 827 | * |
||
| 828 | * @param string $value The input value. |
||
| 829 | * |
||
| 830 | * @return string The input HTML code. |
||
| 831 | */ |
||
| 832 | private function get_alternative_label_input( $value = '' ) { |
||
| 836 | |||
| 837 | /** |
||
| 838 | * Get the number of entity posts published in this blog. |
||
| 839 | * |
||
| 840 | * @since 3.6.0 |
||
| 841 | * |
||
| 842 | * @return int The number of published entity posts. |
||
| 843 | */ |
||
| 844 | public function count() { |
||
| 850 | |||
| 851 | } |
||
| 852 |
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