| @@ -1,5 +1,18 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * FormFactory.php | |
| 4 | + * | |
| 5 | + * The FormFactory class file. | |
| 6 | + * | |
| 7 | + * PHP versions 5 | |
| 8 | + * | |
| 9 | + * @author Alexander Schneider <alexanderschneider85@gmail.com> | |
| 10 | + * @copyright 2008-2017 Alexander Schneider | |
| 11 | + * @license http://www.gnu.org/licenses/gpl-2.0.html GNU General Public License, version 2 | |
| 12 | + * @version SVN: $id$ | |
| 13 | + * @link http://wordpress.org/extend/plugins/user-access-manager/ | |
| 14 | + */ | |
| 2 | 15 | |
| 3 | 16 | declare(strict_types=1); |
| 4 | 17 | |
| 5 | 18 | namespace UserAccessManager\Form; |
| @@ -4,69 +17,108 @@ | ||
| 4 | 17 | |
| 5 | 18 | namespace UserAccessManager\Form; |
| 6 | 19 | |
| 7 | 20 | use Exception; |
| 8 | -use UserAccessManager\Form\Element\Input; | |
| 9 | -use UserAccessManager\Form\Element\MultipleFormElementValue; | |
| 10 | -use UserAccessManager\Form\Element\Radio; | |
| 11 | -use UserAccessManager\Form\Element\Select; | |
| 12 | -use UserAccessManager\Form\Element\Textarea; | |
| 13 | -use UserAccessManager\Form\Element\ValueSetFormElementValue; | |
| 14 | 21 | |
| 22 | +/** | |
| 23 | + * Class FormFactory | |
| 24 | + * | |
| 25 | + * @package UserAccessManager\Form | |
| 26 | + */ | |
| 15 | 27 | class FormFactory |
| 16 | 28 | { |
| 17 | - public function createForm(): Form | |
| 29 | + /** | |
| 30 | + * Creates a form object. | |
| 31 | + * @return Form | |
| 32 | + */ | |
| 33 | + public function createFrom(): Form | |
| 18 | 34 | { |
| 19 | 35 | return new Form(); |
| 20 | 36 | } |
| 21 | 37 | |
| 22 | - public function createValueSetFormElementValue(mixed $value, string $label): ValueSetFormElementValue | |
| 38 | + /** | |
| 39 | + * Creates a ValueSetFormElementValue object. | |
| 40 | + * @param mixed $value | |
| 41 | + * @param string $label | |
| 42 | + * @return ValueSetFormElementValue | |
| 43 | + */ | |
| 44 | + public function createValueSetFromElementValue($value, string $label): ValueSetFormElementValue | |
| 23 | 45 | { |
| 24 | 46 | return new ValueSetFormElementValue($value, $label); |
| 25 | 47 | } |
| 26 | 48 | |
| 27 | - public function createMultipleFormElementValue(mixed $value, string $label): MultipleFormElementValue | |
| 49 | + /** | |
| 50 | + * Creates a MultipleFormElementValue object. | |
| 51 | + * @param mixed $value | |
| 52 | + * @param string $label | |
| 53 | + * @return MultipleFormElementValue | |
| 54 | + */ | |
| 55 | + public function createMultipleFormElementValue($value, string $label): MultipleFormElementValue | |
| 28 | 56 | { |
| 29 | 57 | return new MultipleFormElementValue($value, $label); |
| 30 | 58 | } |
| 31 | 59 | |
| 32 | - public function createInput( | |
| 33 | - string $id, | |
| 34 | - mixed $value = null, | |
| 35 | - ?string $label = null, | |
| 36 | - ?string $description = null | |
| 37 | - ): Input { | |
| 60 | + /** | |
| 61 | + * Creates a Input object. | |
| 62 | + * @param string $id | |
| 63 | + * @param null|mixed $value | |
| 64 | + * @param null|string $label | |
| 65 | + * @param null|string $description | |
| 66 | + * @return Input | |
| 67 | + */ | |
| 68 | + public function createInput(string $id, $value = null, $label = null, $description = null): Input | |
| 69 | + { | |
| 38 | 70 | return new Input($id, $value, $label, $description); |
| 39 | 71 | } |
| 40 | 72 | |
| 41 | - public function createTextarea( | |
| 42 | - string $id, | |
| 43 | - mixed $value = null, | |
| 44 | - ?string $label = null, | |
| 45 | - ?string $description = null | |
| 46 | - ): Textarea { | |
| 73 | + /** | |
| 74 | + * Creates a Textarea object. | |
| 75 | + * @param string $id | |
| 76 | + * @param null|mixed $value | |
| 77 | + * @param null|string $label | |
| 78 | + * @param null|string $description | |
| 79 | + * @return Textarea | |
| 80 | + */ | |
| 81 | + public function createTextarea(string $id, $value = null, $label = null, $description = null): Textarea | |
| 82 | + { | |
| 47 | 83 | return new Textarea($id, $value, $label, $description); |
| 48 | 84 | } |
| 49 | 85 | |
| 86 | + /** | |
| 87 | + * Creates a Select object. | |
| 88 | + * @param string $id | |
| 89 | + * @param ValueSetFormElementValue[] $possibleValues | |
| 90 | + * @param null|mixed $value | |
| 91 | + * @param null|string $label | |
| 92 | + * @param null|string $description | |
| 93 | + * @return Select | |
| 94 | + */ | |
| 50 | 95 | public function createSelect( |
| 51 | 96 | string $id, |
| 52 | 97 | array $possibleValues, |
| 53 | - mixed $value = null, | |
| 54 | - ?string $label = null, | |
| 55 | - ?string $description = null | |
| 98 | + $value = null, | |
| 99 | + $label = null, | |
| 100 | + $description = null | |
| 56 | 101 | ): Select { |
| 57 | 102 | return new Select($id, $possibleValues, $value, $label, $description); |
| 58 | 103 | } |
| 59 | 104 | |
| 60 | 105 | /** |
| 106 | + * Creates a Radio object. | |
| 107 | + * @param string $id | |
| 108 | + * @param MultipleFormElementValue[] $possibleValues | |
| 109 | + * @param null|mixed $value | |
| 110 | + * @param null|string $label | |
| 111 | + * @param null|string $description | |
| 112 | + * @return Radio | |
| 61 | 113 | * @throws Exception |
| 62 | 114 | */ |
| 63 | 115 | public function createRadio( |
| 64 | 116 | string $id, |
| 65 | 117 | array $possibleValues, |
| 66 | - mixed $value = null, | |
| 67 | - ?string $label = null, | |
| 68 | - ?string $description = null | |
| 118 | + $value = null, | |
| 119 | + $label = null, | |
| 120 | + $description = null | |
| 69 | 121 | ): Radio { |
| 70 | 122 | return new Radio($id, $possibleValues, $value, $label, $description); |
| 71 | 123 | } |
| 72 | 124 | } |