ankitpokhrel /
Dynamic-Featured-Image
Complex classes like Dynamic_Featured_Image 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 Dynamic_Featured_Image, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 47 | class Dynamic_Featured_Image { |
||
| 48 | /** |
||
| 49 | * Current version of the plugin. |
||
| 50 | * |
||
| 51 | * @since 3.0.0 |
||
| 52 | */ |
||
| 53 | const VERSION = '3.5.2'; |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Text domain. |
||
| 57 | * |
||
| 58 | * @since 3.6.0 |
||
| 59 | */ |
||
| 60 | const TEXT_DOMAIN = 'dynamic-featured-image'; |
||
| 61 | |||
| 62 | /** |
||
| 63 | * Documentation Link. |
||
| 64 | * |
||
| 65 | * @since 3.6.0 |
||
| 66 | */ |
||
| 67 | const WIKI_LINK = 'https://github.com/ankitpokhrel/Dynamic-Featured-Image/wiki'; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * Image upload directory. |
||
| 71 | * |
||
| 72 | * @var $upload_dir string |
||
| 73 | */ |
||
| 74 | private $upload_dir; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Image upload URL. |
||
| 78 | * |
||
| 79 | * @var $upload_url string |
||
| 80 | */ |
||
| 81 | private $upload_url; |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Database object. |
||
| 85 | * |
||
| 86 | * @var $db wpdb |
||
| 87 | */ |
||
| 88 | private $db; |
||
| 89 | |||
| 90 | /** |
||
| 91 | * Title for dfi metabox. |
||
| 92 | * |
||
| 93 | * @var $metabox_title string |
||
| 94 | */ |
||
| 95 | protected $metabox_title; |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Users post type filter for dfi metabox. |
||
| 99 | * |
||
| 100 | * @var $user_filter array |
||
| 101 | */ |
||
| 102 | protected $user_filter; |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Constructor. Hooks all interactions to initialize the class. |
||
| 106 | * |
||
| 107 | * @since 1.0.0 |
||
| 108 | * @access public |
||
| 109 | * @global object $wpdb |
||
| 110 | * |
||
| 111 | * @see add_action() |
||
| 112 | */ |
||
| 113 | public function __construct() { |
||
| 147 | |||
| 148 | /** |
||
| 149 | * Return site protocol. |
||
| 150 | * |
||
| 151 | * @since 3.5.1 |
||
| 152 | * @access public |
||
| 153 | * |
||
| 154 | * @return string |
||
| 155 | */ |
||
| 156 | private function get_protocol() { |
||
| 160 | |||
| 161 | /** |
||
| 162 | * Add required admin scripts. |
||
| 163 | * |
||
| 164 | * @since 1.0.0 |
||
| 165 | * @access public |
||
| 166 | * |
||
| 167 | * @see wp_enque_style() |
||
| 168 | * @see wp_register_script() |
||
| 169 | * @see wp_enqueue_script() |
||
| 170 | * |
||
| 171 | * @return void |
||
| 172 | */ |
||
| 173 | public function enqueue_admin_scripts() { |
||
| 196 | |||
| 197 | /** |
||
| 198 | * Add upgrade link. |
||
| 199 | * |
||
| 200 | * @access public |
||
| 201 | * @since 3.5.1 |
||
| 202 | * @action plugin_action_links |
||
| 203 | * |
||
| 204 | * @codeCoverageIgnore |
||
| 205 | * |
||
| 206 | * @param array $links Action links. |
||
| 207 | * |
||
| 208 | * @return array |
||
| 209 | */ |
||
| 210 | public function dfi_action_links( $links ) { |
||
| 217 | |||
| 218 | /** |
||
| 219 | * Add featured meta boxes dynamically. |
||
| 220 | * |
||
| 221 | * @since 1.0.0 |
||
| 222 | * @access public |
||
| 223 | * @global object $post |
||
| 224 | * |
||
| 225 | * @see get_post_meta() |
||
| 226 | * @see get_post_types() |
||
| 227 | * @see add_meta_box() |
||
| 228 | * @see add_filter() |
||
| 229 | * |
||
| 230 | * @return void |
||
| 231 | */ |
||
| 232 | public function initialize_featured_box() { |
||
| 260 | |||
| 261 | /** |
||
| 262 | * Translates more than one digit number digit by digit. |
||
| 263 | * |
||
| 264 | * @param int $number Integer to be translated. |
||
| 265 | * |
||
| 266 | * @return string Translated number |
||
| 267 | */ |
||
| 268 | protected function get_number_translation( $number ) { |
||
| 281 | |||
| 282 | /** |
||
| 283 | * Adds meta boxes. |
||
| 284 | * |
||
| 285 | * @param array $post_types Post types to show featured image box. |
||
| 286 | * @param object $featured Callback arguments. |
||
| 287 | * @param int $i Index of the featured image. |
||
| 288 | * |
||
| 289 | * @return void |
||
| 290 | */ |
||
| 291 | private function dfi_add_meta_box( $post_types, $featured = null, $i = null ) { |
||
| 322 | |||
| 323 | /** |
||
| 324 | * Separate thumb and full image url from given URL string. |
||
| 325 | * |
||
| 326 | * @since 3.3.1 |
||
| 327 | * |
||
| 328 | * @param string $url_string Url string. |
||
| 329 | * @param string $state Thumb or full. |
||
| 330 | * |
||
| 331 | * @return string|null |
||
| 332 | */ |
||
| 333 | private function separate( $url_string, $state = 'thumb' ) { |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Create a nonce field |
||
| 345 | * |
||
| 346 | * @since 3.5.0 |
||
| 347 | * |
||
| 348 | * @see wp_nonce_field() |
||
| 349 | * @see plugin_basename() |
||
| 350 | * |
||
| 351 | * @codeCoverageIgnore |
||
| 352 | * |
||
| 353 | * @param string $key Nonce key. |
||
| 354 | * |
||
| 355 | * @return string |
||
| 356 | */ |
||
| 357 | protected function nonce_field( $key ) { |
||
| 360 | |||
| 361 | /** |
||
| 362 | * Featured meta box as seen in the admin |
||
| 363 | * |
||
| 364 | * @since 1.0.0 |
||
| 365 | * @access public |
||
| 366 | * |
||
| 367 | * @param object $post Global post object. |
||
| 368 | * @param array $featured Array containing featured image count. |
||
| 369 | * |
||
| 370 | * @throws Exception Medium size image not found. |
||
| 371 | * @return void |
||
| 372 | */ |
||
| 373 | public function featured_meta_box( $post, $featured ) { |
||
| 400 | |||
| 401 | /** |
||
| 402 | * Returns featured box html content. |
||
| 403 | * |
||
| 404 | * @since 3.1.0 |
||
| 405 | * @access private |
||
| 406 | * |
||
| 407 | * @param string $featured_img_trimmed Medium sized image. |
||
| 408 | * @param string $featured_img Full sized image. |
||
| 409 | * @param string $featured_id Attachment Id. |
||
| 410 | * @param string $thumbnail Thumb sized image. |
||
| 411 | * @param int $post_id Post id. |
||
| 412 | * |
||
| 413 | * @return string Html content |
||
| 414 | */ |
||
| 415 | private function get_featured_box( $featured_img_trimmed, $featured_img, $featured_id, $thumbnail, $post_id ) { |
||
| 429 | |||
| 430 | /** |
||
| 431 | * Load new featured meta box via ajax |
||
| 432 | * |
||
| 433 | * @since 1.0.0 |
||
| 434 | * @access public |
||
| 435 | * |
||
| 436 | * @return void |
||
| 437 | */ |
||
| 438 | public function ajax_callback() { |
||
| 467 | |||
| 468 | /** |
||
| 469 | * Add custom class 'featured-meta-box' to meta box. |
||
| 470 | * |
||
| 471 | * @since 1.0.0 |
||
| 472 | * @access public |
||
| 473 | * |
||
| 474 | * @see add_metabox_classes |
||
| 475 | * |
||
| 476 | * @param array $classes Classes to add in the meta box. |
||
| 477 | * |
||
| 478 | * @return array |
||
| 479 | */ |
||
| 480 | public function add_metabox_classes( $classes ) { |
||
| 485 | |||
| 486 | /** |
||
| 487 | * Add custom fields in media uploader. |
||
| 488 | * |
||
| 489 | * @since 3.4.0 |
||
| 490 | * |
||
| 491 | * @param array $form_fields Fields to include in media attachment form. |
||
| 492 | * @param array $post Post data. |
||
| 493 | * |
||
| 494 | * @return array |
||
| 495 | */ |
||
| 496 | public function media_attachment_custom_fields( $form_fields, $post ) { |
||
| 505 | |||
| 506 | /** |
||
| 507 | * Save values of media uploader custom fields. |
||
| 508 | * |
||
| 509 | * @since 3.4.0 |
||
| 510 | * |
||
| 511 | * @param array $post Post data for database. |
||
| 512 | * @param array $attachment Attachment fields from $_POST form. |
||
| 513 | * |
||
| 514 | * @return array |
||
| 515 | */ |
||
| 516 | public function media_attachment_custom_fields_save( $post, $attachment ) { |
||
| 523 | |||
| 524 | /** |
||
| 525 | * Update featured images in the database. |
||
| 526 | * |
||
| 527 | * @since 1.0.0 |
||
| 528 | * @access public |
||
| 529 | * |
||
| 530 | * @see plugin_basename() |
||
| 531 | * @see update_post_meta() |
||
| 532 | * @see current_user_can() |
||
| 533 | * |
||
| 534 | * @param int $post_id Current post id. |
||
| 535 | * |
||
| 536 | * @return bool|null |
||
| 537 | */ |
||
| 538 | public function save_meta( $post_id ) { |
||
| 560 | |||
| 561 | /** |
||
| 562 | * Verify metabox nonces. |
||
| 563 | * |
||
| 564 | * @access protected |
||
| 565 | * @see wp_verify_nonce() |
||
| 566 | * |
||
| 567 | * @return bool |
||
| 568 | */ |
||
| 569 | protected function verify_nonces() { |
||
| 587 | |||
| 588 | /** |
||
| 589 | * Add update notice. Displayed in plugin update page. |
||
| 590 | * |
||
| 591 | * @since 2.0.0 |
||
| 592 | * @access public |
||
| 593 | * |
||
| 594 | * @return void |
||
| 595 | */ |
||
| 596 | public function update_notice() { |
||
| 602 | |||
| 603 | /** |
||
| 604 | * Execute query. |
||
| 605 | * |
||
| 606 | * @param string $query Query to execute. |
||
| 607 | * |
||
| 608 | * @return null|string |
||
| 609 | */ |
||
| 610 | private function execute_query( $query ) { |
||
| 613 | |||
| 614 | /** |
||
| 615 | * Get attachment id of the image by image url. |
||
| 616 | * |
||
| 617 | * @since 3.1.7 |
||
| 618 | * @access protected |
||
| 619 | * @global object $wpdb |
||
| 620 | * |
||
| 621 | * @param string $image_url URL of an image. |
||
| 622 | * |
||
| 623 | * @return string |
||
| 624 | */ |
||
| 625 | protected function get_attachment_id( $image_url ) { |
||
| 628 | |||
| 629 | /** |
||
| 630 | * Get image url of the image by attachment id. |
||
| 631 | * |
||
| 632 | * @since 2.0.0 |
||
| 633 | * @access public |
||
| 634 | * |
||
| 635 | * @see wp_get_attachment_image_src() |
||
| 636 | * |
||
| 637 | * @param int $attachment_id attachment id of an image. |
||
| 638 | * @param string $size size of the image to fetch (thumbnail, medium, full). |
||
| 639 | * |
||
| 640 | * @return string |
||
| 641 | */ |
||
| 642 | public function get_image_url( $attachment_id, $size = 'full' ) { |
||
| 647 | |||
| 648 | /** |
||
| 649 | * Get image thumbnail url of specific size by image url. |
||
| 650 | * |
||
| 651 | * @since 2.0.0 |
||
| 652 | * @access public |
||
| 653 | * |
||
| 654 | * @see get_image_id() |
||
| 655 | * @see wp_get_attachment_image_src() |
||
| 656 | * |
||
| 657 | * @param string $image_url url of an image. |
||
| 658 | * @param string $size size of the image to fetch (thumbnail, medium, full). |
||
| 659 | * |
||
| 660 | * @return string |
||
| 661 | */ |
||
| 662 | public function get_image_thumb( $image_url, $size = 'thumbnail' ) { |
||
| 668 | |||
| 669 | /** |
||
| 670 | * Gets attachment id from given image url. |
||
| 671 | * |
||
| 672 | * @param string $image_url url of an image. |
||
| 673 | * |
||
| 674 | * @since 2.0.0 |
||
| 675 | * @access public |
||
| 676 | * |
||
| 677 | * @return int|null attachment id of an image |
||
| 678 | */ |
||
| 679 | public function get_image_id( $image_url ) { |
||
| 694 | |||
| 695 | /** |
||
| 696 | * Get image title. |
||
| 697 | * |
||
| 698 | * @since 2.0.0 |
||
| 699 | * @access public |
||
| 700 | * |
||
| 701 | * @param string $image_url URL of an image. |
||
| 702 | * |
||
| 703 | * @return string |
||
| 704 | */ |
||
| 705 | public function get_image_title( $image_url ) { |
||
| 708 | |||
| 709 | /** |
||
| 710 | * Get image title by id. |
||
| 711 | * |
||
| 712 | * @since 2.0.0 |
||
| 713 | * @access public |
||
| 714 | * |
||
| 715 | * @param int $attachment_id Attachment id of an image. |
||
| 716 | * |
||
| 717 | * @return string |
||
| 718 | */ |
||
| 719 | public function get_image_title_by_id( $attachment_id ) { |
||
| 722 | |||
| 723 | /** |
||
| 724 | * Get image caption. |
||
| 725 | * |
||
| 726 | * @since 2.0.0 |
||
| 727 | * @access public |
||
| 728 | * |
||
| 729 | * @param string $image_url URL of an image. |
||
| 730 | * |
||
| 731 | * @return string |
||
| 732 | */ |
||
| 733 | public function get_image_caption( $image_url ) { |
||
| 736 | |||
| 737 | /** |
||
| 738 | * Get image caption by id. |
||
| 739 | * |
||
| 740 | * @since 2.0.0 |
||
| 741 | * @access public |
||
| 742 | * |
||
| 743 | * @param int $attachment_id Attachment id of an image. |
||
| 744 | * |
||
| 745 | * @return string |
||
| 746 | */ |
||
| 747 | public function get_image_caption_by_id( $attachment_id ) { |
||
| 750 | |||
| 751 | /** |
||
| 752 | * Get image alternate text. |
||
| 753 | * |
||
| 754 | * @since 2.0.0 |
||
| 755 | * @access public |
||
| 756 | * |
||
| 757 | * @see get_post_meta() |
||
| 758 | * |
||
| 759 | * @param string $image_url URL of an image. |
||
| 760 | * |
||
| 761 | * @return string |
||
| 762 | */ |
||
| 763 | public function get_image_alt( $image_url ) { |
||
| 773 | |||
| 774 | /** |
||
| 775 | * Get image alternate text by attachment id. |
||
| 776 | * |
||
| 777 | * @since 2.0.0 |
||
| 778 | * @access public |
||
| 779 | * |
||
| 780 | * @see get_post_meta() |
||
| 781 | * |
||
| 782 | * @param int $attachment_id Attachment id of an image. |
||
| 783 | * |
||
| 784 | * @return string |
||
| 785 | */ |
||
| 786 | public function get_image_alt_by_id( $attachment_id ) { |
||
| 791 | |||
| 792 | /** |
||
| 793 | * Get image description. |
||
| 794 | * |
||
| 795 | * @since 3.0.0 |
||
| 796 | * @access public |
||
| 797 | * |
||
| 798 | * @param string $image_url URL of an image. |
||
| 799 | * |
||
| 800 | * @return string |
||
| 801 | */ |
||
| 802 | public function get_image_description( $image_url ) { |
||
| 805 | |||
| 806 | /** |
||
| 807 | * Get image description by id. |
||
| 808 | * |
||
| 809 | * @since 3.0.0 |
||
| 810 | * @access public |
||
| 811 | * |
||
| 812 | * @param int $attachment_id attachment id of an image. |
||
| 813 | * |
||
| 814 | * @return string |
||
| 815 | */ |
||
| 816 | public function get_image_description_by_id( $attachment_id ) { |
||
| 819 | |||
| 820 | /** |
||
| 821 | * Get link to image. |
||
| 822 | * |
||
| 823 | * @since 3.4.0 |
||
| 824 | * @access public |
||
| 825 | * |
||
| 826 | * @param int $attachment_id Attachment id of an image. |
||
| 827 | * |
||
| 828 | * @return string|null |
||
| 829 | */ |
||
| 830 | public function get_link_to_image( $attachment_id ) { |
||
| 833 | |||
| 834 | /** |
||
| 835 | * Get all attachment ids of the post. |
||
| 836 | * |
||
| 837 | * @since 2.0.0 |
||
| 838 | * @access public |
||
| 839 | * |
||
| 840 | * @see get_post_meta() |
||
| 841 | * |
||
| 842 | * @param int $post_id id of the current post. |
||
| 843 | * |
||
| 844 | * @return array |
||
| 845 | */ |
||
| 846 | public function get_post_attachment_ids( $post_id ) { |
||
| 859 | |||
| 860 | /** |
||
| 861 | * Fetches featured image data of nth position. |
||
| 862 | * |
||
| 863 | * @since 3.0.0 |
||
| 864 | * @access public |
||
| 865 | * |
||
| 866 | * @see get_featured_images() |
||
| 867 | * |
||
| 868 | * @param int $position Position of the featured image. |
||
| 869 | * @param int $post_id Current post id. |
||
| 870 | * |
||
| 871 | * @return array if found, null otherwise. |
||
| 872 | */ |
||
| 873 | public function get_nth_featured_image( $position, $post_id = null ) { |
||
| 883 | |||
| 884 | /** |
||
| 885 | * Check if the image is attached with the particular post. |
||
| 886 | * |
||
| 887 | * @since 2.0.0 |
||
| 888 | * @access public |
||
| 889 | * |
||
| 890 | * @see get_post_attachment_ids() |
||
| 891 | * |
||
| 892 | * @param int $attachment_id Attachment id of an image. |
||
| 893 | * @param int $post_id Current post id. |
||
| 894 | * |
||
| 895 | * @return bool |
||
| 896 | */ |
||
| 897 | public function is_attached( $attachment_id, $post_id ) { |
||
| 906 | |||
| 907 | /** |
||
| 908 | * Retrieve featured images for specific post(s). |
||
| 909 | * |
||
| 910 | * @since 2.0.0 |
||
| 911 | * @access public |
||
| 912 | * |
||
| 913 | * @see get_post_meta() |
||
| 914 | * |
||
| 915 | * @param integer $post_id id of the current post. |
||
| 916 | * |
||
| 917 | * @return array |
||
| 918 | */ |
||
| 919 | public function get_featured_images( $post_id = null ) { |
||
| 952 | |||
| 953 | /** |
||
| 954 | * Check to see if the upload url is already available in path. |
||
| 955 | * |
||
| 956 | * @since 3.1.14 |
||
| 957 | * @access protected |
||
| 958 | * |
||
| 959 | * @param string $img Uploaded image. |
||
| 960 | * |
||
| 961 | * @return string |
||
| 962 | */ |
||
| 963 | protected function get_real_upload_path( $img ) { |
||
| 971 | |||
| 972 | /** |
||
| 973 | * Retrieve featured images for specific post(s) including the default Featured Image. |
||
| 974 | * |
||
| 975 | * @since 3.1.7 |
||
| 976 | * @access public |
||
| 977 | * |
||
| 978 | * @see $this->get_featured_images() |
||
| 979 | * |
||
| 980 | * @param int $post_id Current post id. |
||
| 981 | * |
||
| 982 | * @return array An array of images or an empty array on failure |
||
| 983 | */ |
||
| 984 | public function get_all_featured_images( $post_id = null ) { |
||
| 1006 | |||
| 1007 | /** |
||
| 1008 | * Load the plugin's textdomain hooked to 'plugins_loaded'. |
||
| 1009 | * |
||
| 1010 | * @since 1.0.0 |
||
| 1011 | * @access public |
||
| 1012 | * |
||
| 1013 | * @see load_plugin_textdomain() |
||
| 1014 | * @see plugin_basename() |
||
| 1015 | * @action plugins_loaded |
||
| 1016 | * |
||
| 1017 | * @codeCoverageIgnore |
||
| 1018 | * |
||
| 1019 | * @return void |
||
| 1020 | */ |
||
| 1021 | public function load_plugin_textdomain() { |
||
| 1028 | } |
||
| 1029 | |||
| 1040 |
Loading history...
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: