dynamic /
silverstripe-foxy
| Total Complexity | 47 |
| Total Lines | 395 |
| Duplicated Lines | 0 % |
| Changes | 4 | ||
| Bugs | 0 | Features | 0 |
Complex classes like AddToCartForm 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 AddToCartForm, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 30 | class AddToCartForm extends Form |
||
| 31 | { |
||
| 32 | /** |
||
| 33 | * @var |
||
| 34 | */ |
||
| 35 | protected $helper; |
||
| 36 | |||
| 37 | /** |
||
| 38 | * @var |
||
| 39 | */ |
||
| 40 | private $product; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * @param $helper |
||
| 44 | * |
||
| 45 | * @return $this |
||
| 46 | */ |
||
| 47 | public function setFoxyHelper($helper) |
||
| 48 | { |
||
| 49 | $helper = $helper === null ? FoxyHelper::create() : $helper; |
||
| 50 | if ($helper instanceof FoxyHelper) { |
||
| 51 | $this->helper = $helper; |
||
| 52 | |||
| 53 | return $this; |
||
| 54 | } |
||
| 55 | throw new \InvalidArgumentException('$helper needs to be an instance of FoxyHelper.'); |
||
| 56 | } |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @return FoxyHelper |
||
| 60 | */ |
||
| 61 | public function getFoxyHelper() |
||
| 62 | { |
||
| 63 | if (!$this->helper) { |
||
| 64 | $this->setFoxyHelper(FoxyHelper::create()); |
||
| 65 | } |
||
| 66 | |||
| 67 | return $this->helper; |
||
| 68 | } |
||
| 69 | |||
| 70 | /** |
||
| 71 | * @param $product |
||
| 72 | * |
||
| 73 | * @return $this |
||
| 74 | */ |
||
| 75 | public function setProduct($product) |
||
| 76 | { |
||
| 77 | if ($product instanceof VirtualPage) { |
||
| 78 | $product = $this->getFoxyHelper()->getProducts()->filter('ID', $product->CopyContentFromID)->first(); |
||
| 79 | } |
||
| 80 | |||
| 81 | if ($product->isProduct()) { |
||
| 82 | $this->product = $product; |
||
| 83 | |||
| 84 | return $this; |
||
| 85 | } |
||
| 86 | throw new \InvalidArgumentException('$product needs to implement a Foxy DataExtension.'); |
||
| 87 | } |
||
| 88 | |||
| 89 | /** |
||
| 90 | * @return Product |
||
| 91 | */ |
||
| 92 | public function getProduct() |
||
| 93 | { |
||
| 94 | return $this->product; |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * AddToCartForm constructor. |
||
| 99 | * @param $controller |
||
| 100 | * @param $name |
||
| 101 | * @param FieldList|null $fields |
||
| 102 | * @param FieldList|null $actions |
||
| 103 | * @param null $validator |
||
| 104 | * @param null $product |
||
| 105 | * @param null $helper |
||
| 106 | * @throws \SilverStripe\ORM\ValidationException |
||
| 107 | */ |
||
| 108 | public function __construct( |
||
| 109 | $controller, |
||
| 110 | $name, |
||
| 111 | FieldList $fields = null, |
||
| 112 | FieldList $actions = null, |
||
| 113 | $validator = null, |
||
| 114 | $product = null, |
||
| 115 | $helper = null |
||
| 116 | ) |
||
| 117 | { |
||
| 118 | $this->setProduct($product); |
||
| 119 | $this->setFoxyHelper($helper); |
||
| 120 | |||
| 121 | $fields = ($fields != null && $fields->exists()) ? |
||
| 122 | $this->getProductFields($fields) : |
||
| 123 | $this->getProductFields(FieldList::create()); |
||
| 124 | |||
| 125 | $actions = ($actions != null && $actions->exists()) ? |
||
| 126 | $this->getProductActions($actions) : |
||
| 127 | $this->getProductActions(FieldList::create()); |
||
| 128 | |||
| 129 | $validator = (!empty($validator) || $validator != null) ? $validator : RequiredFields::create(); |
||
| 130 | |||
| 131 | parent::__construct($controller, $name, $fields, $actions, $validator); |
||
| 132 | |||
| 133 | //have to call after parent::__construct() |
||
| 134 | $this->setAttribute('action', FoxyHelper::FormActionURL()); |
||
| 135 | $this->disableSecurityToken(); |
||
| 136 | $this->setHTMLID($this->getTemplateHelper()->generateFormID($this) . "_{$product->ID}"); |
||
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * @param FieldList $fields |
||
| 141 | * |
||
| 142 | * @return FieldList |
||
| 143 | */ |
||
| 144 | protected function getProductFields(FieldList $fields) |
||
| 145 | { |
||
| 146 | $hiddenTitle = ($this->product->ReceiptTitle) ? |
||
| 147 | htmlspecialchars($this->product->ReceiptTitle) : |
||
| 148 | htmlspecialchars($this->product->Title); |
||
| 149 | $code = $this->product->Code; |
||
| 150 | |||
| 151 | if ($this->product->isAvailable()) { |
||
| 152 | $fields->push( |
||
| 153 | HiddenField::create('name') |
||
| 154 | ->setValue( |
||
| 155 | self::getGeneratedValue($code, 'name', $hiddenTitle, 'value') |
||
| 156 | ) |
||
| 157 | ); |
||
| 158 | |||
| 159 | $fields->push( |
||
| 160 | HiddenField::create('category') |
||
| 161 | ->setValue( |
||
| 162 | self::getGeneratedValue($code, 'category', $this->product->FoxyCategory()->Code, 'value') |
||
| 163 | ) |
||
| 164 | ); |
||
| 165 | |||
| 166 | $fields->push( |
||
| 167 | HiddenField::create('code') |
||
| 168 | ->setValue( |
||
| 169 | self::getGeneratedValue($code, 'code', $this->product->Code, 'value') |
||
| 170 | ) |
||
| 171 | ); |
||
| 172 | |||
| 173 | $fields->push( |
||
| 174 | HiddenField::create('product_id') |
||
| 175 | ->setValue( |
||
| 176 | self::getGeneratedValue($code, 'product_id', $this->product->ID, 'value') |
||
| 177 | ) |
||
| 178 | ->setName('h:product_id') |
||
| 179 | ); |
||
| 180 | |||
| 181 | $fields->push( |
||
| 182 | HiddenField::create('price') |
||
| 183 | ->setValue( |
||
| 184 | self::getGeneratedValue($code, 'price', $this->product->Price, 'value') |
||
| 185 | ) |
||
| 186 | ); |
||
| 187 | |||
| 188 | if ($this->product->hasMethod('AbsoluteLink')) { |
||
| 189 | $fields->push( |
||
| 190 | HiddenField::create('url') |
||
| 191 | ->setValue( |
||
| 192 | self::getGeneratedValue($code, 'url', $this->product->AbsoluteLink(), 'value') |
||
| 193 | ) |
||
| 194 | ); |
||
| 195 | } |
||
| 196 | |||
| 197 | if ($this->product->hasExtension(Shippable::class)) { |
||
| 198 | if ($this->product->Weight > 0) { |
||
| 199 | $fields->push( |
||
| 200 | HiddenField::create('weight') |
||
| 201 | ->setValue( |
||
| 202 | self::getGeneratedValue($code, 'weight', $this->product->Weight, 'value') |
||
| 203 | ) |
||
| 204 | ); |
||
| 205 | } |
||
| 206 | } |
||
| 207 | |||
| 208 | $image = null; |
||
| 209 | if ($this->product->hasMethod('getImage')) { |
||
| 210 | if ($this->product->getImage()) { |
||
| 211 | $image = $this->product->getImage()->CMSThumbnail()->absoluteURL; |
||
| 212 | } |
||
| 213 | if ($image) { |
||
| 214 | $fields->push( |
||
| 215 | HiddenField::create('image') |
||
| 216 | ->setValue( |
||
| 217 | self::getGeneratedValue($code, 'image', $image, 'value') |
||
| 218 | ) |
||
| 219 | ); |
||
| 220 | } |
||
| 221 | } |
||
| 222 | |||
| 223 | if ($this->product->QuantityMax > 0) { |
||
| 224 | $fields->push( |
||
| 225 | HiddenField::create('quantity_max') |
||
| 226 | ->setValue(self::getGeneratedValue($code, 'quantity_max', $this->product->QuantityMax, 'value')) |
||
| 227 | ); |
||
| 228 | } |
||
| 229 | |||
| 230 | $fields->push($this->getProductVariations()); |
||
| 231 | |||
| 232 | |||
| 233 | if ($this->product->QuantityMax != 1) { |
||
| 234 | $fields->push(QuantityField::create('x:visibleQuantity')->setTitle('Quantity')->setValue(1)); |
||
| 235 | } |
||
| 236 | $fields->push( |
||
| 237 | HiddenField::create('quantity') |
||
| 238 | ->setValue( |
||
| 239 | self::getGeneratedValue($code, 'quantity', 1, 'value') |
||
| 240 | ) |
||
| 241 | ); |
||
| 242 | |||
| 243 | $fields->push( |
||
| 244 | HeaderField::create('submitPrice', '$' . $this->product->Price, 4) |
||
| 245 | ->addExtraClass('submit-price') |
||
| 246 | ); |
||
| 247 | } |
||
| 248 | |||
| 249 | $this->extend('updateProductFields', $fields); |
||
| 250 | |||
| 251 | return $fields; |
||
| 252 | } |
||
| 253 | |||
| 254 | /** |
||
| 255 | * @param FieldList $actions |
||
| 256 | * |
||
| 257 | * @return FieldList |
||
| 258 | */ |
||
| 259 | protected function getProductActions(FieldList $actions) |
||
| 260 | { |
||
| 261 | if (!empty(trim($this->helper->getStoreCartURL())) && $this->product->isAvailable()) { |
||
| 262 | $actions->push( |
||
| 263 | FormAction::create( |
||
| 264 | 'x:submit', |
||
| 265 | _t(__CLASS__ . '.AddToCart', 'Add to Cart') |
||
| 266 | ) |
||
| 267 | ->addExtraClass('fs-add-to-cart-button') |
||
| 268 | ->setName('x:submit') |
||
| 269 | ); |
||
| 270 | } |
||
| 271 | |||
| 272 | $this->extend('updateProductActions', $actions); |
||
| 273 | |||
| 274 | return $actions; |
||
| 275 | } |
||
| 276 | |||
| 277 | /** |
||
| 278 | * @param null $productCode |
||
| 279 | * @param null $optionName |
||
| 280 | * @param null $optionValue |
||
| 281 | * @param string $method |
||
| 282 | * @param bool $output |
||
| 283 | * @param bool $urlEncode |
||
| 284 | * |
||
| 285 | * @return null|string |
||
| 286 | */ |
||
| 287 | // todo - Purchasable Extension or AddToCartForm? protected in Form |
||
| 288 | public static function getGeneratedValue( |
||
| 289 | $productCode = null, |
||
| 290 | $optionName = null, |
||
| 291 | $optionValue = null, |
||
| 292 | $method = 'name', |
||
| 293 | $output = false, |
||
| 294 | $urlEncode = false |
||
| 295 | ) |
||
| 296 | { |
||
| 297 | $optionName = ($optionName !== null) ? preg_replace('/\s/', '_', $optionName) : $optionName; |
||
| 298 | $helper = FoxyHelper::create(); |
||
| 299 | |||
| 300 | return $helper::fc_hash_value($productCode, $optionName, $optionValue, $method, $output, $urlEncode); |
||
| 301 | } |
||
| 302 | |||
| 303 | /** |
||
| 304 | * @return CompositeField |
||
| 305 | * |
||
| 306 | * @deprecated |
||
| 307 | */ |
||
| 308 | protected function getProductOptionSet() |
||
| 309 | { |
||
| 310 | $options = $this->product->Options()->sort('SortOrder'); |
||
| 311 | $groupedOptions = new GroupedList($options); |
||
| 312 | $groupedBy = $groupedOptions->groupBy('Type'); |
||
| 313 | |||
| 314 | /** @var CompositeField $optionsSet */ |
||
| 315 | $optionsSet = CompositeField::create(); |
||
| 316 | |||
| 317 | /** @var DataList $set */ |
||
| 318 | foreach ($groupedBy as $id => $set) { |
||
| 319 | $group = OptionType::get()->byID($id); |
||
| 320 | $title = $group->Title; |
||
| 321 | $fieldName = preg_replace('/\s/', '_', $title); |
||
| 322 | $disabled = []; |
||
| 323 | $fullOptions = []; |
||
| 324 | |||
| 325 | foreach ($set as $item) { |
||
| 326 | $item = $this->setAvailability($item); |
||
| 327 | $name = self::getGeneratedValue( |
||
| 328 | $this->product->Code, |
||
| 329 | $group->Title, |
||
| 330 | $item->getGeneratedValue(), |
||
| 331 | 'value' |
||
| 332 | ); |
||
| 333 | |||
| 334 | $fullOptions[$name] = $item->getGeneratedTitle(); |
||
| 335 | if (!$item->Availability) { |
||
| 336 | array_push($disabled, $name); |
||
| 337 | } |
||
| 338 | } |
||
| 339 | |||
| 340 | $optionsSet->push( |
||
| 341 | $dropdown = DropdownField::create($fieldName, $title, $fullOptions)->setTitle($title) |
||
| 342 | ); |
||
| 343 | |||
| 344 | if (!empty($disabled)) { |
||
| 345 | $dropdown->setDisabledItems($disabled); |
||
| 346 | } |
||
| 347 | |||
| 348 | $dropdown->addExtraClass("product-options"); |
||
| 349 | } |
||
| 350 | |||
| 351 | $optionsSet->addExtraClass('foxycartOptionsContainer'); |
||
| 352 | |||
| 353 | return $optionsSet; |
||
| 354 | } |
||
| 355 | |||
| 356 | /** |
||
| 357 | * @return CompositeField |
||
| 358 | */ |
||
| 359 | protected function getProductVariations() |
||
| 374 | } |
||
| 375 | |||
| 376 | /** |
||
| 377 | * @param VariationType $type |
||
| 378 | * @param HasManyList $variations |
||
| 379 | * @return DropdownField |
||
| 380 | */ |
||
| 381 | protected function createVariationField(VariationType $type, HasManyList $variations) |
||
| 412 | } |
||
| 413 | |||
| 414 | /** |
||
| 415 | * @param ProductOption $option |
||
| 416 | * @return ProductOption |
||
| 417 | * |
||
| 418 | * @deprecated |
||
| 419 | */ |
||
| 420 | protected function setAvailability(ProductOption $option) |
||
| 425 | } |
||
| 426 | } |
||
| 427 |
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