This repository has been archived by the owner on Apr 19, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 23
/
BcFormHelper.php
1641 lines (1514 loc) · 61.3 KB
/
BcFormHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* baserCMS : Based Website Development Project <https://basercms.net>
* Copyright (c) NPO baser foundation <https://baserfoundation.org/>
*
* @copyright Copyright (c) NPO baser foundation
* @link https://basercms.net baserCMS Project
* @since 5.0.0
* @license https://basercms.net/license/index.html MIT License
*/
namespace BaserCore\View\Helper;
use BaserCore\Utility\BcContainerTrait;
use Cake\ORM\TableRegistry;
use Cake\Utility\Inflector;
use Cake\View\Form\EntityContext;
use Cake\View\Helper\FormHelper;
use Cake\Datasource\EntityInterface;
use BaserCore\Event\BcEventDispatcherTrait;
use BaserCore\Annotation\Note;
use BaserCore\Annotation\NoTodo;
use BaserCore\Annotation\Checked;
use BaserCore\Annotation\UnitTest;
/**
* FormHelper 拡張クラス
*
* @property BcHtmlHelper $BcHtml
* @property BcUploadHelper $BcUpload
* @property BcCkeditorHelper $BcCkeditor
*/
class BcFormHelper extends FormHelper
{
/**
* Trait
*/
use BcEventDispatcherTrait;
use BcContainerTrait;
/**
* Other helpers used by FormHelper
*
* @var array
*/
public $helpers = [
'Url',
'Js',
'Html',
'BaserCore.BcHtml',
'BaserCore.BcTime',
'BaserCore.BcText',
'BaserCore.BcUpload',
'BaserCore.BcCkeditor'
];
// CUSTOMIZE ADD 2014/07/02 ryuring
// >>>
/**
* フォームID
*
* @var string
*/
private $formId = null;
// <<<
/**
* フォームの最後のフィールドの後に発動する前提としてイベントを発動する
*
* ### 発動側
* フォームの</table>の直前に記述して利用する
*
* ### コールバック処理
* プラグインのコールバック処理で CakeEvent::data['fields'] に
* 配列で行データを追加する事でフォームの最後に行を追加する事ができる。
*
* ### イベント名
* コントローラー名.Form.afterForm Or コントローラー名.Form.afterOptionForm
*
* ### 行データのキー（配列）
* - title：見出欄
* - input：入力欄
*
* ### 行データの追加例
* $View = $event->subject(); // $event は、CakeEvent
* $input = $View->BcForm->input('Page.add_field', ['type' => 'input']);
* $event->setData('fields', [
* [
* 'title' => '追加フィールド',
* 'input' => $input
* ]
* ]);
*
* @param string $type フォームのタイプ タイプごとにイベントの登録ができる
* @return string 行データ
* @checked
* @note(value="フォームの最後のフィールドの後に発動するイベント")
*/
public function dispatchAfterForm($type = ''): string
{
if ($type) {
$type = Inflector::camelize($type);
}
$event = $this->dispatchLayerEvent('after' . $type . 'Form', ['fields' => [], 'id' => $this->formId], ['class' => 'Form', 'plugin' => '']);
$out = '';
if ($event !== false) {
if (!empty($event->getData('fields'))) {
foreach($event->getData('fields') as $field) {
$out .= "<tr>";
$out .= "<th class=\"bca-form-table__label\">" . $field['title'] . "</th>\n";
$out .= "<td class=\"bca-form-table__input\">" . $field['input'] . "</td>\n";
$out .= "</tr>";
}
}
}
return $out;
}
/**
* コントロールソースを取得する
* Model側でメソッドを用意しておく必要がある
*
* @param string $field フィールド名
* @param array $options
* @return array|false コントロールソース
* @checked
* @noTodo
* @unitTest
*/
public function getControlSource($field, $options = [])
{
$count = preg_match_all('/\./is', $field, $matches);
$plugin = $modelName = null;
if ($count === 1) {
[$modelName, $field] = explode('.', $field);
$plugin = $this->_View->getPlugin();
} elseif ($count === 2) {
[$plugin, $modelName, $field] = explode('.', $field);
}
if (!$modelName) return false;
$serviceName = (($plugin)?: 'App') . '\\Service\\' . $modelName . 'ServiceInterface';
$modelName = (($plugin)? $plugin . '.' : '') . $modelName;
if (method_exists($serviceName, 'getControlSource')) {
return $this->getService($serviceName)->getControlSource($field, $options);
}
if (empty($modelName)) return false;
$model = TableRegistry::getTableLocator()->get($modelName);
if ($model && method_exists($model, 'getControlSource')) {
return $model->getControlSource($field, $options);
} else {
return false;
}
}
/**
* カレンダーピッカー
*
* jquery-ui-1系 必須
*
* @param string フィールド文字列
* @param array オプション
* @return string html
* @checked
* @noTodo
* @unitTest
*/
public function datePicker($fieldName, $options = [])
{
$options = array_merge([
'autocomplete' => 'off',
'id' => $this->_domId($fieldName),
'value' => $this->context()->val($fieldName)
], $options);
if ($options['value']) {
[$options['value'],] = explode(" ", str_replace('-', '/', $options['value']));
}
unset($options['type']);
$input = $this->text($fieldName, $options);
$script = <<< SCRIPT_END
<script>
jQuery(function($){
$("#{$options['id']}").datepicker();
});
</script>
SCRIPT_END;
return $input . "\n" . $script;
}
/**
* カレンダピッカーとタイムピッカー
*
* jquery.timepicker.js 必須
*
* @param string $fieldName
* @param array $options
* @return string
* @checked
* @noTodo
* @unitTest
*/
public function dateTimePicker($fieldName, $options = [])
{
$options = array_merge([
'div' => ['tag' => 'span'],
'dateInput' => [],
'dateDiv' => ['tag' => 'span'],
'dateLabel' => ['text' => '日付'],
'timeInput' => [],
'timeDiv' => ['tag' => 'span'],
'timeLabel' => ['text' => '時間'],
'id' => $this->_domId($fieldName),
'timeStep' => 30
], $options);
$dateOptions = array_merge($options, [
'type' => 'datepicker',
'div' => $options['dateDiv'],
'label' => $options['dateLabel'],
'autocomplete' => 'off',
'id' => $options['id'] . '-date',
], $options['dateInput']);
$timeOptions = array_merge($options, [
'type' => 'text',
'div' => $options['timeDiv'],
'label' => $options['timeLabel'],
'autocomplete' => 'off',
'size' => 8,
'maxlength' => 8,
'escape' => true,
'id' => $options['id'] . '-time',
'step' => $options['timeStep'],
], $options['timeInput']);
unset($options['dateDiv'], $options['dateLabel'], $options['timeDiv'], $options['timeLabel'], $options['dateInput'], $options['timeInput'], $options['timeStep']);
unset($dateOptions['dateDiv'], $dateOptions['dateLabel'], $dateOptions['timeDiv'], $dateOptions['timeLabel'], $dateOptions['dateInput'], $dateOptions['timeInput']);
unset($timeOptions['dateDiv'], $timeOptions['dateLabel'], $timeOptions['timeDiv'], $timeOptions['timeLabel'], $timeOptions['dateInput'], $timeOptions['timeInput']);
if (!isset($options['value'])) {
$value = $this->context()->val($fieldName);
} else {
$value = $options['value'];
unset($options['value']);
}
if ($value && $value != '0000-00-00 00:00:00') {
if (strpos($value, ' ') !== false) {
[$dateValue, $timeValue] = explode(' ', $value);
} else {
$dateValue = $value;
$timeValue = '00:00:00';
}
$dateOptions['value'] = $dateValue;
$timeOptions['value'] = $timeValue;
}
$step = $timeOptions['step'];
unset($timeOptions['step']);
$dateDivOptions = $timeDivOptions = $dateLabelOptions = $timeLabelOptions = null;
if (!empty($dateOptions['div'])) {
$dateDivOptions = $dateOptions['div'];
unset($dateOptions['div']);
}
if (!empty($timeOptions['div'])) {
$timeDivOptions = $timeOptions['div'];
unset($timeOptions['div']);
}
if (!empty($dateOptions['label'])) {
$dateLabelOptions = $dateOptions;
unset($dateOptions['type'], $dateOptions['label']);
}
if (!empty($timeOptions['label'])) {
$timeLabelOptions = $timeOptions;
unset($timeOptions['type'], $timeOptions['label']);
}
$dateTag = $this->datePicker($fieldName . '_date', $dateOptions);
if ($dateLabelOptions['label']) {
$dateTag = $this->_getLabel($fieldName, $dateLabelOptions) . $dateTag;
}
if ($dateDivOptions) {
$tag = 'div';
if (!empty($dateDivOptions['tag'])) {
$tag = $dateDivOptions['tag'];
unset($dateDivOptions['tag']);
}
$dateTag = $this->BcHtml->tag($tag, $dateTag, $dateDivOptions);
}
$timeTag = $this->text($fieldName . '_time', $timeOptions);
if ($timeLabelOptions['label']) {
$timeTag = $this->_getLabel($fieldName, $timeLabelOptions) . $timeTag;
}
if ($timeDivOptions) {
$tag = 'div';
if (!empty($timeDivOptions['tag'])) {
$tag = $timeDivOptions['tag'];
unset($timeDivOptions['tag']);
}
$timeTag = $this->BcHtml->tag($tag, $timeTag, $timeDivOptions);
}
$hiddenTag = $this->hidden($fieldName, ['value' => $value, 'id' => $options['id']]);
if ($this->formProtector) {
$this->unlockField($fieldName);
}
$script = <<< SCRIPT_END
<script>
$(function(){
var id = "{$options['id']}";
var time = $("#" + id + "-time");
var date = $("#" + id + "-date");
time.timepicker({ 'timeFormat': 'H:i', 'step': {$step} });
date.add(time).change(function(){
if(date.val() && !time.val()) {
time.val('00:00');
}
var value = date.val().replace(/\//g, '-');
if(time.val()) {
value += ' ' + time.val();
}
$("#" + id).val(value);
});
});
</script>
SCRIPT_END;
return $dateTag . $timeTag . $hiddenTag . $script;
}
/**
* Returns an HTML form element.
*
* ### Options:
*
* - `type` Form method defaults to autodetecting based on the form context. If
* the form context's isCreate() method returns false, a PUT request will be done.
* - `method` Set the form's method attribute explicitly.
* - `url` The URL the form submits to. Can be a string or a URL array.
* - `encoding` Set the accept-charset encoding for the form. Defaults to `Configure::read('App.encoding')`
* - `enctype` Set the form encoding explicitly. By default `type => file` will set `enctype`
* to `multipart/form-data`.
* - `templates` The templates you want to use for this form. Any templates will be merged on top of
* the already loaded templates. This option can either be a filename in /config that contains
* the templates you want to load, or an array of templates to use.
* - `context` Additional options for the context class. For example the EntityContext accepts a 'table'
* option that allows you to set the specific Table class the form should be based on.
* - `idPrefix` Prefix for generated ID attributes.
* - `valueSources` The sources that values should be read from. See FormHelper::setValueSources()
* - `templateVars` Provide template variables for the formStart template.
*
* @param mixed $context The context for which the form is being defined.
* Can be a ContextInterface instance, ORM entity, ORM resultset, or an
* array of meta data. You can use `null` to make a context-less form.
* @param array $options An array of html attributes and options.
* @return string An formatted opening FORM tag.
* @link https://book.cakephp.org/4/en/views/helpers/form.html#Cake\View\Helper\FormHelper::
* @checked
* @noTodo
* @unitTest
*/
public function create($context = null, $options = []): string
{
// CUSTOMIZE ADD 2014/07/03 ryuring
// ブラウザの妥当性のチェックを除外する
// >>>
$options = array_merge([
'novalidate' => true
], $options);
$formId = $this->setId($this->createId($context, $options));
// EVENT Form.beforeCreate
$event = $this->dispatchLayerEvent('beforeCreate', [
'id' => $formId,
'options' => $options
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$options = ($event->getResult() === null || $event->getResult() === true)? $event->getData('options') : $event->getResult();
}
// <<<
// 第１引数の $model が $context に変わった
// >>>
$out = parent::create($context, $options);
// <<<
// CUSTOMIZE ADD 2014/07/03 ryuring
// >>>
// EVENT Form.afterCreate
$event = $this->dispatchLayerEvent('afterCreate', [
'id' => $formId,
'out' => $out
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$out = ($event->getResult() === null || $event->getResult() === true)? $event->getData('out') : $event->getResult();
}
return $out;
// <<<
}
/**
* Closes an HTML form, cleans up values set by FormHelper::create(), and writes hidden
* input fields where appropriate.
*
* Resets some parts of the state, shared among multiple FormHelper::create() calls, to defaults.
*
* @param array $secureAttributes Secure attributes which will be passed as HTML attributes
* into the hidden input elements generated for the Security Component.
* @return string A closing FORM tag.
* @link https://book.cakephp.org/4/en/views/helpers/form.html#closing-the-form
* @checked
* @noTodo
* @unitTest
*/
public function end(array $secureAttributes = []): string
{
$formId = $this->getId();
$this->setId(null);
// EVENT Form.beforeEnd
$event = $this->dispatchLayerEvent('beforeEnd', [
'id' => $formId,
'secureAttributes' => $secureAttributes
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$secureAttributes = ($event->getResult() === null || $event->getResult() === true)? $event->getData('secureAttributes') : $event->getResult();
}
$out = parent::end($secureAttributes);
// EVENT Form.afterEnd
$event = $this->dispatchLayerEvent('afterEnd', [
'id' => $formId,
'out' => $out
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$out = ($event->getResult() === null || $event->getResult() === true)? $event->getData('out') : $event->getResult();
}
return $out;
}
/**
* Generates a form input element complete with label and wrapper div
*
* ### Options
*
* See each field type method for more information. Any options that are part of
* $attributes or $options for the different **type** methods can be included in `$options` for input().i
* Additionally, any unknown keys that are not in the list below, or part of the selected type's options
* will be treated as a regular html attribute for the generated input.
*
* - `type` - Force the type of widget you want. e.g. `type => 'select'`
* - `label` - Either a string label, or an array of options for the label. See FormHelper::label().
* - `div` - Either `false` to disable the div, or an array of options for the div.
* See HtmlHelper::div() for more options.
* - `options` - For widgets that take options e.g. radio, select.
* - `error` - Control the error message that is produced. Set to `false` to disable any kind of error reporting (field
* error and error messages).
* - `errorMessage` - Boolean to control rendering error messages (field error will still occur).
* - `empty` - String or boolean to enable empty select box options.
* - `before` - Content to place before the label + input.
* - `after` - Content to place after the label + input.
* - `between` - Content to place between the label + input.
* - `format` - Format template for element order. Any element that is not in the array, will not be in the output.
* - Default input format order: array('before', 'label', 'between', 'input', 'after', 'error')
* - Default checkbox format order: array('before', 'input', 'between', 'label', 'after', 'error')
* - Hidden input will not be formatted
* - Radio buttons cannot have the order of input and label elements controlled with these settings.
*
* @param string $fieldName This should be "Modelname.fieldname"
* @param array $options Each type of input takes different options.
* @return string Completed form widget.
* @link https://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#creating-form-elements
*/
public function input($fieldName, $options = [])
{
// CUSTOMIZE ADD 2014/07/03 ryuring
// >>>
// EVENT Form.beforeInput
$event = $this->dispatchLayerEvent('beforeInput', [
'formId' => $this->__id,
'data' => $this->getView()->getRequest()->getData(),
'fieldName' => $fieldName,
'options' => $options
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$options = ($event->getResult() === null || $event->getResult() === true)? $event->getData('options') : $event->getResult();
if (!$options) {
$options = [];
}
}
$type = '';
if (isset($options['type'])) {
$type = $options['type'];
}
if (!isset($options['error'])) {
$options['error'] = false;
}
$class = 'bca-hidden__input';
$divClass = 'bca-hidden';
$labelClass = $childDivClass = $label = '';
switch($type) {
default :
if (!isset($options['label'])) {
$options['label'] = false;
}
break;
case 'file':
$class = 'bca-file__input';
$divClass = 'bca-file';
if (!isset($options['label'])) {
$options['label'] = false;
}
$options = array_replace_recursive([
'link' => ['class' => 'bca-file__link'],
'class' => 'bca-file__input',
'div' => ['tag' => 'span', 'class' => 'bca-file'],
'deleteSpan' => ['class' => 'bca-file__delete'],
'deleteCheckbox' => ['class' => 'bca-file__delete-input'],
'deleteLabel' => ['class' => 'bca-file__delete-label'],
'figure' => ['class' => 'bca-file__figure'],
'img' => ['class' => 'bca-file__img'],
'figcaption' => ['class' => 'bca-file__figcaption']
], $options);
break;
case 'dateTimePicker':
$divClass = 'bca-datetimepicker';
$options['label'] = false;
$options = array_replace_recursive([
'dateInput' => ['class' => 'bca-datetimepicker__date-input'],
'dateDiv' => ['tag' => 'span', 'class' => 'bca-datetimepicker__date'],
'dateLabel' => ['text' => '日付', 'class' => 'bca-datetimepicker__date-label'],
'timeInput' => ['class' => 'bca-datetimepicker__time-input'],
'timeDiv' => ['tag' => 'span', 'class' => 'bca-datetimepicker__time'],
'timeLabel' => ['text' => '時間', 'class' => 'bca-datetimepicker__time-label']
], $options);
break;
case 'text':
case 'password':
case 'datePicker':
if (!isset($options['label'])) {
$options['label'] = false;
}
$class = 'bca-textbox__input';
$divClass = 'bca-textbox';
$labelClass = 'bca-textbox__label';
break;
case 'textarea':
if (!isset($options['label'])) {
$options['label'] = false;
}
$class = 'bca-textarea__textarea';
$divClass = 'bca-textarea';
break;
case 'checkbox':
if (!isset($options['label'])) {
$options['label'] = false;
}
$class = 'bca-checkbox__input';
$divClass = 'bca-checkbox';
$labelClass = 'bca-checkbox__label';
break;
case 'select':
if (!empty($options['multiple']) && $options['multiple'] === 'checkbox') {
$options['label'] = true;
$class = 'bca-checkbox__input';
$divClass = 'bca-checkbox-group';
$labelClass = 'bca-checkbox__label';
$childDivClass = 'bca-checkbox';
} else {
if (!isset($options['label'])) {
$options['label'] = false;
}
$class = 'bca-select__select';
$divClass = 'bca-select';
}
break;
case 'radio':
if (!isset($options['legend'])) {
$options['legend'] = false;
}
if (!isset($options['separator'])) {
$options['separator'] = ' ';
}
$options['label'] = true;
$class = 'bca-radio__input';
$divClass = 'bca-radio-group';
$labelClass = 'bca-radio__label';
$childDivClass = 'bca-radio';
break;
}
if (!isset($options['div'])) {
$options['div'] = ['tag' => 'span', 'class' => $divClass];
}
if (!isset($options['class'])) {
$options['class'] = $class;
}
if (!isset($options['label']['class'])) {
if (!empty($options['label'])) {
if ($options['label'] !== true) {
$options['label'] = ['text' => $options['label'], 'class' => $labelClass];
} else {
$options['label'] = ['class' => $labelClass];
}
}
}
if (!$type) {
unset($options['class']);
}
// <<<
$this->setEntity($fieldName);
$options = $this->_parseOptions($options);
$divOptions = $this->_divOptions($options);
// CUSTOMIZE MODIFY 2018/10/13 ryuring
// checkboxのdivを外せるオプションを追加
// >>>
//unset($options['div']);
// ---
if ($childDivClass && $options['div'] !== false) {
$options['div']['class'] = $childDivClass;
} elseif ($options['div'] !== false) {
unset($options['div']);
}
// <<<
if ($options['type'] === 'radio' && isset($options['options'])) {
$radioOptions = (array)$options['options'];
unset($options['options']);
} else {
$radioOptions = [];
}
// CUSTOMIZE MODIFY 2014/10/27 ryuring
// >>>
//$label = $this->_getLabel($fieldName, $options);
//if ($options['type'] !== 'radio') {
// ---
if ($options['type'] === 'checkbox' || (isset($options['multiple']) && $options['multiple'] === 'checkbox')) {
$label = '';
} else {
$label = $this->_getLabel($fieldName, $options);
}
if ($options['type'] !== 'radio' && $options['type'] !== 'checkbox' && (!isset($options['multiple']) || $options['multiple'] !== 'checkbox')) {
// <<<
unset($options['label']);
}
$error = $this->_extractOption('error', $options, null);
unset($options['error']);
$errorMessage = $this->_extractOption('errorMessage', $options, true);
unset($options['errorMessage']);
$selected = $this->_extractOption('selected', $options, null);
unset($options['selected']);
if ($options['type'] === 'datetime' || $options['type'] === 'date' || $options['type'] === 'time') {
$dateFormat = $this->_extractOption('dateFormat', $options, 'MDY');
$timeFormat = $this->_extractOption('timeFormat', $options, 12);
unset($options['dateFormat'], $options['timeFormat']);
} else {
$dateFormat = 'MDY';
$timeFormat = 12;
}
$type = $options['type'];
$out = ['before' => $options['before'], 'label' => $label, 'between' => $options['between'], 'after' => $options['after']];
$format = $this->_getFormat($options);
unset($options['type'], $options['before'], $options['between'], $options['after'], $options['format']);
$out['error'] = null;
if ($type !== 'hidden' && $error !== false) {
$errMsg = $this->error($fieldName, $error);
if ($errMsg) {
$divOptions = $this->addClass($divOptions, Hash::get($divOptions, 'errorClass', 'error'));
if ($errorMessage) {
$out['error'] = $errMsg;
}
}
}
if ($type === 'radio' && isset($out['between'])) {
$options['between'] = $out['between'];
$out['between'] = null;
}
$out['input'] = $this->_getInput(compact('type', 'fieldName', 'options', 'radioOptions', 'selected', 'dateFormat', 'timeFormat'));
$output = '';
foreach($format as $element) {
$output .= $out[$element];
}
if (!empty($divOptions['tag'])) {
$tag = $divOptions['tag'];
unset($divOptions['tag'], $divOptions['errorClass']);
$output = $this->Html->tag($tag, $output, $divOptions);
}
// CUSTOMIZE MODIFY 2014/07/03 ryuring
// >>>
// return $output;
// ---
// EVENT Form.afterInput
$event = $this->dispatchLayerEvent('afterInput', [
'formId' => $this->__id,
'data' => $this->request->getData(),
'fieldName' => $fieldName,
'out' => $output
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$output = ($event->getResult() === null || $event->getResult() === true)? $event->getData('out') : $event->getResult();
}
return $output;
// <<<
}
/**
* Creates a hidden input field.
*
* @param string $fieldName Name of a field, in the form of "Modelname.fieldname"
* @param array $options Array of HTML attributes.
* @return string A generated hidden input
* @link https://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::hidden
* @checked
* @noTodo
*/
public function hidden($fieldName, $options = []): string
{
$options += ['required' => false, 'secure' => true];
$secure = $options['secure'];
unset($options['secure']);
// CUSTOMIZE ADD 2010/07/24 ryuring
// セキュリティコンポーネントのトークン生成の仕様として、
// ・hiddenタグ以外はフィールド情報のみ
// ・hiddenタグはフィールド情報と値
// をキーとして生成するようになっている。
// その場合、生成の元のなる値は、multipleを想定されておらず、先頭の値のみとなるが
// multiple な hiddenタグの場合、送信される値は配列で送信されるので値違いで認証がとおらない。
// という事で、multiple の場合は、あくまでhiddenタグ以外のようにフィールド情報のみを
// トークンのキーとする事で認証を通すようにする。
// CUSTOMIZE ADD 2022/12/21 by ryuring
// CakePHP4になり、動作しなくなったため、unlockField を追加
// >>>
if (!empty($options['multiple'])) {
$secure = false;
$this->unlockField($fieldName);
}
// <<<
$options = $this->_initInputField($fieldName, array_merge(
$options,
['secure' => static::SECURE_SKIP]
));
if ($secure === true && $this->formProtector) {
$this->formProtector->addField(
$options['name'],
true,
$options['val'] === false? '0' : (string)$options['val']
);
}
$options['type'] = 'hidden';
// CUSTOMIZE ADD 2010/07/24 ryuring
// 配列用のhiddenタグを出力できるオプションを追加
// CUSTOMIZE 2010/08/01 ryuring
// class属性を指定できるようにした
// CUSTOMIZE 2011/03/11 ryuring
// multiple で送信する値が配列の添字となっていたので配列の値に変更した
// >>>
$multiple = false;
$value = '';
if (!empty($options['multiple'])) {
$multiple = true;
$options['id'] = null;
if (!isset($options['val'])) {
$value = $this->getSourceValue($fieldName);
} else {
$value = $options['val'];
}
if (is_array($value) && !$value) {
unset($options['val']);
}
unset($options['multiple']);
}
// <<<
// CUSTOMIZE MODIFY 2010/07/24 ryuring
// >>>
// return $this->widget('hidden', $options);
// ---
if ($multiple && is_array($value)) {
$out = [];
$options['name'] = $options['name'] . '[]';
foreach($value as $v) {
$options['val'] = $v;
$out[] = $this->widget('hidden', $options);;
}
return implode("\n", $out);
} else {
return $this->widget('hidden', $options);
}
// <<<
}
/**
* Creates a submit button element. This method will generate `<input />` elements that
* can be used to submit, and reset forms by using $options. image submits can be created by supplying an
* image path for $caption.
*
* ### Options
*
* - `div` - Include a wrapping div? Defaults to true. Accepts sub options similar to
* FormHelper::input().
* - `before` - Content to include before the input.
* - `after` - Content to include after the input.
* - `type` - Set to 'reset' for reset inputs. Defaults to 'submit'
* - `confirm` - JavaScript confirmation message.
* - Other attributes will be assigned to the input element.
*
* ### Options
*
* - `div` - Include a wrapping div? Defaults to true. Accepts sub options similar to
* FormHelper::input().
* - Other attributes will be assigned to the input element.
*
* @param string $caption The label appearing on the button OR if string contains :// or the
* extension .jpg, .jpe, .jpeg, .gif, .png use an image if the extension
* exists, AND the first character is /, image is relative to webroot,
* OR if the first character is not /, image is relative to webroot/img.
* @param array $options Array of options. See above.
* @return string A HTML submit button
* @link https://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::submit
* @checked
* @noTodo
* @unitTest
*/
public function submit(string $caption = null, array $options = []): string
{
// CUSTOMIZE ADD 2016/06/08 ryuring
// >>>
// EVENT Form.beforeSubmit
$event = $this->dispatchLayerEvent('beforeSubmit', [
'id' => $this->getId(),
'caption' => $caption,
'options' => $options
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$options = ($event->getResult() === null || $event->getResult() === true)? $event->getData('options') : $event->getResult();
}
$output = parent::submit($caption, $options);
// EVENT Form.afterSubmit
$event = $this->dispatchLayerEvent('afterSubmit', [
'id' => $this->getId(),
'caption' => $caption,
'out' => $output
], ['class' => 'Form', 'plugin' => '']);
if ($event !== false) {
$output = ($event->getResult() === null || $event->getResult() === true)? $event->getData('out') : $event->getResult();
}
return $output;
// <<<
}
/**
* Returns an array of formatted OPTION/OPTGROUP elements
*
* @param array $elements Elements to format.
* @param array $parents Parents for OPTGROUP.
* @param bool $showParents Whether to show parents.
* @param array $attributes HTML attributes.
* @return array
*/
protected function _selectOptions($elements = [], $parents = [], $showParents = null, $attributes = [])
{
$select = [];
$attributes = array_merge(
['escape' => true, 'style' => null, 'value' => null, 'class' => null],
$attributes
);
$selectedIsEmpty = ($attributes['value'] === '' || $attributes['value'] === null);
$selectedIsArray = is_array($attributes['value']);
// Cast boolean false into an integer so string comparisons can work.
if ($attributes['value'] === false) {
$attributes['value'] = 0;
}
$this->_domIdSuffixes = [];
foreach($elements as $name => $title) {
$htmlOptions = [];
if (is_array($title) && (!isset($title['name']) || !isset($title['value']))) {
if (!empty($name)) {
if ($attributes['style'] === 'checkbox') {
$select[] = $this->Html->useTag('fieldsetend');
} else {
$select[] = $this->Html->useTag('optiongroupend');
}
$parents[] = (string)$name;
}
$select = array_merge($select, $this->_selectOptions(
$title, $parents, $showParents, $attributes
));
if (!empty($name)) {
$name = $attributes['escape']? h($name) : $name;
if ($attributes['style'] === 'checkbox') {
$select[] = $this->Html->useTag('fieldsetstart', $name);
} else {
$select[] = $this->Html->useTag('optiongroup', $name, '');
}
}
$name = null;
} elseif (is_array($title)) {
$htmlOptions = $title;
$name = $title['value'];
$title = $title['name'];
unset($htmlOptions['name'], $htmlOptions['value']);
}
if ($name !== null) {
$isNumeric = is_numeric($name);
if ((!$selectedIsArray && !$selectedIsEmpty && (string)$attributes['value'] == (string)$name) ||
($selectedIsArray && in_array((string)$name, $attributes['value'], !$isNumeric))
) {
if ($attributes['style'] === 'checkbox') {
$htmlOptions['checked'] = true;
} else {
$htmlOptions['selected'] = 'selected';
}
}
if ($showParents || (!in_array($title, $parents))) {
$title = ($attributes['escape'])? h($title) : $title;
$hasDisabled = !empty($attributes['disabled']);
if ($hasDisabled) {
$disabledIsArray = is_array($attributes['disabled']);
if ($disabledIsArray) {
$disabledIsNumeric = is_numeric($name);
}
}
if ($hasDisabled &&
$disabledIsArray &&
in_array((string)$name, $attributes['disabled'], !$disabledIsNumeric)
) {
$htmlOptions['disabled'] = 'disabled';
}
if ($hasDisabled && !$disabledIsArray && $attributes['style'] === 'checkbox') {
$htmlOptions['disabled'] = $attributes['disabled'] === true? 'disabled' : $attributes['disabled'];
}
if ($attributes['style'] === 'checkbox') {
$htmlOptions['value'] = $name;
$tagName = $attributes['id'] . $this->domIdSuffix($name, 'html5');
$htmlOptions['id'] = $tagName;
$label = ['for' => $tagName];
if (isset($htmlOptions['checked']) && $htmlOptions['checked'] === true) {
$label['class'] = 'selected';
}
$name = $attributes['name'];
if (empty($attributes['class'])) {
$attributes['class'] = 'checkbox';
} elseif ($attributes['class'] === 'form-error') {
$attributes['class'] = 'checkbox ' . $attributes['class'];
}
// CUSTOMIZE MODIFY 2014/02/24 ryuring
// checkboxのdivを外せるオプションを追加
// CUSTOMIZE MODIFY 2014/10/27 ryuring
// チェックボックスをラベルタグで囲う仕様に変更した
// CUSTOMIZE MODIFY 2017/2/19 ryuring
// チェックボックスをラベルタグで囲わない仕様に変更した