silverstripe /
silverstripe-userforms
| Total Complexity | 28 |
| Total Lines | 251 |
| Duplicated Lines | 2.39 % |
| Changes | 0 | ||
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 |
||
| 29 | class UserFormFieldEditorExtension extends DataExtension |
||
| 30 | { |
||
| 31 | /** |
||
| 32 | * @var array |
||
| 33 | */ |
||
| 34 | private static $has_many = array( |
||
|
introduced
by
|
|||
| 35 | 'Fields' => EditableFormField::class |
||
| 36 | ); |
||
| 37 | |||
| 38 | private static $owns = [ |
||
| 39 | 'Fields' |
||
| 40 | ]; |
||
| 41 | |||
| 42 | private static $cascade_deletes = [ |
||
| 43 | 'Fields' |
||
| 44 | ]; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Adds the field editor to the page. |
||
| 48 | * |
||
| 49 | * @return FieldList |
||
| 50 | */ |
||
| 51 | public function updateCMSFields(FieldList $fields) |
||
| 52 | { |
||
| 53 | $fieldEditor = $this->getFieldEditorGrid(); |
||
| 54 | |||
| 55 | $fields->insertAfter(new Tab('FormFields', _t(__CLASS__.'.FORMFIELDS', 'Form Fields')), 'Main'); |
||
| 56 | $fields->addFieldToTab('Root.FormFields', $fieldEditor); |
||
| 57 | |||
| 58 | return $fields; |
||
| 59 | } |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Gets the field editor, for adding and removing EditableFormFields. |
||
| 63 | * |
||
| 64 | * @return GridField |
||
| 65 | */ |
||
| 66 | public function getFieldEditorGrid() |
||
| 67 | { |
||
| 68 | Requirements::javascript('silverstripe/userforms:client/dist/js/userforms-cms.js'); |
||
| 69 | |||
| 70 | $fields = $this->owner->Fields(); |
||
| 71 | |||
| 72 | $this->createInitialFormStep(true); |
||
| 73 | |||
| 74 | $editableColumns = new GridFieldEditableColumns(); |
||
| 75 | $fieldClasses = singleton(EditableFormField::class)->getEditableFieldClasses(); |
||
| 76 | $editableColumns->setDisplayFields([ |
||
| 77 | 'ClassName' => function ($record, $column, $grid) use ($fieldClasses) { |
||
| 78 | if ($record instanceof EditableFormField) { |
||
| 79 | return $record->getInlineClassnameField($column, $fieldClasses); |
||
| 80 | } |
||
| 81 | }, |
||
| 82 | 'Title' => function ($record, $column, $grid) { |
||
| 83 | if ($record instanceof EditableFormField) { |
||
| 84 | return $record->getInlineTitleField($column); |
||
| 85 | } |
||
| 86 | } |
||
| 87 | ]); |
||
| 88 | |||
| 89 | $config = GridFieldConfig::create() |
||
| 90 | ->addComponents( |
||
| 91 | $editableColumns, |
||
| 92 | new GridFieldButtonRow(), |
||
| 93 | (new GridFieldAddClassesButton(EditableTextField::class)) |
||
| 94 | ->setButtonName(_t(__CLASS__.'.ADD_FIELD', 'Add Field')) |
||
| 95 | ->setButtonClass('btn-primary'), |
||
| 96 | (new GridFieldAddClassesButton(EditableFormStep::class)) |
||
| 97 | ->setButtonName(_t(__CLASS__.'.ADD_PAGE_BREAK', 'Add Page Break')) |
||
| 98 | ->setButtonClass('btn-secondary'), |
||
| 99 | (new GridFieldAddClassesButton([EditableFieldGroup::class, EditableFieldGroupEnd::class])) |
||
| 100 | ->setButtonName(_t(__CLASS__.'.ADD_FIELD_GROUP', 'Add Field Group')) |
||
| 101 | ->setButtonClass('btn-secondary'), |
||
| 102 | $editButton = new GridFieldEditButton(), |
||
| 103 | new GridFieldDeleteAction(), |
||
| 104 | new GridFieldToolbarHeader(), |
||
| 105 | new GridFieldOrderableRows('Sort'), |
||
| 106 | new GridFieldDetailForm() |
||
| 107 | ); |
||
| 108 | |||
| 109 | $editButton->removeExtraClass('grid-field__icon-action--hidden-on-hover'); |
||
| 110 | |||
| 111 | $fieldEditor = GridField::create( |
||
| 112 | 'Fields', |
||
| 113 | '', |
||
| 114 | $fields, |
||
| 115 | $config |
||
| 116 | )->addExtraClass('uf-field-editor'); |
||
| 117 | |||
| 118 | return $fieldEditor; |
||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * A UserForm must have at least one step. |
||
| 123 | * If no steps exist, create an initial step, and put all fields inside it. |
||
| 124 | * |
||
| 125 | * @param bool $force |
||
| 126 | * @return void |
||
| 127 | */ |
||
| 128 | public function createInitialFormStep($force = false) |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Ensure that at least one page exists at the start |
||
| 165 | */ |
||
| 166 | public function onAfterWrite() |
||
| 167 | { |
||
| 168 | $this->createInitialFormStep(); |
||
| 169 | } |
||
| 170 | |||
| 171 | /** |
||
| 172 | * Remove any orphaned child records on publish |
||
| 173 | */ |
||
| 174 | public function onAfterPublish() |
||
| 175 | { |
||
| 176 | // store IDs of fields we've published |
||
| 177 | $seenIDs = []; |
||
| 178 | foreach ($this->owner->Fields() as $field) { |
||
| 179 | // store any IDs of fields we publish so we don't unpublish them |
||
| 180 | $seenIDs[] = $field->ID; |
||
| 181 | $field->doPublish(Versioned::DRAFT, Versioned::LIVE); |
||
| 182 | $field->destroy(); |
||
| 183 | } |
||
| 184 | |||
| 185 | // fetch any orphaned live records |
||
| 186 | $live = Versioned::get_by_stage(EditableFormField::class, Versioned::LIVE) |
||
| 187 | ->filter([ |
||
| 188 | 'ParentID' => $this->owner->ID, |
||
| 189 | ]); |
||
| 190 | |||
| 191 | if (!empty($seenIDs)) { |
||
| 192 | $live = $live->exclude([ |
||
| 193 | 'ID' => $seenIDs, |
||
| 194 | ]); |
||
| 195 | } |
||
| 196 | |||
| 197 | // delete orphaned records |
||
| 198 | foreach ($live as $field) { |
||
| 199 | $field->deleteFromStage(Versioned::LIVE); |
||
| 200 | $field->destroy(); |
||
| 201 | } |
||
| 202 | } |
||
| 203 | |||
| 204 | /** |
||
| 205 | * Remove all fields from the live stage when unpublishing the page |
||
| 206 | */ |
||
| 207 | public function onAfterUnpublish() |
||
| 208 | { |
||
| 209 | foreach ($this->owner->Fields() as $field) { |
||
| 210 | $field->deleteFromStage(Versioned::LIVE); |
||
| 211 | } |
||
| 212 | } |
||
| 213 | |||
| 214 | /** |
||
| 215 | * When duplicating a UserDefinedForm, duplicate all of its fields and display rules |
||
| 216 | * |
||
| 217 | * @see \SilverStripe\ORM\DataObject::duplicate |
||
| 218 | * @param \SilverStripe\ORM\DataObject $oldPage |
||
| 219 | * @param bool $doWrite |
||
| 220 | * @param string $manyMany |
||
| 221 | * @return \SilverStripe\ORM\DataObject |
||
| 222 | */ |
||
| 223 | public function onAfterDuplicate($oldPage, $doWrite, $manyMany) |
||
| 251 | } |
||
| 252 | } |
||
| 253 | } |
||
| 254 | |||
| 255 | /** |
||
| 256 | * Checks child fields to see if any are modified in draft as well. The owner of this extension will still |
||
| 257 | * use the Versioned method to determine its own status. |
||
| 258 | * |
||
| 259 | * @see Versioned::isModifiedOnDraft |
||
| 260 | * |
||
| 261 | * @return boolean|null |
||
| 262 | */ |
||
| 263 | public function isModifiedOnDraft() |
||
| 264 | { |
||
| 265 | foreach ($this->owner->Fields() as $field) { |
||
| 266 | if ($field->isModifiedOnDraft()) { |
||
| 267 | return true; |
||
| 268 | } |
||
| 269 | } |
||
| 270 | } |
||
| 271 | |||
| 272 | /** |
||
| 273 | * @see Versioned::doRevertToLive |
||
| 274 | */ |
||
| 275 | public function onAfterRevertToLive() |
||
| 280 | } |
||
| 281 | } |
||
| 282 | } |
||
| 283 |
Loading history...
