pryley /
castor-framework
| Total Complexity | 54 |
| Total Lines | 342 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Base 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 Base, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | abstract class Base |
||
| 9 | { |
||
| 10 | /** |
||
| 11 | * @var array |
||
| 12 | */ |
||
| 13 | protected $args; |
||
| 14 | |||
| 15 | /** |
||
| 16 | * @var array |
||
| 17 | */ |
||
| 18 | protected $dependencies = []; |
||
| 19 | |||
| 20 | /** |
||
| 21 | * Whether the field has multiple values |
||
| 22 | * |
||
| 23 | * @var bool |
||
| 24 | */ |
||
| 25 | protected $multi = false; |
||
| 26 | |||
| 27 | /** |
||
| 28 | * Whether the field is rendered outside of the form table |
||
| 29 | * |
||
| 30 | * @var bool |
||
| 31 | */ |
||
| 32 | protected $outside = false; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * The field element tag (i.e. "input") |
||
| 36 | * |
||
| 37 | * @var string |
||
| 38 | */ |
||
| 39 | protected $element; |
||
| 40 | |||
| 41 | public function __construct( array $args = [] ) |
||
| 42 | { |
||
| 43 | $this->args = $args; |
||
| 44 | } |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @param string $property |
||
| 48 | * |
||
| 49 | * @return mixed |
||
| 50 | * @throws Exception |
||
| 51 | */ |
||
| 52 | public function __get( $property ) |
||
| 53 | { |
||
| 54 | switch( $property ) { |
||
| 55 | case 'args': |
||
| 56 | case 'dependencies': |
||
| 57 | case 'element': |
||
| 58 | case 'multi': |
||
| 59 | case 'outside': |
||
| 60 | return $this->$property; |
||
| 61 | } |
||
| 62 | throw new Exception( sprintf( 'Invalid %s property: %s', __CLASS__, $property )); |
||
| 63 | } |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Generate the field description |
||
| 67 | * |
||
| 68 | * @param bool $paragraph |
||
| 69 | * |
||
| 70 | * @return null|string |
||
| 71 | */ |
||
| 72 | public function generateDescription( $paragraph = true ) |
||
| 79 | } |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Generate the field label |
||
| 83 | * |
||
| 84 | * @return null|string |
||
| 85 | */ |
||
| 86 | public function generateLabel() |
||
| 87 | { |
||
| 88 | if( empty( $this->args['label'] ))return; |
||
| 89 | |||
| 90 | $for = !!$this->args['id'] |
||
| 91 | ? " for=\"{$this->args['id']}\"" |
||
| 92 | : ''; |
||
| 93 | |||
| 94 | return sprintf( '<label%s>%s</label>', $for, $this->args['label'] ); |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Render this field type |
||
| 99 | * |
||
| 100 | * @return string |
||
| 101 | */ |
||
| 102 | abstract public function render(); |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Convert a value to camel case. |
||
| 106 | * |
||
| 107 | * @param string $value |
||
| 108 | * |
||
| 109 | * @return string |
||
| 110 | */ |
||
| 111 | protected function camelCase( $value ) |
||
| 112 | { |
||
| 113 | $value = ucwords( str_replace( ['-', '_'], ' ', $value )); |
||
| 114 | |||
| 115 | return lcfirst( str_replace( ' ', '', $value )); |
||
| 116 | } |
||
| 117 | |||
| 118 | /** |
||
| 119 | * Implode the field attributes |
||
| 120 | * |
||
| 121 | * @return array |
||
| 122 | */ |
||
| 123 | protected function implodeAttributes( $defaults = [] ) |
||
| 124 | { |
||
| 125 | return $this->normalize( $defaults, 'implode' ); |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Implode multi-field items |
||
| 130 | * |
||
| 131 | * @return null|string |
||
| 132 | */ |
||
| 133 | protected function implodeOptions( $method = 'select_option', $default = null ) |
||
| 134 | { |
||
| 135 | $this->args['default'] ?: $this->args['default'] = $default; |
||
| 136 | |||
| 137 | $method = $this->camelCase( $method ); |
||
| 138 | |||
| 139 | $method = method_exists( $this, $method ) |
||
| 140 | ? $method |
||
| 141 | : 'selectOption'; |
||
| 142 | |||
| 143 | $i = 0; |
||
| 144 | |||
| 145 | if( $method === 'singleInput' ) { |
||
| 146 | |||
| 147 | if( !isset( $this->args['options'] ) || empty( $this->args['options'] ))return; |
||
| 148 | |||
| 149 | // hack to make sure unset single checkbox values start at 1 instead of 0 |
||
| 150 | if( key( $this->args['options'] ) === 0 ) { |
||
| 151 | $options = ['1' => $this->args['options'][0]]; |
||
| 152 | $this->args['options'] = $options; |
||
| 153 | } |
||
| 154 | |||
| 155 | return $this->singleInput(); |
||
| 156 | } |
||
| 157 | |||
| 158 | return array_reduce( array_keys( $this->args['options'] ), function( $carry, $key ) use ( &$i, $method ) { |
||
| 159 | return $carry .= $this->$method( $key, $i++ ); |
||
| 160 | }); |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Normalize attributes for this specific field type |
||
| 165 | * |
||
| 166 | * @param bool|string $implode |
||
| 167 | * |
||
| 168 | * @return array |
||
| 169 | */ |
||
| 170 | protected function normalize( array $defaults = [], $implode = false ) |
||
| 179 | } |
||
| 180 | |||
| 181 | /** |
||
| 182 | * Merge and overwrite empty $this->args values with $defaults |
||
| 183 | * |
||
| 184 | * @return array |
||
| 185 | */ |
||
| 186 | protected function mergeAttributesWith( array $defaults ) |
||
| 198 | } |
||
| 199 | |||
| 200 | /** |
||
| 201 | * Generate checkboxes and radios |
||
| 202 | * |
||
| 203 | * @param string $optionKey |
||
| 204 | * @param string $number |
||
| 205 | * @param string $type |
||
| 206 | * |
||
| 207 | * @return null|string |
||
| 208 | */ |
||
| 209 | protected function multiInput( $optionKey, $number, $type = 'radio' ) |
||
| 210 | { |
||
| 211 | $args = $this->multiInputArgs( $type, $optionKey, $number ); |
||
| 212 | |||
| 213 | if( !$args )return; |
||
| 214 | |||
| 215 | $attributes = ''; |
||
| 216 | |||
| 217 | foreach( $args['attributes'] as $key => $val ) { |
||
| 218 | $attributes .= sprintf( '%s="%s" ', $key, $val ); |
||
| 219 | } |
||
| 220 | |||
| 221 | return sprintf( '<li><label for="%s"><input %s%s/> %s</label></li>', |
||
| 222 | $args['attributes']['id'], |
||
| 223 | $attributes, |
||
| 224 | checked( $args['value'], $args['attributes']['value'], false ), |
||
| 225 | $args['label'] |
||
| 226 | ); |
||
| 227 | } |
||
| 228 | |||
| 229 | /** |
||
| 230 | * Build the checkbox/radio args |
||
| 231 | * |
||
| 232 | * @param string $type |
||
| 233 | * @param string $optionName |
||
| 234 | * @param string $number |
||
| 235 | * |
||
| 236 | * @return array|null |
||
| 237 | */ |
||
| 238 | protected function multiInputArgs( $type, $optionName, $number ) |
||
| 239 | { |
||
| 240 | $defaults = [ |
||
| 241 | 'class' => '', |
||
| 242 | 'name' => '', |
||
| 243 | 'type' => $type, |
||
| 244 | 'value' => '', |
||
| 245 | ]; |
||
| 246 | |||
| 247 | $args = []; |
||
| 248 | |||
| 249 | $value = $this->args['options'][ $optionName ]; |
||
| 250 | |||
| 251 | if( is_array( $value )) { |
||
| 252 | $args = $value; |
||
| 253 | } |
||
| 254 | |||
| 255 | if( is_string( $value )) { |
||
| 256 | $label = $value; |
||
| 257 | } |
||
| 258 | |||
| 259 | isset( $args['name'] ) ?: $args['name'] = $optionName; |
||
| 260 | isset( $args['value'] ) ?: $args['value'] = $optionName; |
||
| 261 | |||
| 262 | $args = wp_parse_args( $args, $defaults ); |
||
| 263 | |||
| 264 | if( !isset( $label ) || $args['name'] === '' )return; |
||
| 265 | |||
| 266 | $args['id'] = $this->args['id'] . "-{$number}"; |
||
| 267 | $args['name'] = $this->args['name'] . ( $type === 'checkbox' && $this->multi ? '[]' : '' ); |
||
| 268 | |||
| 269 | $args = array_filter( $args, function( $value ) { |
||
| 270 | return $value !== ''; |
||
| 271 | }); |
||
| 272 | |||
| 273 | if( is_array( $this->args['value'] )) { |
||
| 274 | if( in_array( $args['value'], $this->args['value'] )) { |
||
| 275 | $this->args['default'] = $args['value']; |
||
| 276 | } |
||
| 277 | } |
||
| 278 | else if( $this->args['value'] ) { |
||
| 279 | $this->args['default'] = $this->args['value']; |
||
| 280 | } |
||
| 281 | else if( $type == 'radio' && !$this->args['default'] ) { |
||
| 282 | $this->args['default'] = 0; |
||
| 283 | } |
||
| 284 | |||
| 285 | return [ |
||
| 286 | 'attributes' => $args, |
||
| 287 | 'label' => $label, |
||
|
1 ignored issue
–
show
|
|||
| 288 | 'value' => $this->args['default'], |
||
| 289 | ]; |
||
| 290 | } |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Generate checkboxes |
||
| 294 | * |
||
| 295 | * @param string $optionKey |
||
| 296 | * @param string $number |
||
| 297 | * |
||
| 298 | * @return null|string |
||
| 299 | */ |
||
| 300 | protected function multiInputCheckbox( $optionKey, $number ) |
||
| 301 | { |
||
| 302 | return $this->multiInput( $optionKey, $number, 'checkbox' ); |
||
| 303 | } |
||
| 304 | |||
| 305 | /** |
||
| 306 | * Generate select options |
||
| 307 | * |
||
| 308 | * @param string $optionKey |
||
| 309 | * |
||
| 310 | * @return string |
||
| 311 | */ |
||
| 312 | protected function selectOption( $optionKey ) |
||
| 313 | { |
||
| 314 | return sprintf( '<option value="%s"%s>%s</option>', |
||
| 315 | $optionKey, |
||
| 316 | selected( $this->args['value'], $optionKey, false ), |
||
| 317 | $this->args['options'][ $optionKey ] |
||
| 318 | ); |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Generate a single checkbox |
||
| 323 | * |
||
| 324 | * @param string $type |
||
| 325 | * |
||
| 326 | * @return null|string |
||
| 327 | */ |
||
| 328 | protected function singleInput( $type = 'checkbox' ) |
||
| 350 | ); |
||
| 351 | } |
||
| 352 | } |
||
| 353 |
Loading history...
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths