Completed
Push — master ( bb5c69...2e7c79 )
by Gino
06:03 queued 02:48
created

ClassXoopsCode::getClassXoopsPageNav()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 11
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

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