Completed
Push — master ( a8ea98...cecb98 )
by Gino
06:23 queued 03:11
created

ClassXoopsCode::getXoopsSimpleForm()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 11
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 11
rs 9.4285
cc 2
eloc 7
nc 2
nop 8

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       The XOOPS Project http://sourceforge.net/projects/xoops/
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
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

You can fix this by adding a namespace to your class:

namespace YourVendor;

class YourClass { }

When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.

Loading history...
29
{
30
    /*
31
    * @var mixed
32
    */
33
    private $phpcode = null;
34
35
    /*
36
    * @var mixed
37
    */
38
    private $xoopscode = null;
39
40
    /*
41
    *  @public function constructor
42
    *  @param null
43
    */
44
    /**
45
     *
46
     */
47
    public function __construct()
48
    {
49
        $this->phpcode = TDMCreatePhpCode::getInstance();
50
        $this->xoopscode = TDMCreateXoopsCode::getInstance();
51
    }
52
53
    /*
54
    *  @static function &getInstance
55
    *  @param null
56
    */
57
    /**
58
     * @return ClassXoopsCode
59
     */
60
    public static function &getInstance()
61
    {
62
        static $instance = false;
63
        if (!$instance) {
64
            $instance = new self();
65
        }
66
67
        return $instance;
68
    }
69
70
    /*
71
     * @public function getClassCriteriaCompo
72
     * @param $var
73
     *  
74
     * @return string
75
     */
76
    public function getClassCriteriaCompo($var, $t = '')
77
    {
78
        return "{$t}\${$var} = new CriteriaCompo();\n";
79
    }
80
81
    /*
82
     * @public function getClassCriteria
83
     * @param $var
84
     * @param $param1
85
     * @param $param2
86
     * @param $param3
87
     *  
88
     * @return string
89
     */
90
    public function getClassCriteria($var, $param1, $param2 = '', $param3 = '', $isParam = false, $t = '')
91
    {
92
        $params = ($param2 != '') ? ', '.$param2 : '';
93
        $params .= ($param3 != '') ? ', '.$param3 : '';
94
95
        if ($isParam === false) {
96
            $ret = "{$t}\${$var} = new Criteria( {$param1}{$params} );\n";
97
        } else {
98
            $ret = "new Criteria( {$param1}{$params} )";
99
        }
100
101
        return $ret;
102
    }
103
104
    /*
105
     * @public function getClassAdd
106
     * @param $var
107
     * @param $param
108
     *  
109
     * @return string
110
     */
111
    public function getClassAdd($var, $param, $t = '')
112
    {
113
        return "{$t}\${$var}->add( {$param} );\n";
114
    }
115
116
    /*
117
     * @public function getClassSetStart
118
     * @param $var
119
     * @param $start
120
     *  
121
     * @return string
122
     */
123
    public function getClassSetStart($var, $start, $t = '')
124
    {
125
        return "{$t}\${$var}->setStart( \${$start} );\n";
126
    }
127
128
    /*
129
     * @public function getClassSetLimit
130
     * @param $var
131
     * @param $limit
132
     *  
133
     * @return string
134
     */
135
    public function getClassSetLimit($var, $limit, $t = '')
136
    {
137
        return "{$t}\${$var}->setLimit( \${$limit} );\n";
138
    }
139
140
    /*
141
     * @public function getClassAdd
142
     * @param $var
143
     * @param $sort
144
     *  
145
     * @return string
146
     */
147
    public function getClassSetSort($var, $sort, $t = '')
148
    {
149
        return "{$t}\${$var}->setSort( \${$sort} );\n";
150
    }
151
152
    /*
153
     * @public function getClassAdd
154
     * @param $var
155
     * @param $order
156
     *  
157
     * @return string
158
     */
159
    public function getClassSetOrder($var, $order, $t = '')
160
    {
161
        return "{$t}\${$var}->setOrder( \${$order} );\n";
162
    }
163
164
    /*
165
     * @public function getClassAdd
166
     * @param $paramLeft
167
     * @param $paramRight
168
     * @param $var
169
     * @param $t = Indentation
170
     *  
171
     * @return string
172
     */
173
    public function getClassInitVar($paramLeft = '', $paramRight = '', $var = 'this', $t = "\t\t")
174
    {
175
        $stuParamRight = strtoupper($paramRight);
176
177
        return "{$t}\${$var}->initVar('{$paramLeft}', XOBJ_DTYPE_{$stuParamRight});\n";
178
    }
179
180
    /*
181
    *  @public function getXoopsSimpleForm
182
    *  @param $left
183
    *  @param $element
184
    *  @param $elementsContent
185
    *  @param $caption
186
    *  @param $var
187
    *  @param $filename
188
    *  @param $type
189
    *  
190
    *  @return string
191
    */
192
    public function getXoopsSimpleForm($left = '', $element = '', $elementsContent = '', $caption = '', $var = '', $filename = '', $type = 'post', $t = '')
193
    {
194
        $ret = "{$t}\${$left} = new XoopsSimpleForm({$caption}, '{$var}', '{$filename}.php', '{$type}');\n";
195
        if (!empty($elementsContent)) {
196
            $ret .= "{$elementsContent}";
197
        }
198
        $ret .= "{$t}\${$left}->addElement(\${$element});\n";
199
        $ret .= "{$t}\${$left}->display();\n";
200
201
        return $ret;
202
    }
203
204
    /*
205
     * @public function getClassXoopsThemeForm
206
     * @param $var
207
     * @param $param1
208
     * @param $param2
209
     * @param $param3
210
     * @param $param4
211
     * @param $isParam
212
     * @param $t = Indentation
213
     *  
214
     * @return string
215
     */
216
    public function getClassXoopsThemeForm($var, $param1, $param2 = null, $param3 = null, $param4 = null, $isParam = false, $t = "\t\t")
217
    {
218
        $themeForm = 'new XoopsThemeForm(';
219
        if ($isParam === false) {
220
            $ret = "{$t}\${$var} = {$themeForm}\${$param1}, '{$param2}', \${$param3}, '{$param4}', true);\n";
221
        } else {
222
            $ret = "{$themeForm}\${$param1}, '{$param2}', \${$param3}, '{$param4}', true)";
223
        }
224
225
        return $ret;
226
    }
227
228
    /*
229
     * @public function XoopsFormElementTray
230
     * @param $var
231
     * @param $param1
232
     * @param $param2
233
     *  
234
     * @return string
235
     */
236
    public function getClassXoopsFormElementTray($var, $param1, $param2 = '', $isParam = false, $t = "\t\t")
237
    {
238
        $tray = 'new XoopsFormElementTray(';
239
        if ($isParam === false) {
240
            $ret = "{$t}\${$var} = {$tray}{$param1}, '{$param2}' );\n";
241
        } else {
242
            $ret = "{$tray}{$param1}, '{$param2}' )";
243
        }
244
245
        return $ret;
246
    }
247
248
    /*
249
     * @public function getClassXoopsFormLabel
250
     * @param $var
251
     * @param $param1
252
     * @param $param2
253
     *  
254
     * @return string
255
     */
256
    public function getClassXoopsFormLabel($var, $param1 = '', $isParam = false, $t = "\t\t")
257
    {
258
        $label = 'new XoopsFormLabel(';
259
        if ($isParam === false) {
260
            $ret = "{$t}\${$var} = {$label}{$param1});\n";
261
        } else {
262
            $ret = "{$label}{$param1})";
263
        }
264
265
        return $ret;
266
    }
267
268
    /*
269
     * @public function getClassXoopsFormFile
270
     * @param $var
271
     * @param $param1
272
     * @param $param2
273
     * @param $param3
274
     *  
275
     * @return string
276
     */
277
    public function getClassXoopsFormFile($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
278
    {
279
        $file = 'new XoopsFormFile( ';
280
        if ($isParam === false) {
281
            $ret = "{$t}\${$var} = {$file}{$param1}, '{$param2}', {$param3} );\n";
282
        } else {
283
            $ret = "{$file}{$param1}, '{$param2}', {$param3} )";
284
        }
285
286
        return $ret;
287
    }
288
289
    /*
290
     * @public function getClassXoopsFormHidden
291
     * @param $var
292
     * @param $param1
293
     * @param $param2
294
     *  
295
     * @return string
296
     */
297
    public function getClassXoopsFormHidden($var, $param1, $param2, $isForm = false, $isParam = false, $t = "\t\t")
298
    {
299
        $hidden = 'new XoopsFormHidden( ';
300
        $getVarHidden = $this->xoopscode->getXoopsCodeGetVar('', 'this', $param2, true);
301
        $ret = '';
302
        if ($isParam === false) {
303
            $ret .= "{$t}\${$var} = {$hidden}{$param1}, {$getVarHidden} );\n";
304
        } else {
305
            if ($isForm === false) {
306
                $ret .= "{$hidden}{$param1}, {$param2} )";
307
            } else {
308
                $ret .= "{$hidden}'{$param1}', '{$param2}' )";
309
            }
310
        }
311
312
        return $ret;
313
    }
314
315
    /*
316
     * @public function getClassXoopsFormText
317
     * @param $var
318
     * @param $param1
319
     * @param $param2
320
     * @param $param3
321
     * @param $param4
322
     * @param $param5
323
     *  
324
     * @return string
325
     */
326
    public function getClassXoopsFormText($var, $param1, $param2, $param3 = 75, $param4 = 255, $param5, $isParam = false, $t = "\t\t")
327
    {
328
        $text = 'new XoopsFormText( ';
329
        if ($isParam === false) {
330
            $ret = "{$t}\${$var} = {$text}{$param1}, '{$param2}', {$param3}, {$param4}, \${$param5} );\n";
331
        } else {
332
            $ret = "{$text}{$param1}, '{$param2}', {$param3}, {$param4}, \${$param5} )";
333
        }
334
335
        return $ret;
336
    }
337
338
    /*
339
     * @public function getClassXoopsFormTextArea
340
     * @param $var
341
     * @param $param1
342
     * @param $param2
343
     * @param $param3
344
     * @param $param4
345
     * @param $param5
346
     *  
347
     * @return string
348
     */
349
    public function getClassXoopsFormTextArea($var, $param1, $param2, $param3, $param4, $isParam = false, $t = "\t\t")
350
    {
351
        $area = 'new XoopsFormTextArea( ';
352
        $getVarTextArea = $this->xoopscode->getXoopsCodeGetVar('', 'this', $param2, true);
353
        if ($isParam === false) {
354
            $ret = "{$t}\${$var} = {$area}{$param1}, '{$param2}', {$getVarTextArea}, {$param3}, {$param4} );\n";
355
        } else {
356
            $ret = "{$area}{$param1}, '{$param2}', {$getVarTextArea}, {$param3}, {$param4} )";
357
        }
358
359
        return $ret;
360
    }
361
362
    /*
363
     * @public function getClassXoopsFormColorPicker
364
     * @param $var
365
     * @param $param1
366
     * @param $param2
367
     * @param $param3
368
     *  
369
     * @return string
370
     */
371
    public function getClassXoopsFormColorPicker($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
372
    {
373
        $picker = 'new XoopsFormColorPicker( ';
374
        if ($isParam === false) {
375
            $ret = "{$t}\${$var} = {$picker}{$param1}, '{$param2}', {$param3} );\n";
376
        } else {
377
            $ret = "{$picker}{$param1}, '{$param2}', {$param3} )";
378
        }
379
380
        return $ret;
381
    }
382
383
    /*
384
     * @public function getClassXoopsFormSelectUser
385
     * @param $var
386
     * @param $param1
387
     * @param $param2
388
     * @param $param3
389
     *  
390
     * @return string
391
     */
392
    public function getClassXoopsFormSelectUser($var, $param1, $param2, $param3 = 'false', $param4, $isParam = false, $t = "\t\t")
393
    {
394
        $user = 'new XoopsFormSelectUser( ';
395
        $getVarSelectUser = $this->xoopscode->getXoopsCodeGetVar('', 'this', $param4, true);
396
        if ($isParam === false) {
397
            $ret = "{$t}\${$var} = {$user}{$param1}, '{$param2}', {$param3}, {$getVarSelectUser} );\n";
398
        } else {
399
            $ret = "{$user}{$param1}, '{$param2}', {$param3}, {$getVarSelectUser} )";
400
        }
401
402
        return $ret;
403
    }
404
405
    /*
406
     * @public function getClassXoopsFormTextDateSelect
407
     * @param $var
408
     * @param $param1
409
     * @param $param2
410
     * @param $param3
411
     *  
412
     * @return string
413
     */
414
    public function getClassXoopsFormTextDateSelect($var, $param1, $param2, $param3 = '', $param4, $isParam = false, $t = "\t\t")
415
    {
416
        $tdate = 'new XoopsFormTextDateSelect( ';
417
        $getVarTextDateSelect = $this->xoopscode->getXoopsCodeGetVar('', 'this', $param4, true);
418
        if ($isParam === false) {
419
            $ret = "{$t}\${$var} = {$tdate}{$param1}, '{$param2}', {$param3}, {$getVarTextDateSelect} );\n";
420
        } else {
421
            $ret = "{$tdate}{$param1}, '{$param2}', {$param3}, {$getVarTextDateSelect} )";
422
        }
423
424
        return $ret;
425
    }
426
427
    /*
428
     * @public function getClassXoopsFormEditor
429
     * @param $var
430
     * @param $param1
431
     * @param $param2
432
     * @param $param3
433
     *  
434
     * @return string
435
     */
436
    public function getClassXoopsFormEditor($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
437
    {
438
        $editor = 'new XoopsFormEditor( ';
439
        if ($isParam === false) {
440
            $ret = "{$t}\${$var} = {$editor}{$param1}, '{$param2}', \${$param3});\n";
441
        } else {
442
            $ret = "{$editor}{$param1}, '{$param2}', \${$param3})";
443
        }
444
445
        return $ret;
446
    }
447
448
    /*
449
     * @public function getClassXoopsFormCheckBox
450
     * @param $var
451
     * @param $param1
452
     * @param $param2
453
     * @param $param3
454
     *  
455
     * @return string
456
     */
457
    public function getClassXoopsFormCheckBox($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
458
    {
459
        $checkBox = 'new XoopsFormCheckBox( ';
460
        if ($isParam === false) {
461
            $ret = "{$t}\${$var} = {$checkBox}{$param1}, '{$param2}', {$param3});\n";
462
        } else {
463
            $ret = "{$checkBox}{$param1}, '{$param2}', {$param3})";
464
        }
465
466
        return $ret;
467
    }
468
469
    /*
470
     * @public function getClassXoopsFormRadioYN
471
     * @param $var
472
     * @param $param1
473
     * @param $param2
474
     * @param $param3
475
     *  
476
     * @return string
477
     */
478
    public function getClassXoopsFormRadioYN($var, $param1, $param2, $param3, $isParam = false, $t = "\t\t")
479
    {
480
        $radioYN = 'new XoopsFormRadioYN( ';
481
        if ($isParam === false) {
482
            $ret = "{$t}\${$var} = {$radioYN}{$param1}, '{$param2}', \${$param3});\n";
483
        } else {
484
            $ret = "{$radioYN}{$param1}, '{$param2}', \${$param3})";
485
        }
486
487
        return $ret;
488
    }
489
490
    /*
491
     * @public function getClassXoopsFormSelect
492
     * @param $var
493
     * @param $param1
494
     * @param $param2
495
     * @param $param3
496
     * @param $param4
497
     * @param $param5
498
     *  
499
     * @return string
500
     */
501
    public function getClassXoopsFormSelect($var, $param1, $param2, $param3, $param4, $param5 = 5, $isParam = false, $t = "\t\t")
502
    {
503
        $select = 'new XoopsFormSelect( ';
504
        if ($isParam === false) {
505
            $ret = "{$t}\${$var} = {$select}{$param1}, \".{\${$param2}}/\", '{$param3}', \${$param4}, {$param5} );\n";
506
        } else {
507
            $ret = "{$select}{$param1}, \".{\${$param2}}/\", '{$param3}', \${$param4}, {$param5} )";
508
        }
509
510
        return $ret;
511
    }
512
513
    /*
514
     * @public function getClassXoopsFormTag
515
     * @param $var
516
     * @param $param1
517
     * @param $param2
518
     * @param $param3
519
     * @param $param4
520
     * @param $param5
521
     * @param $isParam
522
     *  
523
     * @return string
524
     */
525
    public function getClassXoopsFormTag($var, $param1, $param2, $param3, $param4, $param5 = 0, $isParam = false, $t = "\t\t")
526
    {
527
        $tag = 'new XoopsFormTag( ';
528
        if ($isParam === false) {
529
            $ret = "{$t}\${$var} = {$tag}'{$param1}', {$param2}, {$param3}, \${$param4}, {$param5} );\n";
530
        } else {
531
            $ret = "{$tag}'{$param1}', {$param2}, {$param3}, \${$param4}, {$param5} )";
532
        }
533
534
        return $ret;
535
    }
536
537
    /*
538
     * @public function getClassXoopsFormButton
539
     * @param $var
540
     * @param $param1
541
     * @param $param2
542
     * @param $param3
543
     * @param $param4
544
     * @param $isParam
545
     *  
546
     * @return string
547
     */
548
    public function getClassXoopsFormButton($var, $param1, $param2, $param3, $param4, $isParam = false, $t = "\t\t")
549
    {
550
        $button = 'new XoopsFormButton( ';
551
        if ($isParam === false) {
552
            $ret = "{$t}\${$var} = {$button}'{$param1}', '{$param2}', {$param3}, '{$param4}');\n";
553
        } else {
554
            $ret = "{$button}'{$param1}', '{$param2}', {$param3}, '{$param4}')";
555
        }
556
557
        return $ret;
558
    }
559
560
    /*
561
     * @public function getClassAddOption
562
     * @param $var
563
     * @param $params
564
     *  
565
     * @return string
566
     */
567
    public function getClassAddOption($var, $params, $t = "\t\t")
568
    {
569
        return "{$t}\${$var}->addOption({$params});\n";
570
    }
571
572
    /*
573
     * @public function getClassAddOptionArray
574
     * @param $var
575
     * @param $params
576
     *  
577
     * @return string
578
     */
579
    public function getClassAddOptionArray($var, $params, $t = "\t\t")
580
    {
581
        return "{$t}\${$var}->addOptionArray({$params});\n";
582
    }
583
584
    /*
585
     * @public function getClassAddElement
586
     * @param $var
587
     * @param $params
588
     *  
589
     * @return string
590
     */
591
    public function getClassAddElement($var = '', $params = '', $t = "\t\t")
592
    {
593
        return "{$t}\${$var}->addElement({$params});\n";
594
    }
595
596
    /*
597
     * @public function getClassSetDescription
598
     * @param $var
599
     * @param $params
600
     *  
601
     * @return string
602
     */
603
    public function getClassSetDescription($var, $params, $t = "\t\t")
604
    {
605
        return "{$t}\${$var}->setDescription({$params});\n";
606
    }
607
608
    /*
609
     * @public function getClassSetExtra
610
     * @param $var
611
     * @param $params
612
     *  
613
     * @return string
614
     */
615
    public function getClassSetExtra($var, $params, $t = "\t\t")
616
    {
617
        return "{$t}\${$var}->setExtra({$params});\n";
618
    }
619
}
620