Alumni::getUserId()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 4
nc 2
nop 0
dl 0
loc 8
rs 9.4285
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 25 and the first side effect is on line 20.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
/*
3
 You may not change or alter any portion of this comment or credits
4
 of supporting developers from this source code or any supporting source code
5
 which is considered copyrighted (c) material of the original comment or credit authors.
6
7
 This program is distributed in the hope that it will be useful,
8
 but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10
*/
11
/**
12
 * Alumni module for Xoops
13
 *
14
 * @copyright       XOOPS Project https://xoops.org/
15
 * @license         GPL 2.0 or later
16
 * @package         alumni
17
 * @since           2.6.x
18
 * @author          John Mordo (jlm69)
19
 */
20
defined('XOOPS_ROOT_PATH') || exit('XOOPS root path not defined');
21
22
/**
23
 * Class Alumni
24
 */
25
class Alumni extends Xoops\Module\Helper\HelperAbstract
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...
26
{
27
    /**
28
     * Init the module
29
     *
30
     * @return null|void
31
     */
32
    public function init()
33
    {
34
        //        $this->setDirname('alumni');
0 ignored issues
show
Unused Code Comprehensibility introduced by
75% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
35
        $moduleDirName = basename(dirname(__DIR__));
36
        $this->setDirname($moduleDirName);
37
    }
38
39
    /**
40
     * @return Alumni
41
     */
42
    public static function getInstance()
43
    {
44
        return parent::getInstance();
45
    }
46
47
    /**
48
     * @return AlumnilistingHandler
49
     */
50
    public function getListingHandler()
51
    {
52
        return $this->getHandler('listing');
53
    }
54
55
    /**
56
     * @return \Xoops\Core\Kernel\XoopsObjectHandler
57
     */
58
    public function getCategoryHandler()
59
    {
60
        return $this->getHandler('category');
61
    }
62
63
    /**
64
     * @return AlumniPermissionHandler
65
     */
66
    public function getPermissionHandler()
67
    {
68
        return $this->getHandler('permission');
69
    }
70
71
    /**
72
     * @return AlumniGroupPermHandler
73
     */
74
    public function getGrouppermHandler()
75
    {
76
        return $this->getHandler('groupperm');
77
    }
78
79
    /**
80
     * @return int|mixed
81
     */
82
    public function getUserId()
83
    {
84
        if ($this->xoops()->isUser()) {
85
            return $this->xoops()->user->getVar('uid');
86
        }
87
88
        return 0;
89
    }
90
}
91