Passed
Push — master ( 0c230a...202965 )
by Michael
02:53
created

ClassXoopsCode::getClassXoopsFormSelect()   A

Complexity

Conditions 4
Paths 8

Size

Total Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
nc 8
nop 8
dl 0
loc 12
rs 9.8666
c 0
b 0
f 0

How to fix   Many Parameters   

Many Parameters

Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.

There are several approaches to avoid long parameter lists:

1
<?php
2
3
/*
4
 You may not change or alter any portion of this comment or credits
5
 of supporting developers from this source code or any supporting source code
6
 which is considered copyrighted (c) material of the original comment or credit authors.
7
8
 This program is distributed in the hope that it will be useful,
9
 but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11
 */
12
/**
13
 * tdmcreate module.
14
 *
15
 * @copyright       XOOPS Project (https://xoops.org)
16
 * @license         GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
17
 *
18
 * @since           2.5.0
19
 *
20
 * @author          Txmod Xoops http://www.txmodxoops.org
21
 *
22
 * @version         $Id: ClassXoopsCode.php 12258 2014-01-02 09:33:29Z timgno $
23
 */
24
25
/**
26
 * Class ClassXoopsCode.
27
 */
28
class ClassXoopsCode
29
{
30
    /*
31
    *  @static function getInstance
32
    *  @param null
33
    */
34
35
    /**
36
     * @return ClassXoopsCode
37
     */
38
    public static function getInstance()
39
    {
40
        static $instance = false;
41
        if (!$instance) {
42
            $instance = new self();
43
        }
44
45
        return $instance;
46
    }
47
48
    /**
49
     * @public function getClassCriteriaCompo
50
     *
51
     * @param        $var
52
     * @param string $t
53
     *
54
     * @return string
55
     */
56
    public function getClassCriteriaCompo($var, $t = '')
57
    {
58
        return "{$t}\${$var} = new CriteriaCompo();\n";
59
    }
60
61
    /**
62
     * @public function getClassCriteria
63
     *
64
     * @param        $var
65
     * @param        $param1
66
     * @param string $param2
67
     * @param string $param3
68
     * @param bool   $isParam
69
     * @param string $t
70
     *
71
     * @return string
72
     */
73
    public function getClassCriteria($var, $param1, $param2 = '', $param3 = '', $isParam = false, $t = '')
74
    {
75
        $params = ('' != $param2) ? ', ' . $param2 : '';
76
        $params .= ('' != $param3) ? ', ' . $param3 : '';
77
78
        if (false === $isParam) {
79
            $ret = "{$t}\${$var} = new Criteria( {$param1}{$params} );\n";
80
        } else {
81
            $ret = "new Criteria( {$param1}{$params} )";
82
        }
83
84
        return $ret;
85
    }
86
87
    /**
88
     * @public function getClassAdd
89
     *
90
     * @param        $var
91
     * @param        $param
92
     * @param string $t
93
     *
94
     * @return string
95
     */
96
    public function getClassAdd($var, $param, $t = '')
97
    {
98
        return "{$t}\${$var}->add( {$param} );\n";
99
    }
100
101
    /**
102
     * @public function getClassSetStart
103
     *
104
     * @param        $var
105
     * @param        $start
106
     * @param string $t
107
     *
108
     * @return string
109
     */
110
    public function getClassSetStart($var, $start, $t = '')
111
    {
112
        return "{$t}\${$var}->setStart( \${$start} );\n";
113
    }
114
115
    /**
116
     * @public function getClassSetLimit
117
     *
118
     * @param        $var
119
     * @param        $limit
120
     * @param string $t
121
     *
122
     * @return string
123
     */
124
    public function getClassSetLimit($var, $limit, $t = '')
125
    {
126
        return "{$t}\${$var}->setLimit( \${$limit} );\n";
127
    }
128
129
    /**
130
     * @public function getClassAdd
131
     *
132
     * @param        $var
133
     * @param        $sort
134
     * @param string $t
135
     *
136
     * @return string
137
     */
138
    public function getClassSetSort($var, $sort, $t = '')
139
    {
140
        return "{$t}\${$var}->setSort( \${$sort} );\n";
141
    }
142
143
    /**
144
     * @public function getClassAdd
145
     *
146
     * @param        $var
147
     * @param        $order
148
     * @param string $t
149
     *
150
     * @return string
151
     */
152
    public function getClassSetOrder($var, $order, $t = '')
153
    {
154
        return "{$t}\${$var}->setOrder( \${$order} );\n";
155
    }
156
157
    /**
158
     * @public function getClassAdd
159
     *
160
     * @param string $paramLeft
161
     * @param string $paramRight
162
     * @param string $var
163
     * @param string $t
164
     *
165
     * @return string
166
     */
167
    public function getClassInitVar($paramLeft = '', $paramRight = '', $var = 'this', $t = "\t\t")
168
    {
169
        $stuParamRight = mb_strtoupper($paramRight);
170
171
        return "{$t}\${$var}->initVar('{$paramLeft}', XOBJ_DTYPE_{$stuParamRight});\n";
172
    }
173
174
    /**
175
     * @public function getClassXoopsPageNav
176
     *
177
     * @param        $var
178
     * @param        $param1
179
     * @param null   $param2
180
     * @param null   $param3
181
     * @param null   $param4
182
     * @param null   $param5
183
     * @param bool   $isParam
184
     * @param string $t
185
     *
186
     * @return string
187
     */
188
    public function getClassXoopsPageNav($var, $param1, $param2 = null, $param3 = null, $param4 = null, $param5 = null, $isParam = false, $t = '')
189
    {
190
        $xPageNav = 'new XoopsPageNav(';
191
        if (false === $isParam) {
192
            $ret = "{$t}\${$var} = {$xPageNav}\${$param1}, \${$param2}, \${$param3}, '{$param4}', {$param5});\n";
193
        } else {
194
            $ret = "{$xPageNav}\${$param1}, \${$param2}, \${$param3}, '{$param4}', {$param5})";
195
        }
196
197
        return $ret;
198
    }
199
200
    /**
201
     *  @public function getXoopsSimpleForm
202
     *
203
     * @param string $left
204
     * @param string $element
205
     * @param string $elementsContent
206
     * @param string $caption
207
     * @param string $var
208
     * @param string $filename
209
     * @param string $type
210
     * @param string $t
211
     *
212
     * @return string
213
     */
214
    public function getXoopsSimpleForm($left = '', $element = '', $elementsContent = '', $caption = '', $var = '', $filename = '', $type = 'post', $t = '')
215
    {
216
        $ret = "{$t}\${$left} = new XoopsSimpleForm({$caption}, '{$var}', '{$filename}.php', '{$type}');\n";
217
        if (!empty($elementsContent)) {
218
            $ret .= "{$elementsContent}";
219
        }
220
        $ret .= "{$t}\${$left}->addElement(\${$element});\n";
221
        $ret .= "{$t}\${$left}->display();\n";
222
223
        return $ret;
224
    }
225
226
    /**
227
     * @public function getClassXoopsThemeForm
228
     *
229
     * @param        $var
230
     * @param        $param1
231
     * @param null   $param2
232
     * @param null   $param3
233
     * @param null   $param4
234
     * @param bool   $isParam
235
     * @param string $t
236
     *
237
     * @return string
238
     */
239
    public function getClassXoopsThemeForm($var, $param1, $param2 = null, $param3 = null, $param4 = null, $isParam = false, $t = "\t\t")
240
    {
241
        $themeForm = 'new XoopsThemeForm(';
242
        if (false === $isParam) {
243
            $ret = "{$t}\${$var} = {$themeForm}\${$param1}, '{$param2}', \${$param3}, '{$param4}', true);\n";
244
        } else {
245
            $ret = "{$themeForm}\${$param1}, '{$param2}', \${$param3}, '{$param4}', true)";
246
        }
247
248
        return $ret;
249
    }
250
251
    /**
252
     * @public function XoopsFormElementTray
253
     *
254
     * @param        $var
255
     * @param        $param1
256
     * @param string $param2
257
     * @param string $t
258
     *
259
     * @return string
260
     */
261
    public function getClassXoopsFormElementTray($var, $param1, $param2 = '', $t = "\t\t")
262
    {
263
        return "{$t}\${$var} = new XoopsFormElementTray({$param1}, '{$param2}' );\n";
264
    }
265
266
    /**
267
     * @public function getClassXoopsFormLabel
268
     *
269
     * @param        $var
270
     * @param string $param1
271
     * @param null   $param2
272
     * @param bool   $isParam
273
     * @param string $t
274
     *
275
     * @return string
276
     */
277
    public function getClassXoopsFormLabel($var, $param1 = '', $param2 = null, $isParam = false, $t = "\t\t")
278
    {
279
        $label = 'new XoopsFormLabel(';
280
        $params = null != $param2 ? "{$param1}, {$param2}" : $param1;
281
        if (false === $isParam) {
282
            $ret = "{$t}\${$var} = {$label}{$params});\n";
283
        } else {
284
            $ret = "{$label}{$params})";
285
        }
286
287
        return $ret;
288
    }
289
290
    /**
291
     * @public function getClassXoopsFormFile
292
     *
293
     * @param        $var
294
     * @param        $param1
295
     * @param        $param2
296
     * @param        $param3
297
     * @param bool   $isParam
298
     * @param string $t
299
     *
300
     * @return string
301
     */
302
    public function getClassXoopsFormFile($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
303
    {
304
        $file = 'new XoopsFormFile( ';
305
        if (false === $isParam) {
306
            $ret = "{$t}\${$var} = {$file}{$param1}, '{$param2}', {$param3} );\n";
307
        } else {
308
            $ret = "{$file}{$param1}, '{$param2}', {$param3} )";
309
        }
310
311
        return $ret;
312
    }
313
314
    /**
315
     * @public function getClassXoopsFormHidden
316
     *
317
     * @param        $var
318
     * @param        $param1
319
     * @param        $param2
320
     * @param bool   $isForm
321
     * @param bool   $isParam
322
     * @param string $t
323
     *
324
     * @return string
325
     */
326
    public function getClassXoopsFormHidden($var, $param1, $param2, $isForm = false, $isParam = false, $t = "\t\t")
327
    {
328
        $hidden = 'new XoopsFormHidden( ';
329
        $getVarHidden = TDMCreateXoopsCode::getInstance()->getXcGetVar('', 'this', $param2, true);
330
        $ret = '';
331
        if (false === $isParam) {
332
            $ret .= "{$t}\${$var} = {$hidden}{$param1}, {$getVarHidden} );\n";
333
        } else {
334
            if (false === $isForm) {
335
                $ret .= "{$hidden}{$param1}, {$param2} )";
336
            } else {
337
                $ret .= "{$hidden}'{$param1}', '{$param2}' )";
338
            }
339
        }
340
341
        return $ret;
342
    }
343
344
    /**
345
     * @public function getClassXoopsFormText
346
     *
347
     * @param        $var
348
     * @param        $param1
349
     * @param        $param2
350
     * @param int    $param3
351
     * @param int    $param4
352
     * @param        $param5
353
     * @param bool   $isParam
354
     * @param string $t
355
     *
356
     * @return string
357
     */
358
    public function getClassXoopsFormText($var, $param1, $param2, $param3, $param4, $param5, $isParam = false, $t = "\t\t")
359
    {
360
        $text = 'new XoopsFormText( ';
361
        if (false === $isParam) {
362
            $ret = "{$t}\${$var} = {$text}{$param1}, '{$param2}', {$param3}, {$param4}, \${$param5} );\n";
363
        } else {
364
            $ret = "{$text}{$param1}, '{$param2}', {$param3}, {$param4}, \${$param5} )";
365
        }
366
367
        return $ret;
368
    }
369
370
    /**
371
     * @public function getClassXoopsFormTextArea
372
     *
373
     * @param        $var
374
     * @param        $param1
375
     * @param        $param2
376
     * @param        $param3
377
     * @param        $param4
378
     * @param bool   $isParam
379
     * @param string $t
380
     *
381
     * @return string
382
     */
383
    public function getClassXoopsFormTextArea($var, $param1, $param2, $param3, $param4, $isParam = false, $t = "\t\t")
384
    {
385
        $area = 'new XoopsFormTextArea( ';
386
        $getVarTextArea = TDMCreateXoopsCode::getInstance()->getXcGetVar('', 'this', $param2, true);
387
        if (false === $isParam) {
388
            $ret = "{$t}\${$var} = {$area}{$param1}, '{$param2}', {$getVarTextArea}, {$param3}, {$param4} );\n";
389
        } else {
390
            $ret = "{$area}{$param1}, '{$param2}', {$getVarTextArea}, {$param3}, {$param4} )";
391
        }
392
393
        return $ret;
394
    }
395
396
    /**
397
     * @public function getClassXoopsFormColorPicker
398
     *
399
     * @param        $var
400
     * @param        $param1
401
     * @param        $param2
402
     * @param        $param3
403
     * @param bool   $isParam
404
     * @param string $t
405
     *
406
     * @return string
407
     */
408
    public function getClassXoopsFormColorPicker($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
409
    {
410
        $picker = 'new XoopsFormColorPicker( ';
411
        if (false === $isParam) {
412
            $ret = "{$t}\${$var} = {$picker}{$param1}, '{$param2}', {$param3} );\n";
413
        } else {
414
            $ret = "{$picker}{$param1}, '{$param2}', {$param3} )";
415
        }
416
417
        return $ret;
418
    }
419
420
    /**
421
     * @public function getClassXoopsFormSelectUser
422
     *
423
     * @param        $var
424
     * @param        $param1
425
     * @param        $param2
426
     * @param string $param3
427
     * @param        $param4
428
     * @param bool   $isParam
429
     * @param string $t
430
     *
431
     * @return string
432
     */
433
    public function getClassXoopsFormSelectUser($var, $param1, $param2, $param3, $param4, $isParam = false, $t = "\t\t")
434
    {
435
        $user = 'new XoopsFormSelectUser( ';
436
        $getVarSelectUser = TDMCreateXoopsCode::getInstance()->getXcGetVar('', 'this', $param4, true);
437
        if (false === $isParam) {
438
            $ret = "{$t}\${$var} = {$user}{$param1}, '{$param2}', {$param3}, {$getVarSelectUser} );\n";
439
        } else {
440
            $ret = "{$user}{$param1}, '{$param2}', {$param3}, {$getVarSelectUser} )";
441
        }
442
443
        return $ret;
444
    }
445
446
    /**
447
     * @public function getClassXoopsFormTextDateSelect
448
     *
449
     * @param        $var
450
     * @param        $param1
451
     * @param        $param2
452
     * @param string $param3
453
     * @param        $param4
454
     * @param bool   $isParam
455
     * @param string $t
456
     *
457
     * @return string
458
     */
459
    public function getClassXoopsFormTextDateSelect($var, $param1, $param2, $param3, $param4, $isParam = false, $t = "\t\t")
460
    {
461
        $tdate = 'new XoopsFormTextDateSelect( ';
462
        $getVarTextDateSelect = TDMCreateXoopsCode::getInstance()->getXcGetVar('', 'this', $param3, true);
463
        if (false === $isParam) {
464
            $ret = "{$t}\${$var} = {$tdate}{$param1}, '{$param2}', '', {$getVarTextDateSelect} );\n";
465
        } else {
466
            $ret = "{$tdate}{$param1}, '{$param2}', '', \${$param4} )";
467
        }
468
469
        return $ret;
470
    }
471
472
    /**
473
     * @public function getClassXoopsFormEditor
474
     *
475
     * @param        $var
476
     * @param        $param1
477
     * @param        $param2
478
     * @param        $param3
479
     * @param bool   $isParam
480
     * @param string $t
481
     *
482
     * @return string
483
     */
484
    public function getClassXoopsFormEditor($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
485
    {
486
        $editor = 'new XoopsFormEditor( ';
487
        if (false === $isParam) {
488
            $ret = "{$t}\${$var} = {$editor}{$param1}, '{$param2}', \${$param3});\n";
489
        } else {
490
            $ret = "{$editor}{$param1}, '{$param2}', \${$param3})";
491
        }
492
493
        return $ret;
494
    }
495
496
    /**
497
     * @public function getClassXoopsFormCheckBox
498
     *
499
     * @param        $var
500
     * @param        $param1
501
     * @param        $param2
502
     * @param        $param3
503
     * @param bool   $isParam
504
     * @param string $t
505
     *
506
     * @return string
507
     */
508
    public function getClassXoopsFormCheckBox($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
509
    {
510
        $checkBox = 'new XoopsFormCheckBox( ';
511
        if (false === $isParam) {
512
            $ret = "{$t}\${$var} = {$checkBox}{$param1}, '{$param2}', {$param3});\n";
513
        } else {
514
            $ret = "{$checkBox}{$param1}, '{$param2}', {$param3})";
515
        }
516
517
        return $ret;
518
    }
519
520
    /**
521
     * @public function getClassXoopsFormRadioYN
522
     *
523
     * @param        $var
524
     * @param        $param1
525
     * @param        $param2
526
     * @param        $param3
527
     * @param bool   $isParam
528
     * @param string $t
529
     *
530
     * @return string
531
     */
532
    public function getClassXoopsFormRadioYN($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
533
    {
534
        $radioYN = 'new XoopsFormRadioYN( ';
535
        if (false === $isParam) {
536
            $ret = "{$t}\${$var} = {$radioYN}{$param1}, '{$param2}', \${$param3});\n";
537
        } else {
538
            $ret = "{$radioYN}{$param1}, '{$param2}', \${$param3})";
539
        }
540
541
        return $ret;
542
    }
543
544
    /**
545
     * @public function getClassXoopsFormSelect
546
     *
547
     * @param        $var
548
     * @param        $param1
549
     * @param        $param2
550
     * @param        $param3
551
     * @param null   $param4
552
     * @param null   $param5
553
     * @param bool   $isParam
554
     * @param string $t
555
     *
556
     * @return string
557
     */
558
    public function getClassXoopsFormSelect($var, $param1, $param2, $param3, $param4 = null, $param5 = null, $isParam = false, $t = "\t\t")
559
    {
560
        $otherParam = null != $param4 ? ", {$param4}" : (null != $param5 ? ", {$param5}" : '');
561
        $select = 'new XoopsFormSelect( ';
562
        if (false === $isParam) {
563
            $ret = "{$t}\${$var} = {$select}{$param1}, '{$param2}', \${$param3}{$otherParam});\n";
564
        } else {
565
            $ret = "{$select}{$param1}, '{$param2}', \${$param3}{$otherParam})";
566
        }
567
568
        return $ret;
569
    }
570
571
    /**
572
     * @public function getClassXoopsFormTag
573
     *
574
     * @param        $var
575
     * @param        $param1
576
     * @param        $param2
577
     * @param        $param3
578
     * @param        $param4
579
     * @param int    $param5
580
     * @param bool   $isParam
581
     * @param string $t
582
     *
583
     * @return string
584
     */
585
    public function getClassXoopsFormTag($var, $param1, $param2, $param3, $param4, $param5 = 0, $isParam = false, $t = "\t\t")
586
    {
587
        $tag = 'new XoopsFormTag( ';
588
        if (false === $isParam) {
589
            $ret = "{$t}\${$var} = {$tag}'{$param1}', {$param2}, {$param3}, \${$param4}, {$param5} );\n";
590
        } else {
591
            $ret = "{$tag}'{$param1}', {$param2}, {$param3}, \${$param4}, {$param5} )";
592
        }
593
594
        return $ret;
595
    }
596
597
    /**
598
     * @public function getClassXoopsFormButton
599
     *
600
     * @param        $var
601
     * @param        $param1
602
     * @param        $param2
603
     * @param        $param3
604
     * @param        $param4
605
     * @param bool   $isParam
606
     * @param string $t
607
     *
608
     * @return string
609
     */
610
    public function getClassXoopsFormButton($var, $param1, $param2, $param3, $param4, $isParam = false, $t = "\t\t")
611
    {
612
        $button = 'new XoopsFormButton( ';
613
        if (false === $isParam) {
614
            $ret = "{$t}\${$var} = {$button}'{$param1}', '{$param2}', {$param3}, '{$param4}');\n";
615
        } else {
616
            $ret = "{$button}'{$param1}', '{$param2}', {$param3}, '{$param4}')";
617
        }
618
619
        return $ret;
620
    }
621
622
    /**
623
     * @public   function getClassXoopsObjectTree
624
     *
625
     * @param string $var
626
     * @param        $param1
627
     * @param        $param2
628
     * @param        $param3
629
     * @param string $t
630
     *
631
     * @return string
632
     */
633
    public function getClassXoopsObjectTree($var, $param1, $param2, $param3, $t = '')
634
    {
635
        $ret = "{$t}\${$var} = new XoopsObjectTree(\${$param1}, '{$param2}', '{$param3}');\n";
636
637
        return $ret;
638
    }
639
640
    /**
641
     * @public function getClassXoopsMakeSelBox
642
     *
643
     * @param        $var
644
     * @param        $anchor
645
     * @param        $param1
646
     * @param        $param2
647
     * @param string $param3
648
     * @param        $param4
649
     * @param string $t
650
     *
651
     * @return string
652
     */
653
    public function getClassXoopsMakeSelBox($var, $anchor, $param1, $param2, $param3, $param4, $t = '')
654
    {
655
        $getVar = TDMCreateXoopsCode::getInstance()->getXcGetVar('', 'this', $param4, true);
656
        $ret = "{$t}\${$var} = \${$anchor}->makeSelBox( '{$param1}', '{$param2}', '{$param3}', {$getVar}, true );\n";
657
658
        return $ret;
659
    }
660
661
    /**
662
     * @public function getClassAddOption
663
     *
664
     * @param        $var
665
     * @param        $params
666
     * @param string $t
667
     *
668
     * @return string
669
     */
670
    public function getClassAddOption($var, $params, $t = "\t\t")
671
    {
672
        return "{$t}\${$var}->addOption({$params});\n";
673
    }
674
675
    /**
676
     * @public function getClassAddOptionArray
677
     *
678
     * @param        $var
679
     * @param        $params
680
     * @param string $t
681
     *
682
     * @return string
683
     */
684
    public function getClassAddOptionArray($var, $params, $t = "\t\t")
685
    {
686
        return "{$t}\${$var}->addOptionArray({$params});\n";
687
    }
688
689
    /**
690
     * @public function getClassAddElement
691
     *
692
     * @param string $var
693
     * @param string $params
694
     * @param string $t
695
     *
696
     * @return string
697
     */
698
    public function getClassAddElement($var = '', $params = '', $t = "\t\t")
699
    {
700
        return "{$t}\${$var}->addElement({$params});\n";
701
    }
702
703
    /**
704
     * @public function getClassSetDescription
705
     *
706
     * @param        $var
707
     * @param        $params
708
     * @param string $t
709
     *
710
     * @return string
711
     */
712
    public function getClassSetDescription($var, $params, $t = "\t\t")
713
    {
714
        return "{$t}\${$var}->setDescription({$params});\n";
715
    }
716
717
    /**
718
     * @public function getClassSetExtra
719
     *
720
     * @param        $var
721
     * @param        $params
722
     * @param string $t
723
     *
724
     * @return string
725
     */
726
    public function getClassSetExtra($var, $params, $t = "\t\t")
727
    {
728
        return "{$t}\${$var}->setExtra({$params});\n";
729
    }
730
}
731