htmlburger /
carbon-fields
Complex classes like Fulfillable_Collection 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 Fulfillable_Collection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 9 | class Fulfillable_Collection implements Fulfillable { |
||
| 10 | |||
| 11 | /** |
||
| 12 | * Condition factory used to translated condition types |
||
| 13 | * |
||
| 14 | * @var Factory |
||
| 15 | */ |
||
| 16 | protected $condition_factory; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * Array translator used to support array representations of fulfillables |
||
| 20 | * |
||
| 21 | * @var Array_Translator |
||
| 22 | */ |
||
| 23 | protected $array_translator; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * Array of fulfillables in this collection |
||
| 27 | * |
||
| 28 | * @var array<array> |
||
| 29 | */ |
||
| 30 | protected $fulfillables = array(); |
||
| 31 | |||
| 32 | /** |
||
| 33 | * Array of supported fulfillable comparisons |
||
| 34 | * |
||
| 35 | * @var array<string> |
||
| 36 | */ |
||
| 37 | protected $supported_fulfillable_comparisons = array( 'AND', 'OR' ); |
||
| 38 | |||
| 39 | /** |
||
| 40 | * Array of allowed condition types which propagate to child collections |
||
| 41 | * |
||
| 42 | * @var array<string> |
||
| 43 | */ |
||
| 44 | protected $condition_type_list = array(); |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Whether the condition type list is a whitelist or a blacklist |
||
| 48 | * |
||
| 49 | * @var bool |
||
| 50 | */ |
||
| 51 | protected $condition_type_list_whitelist = false; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * Constructor |
||
| 55 | * |
||
| 56 | * @param Factory $condition_factory |
||
| 57 | * @param Array_Translator $array_translator |
||
| 58 | */ |
||
| 59 | public function __construct( Factory $condition_factory, Array_Translator $array_translator ) { |
||
| 60 | $this->condition_factory = $condition_factory; |
||
| 61 | $this->array_translator = $array_translator; |
||
| 62 | } |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Get an array of the fulfillables in this collection |
||
| 66 | * |
||
| 67 | * @return array<Fulfillable> |
||
| 68 | */ |
||
| 69 | 1 | public function get_fulfillables() { |
|
| 70 | 1 | return $this->fulfillables; |
|
| 71 | } |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Get array of allowed condition types |
||
| 75 | * |
||
| 76 | * @return array<string> |
||
| 77 | */ |
||
| 78 | public function get_condition_type_list() { |
||
| 79 | return $this->condition_type_list; |
||
| 80 | } |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Set array of allowed condition types |
||
| 84 | * WARNING: this will NOT remove already added conditions which are no longer allowed |
||
| 85 | * |
||
| 86 | * @param array<string> $condition_type_list |
||
| 87 | * @param bool $whitelist |
||
| 88 | * @return Fulfillable_Collection $this |
||
| 89 | */ |
||
| 90 | public function set_condition_type_list( $condition_type_list, $whitelist ) { |
||
| 91 | $this->condition_type_list_whitelist = $whitelist; |
||
| 92 | $this->condition_type_list = $condition_type_list; |
||
| 93 | $this->propagate_condition_type_list(); |
||
| 94 | return $this; |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Check if conditions types list is a whitelist |
||
| 99 | * |
||
| 100 | * @return bool |
||
| 101 | */ |
||
| 102 | public function is_condition_type_list_whitelist() { |
||
| 103 | return $this->condition_type_list_whitelist; |
||
| 104 | } |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Check if condition type is allowed |
||
| 108 | * |
||
| 109 | * @param string $condition_type |
||
| 110 | * @return bool |
||
| 111 | */ |
||
| 112 | public function is_condition_type_allowed( $condition_type ) { |
||
| 113 | $in_list = in_array( $condition_type, $this->get_condition_type_list() ); |
||
| 114 | if ( $this->is_condition_type_list_whitelist() ) { |
||
| 115 | return $in_list; |
||
| 116 | } |
||
| 117 | return ! $in_list; |
||
| 118 | } |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Propagate allowed condition types to child collections |
||
| 122 | */ |
||
| 123 | protected function propagate_condition_type_list() { |
||
| 124 | $condition_type_list = $this->get_condition_type_list(); |
||
| 125 | $fulfillables = $this->get_fulfillables(); |
||
| 126 | foreach ( $fulfillables as $fulfillable ) { |
||
| 127 | if ( is_a( $fulfillable['fulfillable'], get_class() ) ) { |
||
| 128 | $fulfillable->set_condition_type_list( $condition_type_list, $this->is_condition_type_list_whitelist() ); |
||
| 129 | } |
||
| 130 | } |
||
| 131 | } |
||
| 132 | |||
| 133 | /** |
||
| 134 | * Shorthand for when with AND comparison |
||
| 135 | * |
||
| 136 | * @param string|array|callable $condition_type |
||
| 137 | * @param string $comparison_operator Can be skipped. Defaults to "=" |
||
| 138 | * @param mixed $value |
||
| 139 | * @return Fulfillable_Collection $this |
||
| 140 | */ |
||
| 141 | public function and_when( $condition_type, $comparison_operator = '=', $value = null ) { |
||
| 142 | $this->when( $condition_type, $comparison_operator, $value, 'AND' ); |
||
| 143 | return $this; |
||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Shorthand for when with OR comparison |
||
| 148 | * |
||
| 149 | * @param string|array|callable $condition_type |
||
| 150 | * @param string $comparison_operator Can be skipped. Defaults to "=" |
||
| 151 | * @param mixed $value |
||
| 152 | * @return Fulfillable_Collection $this |
||
| 153 | */ |
||
| 154 | public function or_when( $condition_type, $comparison_operator = '=', $value = null ) { |
||
| 155 | $this->when( $condition_type, $comparison_operator, $value, 'OR' ); |
||
| 156 | return $this; |
||
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * Add fulfillable with optional comparison_operator |
||
| 161 | * This method assumes there is no fulfillable that can be compared with literal NULL |
||
| 162 | * |
||
| 163 | * @param string|array|callable $condition_type |
||
| 164 | * @param string $comparison_operator Can be skipped. Defaults to "=" |
||
| 165 | * @param mixed $value |
||
| 166 | * @param string $fulfillable_comparison |
||
| 167 | * @return Fulfillable_Collection $this |
||
| 168 | */ |
||
| 169 | 9 | public function when( $condition_type, $comparison_operator = '=', $value = null, $fulfillable_comparison = 'AND' ) { |
|
| 170 | 9 | if ( is_array( $condition_type ) ) { |
|
| 171 | 2 | return $this->when_array( $condition_type, $fulfillable_comparison ); |
|
| 172 | } |
||
| 173 | |||
| 174 | 7 | if ( is_callable( $condition_type ) ) { |
|
| 175 | 2 | return $this->when_collection( $condition_type, $fulfillable_comparison ); |
|
| 176 | } |
||
| 177 | |||
| 178 | 7 | if ( ! $this->is_condition_type_allowed( $condition_type ) ) { |
|
| 179 | Incorrect_Syntax_Exception::raise( 'Unsupported container condition used: ' . $condition_type ); |
||
| 180 | return $this; |
||
| 181 | } |
||
| 182 | |||
| 183 | 7 | if ( $value === null ) { |
|
| 184 | // We do not have a supplied comparison_operator so we default to "=" |
||
| 185 | 5 | $value = $comparison_operator; |
|
| 186 | 5 | $comparison_operator = '='; |
|
| 187 | } |
||
| 188 | |||
| 189 | 7 | $condition = $this->condition_factory->make( $condition_type ); |
|
| 190 | 6 | $condition->set_comparison_operator( $comparison_operator ); |
|
| 191 | 6 | $condition->set_value( $value ); |
|
| 192 | 6 | $this->add_fulfillable( $condition, $fulfillable_comparison ); |
|
| 193 | 6 | return $this; |
|
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Add a Fulfillable through array representation |
||
| 198 | * |
||
| 199 | * @param array $fulfillable_as_array |
||
| 200 | * @param string $fulfillable_comparison |
||
| 201 | * @return Fulfillable_Collection $this |
||
| 202 | */ |
||
| 203 | protected function when_array( $fulfillable_as_array, $fulfillable_comparison) { |
||
| 208 | |||
| 209 | /** |
||
| 210 | * Add a Fulfillable_Collection for nested logic |
||
| 211 | * |
||
| 212 | * @param callable $collection_callable |
||
| 213 | * @param string $fulfillable_comparison |
||
| 214 | * @return Fulfillable_Collection $this |
||
| 215 | */ |
||
| 216 | protected function when_collection( $collection_callable, $fulfillable_comparison) { |
||
| 223 | |||
| 224 | /** |
||
| 225 | * Add fulfillable to collection |
||
| 226 | * |
||
| 227 | * @param Fulfillable $fulfillable |
||
| 228 | * @param string $fulfillable_comparison See static::$supported_fulfillable_comparisons |
||
| 229 | */ |
||
| 230 | 2 | public function add_fulfillable( Fulfillable $fulfillable, $fulfillable_comparison ) { |
|
| 231 | 2 | if ( ! in_array( $fulfillable_comparison, $this->supported_fulfillable_comparisons ) ) { |
|
| 241 | |||
| 242 | /** |
||
| 243 | * Remove fulfillable from collection |
||
| 244 | * |
||
| 245 | * @param Fulfillable $fulfillable |
||
| 246 | * @return bool Fulfillable found and removed |
||
| 247 | */ |
||
| 248 | public function remove_fulfillable( Fulfillable $fulfillable ) { |
||
| 260 | |||
| 261 | /** |
||
| 262 | * Get a copy of the collection with conditions not in the whitelist filtered out |
||
| 263 | * |
||
| 264 | * @param array<string> $condition_whitelist |
||
| 265 | * @return Fulfillable_Collection |
||
| 266 | */ |
||
| 267 | 2 | public function filter( $condition_whitelist ) { |
|
| 294 | |||
| 295 | /** |
||
| 296 | * Get a copy of the collection with passed conditions evaluated into boolean conditions |
||
| 297 | * Useful when evaluating only certain condition types but preserving the rest |
||
| 298 | * or when passing dynamic conditions to the front-end |
||
| 299 | * |
||
| 300 | * @param array<string> $condition_types |
||
| 301 | * @param array|boolean $environment Environment array or a boolean value to force on conditions |
||
| 302 | * @param array $comparison_operators Array of comparison operators to evaluate regardless of condition type |
||
| 303 | * @return Fulfillable_Collection |
||
| 304 | */ |
||
| 305 | 3 | public function evaluate( $condition_types, $environment, $comparison_operators = array() ) { |
|
| 333 | |||
| 334 | /** |
||
| 335 | * Check if all fulfillables are fulfilled taking into account their fulfillable comparison |
||
| 336 | * |
||
| 337 | * @param array $environment |
||
| 338 | * @return bool |
||
| 339 | */ |
||
| 340 | 14 | public function is_fulfilled( $environment ) { |
|
| 369 | } |
