silverstripe /
silverstripe-userforms
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:
Complex classes like EditableFormField 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 EditableFormField, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 20 | class EditableFormField extends DataObject { |
||
|
|
|||
| 21 | |||
| 22 | /** |
||
| 23 | * Set to true to hide from class selector |
||
| 24 | * |
||
| 25 | * @config |
||
| 26 | * @var bool |
||
| 27 | */ |
||
| 28 | private static $hidden = false; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * Define this field as abstract (not inherited) |
||
| 32 | * |
||
| 33 | * @config |
||
| 34 | * @var bool |
||
| 35 | */ |
||
| 36 | private static $abstract = true; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Flag this field type as non-data (e.g. literal, header, html) |
||
| 40 | * |
||
| 41 | * @config |
||
| 42 | * @var bool |
||
| 43 | */ |
||
| 44 | private static $literal = false; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Default sort order |
||
| 48 | * |
||
| 49 | * @config |
||
| 50 | * @var string |
||
| 51 | */ |
||
| 52 | private static $default_sort = '"Sort"'; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * A list of CSS classes that can be added |
||
| 56 | * |
||
| 57 | * @var array |
||
| 58 | */ |
||
| 59 | public static $allowed_css = array(); |
||
| 60 | |||
| 61 | /** |
||
| 62 | * @config |
||
| 63 | * @var array |
||
| 64 | */ |
||
| 65 | private static $summary_fields = array( |
||
| 66 | 'Title' |
||
| 67 | ); |
||
| 68 | |||
| 69 | /** |
||
| 70 | * @config |
||
| 71 | * @var array |
||
| 72 | */ |
||
| 73 | private static $db = array( |
||
| 74 | "Name" => "Varchar", |
||
| 75 | "Title" => "Varchar(255)", |
||
| 76 | "Default" => "Varchar(255)", |
||
| 77 | "Sort" => "Int", |
||
| 78 | "Required" => "Boolean", |
||
| 79 | "CustomErrorMessage" => "Varchar(255)", |
||
| 80 | |||
| 81 | "CustomRules" => "Text", // @deprecated from 2.0 |
||
| 82 | "CustomSettings" => "Text", // @deprecated from 2.0 |
||
| 83 | "Migrated" => "Boolean", // set to true when migrated |
||
| 84 | |||
| 85 | "ExtraClass" => "Text", // from CustomSettings |
||
| 86 | "RightTitle" => "Varchar(255)", // from CustomSettings |
||
| 87 | "ShowOnLoad" => "Boolean(1)", // from CustomSettings |
||
| 88 | ); |
||
| 89 | |||
| 90 | private static $defaults = array( |
||
| 91 | 'ShowOnLoad' => true, |
||
| 92 | ); |
||
| 93 | |||
| 94 | |||
| 95 | /** |
||
| 96 | * @config |
||
| 97 | * @var array |
||
| 98 | */ |
||
| 99 | private static $has_one = array( |
||
| 100 | "Parent" => "UserDefinedForm", |
||
| 101 | ); |
||
| 102 | |||
| 103 | /** |
||
| 104 | * Built in extensions required |
||
| 105 | * |
||
| 106 | * @config |
||
| 107 | * @var array |
||
| 108 | */ |
||
| 109 | private static $extensions = array( |
||
| 110 | "Versioned('Stage', 'Live')" |
||
| 111 | ); |
||
| 112 | |||
| 113 | /** |
||
| 114 | * @config |
||
| 115 | * @var array |
||
| 116 | */ |
||
| 117 | private static $has_many = array( |
||
| 118 | "DisplayRules" => "EditableCustomRule.Parent" // from CustomRules |
||
| 119 | ); |
||
| 120 | |||
| 121 | /** |
||
| 122 | * @var bool |
||
| 123 | */ |
||
| 124 | protected $readonly; |
||
| 125 | |||
| 126 | /** |
||
| 127 | * Set the visibility of an individual form field |
||
| 128 | * |
||
| 129 | * @param bool |
||
| 130 | */ |
||
| 131 | public function setReadonly($readonly = true) { |
||
| 132 | $this->readonly = $readonly; |
||
| 133 | } |
||
| 134 | |||
| 135 | /** |
||
| 136 | * Returns whether this field is readonly |
||
| 137 | * |
||
| 138 | * @return bool |
||
| 139 | */ |
||
| 140 | private function isReadonly() { |
||
| 141 | return $this->readonly; |
||
| 142 | } |
||
| 143 | |||
| 144 | /** |
||
| 145 | * @return FieldList |
||
| 146 | */ |
||
| 147 | public function getCMSFields() { |
||
| 148 | $fields = new FieldList(new TabSet('Root')); |
||
| 149 | |||
| 150 | // Main tab |
||
| 151 | $fields->addFieldsToTab( |
||
| 152 | 'Root.Main', |
||
| 153 | array( |
||
| 154 | ReadonlyField::create( |
||
| 155 | 'Type', |
||
| 156 | _t('EditableFormField.TYPE', 'Type'), |
||
| 157 | $this->i18n_singular_name() |
||
| 158 | ), |
||
| 159 | LiteralField::create( |
||
| 160 | 'MergeField', |
||
| 161 | _t( |
||
| 162 | 'EditableFormField.MERGEFIELDNAME', |
||
| 163 | '<div class="field readonly">' . |
||
| 164 | '<label class="left">Merge field</label>' . |
||
| 165 | '<div class="middleColumn">' . |
||
| 166 | '<span class="readonly">$' . $this->Name . '</span>' . |
||
| 167 | '</div>' . |
||
| 168 | '</div>' |
||
| 169 | ) |
||
| 170 | ), |
||
| 171 | TextField::create('Title'), |
||
| 172 | TextField::create('Default', _t('EditableFormField.DEFAULT', 'Default value')), |
||
| 173 | TextField::create('RightTitle', _t('EditableFormField.RIGHTTITLE', 'Right title')), |
||
| 174 | SegmentField::create('Name')->setModifiers(array( |
||
| 175 | UnderscoreSegmentFieldModifier::create()->setDefault('FieldName'), |
||
| 176 | DisambiguationSegmentFieldModifier::create(), |
||
| 177 | ))->setPreview($this->Name) |
||
| 178 | ) |
||
| 179 | ); |
||
| 180 | |||
| 181 | // Custom settings |
||
| 182 | if (!empty(self::$allowed_css)) { |
||
| 183 | $cssList = array(); |
||
| 184 | foreach(self::$allowed_css as $k => $v) { |
||
| 185 | if (!is_array($v)) { |
||
| 186 | $cssList[$k]=$v; |
||
| 187 | } elseif ($k === $this->ClassName) { |
||
| 188 | $cssList = array_merge($cssList, $v); |
||
| 189 | } |
||
| 190 | } |
||
| 191 | |||
| 192 | $fields->addFieldToTab('Root.Main', |
||
| 193 | DropdownField::create( |
||
| 194 | 'ExtraClass', |
||
| 195 | _t('EditableFormField.EXTRACLASS_TITLE', 'Extra Styling/Layout'), |
||
| 196 | $cssList |
||
| 197 | )->setDescription(_t( |
||
| 198 | 'EditableFormField.EXTRACLASS_SELECT', |
||
| 199 | 'Select from the list of allowed styles' |
||
| 200 | )) |
||
| 201 | ); |
||
| 202 | } else { |
||
| 203 | $fields->addFieldToTab('Root.Main', |
||
| 204 | TextField::create( |
||
| 205 | 'ExtraClass', |
||
| 206 | _t('EditableFormField.EXTRACLASS_Title', 'Extra CSS classes') |
||
| 207 | )->setDescription(_t( |
||
| 208 | 'EditableFormField.EXTRACLASS_MULTIPLE', |
||
| 209 | 'Separate each CSS class with a single space' |
||
| 210 | )) |
||
| 211 | ); |
||
| 212 | } |
||
| 213 | |||
| 214 | // Validation |
||
| 215 | $validationFields = $this->getFieldValidationOptions(); |
||
| 216 | if($validationFields && $validationFields->count()) { |
||
| 217 | $fields->addFieldsToTab('Root.Validation', $validationFields); |
||
| 218 | } |
||
| 219 | |||
| 220 | // Add display rule fields |
||
| 221 | $displayFields = $this->getDisplayRuleFields(); |
||
| 222 | if($displayFields && $displayFields->count()) { |
||
| 223 | $fields->addFieldsToTab('Root.DisplayRules', $displayFields); |
||
| 224 | } |
||
| 225 | |||
| 226 | $this->extend('updateCMSFields', $fields); |
||
| 227 | |||
| 228 | return $fields; |
||
| 229 | } |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Return fields to display on the 'Display Rules' tab |
||
| 233 | * |
||
| 234 | * @return FieldList |
||
| 235 | */ |
||
| 236 | protected function getDisplayRuleFields() { |
||
| 303 | |||
| 304 | public function onBeforeWrite() { |
||
| 305 | parent::onBeforeWrite(); |
||
| 306 | |||
| 307 | // Set a field name. |
||
| 308 | if(!$this->Name) { |
||
| 309 | // New random name |
||
| 310 | $this->Name = $this->generateName(); |
||
| 311 | |||
| 312 | } elseif($this->Name === 'Field') { |
||
| 313 | throw new ValidationException('Field name cannot be "Field"'); |
||
| 314 | } |
||
| 315 | |||
| 316 | if(!$this->Sort && $this->ParentID) { |
||
| 317 | $parentID = $this->ParentID; |
||
| 318 | $this->Sort = EditableFormField::get() |
||
| 319 | ->filter('ParentID', $parentID) |
||
| 320 | ->max('Sort') + 1; |
||
| 321 | } |
||
| 322 | } |
||
| 323 | |||
| 324 | /** |
||
| 325 | * Generate a new non-conflicting Name value |
||
| 326 | * |
||
| 327 | * @return string |
||
| 328 | */ |
||
| 329 | protected function generateName() { |
||
| 330 | do { |
||
| 331 | // Generate a new random name after this class |
||
| 332 | $class = get_class($this); |
||
| 333 | $entropy = substr(sha1(uniqid()), 0, 5); |
||
| 334 | $name = "{$class}_{$entropy}"; |
||
| 335 | |||
| 336 | // Check if it conflicts |
||
| 337 | $exists = EditableFormField::get()->filter('Name', $name)->count() > 0; |
||
| 338 | } while($exists); |
||
| 339 | return $name; |
||
| 340 | } |
||
| 341 | |||
| 342 | /** |
||
| 343 | * Flag indicating that this field will set its own error message via data-msg='' attributes |
||
| 344 | * |
||
| 345 | * @return bool |
||
| 346 | */ |
||
| 347 | public function getSetsOwnError() { |
||
| 348 | return false; |
||
| 349 | } |
||
| 350 | |||
| 351 | /** |
||
| 352 | * Return whether a user can delete this form field |
||
| 353 | * based on whether they can edit the page |
||
| 354 | * |
||
| 355 | * @param Member $member |
||
| 356 | * @return bool |
||
| 357 | */ |
||
| 358 | public function canDelete($member = null) { |
||
| 361 | |||
| 362 | /** |
||
| 363 | * Return whether a user can edit this form field |
||
| 364 | * based on whether they can edit the page |
||
| 365 | * |
||
| 366 | * @param Member $member |
||
| 367 | * @return bool |
||
| 368 | */ |
||
| 369 | public function canEdit($member = null) { |
||
| 370 | $parent = $this->Parent(); |
||
| 371 | if($parent && $parent->exists()) { |
||
| 372 | return $parent->canEdit($member) && !$this->isReadonly(); |
||
| 373 | } else if (!$this->exists() && Controller::has_curr()) { |
||
| 374 | // This is for GridFieldOrderableRows support as it checks edit permissions on |
||
| 375 | // singleton of the class. Allows editing of User Defined Form pages by |
||
| 376 | // 'Content Authors' and those with permission to edit the UDF page. (ie. CanEditType/EditorGroups) |
||
| 377 | // This is to restore User Forms 2.x backwards compatibility. |
||
| 378 | $controller = Controller::curr(); |
||
| 379 | if ($controller && $controller instanceof CMSPageEditController) |
||
| 380 | { |
||
| 381 | $parent = $controller->getRecord($controller->currentPageID()); |
||
| 382 | // Only allow this behaviour on pages using UserFormFieldEditorExtension, such |
||
| 383 | // as UserDefinedForm page type. |
||
| 384 | if ($parent && $parent->hasExtension('UserFormFieldEditorExtension')) |
||
| 385 | { |
||
| 386 | return $parent->canEdit($member); |
||
| 387 | } |
||
| 388 | } |
||
| 389 | } |
||
| 390 | |||
| 391 | // Fallback to secure admin permissions |
||
| 392 | return parent::canEdit($member); |
||
| 393 | } |
||
| 394 | |||
| 395 | /** |
||
| 396 | * Return whether a user can view this form field |
||
| 397 | * based on whether they can view the page, regardless of the ReadOnly status of the field |
||
| 398 | * |
||
| 399 | * @param Member $member |
||
| 400 | * @return bool |
||
| 401 | */ |
||
| 402 | public function canView($member = null) { |
||
| 410 | |||
| 411 | /** |
||
| 412 | * Return whether a user can create an object of this type |
||
| 413 | * |
||
| 414 | * @param Member $member |
||
| 415 | * @param array $context Virtual parameter to allow context to be passed in to check |
||
| 416 | * @return bool |
||
| 417 | */ |
||
| 418 | View Code Duplication | public function canCreate($member = null) { |
|
| 428 | |||
| 429 | /** |
||
| 430 | * Helper method to check the parent for this object |
||
| 431 | * |
||
| 432 | * @param array $args List of arguments passed to canCreate |
||
| 433 | * @return SiteTree Parent page instance |
||
| 434 | */ |
||
| 435 | View Code Duplication | protected function getCanCreateContext($args) { |
|
| 448 | |||
| 449 | /** |
||
| 450 | * Check if can publish |
||
| 451 | * |
||
| 452 | * @param Member $member |
||
| 453 | * @return bool |
||
| 454 | */ |
||
| 455 | public function canPublish($member = null) { |
||
| 458 | |||
| 459 | /** |
||
| 460 | * Check if can unpublish |
||
| 461 | * |
||
| 462 | * @param Member $member |
||
| 463 | * @return bool |
||
| 464 | */ |
||
| 465 | public function canUnpublish($member = null) { |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Publish this Form Field to the live site |
||
| 471 | * |
||
| 472 | * Wrapper for the {@link Versioned} publish function |
||
| 473 | */ |
||
| 474 | public function doPublish($fromStage, $toStage, $createNewVersion = false) { |
||
| 475 | $this->publish($fromStage, $toStage, $createNewVersion); |
||
| 476 | |||
| 477 | // Don't forget to publish the related custom rules... |
||
| 478 | foreach ($this->DisplayRules() as $rule) { |
||
| 479 | $rule->doPublish($fromStage, $toStage, $createNewVersion); |
||
| 480 | } |
||
| 481 | } |
||
| 482 | |||
| 483 | /** |
||
| 484 | * Delete this field from a given stage |
||
| 485 | * |
||
| 486 | * Wrapper for the {@link Versioned} deleteFromStage function |
||
| 487 | */ |
||
| 488 | public function doDeleteFromStage($stage) { |
||
| 499 | |||
| 500 | /** |
||
| 501 | * checks wether record is new, copied from Sitetree |
||
| 502 | */ |
||
| 503 | function isNew() { |
||
| 504 | if(empty($this->ID)) return true; |
||
| 505 | |||
| 506 | if(is_numeric($this->ID)) return false; |
||
| 507 | |||
| 508 | return stripos($this->ID, 'new') === 0; |
||
| 509 | } |
||
| 510 | |||
| 511 | /** |
||
| 512 | * checks if records is changed on stage |
||
| 513 | * @return boolean |
||
| 514 | */ |
||
| 515 | public function getIsModifiedOnStage() { |
||
| 516 | // new unsaved fields could be never be published |
||
| 517 | if($this->isNew()) return false; |
||
| 518 | |||
| 519 | $stageVersion = Versioned::get_versionnumber_by_stage('EditableFormField', 'Stage', $this->ID); |
||
| 520 | $liveVersion = Versioned::get_versionnumber_by_stage('EditableFormField', 'Live', $this->ID); |
||
| 521 | |||
| 522 | return ($stageVersion && $stageVersion != $liveVersion); |
||
| 523 | } |
||
| 524 | |||
| 525 | /** |
||
| 526 | * @deprecated since version 4.0 |
||
| 527 | */ |
||
| 528 | public function getSettings() { |
||
| 529 | Deprecation::notice('4.0', 'getSettings is deprecated'); |
||
| 530 | return (!empty($this->CustomSettings)) ? unserialize($this->CustomSettings) : array(); |
||
| 531 | } |
||
| 532 | |||
| 533 | /** |
||
| 534 | * @deprecated since version 4.0 |
||
| 535 | */ |
||
| 536 | public function setSettings($settings = array()) { |
||
| 537 | Deprecation::notice('4.0', 'setSettings is deprecated'); |
||
| 538 | $this->CustomSettings = serialize($settings); |
||
| 539 | } |
||
| 540 | |||
| 541 | /** |
||
| 542 | * @deprecated since version 4.0 |
||
| 543 | */ |
||
| 544 | public function setSetting($key, $value) { |
||
| 545 | Deprecation::notice('4.0', "setSetting({$key}) is deprecated"); |
||
| 546 | $settings = $this->getSettings(); |
||
| 547 | $settings[$key] = $value; |
||
| 548 | |||
| 549 | $this->setSettings($settings); |
||
| 550 | } |
||
| 551 | |||
| 552 | /** |
||
| 553 | * Set the allowed css classes for the extraClass custom setting |
||
| 554 | * |
||
| 555 | * @param array The permissible CSS classes to add |
||
| 556 | */ |
||
| 557 | public function setAllowedCss(array $allowed) { |
||
| 558 | if (is_array($allowed)) { |
||
| 559 | foreach ($allowed as $k => $v) { |
||
| 560 | self::$allowed_css[$k] = (!is_null($v)) ? $v : $k; |
||
| 561 | } |
||
| 562 | } |
||
| 563 | } |
||
| 564 | |||
| 565 | /** |
||
| 566 | * @deprecated since version 4.0 |
||
| 567 | */ |
||
| 568 | public function getSetting($setting) { |
||
| 569 | Deprecation::notice("4.0", "getSetting({$setting}) is deprecated"); |
||
| 570 | |||
| 571 | $settings = $this->getSettings(); |
||
| 572 | if(isset($settings) && count($settings) > 0) { |
||
| 573 | if(isset($settings[$setting])) { |
||
| 574 | return $settings[$setting]; |
||
| 575 | } |
||
| 576 | } |
||
| 577 | return ''; |
||
| 578 | } |
||
| 579 | |||
| 580 | /** |
||
| 581 | * Get the path to the icon for this field type, relative to the site root. |
||
| 582 | * |
||
| 583 | * @return string |
||
| 584 | */ |
||
| 585 | public function getIcon() { |
||
| 586 | return USERFORMS_DIR . '/images/' . strtolower($this->class) . '.png'; |
||
| 587 | } |
||
| 588 | |||
| 589 | /** |
||
| 590 | * Return whether or not this field has addable options |
||
| 591 | * such as a dropdown field or radio set |
||
| 592 | * |
||
| 593 | * @return bool |
||
| 594 | */ |
||
| 595 | public function getHasAddableOptions() { |
||
| 596 | return false; |
||
| 597 | } |
||
| 598 | |||
| 599 | /** |
||
| 600 | * Return whether or not this field needs to show the extra |
||
| 601 | * options dropdown list |
||
| 602 | * |
||
| 603 | * @return bool |
||
| 604 | */ |
||
| 605 | public function showExtraOptions() { |
||
| 606 | return true; |
||
| 607 | } |
||
| 608 | |||
| 609 | /** |
||
| 610 | * Returns the Title for rendering in the front-end (with XML values escaped) |
||
| 611 | * |
||
| 612 | * @return string |
||
| 613 | */ |
||
| 614 | public function getEscapedTitle() { |
||
| 615 | return Convert::raw2xml($this->Title); |
||
| 616 | } |
||
| 617 | |||
| 618 | /** |
||
| 619 | * Find the numeric indicator (1.1.2) that represents it's nesting value |
||
| 620 | * |
||
| 621 | * Only useful for fields attached to a current page, and that contain other fields such as pages |
||
| 622 | * or groups |
||
| 623 | * |
||
| 624 | * @return string |
||
| 625 | */ |
||
| 626 | public function getFieldNumber() { |
||
| 627 | // Check if exists |
||
| 628 | if(!$this->exists()) { |
||
| 629 | return null; |
||
| 630 | } |
||
| 631 | // Check parent |
||
| 632 | $form = $this->Parent(); |
||
| 633 | if(!$form || !$form->exists() || !($fields = $form->Fields())) { |
||
| 634 | return null; |
||
| 635 | } |
||
| 636 | |||
| 637 | $prior = 0; // Number of prior group at this level |
||
| 638 | $stack = array(); // Current stack of nested groups, where the top level = the page |
||
| 639 | foreach($fields->map('ID', 'ClassName') as $id => $className) { |
||
| 640 | if($className === 'EditableFormStep') { |
||
| 641 | $priorPage = empty($stack) ? $prior : $stack[0]; |
||
| 642 | $stack = array($priorPage + 1); |
||
| 643 | $prior = 0; |
||
| 644 | } elseif($className === 'EditableFieldGroup') { |
||
| 645 | $stack[] = $prior + 1; |
||
| 646 | $prior = 0; |
||
| 647 | } elseif($className === 'EditableFieldGroupEnd') { |
||
| 648 | $prior = array_pop($stack); |
||
| 649 | } |
||
| 650 | if($id == $this->ID) { |
||
| 651 | return implode('.', $stack); |
||
| 652 | } |
||
| 653 | } |
||
| 654 | return null; |
||
| 655 | } |
||
| 656 | |||
| 657 | public function getCMSTitle() { |
||
| 658 | return $this->i18n_singular_name() . ' (' . $this->Title . ')'; |
||
| 659 | } |
||
| 660 | |||
| 661 | /** |
||
| 662 | * @deprecated since version 4.0 |
||
| 663 | */ |
||
| 664 | public function getFieldName($field = false) { |
||
| 665 | Deprecation::notice('4.0', "getFieldName({$field}) is deprecated"); |
||
| 666 | return ($field) ? "Fields[".$this->ID."][".$field."]" : "Fields[".$this->ID."]"; |
||
| 667 | } |
||
| 668 | |||
| 669 | /** |
||
| 670 | * @deprecated since version 4.0 |
||
| 671 | */ |
||
| 672 | public function getSettingName($field) { |
||
| 673 | Deprecation::notice('4.0', "getSettingName({$field}) is deprecated"); |
||
| 674 | $name = $this->getFieldName('CustomSettings'); |
||
| 675 | |||
| 676 | return $name . '[' . $field .']'; |
||
| 677 | } |
||
| 678 | |||
| 679 | /** |
||
| 680 | * Append custom validation fields to the default 'Validation' |
||
| 681 | * section in the editable options view |
||
| 682 | * |
||
| 683 | * @return FieldList |
||
| 684 | */ |
||
| 685 | public function getFieldValidationOptions() { |
||
| 696 | |||
| 697 | /** |
||
| 698 | * Return a FormField to appear on the front end. Implement on |
||
| 699 | * your subclass. |
||
| 700 | * |
||
| 701 | * @return FormField |
||
| 702 | */ |
||
| 703 | public function getFormField() { |
||
| 704 | user_error("Please implement a getFormField() on your EditableFormClass ". $this->ClassName, E_USER_ERROR); |
||
| 705 | } |
||
| 706 | |||
| 707 | /** |
||
| 708 | * Updates a formfield with extensions |
||
| 709 | * |
||
| 710 | * @param FormField $field |
||
| 711 | */ |
||
| 712 | public function doUpdateFormField($field) { |
||
| 713 | $this->extend('beforeUpdateFormField', $field); |
||
| 714 | $this->updateFormField($field); |
||
| 715 | $this->extend('afterUpdateFormField', $field); |
||
| 716 | } |
||
| 717 | |||
| 718 | /** |
||
| 719 | * Updates a formfield with the additional metadata specified by this field |
||
| 720 | * |
||
| 721 | * @param FormField $field |
||
| 722 | */ |
||
| 723 | protected function updateFormField($field) { |
||
| 724 | // set the error / formatting messages |
||
| 725 | $field->setCustomValidationMessage($this->getErrorMessage()->RAW()); |
||
| 726 | |||
| 727 | // set the right title on this field |
||
| 728 | if($this->RightTitle) { |
||
| 729 | // Since this field expects raw html, safely escape the user data prior |
||
| 730 | $field->setRightTitle(Convert::raw2xml($this->RightTitle)); |
||
| 731 | } |
||
| 732 | |||
| 733 | // if this field is required add some |
||
| 734 | if($this->Required) { |
||
| 735 | // Required validation can conflict so add the Required validation messages as input attributes |
||
| 736 | $errorMessage = $this->getErrorMessage()->HTML(); |
||
| 737 | $field->addExtraClass('requiredField'); |
||
| 738 | $field->setAttribute('data-rule-required', 'true'); |
||
| 739 | $field->setAttribute('data-msg-required', $errorMessage); |
||
| 740 | |||
| 741 | if($identifier = UserDefinedForm::config()->required_identifier) { |
||
| 742 | $title = $field->Title() . " <span class='required-identifier'>". $identifier . "</span>"; |
||
| 743 | $field->setTitle($title); |
||
| 744 | } |
||
| 745 | } |
||
| 746 | |||
| 747 | // if this field has an extra class |
||
| 748 | if($this->ExtraClass) { |
||
| 749 | $field->addExtraClass($this->ExtraClass); |
||
| 750 | } |
||
| 751 | } |
||
| 752 | |||
| 753 | /** |
||
| 754 | * Return the instance of the submission field class |
||
| 755 | * |
||
| 756 | * @return SubmittedFormField |
||
| 757 | */ |
||
| 758 | public function getSubmittedFormField() { |
||
| 759 | return new SubmittedFormField(); |
||
| 760 | } |
||
| 761 | |||
| 762 | |||
| 763 | /** |
||
| 764 | * Show this form field (and its related value) in the reports and in emails. |
||
| 765 | * |
||
| 766 | * @return bool |
||
| 767 | */ |
||
| 768 | public function showInReports() { |
||
| 769 | return true; |
||
| 770 | } |
||
| 771 | |||
| 772 | /** |
||
| 773 | * Return the error message for this field. Either uses the custom |
||
| 774 | * one (if provided) or the default SilverStripe message |
||
| 775 | * |
||
| 776 | * @return Varchar |
||
| 777 | */ |
||
| 778 | public function getErrorMessage() { |
||
| 779 | $title = strip_tags("'". ($this->Title ? $this->Title : $this->Name) . "'"); |
||
| 780 | $standard = sprintf(_t('Form.FIELDISREQUIRED', '%s is required').'.', $title); |
||
| 781 | |||
| 782 | // only use CustomErrorMessage if it has a non empty value |
||
| 783 | $errorMessage = (!empty($this->CustomErrorMessage)) ? $this->CustomErrorMessage : $standard; |
||
| 784 | |||
| 785 | return DBField::create_field('Varchar', $errorMessage); |
||
| 786 | } |
||
| 787 | |||
| 788 | /** |
||
| 789 | * Invoked by UserFormUpgradeService to migrate settings specific to this field from CustomSettings |
||
| 790 | * to the field proper |
||
| 791 | * |
||
| 792 | * @param array $data Unserialised data |
||
| 793 | */ |
||
| 794 | public function migrateSettings($data) { |
||
| 795 | // Map 'Show' / 'Hide' to boolean |
||
| 796 | if(isset($data['ShowOnLoad'])) { |
||
| 797 | $this->ShowOnLoad = $data['ShowOnLoad'] === '' || ($data['ShowOnLoad'] && $data['ShowOnLoad'] !== 'Hide'); |
||
| 798 | unset($data['ShowOnLoad']); |
||
| 799 | } |
||
| 800 | |||
| 801 | // Migrate all other settings |
||
| 802 | foreach($data as $key => $value) { |
||
| 803 | if($this->hasField($key)) { |
||
| 804 | $this->setField($key, $value); |
||
| 805 | } |
||
| 806 | } |
||
| 807 | } |
||
| 808 | |||
| 809 | /** |
||
| 810 | * Get the formfield to use when editing this inline in gridfield |
||
| 811 | * |
||
| 812 | * @param string $column name of column |
||
| 813 | * @param array $fieldClasses List of allowed classnames if this formfield has a selectable class |
||
| 814 | * @return FormField |
||
| 815 | */ |
||
| 816 | public function getInlineClassnameField($column, $fieldClasses) { |
||
| 817 | return DropdownField::create($column, false, $fieldClasses); |
||
| 818 | } |
||
| 819 | |||
| 820 | /** |
||
| 821 | * Get the formfield to use when editing the title inline |
||
| 822 | * |
||
| 823 | * @param string $column |
||
| 824 | * @return FormField |
||
| 825 | */ |
||
| 826 | public function getInlineTitleField($column) { |
||
| 827 | return TextField::create($column, false) |
||
| 828 | ->setAttribute('placeholder', _t('EditableFormField.TITLE', 'Title')) |
||
| 829 | ->setAttribute('data-placeholder', _t('EditableFormField.TITLE', 'Title')); |
||
| 830 | } |
||
| 831 | |||
| 832 | /** |
||
| 833 | * Get the JS expression for selecting the holder for this field |
||
| 834 | * |
||
| 835 | * @return string |
||
| 836 | */ |
||
| 837 | public function getSelectorHolder() { |
||
| 838 | return "$(\"#{$this->Name}\")"; |
||
| 839 | } |
||
| 840 | |||
| 841 | /** |
||
| 842 | * Gets the JS expression for selecting the value for this field |
||
| 843 | * |
||
| 844 | * @param EditableCustomRule $rule Custom rule this selector will be used with |
||
| 845 | * @param bool $forOnLoad Set to true if this will be invoked on load |
||
| 846 | */ |
||
| 847 | public function getSelectorField(EditableCustomRule $rule, $forOnLoad = false) { |
||
| 848 | return "$(\"input[name='{$this->Name}']\")"; |
||
| 849 | } |
||
| 850 | |||
| 851 | |||
| 852 | /** |
||
| 853 | * Get the list of classes that can be selected and used as data-values |
||
| 854 | * |
||
| 855 | * @param $includeLiterals Set to false to exclude non-data fields |
||
| 856 | * @return array |
||
| 857 | */ |
||
| 858 | public function getEditableFieldClasses($includeLiterals = true) { |
||
| 885 | |||
| 886 | /** |
||
| 887 | * @return EditableFormFieldValidator |
||
| 888 | */ |
||
| 889 | public function getCMSValidator() { |
||
| 893 | |||
| 894 | /** |
||
| 895 | * Determine effective display rules for this field. |
||
| 896 | * |
||
| 897 | * @return SS_List |
||
| 898 | */ |
||
| 899 | public function EffectiveDisplayRules() { |
||
| 905 | |||
| 906 | } |
||
| 907 |
Loading history...
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.