Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 13 | abstract class View { |
||
| 14 | |||
| 15 | /** |
||
| 16 | * title |
||
| 17 | * Title of the tab. |
||
| 18 | * |
||
| 19 | * @var string |
||
| 20 | * @access protected |
||
| 21 | */ |
||
| 22 | protected $title; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * type |
||
| 26 | * Type of objects we'll be dealing with i.e.: post or term. |
||
| 27 | * |
||
| 28 | * @var string |
||
| 29 | * @access protected |
||
| 30 | */ |
||
| 31 | protected $type; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * priority |
||
| 35 | * SPriority to pass into the actions. |
||
| 36 | * |
||
| 37 | * @var int |
||
| 38 | * @access protected |
||
| 39 | */ |
||
| 40 | protected $priority; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Registers our view with appropriate actions. |
||
| 44 | * |
||
| 45 | * @see tab, view |
||
| 46 | */ |
||
| 47 | public function register_view() { |
||
| 53 | |||
| 54 | |||
| 55 | /** |
||
| 56 | * Builf the HTML for our tab navigation item. |
||
| 57 | * |
||
| 58 | * Each view has a tab and tab navigation - this function compiles our |
||
| 59 | * navigation tab. Rarely extended. |
||
| 60 | */ |
||
| 61 | public function tab() { |
||
| 62 | $html = ""; |
||
| 63 | |||
| 64 | $html .= "<a class='nav-tab' data-type='" . esc_attr( sanitize_title( $this->title ) ) . "' href='javascript:void(0)'>"; |
||
| 65 | $html .= esc_html( $this->title ); |
||
| 66 | $html .= "</a>"; |
||
| 67 | |||
| 68 | echo $html; |
||
| 69 | |||
| 70 | } |
||
| 71 | |||
| 72 | |||
| 73 | /** |
||
| 74 | * Build the HTML for the actual tab content. |
||
| 75 | * |
||
| 76 | * Each view has a tab and tab navigation - this function compiles our |
||
| 77 | * tab content. Rarely extended |
||
| 78 | * |
||
| 79 | * @see actions_section, options_section |
||
| 80 | */ |
||
| 81 | public function view() { |
||
|
|
|||
| 82 | $html = ''; |
||
| 83 | |||
| 84 | $html .= "<section class='test-content-tab' data-type='" . esc_attr( sanitize_title( $this->title ) ) . "'>"; |
||
| 85 | $html .= $this->actions_section(); |
||
| 86 | $html .= $this->options_section(); |
||
| 87 | $html .= "</section>"; |
||
| 88 | |||
| 89 | echo $html; |
||
| 90 | |||
| 91 | } |
||
| 92 | |||
| 93 | |||
| 94 | /** |
||
| 95 | * Holder function to build the tab main content. Extend this with your content. |
||
| 96 | * |
||
| 97 | * @access protected |
||
| 98 | * |
||
| 99 | * @return string HTML content. |
||
| 100 | */ |
||
| 101 | protected function actions_section() { |
||
| 105 | |||
| 106 | |||
| 107 | /** |
||
| 108 | * Starter for an options section for the view. |
||
| 109 | * |
||
| 110 | * Options are where you could add various options and triggers such as author, |
||
| 111 | * quantity, or any other customization of the created/deleted data. |
||
| 112 | * |
||
| 113 | * @access protected |
||
| 114 | * |
||
| 115 | * @param string $html Existing HTML content. |
||
| 116 | * @return string HTML section content. |
||
| 117 | */ |
||
| 118 | View Code Duplication | protected function options_section( $html = '' ) { |
|
| 119 | $html .= "<hr>"; |
||
| 120 | |||
| 121 | $html .= "<div class='test-data-cpt'>"; |
||
| 122 | $html .= "<h3>"; |
||
| 123 | $html .= "<span class='label'>" . esc_html__( 'Quantity', 'dummybot' ) . "</span>"; |
||
| 124 | $html .= "<input type='number' value='0' class='quantity-adjustment' for='" . esc_attr( $this->type ) . "' > "; |
||
| 125 | $html .= "</h3>"; |
||
| 126 | $html .= "</div>"; |
||
| 127 | |||
| 128 | return $html; |
||
| 129 | } |
||
| 130 | |||
| 131 | |||
| 132 | /** |
||
| 133 | * Builds action buttons for creating or deleting content. |
||
| 134 | * |
||
| 135 | * @access protected |
||
| 136 | * |
||
| 137 | * @param string $action Type of action to take - i.e.: create or delete. |
||
| 138 | * @param string $slug Slug ID of the object to create i.e.: page or category. |
||
| 139 | * @param string $text Text to display in the button. |
||
| 140 | * @return string HTML. |
||
| 141 | */ |
||
| 142 | protected function build_button( $action, $slug, $text ) { |
||
| 164 | |||
| 165 | } |
||
| 166 |