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 FormBuilder 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 FormBuilder, and based on these observations, apply Extract Interface, too.
| 1 | <?php namespace Anomaly\Streams\Platform\Ui\Form; | ||
| 39 | class FormBuilder | ||
| 40 | { | ||
| 41 | |||
| 42 | use DispatchesJobs; | ||
| 43 | use FiresCallbacks; | ||
| 44 | |||
| 45 | /** | ||
| 46 | * The ajax flag. | ||
| 47 | * | ||
| 48 | * @var bool | ||
| 49 | */ | ||
| 50 | protected $ajax = false; | ||
| 51 | |||
| 52 | /** | ||
| 53 | * The form handler. | ||
| 54 | * | ||
| 55 | * @var null|string | ||
| 56 | */ | ||
| 57 | protected $handler = null; | ||
| 58 | |||
| 59 | /** | ||
| 60 | * The form validator. | ||
| 61 | * | ||
| 62 | * @var null|string | ||
| 63 | */ | ||
| 64 | protected $validator = null; | ||
| 65 | |||
| 66 | /** | ||
| 67 | * The form repository. | ||
| 68 | * | ||
| 69 | * @var null|FormRepositoryInterface | ||
| 70 | */ | ||
| 71 | protected $repository = null; | ||
| 72 | |||
| 73 | /** | ||
| 74 | * The form model. | ||
| 75 | * | ||
| 76 | * @var null | ||
| 77 | */ | ||
| 78 | protected $model = null; | ||
| 79 | |||
| 80 | /** | ||
| 81 | * The entry object. | ||
| 82 | * | ||
| 83 | * @var null|int | ||
| 84 | */ | ||
| 85 | protected $entry = null; | ||
| 86 | |||
| 87 | /** | ||
| 88 | * The fields config. | ||
| 89 | * | ||
| 90 | * @var array|string | ||
| 91 | */ | ||
| 92 | protected $fields = []; | ||
| 93 | |||
| 94 | /** | ||
| 95 | * Fields to skip. | ||
| 96 | * | ||
| 97 | * @var array|string | ||
| 98 | */ | ||
| 99 | protected $skips = []; | ||
| 100 | |||
| 101 | /** | ||
| 102 | * The actions config. | ||
| 103 | * | ||
| 104 | * @var array|string | ||
| 105 | */ | ||
| 106 | protected $actions = []; | ||
| 107 | |||
| 108 | /** | ||
| 109 | * The buttons config. | ||
| 110 | * | ||
| 111 | * @var array|string | ||
| 112 | */ | ||
| 113 | protected $buttons = []; | ||
| 114 | |||
| 115 | /** | ||
| 116 | * The form options. | ||
| 117 | * | ||
| 118 | * @var array | ||
| 119 | */ | ||
| 120 | protected $options = []; | ||
| 121 | |||
| 122 | /** | ||
| 123 | * The form sections. | ||
| 124 | * | ||
| 125 | * @var array | ||
| 126 | */ | ||
| 127 | protected $sections = []; | ||
| 128 | |||
| 129 | /** | ||
| 130 | * The form assets. | ||
| 131 | * | ||
| 132 | * @var array | ||
| 133 | */ | ||
| 134 | protected $assets = []; | ||
| 135 | |||
| 136 | /** | ||
| 137 | * The save flag. | ||
| 138 | * | ||
| 139 | * @var bool | ||
| 140 | */ | ||
| 141 | protected $save = true; | ||
| 142 | |||
| 143 | /** | ||
| 144 | * The read only flag. | ||
| 145 | * | ||
| 146 | * @var bool | ||
| 147 | */ | ||
| 148 | protected $readOnly = false; | ||
| 149 | |||
| 150 | /** | ||
| 151 | * The form object. | ||
| 152 | * | ||
| 153 | * @var Form | ||
| 154 | */ | ||
| 155 | protected $form; | ||
| 156 | |||
| 157 | /** | ||
| 158 | * Crate a new FormBuilder instance. | ||
| 159 | * | ||
| 160 | * @param Form $form | ||
| 161 | */ | ||
| 162 | public function __construct(Form $form) | ||
| 166 | |||
| 167 | /** | ||
| 168 | * Build the form. | ||
| 169 | * | ||
| 170 | * @param null $entry | ||
| 171 | * @return $this | ||
| 172 | */ | ||
| 173 | public function build($entry = null) | ||
| 187 | |||
| 188 | /** | ||
| 189 | * Make the form. | ||
| 190 | * | ||
| 191 | * @param null $entry | ||
| 192 | * @return $this | ||
| 193 | */ | ||
| 194 | public function make($entry = null) | ||
| 209 | |||
| 210 | /** | ||
| 211 | * Handle the form post. | ||
| 212 | * | ||
| 213 | * @param null $entry | ||
| 214 | * @return $this | ||
| 215 | * @throws \Exception | ||
| 216 | */ | ||
| 217 | public function handle($entry = null) | ||
| 228 | |||
| 229 | /** | ||
| 230 | * Trigger post operations | ||
| 231 | * for the form. | ||
| 232 | * | ||
| 233 | * @return $this | ||
| 234 | */ | ||
| 235 | public function post() | ||
| 249 | |||
| 250 | /** | ||
| 251 | * Validate the form. | ||
| 252 | * | ||
| 253 | * @return $this | ||
| 254 | */ | ||
| 255 | public function validate() | ||
| 262 | |||
| 263 | /** | ||
| 264 | * Flash form information to be | ||
| 265 | * used in conjunction with redirect | ||
| 266 | * type responses (not self handling). | ||
| 267 | */ | ||
| 268 | public function flash() | ||
| 273 | |||
| 274 | /** | ||
| 275 | * Render the form. | ||
| 276 | * | ||
| 277 | * @param null $entry | ||
| 278 | * @return Response | ||
| 279 | */ | ||
| 280 | public function render($entry = null) | ||
| 290 | |||
| 291 | /** | ||
| 292 | * Fire field events. | ||
| 293 | * | ||
| 294 | * @param $trigger | ||
| 295 | * @param array $payload | ||
| 296 | */ | ||
| 297 | public function fireFieldEvents($trigger, array $payload = []) | ||
| 304 | |||
| 305 | /** | ||
| 306 | * Save the form. | ||
| 307 | */ | ||
| 308 | public function saveForm() | ||
| 312 | |||
| 313 | /** | ||
| 314 | * Get the form object. | ||
| 315 | * | ||
| 316 | * @return Form | ||
| 317 | */ | ||
| 318 | public function getForm() | ||
| 322 | |||
| 323 | /** | ||
| 324 | * Get the form presenter. | ||
| 325 | * | ||
| 326 | * @return FormPresenter | ||
| 327 | */ | ||
| 328 | public function getFormPresenter() | ||
| 332 | |||
| 333 | /** | ||
| 334 | * Get the ajax flag. | ||
| 335 | * | ||
| 336 | * @return bool | ||
| 337 | */ | ||
| 338 | public function isAjax() | ||
| 342 | |||
| 343 | /** | ||
| 344 | * Set the ajax flag. | ||
| 345 | * | ||
| 346 | * @param $ajax | ||
| 347 | * @return $this | ||
| 348 | */ | ||
| 349 | public function setAjax($ajax) | ||
| 355 | |||
| 356 | /** | ||
| 357 | * Get the handler. | ||
| 358 | * | ||
| 359 | * @return null|string | ||
| 360 | */ | ||
| 361 | public function getHandler() | ||
| 365 | |||
| 366 | /** | ||
| 367 | * Set the handler. | ||
| 368 | * | ||
| 369 | * @param $handler | ||
| 370 | * @return $this | ||
| 371 | */ | ||
| 372 | public function setHandler($handler) | ||
| 378 | |||
| 379 | /** | ||
| 380 | * Get the validator. | ||
| 381 | * | ||
| 382 | * @return null|string | ||
| 383 | */ | ||
| 384 | public function getValidator() | ||
| 388 | |||
| 389 | /** | ||
| 390 | * Set the validator. | ||
| 391 | * | ||
| 392 | * @param $validator | ||
| 393 | * @return $this | ||
| 394 | */ | ||
| 395 | public function setValidator($validator) | ||
| 401 | |||
| 402 | /** | ||
| 403 | * Get the repository. | ||
| 404 | * | ||
| 405 | * @return FormRepositoryInterface|null | ||
| 406 | */ | ||
| 407 | public function getRepository() | ||
| 411 | |||
| 412 | /** | ||
| 413 | * Set the form repository. | ||
| 414 | * | ||
| 415 | * @param FormRepositoryInterface $repository | ||
| 416 | * @return $this | ||
| 417 | */ | ||
| 418 | public function setRepository(FormRepositoryInterface $repository) | ||
| 424 | |||
| 425 | /** | ||
| 426 | * Set the form model. | ||
| 427 | * | ||
| 428 | * @param $model | ||
| 429 | * @return $this | ||
| 430 | */ | ||
| 431 | public function setModel($model) | ||
| 437 | |||
| 438 | /** | ||
| 439 | * Get the form model. | ||
| 440 | * | ||
| 441 | * @return null | ||
| 442 | */ | ||
| 443 | public function getModel() | ||
| 447 | |||
| 448 | /** | ||
| 449 | * Set the entry object. | ||
| 450 | * | ||
| 451 | * @param $entry | ||
| 452 | * @return $this | ||
| 453 | */ | ||
| 454 | public function setEntry($entry) | ||
| 460 | |||
| 461 | /** | ||
| 462 | * Get the entry object. | ||
| 463 | * | ||
| 464 | * @return null|EntryInterface|FieldInterface|mixed | ||
| 465 | */ | ||
| 466 | public function getEntry() | ||
| 470 | |||
| 471 | /** | ||
| 472 | * Set the fields. | ||
| 473 | * | ||
| 474 | * @param $fields | ||
| 475 | * @return $this | ||
| 476 | */ | ||
| 477 | public function setFields($fields) | ||
| 483 | |||
| 484 | /** | ||
| 485 | * Get the fields. | ||
| 486 | * | ||
| 487 | * @return array | ||
| 488 | */ | ||
| 489 | public function getFields() | ||
| 493 | |||
| 494 | /** | ||
| 495 | * Add a field. | ||
| 496 | * | ||
| 497 | * @param $field | ||
| 498 | */ | ||
| 499 | public function addField($field) | ||
| 503 | |||
| 504 | /** | ||
| 505 | * Add fields. | ||
| 506 | * | ||
| 507 | * @param array $fields | ||
| 508 | */ | ||
| 509 | public function addFields(array $fields) | ||
| 513 | |||
| 514 | /** | ||
| 515 | * Get the skipped fields. | ||
| 516 | * | ||
| 517 | * @return array | ||
| 518 | */ | ||
| 519 | public function getSkips() | ||
| 523 | |||
| 524 | /** | ||
| 525 | * Set the skipped fields. | ||
| 526 | * | ||
| 527 | * @param $skips | ||
| 528 | * @return $this | ||
| 529 | */ | ||
| 530 | public function setSkips($skips) | ||
| 536 | |||
| 537 | /** | ||
| 538 | * Add a skipped field. | ||
| 539 | * | ||
| 540 | * @param $fieldSlug | ||
| 541 | * @return $this | ||
| 542 | */ | ||
| 543 | public function skipField($fieldSlug) | ||
| 549 | |||
| 550 | /** | ||
| 551 | * Set the actions config. | ||
| 552 | * | ||
| 553 | * @param $actions | ||
| 554 | * @return $this | ||
| 555 | */ | ||
| 556 | public function setActions($actions) | ||
| 562 | |||
| 563 | /** | ||
| 564 | * Add an action. | ||
| 565 | * | ||
| 566 | * @param $slug | ||
| 567 | * @param array $definition | ||
| 568 | * @return $this | ||
| 569 | */ | ||
| 570 | public function addAction($slug, array $definition = []) | ||
| 580 | |||
| 581 | /** | ||
| 582 | * Get the actions config. | ||
| 583 | * | ||
| 584 | * @return array | ||
| 585 | */ | ||
| 586 | public function getActions() | ||
| 590 | |||
| 591 | /** | ||
| 592 | * Set the buttons config. | ||
| 593 | * | ||
| 594 | * @param $buttons | ||
| 595 | * @return $this | ||
| 596 | */ | ||
| 597 | public function setButtons($buttons) | ||
| 603 | |||
| 604 | /** | ||
| 605 | * Get the buttons config. | ||
| 606 | * | ||
| 607 | * @return array | ||
| 608 | */ | ||
| 609 | public function getButtons() | ||
| 613 | |||
| 614 | /** | ||
| 615 | * The the options. | ||
| 616 | * | ||
| 617 | * @return array | ||
| 618 | */ | ||
| 619 | public function getOptions() | ||
| 623 | |||
| 624 | /** | ||
| 625 | * Set the options. | ||
| 626 | * | ||
| 627 | * @param array|string $options | ||
| 628 | * @return $this | ||
| 629 | */ | ||
| 630 | public function setOptions($options) | ||
| 636 | |||
| 637 | /** | ||
| 638 | * Merge in options. | ||
| 639 | * | ||
| 640 | * @param array|string $options | ||
| 641 | * @return $this | ||
| 642 | */ | ||
| 643 | public function mergeOptions($options) | ||
| 649 | |||
| 650 | /** | ||
| 651 | * Get the sections. | ||
| 652 | * | ||
| 653 | * @return array | ||
| 654 | */ | ||
| 655 | public function getSections() | ||
| 659 | |||
| 660 | /** | ||
| 661 | * Set the sections. | ||
| 662 | * | ||
| 663 | * @param array|Closure $sections | ||
| 664 | * @return $this | ||
| 665 | */ | ||
| 666 | public function setSections($sections) | ||
| 672 | |||
| 673 | /** | ||
| 674 | * Add a section. | ||
| 675 | * | ||
| 676 | * @param $slug | ||
| 677 | * @param array $section | ||
| 678 | * @return $this | ||
| 679 | */ | ||
| 680 | public function addSection($slug, array $section) | ||
| 686 | |||
| 687 | /** | ||
| 688 | * Add a section tab. | ||
| 689 | * | ||
| 690 | * @param $section | ||
| 691 | * @param $slug | ||
| 692 | * @param array $tab | ||
| 693 | * @return $this | ||
| 694 | */ | ||
| 695 | public function addSectionTab($section, $slug, array $tab) | ||
| 701 | |||
| 702 | /** | ||
| 703 | * Get an option value. | ||
| 704 | * | ||
| 705 | * @param $key | ||
| 706 | * @param null $default | ||
| 707 | * @return mixed | ||
| 708 | */ | ||
| 709 | public function getOption($key, $default = null) | ||
| 713 | |||
| 714 | /** | ||
| 715 | * Set an option value. | ||
| 716 | * | ||
| 717 | * @param $key | ||
| 718 | * @param $value | ||
| 719 | * @return $this | ||
| 720 | */ | ||
| 721 | public function setOption($key, $value) | ||
| 727 | |||
| 728 | /** | ||
| 729 | * Get the assets. | ||
| 730 | * | ||
| 731 | * @return array | ||
| 732 | */ | ||
| 733 | public function getAssets() | ||
| 737 | |||
| 738 | /** | ||
| 739 | * Set the assets. | ||
| 740 | * | ||
| 741 | * @param $assets | ||
| 742 | * @return $this | ||
| 743 | */ | ||
| 744 | public function setAssets($assets) | ||
| 750 | |||
| 751 | /** | ||
| 752 | * Add an asset. | ||
| 753 | * | ||
| 754 | * @param $collection | ||
| 755 | * @param $asset | ||
| 756 | * @return $this | ||
| 757 | */ | ||
| 758 | View Code Duplication | public function addAsset($collection, $asset) | |
| 768 | |||
| 769 | /** | ||
| 770 | * Get the form's stream. | ||
| 771 | * | ||
| 772 | * @return StreamInterface|null | ||
| 773 | */ | ||
| 774 | public function getFormStream() | ||
| 778 | |||
| 779 | /** | ||
| 780 | * Get a form option value. | ||
| 781 | * | ||
| 782 | * @param $key | ||
| 783 | * @param null $default | ||
| 784 | * @return mixed | ||
| 785 | */ | ||
| 786 | public function getFormOption($key, $default = null) | ||
| 790 | |||
| 791 | /** | ||
| 792 | * Set a form option value. | ||
| 793 | * | ||
| 794 | * @param $key | ||
| 795 | * @param $value | ||
| 796 | * @return $this | ||
| 797 | */ | ||
| 798 | public function setFormOption($key, $value) | ||
| 804 | |||
| 805 | /** | ||
| 806 | * Get the form options. | ||
| 807 | * | ||
| 808 | * @return \Anomaly\Streams\Platform\Support\Collection | ||
| 809 | */ | ||
| 810 | public function getFormOptions() | ||
| 814 | |||
| 815 | /** | ||
| 816 | * Get the form model. | ||
| 817 | * | ||
| 818 | * @return \Anomaly\Streams\Platform\Entry\EntryModel|EloquentModel|null | ||
| 819 | */ | ||
| 820 | public function getFormModel() | ||
| 824 | |||
| 825 | /** | ||
| 826 | * Get the form entry. | ||
| 827 | * | ||
| 828 | * @return EloquentModel|EntryInterface|FieldInterface|AssignmentInterface | ||
| 829 | */ | ||
| 830 | public function getFormEntry() | ||
| 834 | |||
| 835 | /** | ||
| 836 | * Return the form entry's ID. | ||
| 837 | * | ||
| 838 | * @return int|mixed|null | ||
| 839 | */ | ||
| 840 | public function getFormEntryId() | ||
| 850 | |||
| 851 | /** | ||
| 852 | * Get the contextual entry ID. | ||
| 853 | * | ||
| 854 | * @return int|null | ||
| 855 | */ | ||
| 856 | public function getContextualId() | ||
| 860 | |||
| 861 | /** | ||
| 862 | * Get the form mode. | ||
| 863 | * | ||
| 864 | * @return null|string | ||
| 865 | */ | ||
| 866 | public function getFormMode() | ||
| 870 | |||
| 871 | /** | ||
| 872 | * Set the form mode. | ||
| 873 | * | ||
| 874 | * @param $mode | ||
| 875 | * @return $this | ||
| 876 | */ | ||
| 877 | public function setFormMode($mode) | ||
| 883 | |||
| 884 | /** | ||
| 885 | * Get a form value. | ||
| 886 | * | ||
| 887 | * @param $key | ||
| 888 | * @param null $default | ||
| 889 | * @return mixed | ||
| 890 | */ | ||
| 891 | public function getFormValue($key, $default = null) | ||
| 895 | |||
| 896 | /** | ||
| 897 | * Set a form value. | ||
| 898 | * | ||
| 899 | * @param $key | ||
| 900 | * @param $value | ||
| 901 | * @return $this | ||
| 902 | */ | ||
| 903 | public function setFormValue($key, $value) | ||
| 909 | |||
| 910 | /** | ||
| 911 | * Get the form values. | ||
| 912 | * | ||
| 913 | * @return \Anomaly\Streams\Platform\Support\Collection | ||
| 914 | */ | ||
| 915 | public function getFormValues() | ||
| 919 | |||
| 920 | /** | ||
| 921 | * Reset the form. | ||
| 922 | * | ||
| 923 | * @return $this | ||
| 924 | */ | ||
| 925 | public function resetForm() | ||
| 933 | |||
| 934 | /** | ||
| 935 | * Get the form input. | ||
| 936 | * | ||
| 937 | * @return array | ||
| 938 | */ | ||
| 939 | public function getFormInput() | ||
| 945 | |||
| 946 | /** | ||
| 947 | * Get the form data. | ||
| 948 | * | ||
| 949 | * @return \Anomaly\Streams\Platform\Support\Collection | ||
| 950 | */ | ||
| 951 | public function getFormData() | ||
| 955 | |||
| 956 | /** | ||
| 957 | * Add form data. | ||
| 958 | * | ||
| 959 | * @param $key | ||
| 960 | * @param $value | ||
| 961 | * @return $this | ||
| 962 | */ | ||
| 963 | public function addFormData($key, $value) | ||
| 969 | |||
| 970 | /** | ||
| 971 | * Ge the form response. | ||
| 972 | * | ||
| 973 | * @return null|Response | ||
| 974 | */ | ||
| 975 | public function getFormResponse() | ||
| 979 | |||
| 980 | /** | ||
| 981 | * Set the form response. | ||
| 982 | * | ||
| 983 | * @param null|false|Response $response | ||
| 984 | * @return $this | ||
| 985 | */ | ||
| 986 | public function setFormResponse(Response $response) | ||
| 992 | |||
| 993 | /** | ||
| 994 | * Get the form content. | ||
| 995 | * | ||
| 996 | * @return null|string | ||
| 997 | */ | ||
| 998 | public function getFormContent() | ||
| 1002 | |||
| 1003 | /** | ||
| 1004 | * Get the form fields. | ||
| 1005 | * | ||
| 1006 | * @return Component\Field\FieldCollection | ||
| 1007 | */ | ||
| 1008 | public function getFormFields() | ||
| 1012 | |||
| 1013 | /** | ||
| 1014 | * Get the enabled form fields. | ||
| 1015 | * | ||
| 1016 | * @return Component\Field\FieldCollection | ||
| 1017 | */ | ||
| 1018 | public function getEnabledFormFields() | ||
| 1022 | |||
| 1023 | /** | ||
| 1024 | * Get the form field. | ||
| 1025 | * | ||
| 1026 | * @param $fieldSlug | ||
| 1027 | * @return FieldType | ||
| 1028 | */ | ||
| 1029 | public function getFormField($fieldSlug) | ||
| 1033 | |||
| 1034 | /** | ||
| 1035 | * Get the form attribute map. | ||
| 1036 | * | ||
| 1037 | * @return FieldType | ||
| 1038 | */ | ||
| 1039 | public function getFormFieldFromAttribute($attribute) | ||
| 1050 | |||
| 1051 | /** | ||
| 1052 | * Disable a form field. | ||
| 1053 | * | ||
| 1054 | * @param $fieldSlug | ||
| 1055 | * @return FieldType | ||
| 1056 | */ | ||
| 1057 | public function disableFormField($fieldSlug) | ||
| 1061 | |||
| 1062 | /** | ||
| 1063 | * Get the form field slugs. | ||
| 1064 | * | ||
| 1065 | * @param null $prefix | ||
| 1066 | * @return array | ||
| 1067 | */ | ||
| 1068 | public function getFormFieldSlugs($prefix = null) | ||
| 1079 | |||
| 1080 | /** | ||
| 1081 | * Get the form field names. | ||
| 1082 | * | ||
| 1083 | * @return array | ||
| 1084 | */ | ||
| 1085 | public function getFormFieldNames() | ||
| 1091 | |||
| 1092 | /** | ||
| 1093 | * Add a form field. | ||
| 1094 | * | ||
| 1095 | * @param FieldType $field | ||
| 1096 | * @return $this | ||
| 1097 | */ | ||
| 1098 | public function addFormField(FieldType $field) | ||
| 1104 | |||
| 1105 | /** | ||
| 1106 | * Set the form errors. | ||
| 1107 | * | ||
| 1108 | * @param MessageBag $errors | ||
| 1109 | * @return $this | ||
| 1110 | */ | ||
| 1111 | public function setFormErrors(MessageBag $errors) | ||
| 1117 | |||
| 1118 | /** | ||
| 1119 | * Get the form errors. | ||
| 1120 | * | ||
| 1121 | * @return null|MessageBag | ||
| 1122 | */ | ||
| 1123 | public function getFormErrors() | ||
| 1127 | |||
| 1128 | /** | ||
| 1129 | * Add an error to the form. | ||
| 1130 | * | ||
| 1131 | * @param $field | ||
| 1132 | * @param $message | ||
| 1133 | * @return $this | ||
| 1134 | */ | ||
| 1135 | public function addFormError($field, $message) | ||
| 1143 | |||
| 1144 | /** | ||
| 1145 | * Return whether the form has errors or not. | ||
| 1146 | * | ||
| 1147 | * @return bool | ||
| 1148 | */ | ||
| 1149 | public function hasFormErrors() | ||
| 1155 | |||
| 1156 | /** | ||
| 1157 | * Return whether the field has an error or not. | ||
| 1158 | * | ||
| 1159 | * @param $fieldName | ||
| 1160 | * @return bool | ||
| 1161 | */ | ||
| 1162 | public function hasFormError($fieldName) | ||
| 1166 | |||
| 1167 | /** | ||
| 1168 | * Get the form actions. | ||
| 1169 | * | ||
| 1170 | * @return ActionCollection | ||
| 1171 | */ | ||
| 1172 | public function getFormActions() | ||
| 1176 | |||
| 1177 | /** | ||
| 1178 | * Get the active form action. | ||
| 1179 | * | ||
| 1180 | * @return null|ActionInterface | ||
| 1181 | */ | ||
| 1182 | public function getActiveFormAction() | ||
| 1194 | |||
| 1195 | /** | ||
| 1196 | * Add a form button. | ||
| 1197 | * | ||
| 1198 | * @param ButtonInterface $button | ||
| 1199 | * @return $this | ||
| 1200 | */ | ||
| 1201 | public function addFormButton(ButtonInterface $button) | ||
| 1207 | |||
| 1208 | /** | ||
| 1209 | * Add a form section. | ||
| 1210 | * | ||
| 1211 | * @param $slug | ||
| 1212 | * @param array $section | ||
| 1213 | * @return $this | ||
| 1214 | */ | ||
| 1215 | public function addFormSection($slug, array $section) | ||
| 1221 | |||
| 1222 | /** | ||
| 1223 | * Set the form entry. | ||
| 1224 | * | ||
| 1225 | * @param $entry | ||
| 1226 | * @return $this | ||
| 1227 | */ | ||
| 1228 | public function setFormEntry($entry) | ||
| 1234 | |||
| 1235 | /** | ||
| 1236 | * Get a request value. | ||
| 1237 | * | ||
| 1238 | * @param $key | ||
| 1239 | * @param null $default | ||
| 1240 | * @return mixed | ||
| 1241 | */ | ||
| 1242 | public function getRequestValue($key, $default = null) | ||
| 1246 | |||
| 1247 | /** | ||
| 1248 | * Get a post value. | ||
| 1249 | * | ||
| 1250 | * @param $key | ||
| 1251 | * @param null $default | ||
| 1252 | * @return mixed | ||
| 1253 | */ | ||
| 1254 | public function getPostValue($key, $default = null) | ||
| 1258 | |||
| 1259 | /** | ||
| 1260 | * Return a post key flag. | ||
| 1261 | * | ||
| 1262 | * @param $key | ||
| 1263 | * @param null $default | ||
| 1264 | * @return mixed | ||
| 1265 | */ | ||
| 1266 | public function hasPostedInput($key) | ||
| 1270 | |||
| 1271 | /** | ||
| 1272 | * Return whether any post data exists. | ||
| 1273 | * | ||
| 1274 | * @return bool | ||
| 1275 | */ | ||
| 1276 | public function hasPostData() | ||
| 1287 | |||
| 1288 | /** | ||
| 1289 | * Set the save flag. | ||
| 1290 | * | ||
| 1291 | * @param bool $save | ||
| 1292 | * @return $this | ||
| 1293 | */ | ||
| 1294 | public function setSave($save) | ||
| 1300 | |||
| 1301 | /** | ||
| 1302 | * Return the save flag. | ||
| 1303 | * | ||
| 1304 | * @return bool | ||
| 1305 | */ | ||
| 1306 | public function canSave() | ||
| 1310 | |||
| 1311 | /** | ||
| 1312 | * Set the read only flag. | ||
| 1313 | * | ||
| 1314 | * @param $readOnly | ||
| 1315 | * @return $this | ||
| 1316 | */ | ||
| 1317 | public function setReadOnly($readOnly) | ||
| 1323 | |||
| 1324 | /** | ||
| 1325 | * Return the read only flag. | ||
| 1326 | * | ||
| 1327 | * @return bool | ||
| 1328 | */ | ||
| 1329 | public function isReadOnly() | ||
| 1333 | } | ||
| 1334 | 
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.