Completed
Push — master ( f541a6...b68755 )
by Gino
06:36 queued 03:15
created

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