VolunteerShift::__get() - Code Metrics - Inspection of "Add ability to print own shift schedule" - BurningFlipside/VolunteerSystem - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 470265...410c93 )

by Patrick

created 2020-01-15 05:06 UTC

VolunteerShift::__get() D

↳ Parent: VolunteerShift

Complexity

Conditions	22
Paths	22

Size

Total Lines

Duplication

Lines	28
Ratio	32.18 %

Importance

Changes

Metric	Value
cc	22
nc	22
nop	1
dl	28
loc	87
rs	4.1666
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * A class to abstract access to a Volunter System Shift.
 *
 * This class is the primary method to access shift information.
 *
 * @property string $_id The shift's ID
 * @property string $departmentID The shift's department
 * @property string $eventID The shift's event
 * @property string $roleID The shift's role
 * @property DateTime $startTime The shifts's starting time
 * @property DateTime $endTime The shifts's ending time
 * @property boolean $enabled Is the shift available for signup
 * @property string $earlyLate The shift's Early Entry/Late Stay status
 */
class VolunteerShift extends VolunteerObject
{
    protected static $roleCache = array();
    protected $mod = null;
    protected $myStart = null;
    protected $myEnd = null;
    protected $modStart = null;
    protected $modEnd = null;
    protected $webParticipantName = null;

    public function __construct($shiftID, $dbData = null)
    {
        parent::__construct($shiftID, $dbData, 'shifts', '_id');
    }

    public function __get($propName)
    {
        switch($propName)
        {
            case 'modTime':
                if($this->mod === null)
                {
                    $this->mod = new \DateInterval('PT'.strval($this->role->down_time).'H');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                }
                return $this->mod;
            case 'startTime':
                if($this->myStart === null)
                {
                    $this->myStart = new \DateTime($this->dbData['startTime']);
                }
                return $this->myStart;
            case 'startTimeWithMod':
                if($this->modStart === null)
                {
                    $this->modStart = clone $this->startTime;
                    $this->modStart->sub($this->modTime);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                }
                return $this->modStart;
            case 'endTime':
                if($this->myEnd === null)
                {
                    $this->myEnd = new \DateTime($this->dbData['endTime']);
                }
                return $this->myEnd;
            case 'endTimeWithMod':
                if($this->modEnd === null)
                {
                    $this->modEnd = clone $this->endTime;
                    $this->modEnd->add($this->modTime);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                }
                return $this->modEnd;
            case 'role':
                if(!isset(self::$roleCache[$this->dbData['roleID']]))
                {
                    self::$roleCache[$this->dbData['roleID']] = new \VolunteerRole($this->dbData['roleID']);
                }
                return self::$roleCache[$this->dbData['roleID']];
            case 'participantObj':
                if($this->participantObj === null)
                {
                    if(isset($this->dbData['participant']))
                    {
                        $this->participantObj = new \VolunteerProfile($this->dbData['participant']);
class MyClass { }

$x = new MyClass();
$x->foo = true;
                    }
                    else
                    {
                        $this->participantObj = false;
                    }
                }
                return $this->participantObj;
            case 'webParticipantName':

                if($this->webParticipantName === null)
                {
                    if(isset($this->dbData['participant']))
                    {
                        $tmp = new \VolunteerProfile($this->dbData['participant']);
                        $this->webParticipantName = $tmp->getDisplayName();
                    }
                    else
                    {
                        $this->webParticipantName = "";
                    }
                }
                return $this->webParticipantName;
            case 'scheduleParticipantName':

                if($this->scheduleParticipantName === null)
                {
                    if(isset($this->dbData['participant']))
                    {
                        $tmp = new \VolunteerProfile($this->dbData['participant']);
                        $this->scheduleParticipantName = $tmp->getDisplayName('paperName');
class MyClass { }

$x = new MyClass();
$x->foo = true;
                    }
                    else
                    {
                        $this->scheduleParticipantName = "";
                    }
                }
                return $this->scheduleParticipantName;
            default:
                return $this->dbData[$propName];
        }
    }

    public function isSame($shift)
    {
        return $this->dbData['_id'] === $shift->dbData['_id'];
    }

    public function overlaps($shift)
    {
        if($this->isSame($shift))
        {
            return false;
        }
        if($this->startTimeWithMod > $shift->startTimeWithMod && $this->startTimeWithMod < $shift->endTimeWithMod)

        {
            return true;
        }
        if($this->endTimeWithMod < $shift->endTimeWithMod && $this->endTimeWithMod > $shift->startTimeWithMod)

        {
            return true;
        }
        return false;
    }

    public function isFilled()
    {
         return isset($this->dbData['status']) && ($this->dbData['status'] === 'pending' || $this->dbData['status'] === 'filled' || $this->dbData['status'] === 'groupPending');
    }

    public function findOverlaps($uid, $shortCircuit = false)
    {
        static $userShifts = null;
        static $count = 0;
        if($userShifts === null)
        {
            $dataTable = DataSetFactory::getDataTableByNames('fvs', 'shifts');
            $filter = new \Data\Filter("participant eq '$uid'");
            $userShifts = $dataTable->read($filter);
            $count = count($userShifts);
            for($i = 0; $i < $count; $i++)
            {
                $userShifts[$i] = new VolunteerShift(false, $userShifts[$i]);
            }
        }
        $res = array();
        for($i = 0; $i < $count; $i++)
        {
            if($this->overlaps($userShifts[$i]))
            {
                if($shortCircuit === true)
                {
                    return true;
                }
                array_push($res, $userShifts[$i]);
            }
        }
        if($shortCircuit === true)
        {
            return false;
        }
        return $res;
    }
}


1		<?php
2		/**
3		* A class to abstract access to a Volunter System Shift.
4		*
5		* This class is the primary method to access shift information.
6		*
7		* @property string $_id The shift's ID
8		* @property string $departmentID The shift's department
9		* @property string $eventID The shift's event
10		* @property string $roleID The shift's role
11		* @property DateTime $startTime The shifts's starting time
12		* @property DateTime $endTime The shifts's ending time
13		* @property boolean $enabled Is the shift available for signup
14		* @property string $earlyLate The shift's Early Entry/Late Stay status
15		*/
16		class VolunteerShift extends VolunteerObject
17		{
18		protected static $roleCache = array();
19		protected $mod = null;
20		protected $myStart = null;
21		protected $myEnd = null;
22		protected $modStart = null;
23		protected $modEnd = null;
24		protected $webParticipantName = null;
25
26		public function __construct($shiftID, $dbData = null)
27		{
28		parent::__construct($shiftID, $dbData, 'shifts', '_id');
29		}
30
31		public function __get($propName)
32		{
33		switch($propName)
34		{
35		case 'modTime':
36		if($this->mod === null)
37		{
38		$this->mod = new \DateInterval('PT'.strval($this->role->down_time).'H');
		0 ignored issues – show Documentation introduced 2019-06-25 16:42 UTC by Report Bug Copy Issue Report The property `role` does not exist on `object<VolunteerShift>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
39		}
40		return $this->mod;
41		case 'startTime':
42		if($this->myStart === null)
43		{
44		$this->myStart = new \DateTime($this->dbData['startTime']);
45		}
46		return $this->myStart;
47		case 'startTimeWithMod':
48		if($this->modStart === null)
49		{
50		$this->modStart = clone $this->startTime;
51		$this->modStart->sub($this->modTime);
		0 ignored issues – show Documentation introduced 2019-06-25 16:42 UTC by Report Bug Copy Issue Report The property `modTime` does not exist on `object<VolunteerShift>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
52		}
53		return $this->modStart;
54		case 'endTime':
55		if($this->myEnd === null)
56		{
57		$this->myEnd = new \DateTime($this->dbData['endTime']);
58		}
59		return $this->myEnd;
60		case 'endTimeWithMod':
61		if($this->modEnd === null)
62		{
63		$this->modEnd = clone $this->endTime;
64		$this->modEnd->add($this->modTime);
		0 ignored issues – show Documentation introduced 2019-06-25 16:42 UTC by Report Bug Copy Issue Report The property `modTime` does not exist on `object<VolunteerShift>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
65		}
66		return $this->modEnd;
67		case 'role':
68		if(!isset(self::$roleCache[$this->dbData['roleID']]))
69		{
70		self::$roleCache[$this->dbData['roleID']] = new \VolunteerRole($this->dbData['roleID']);
71		}
72		return self::$roleCache[$this->dbData['roleID']];
73		case 'participantObj':
74		if($this->participantObj === null)
75		{
76		if(isset($this->dbData['participant']))
77		{
78		$this->participantObj = new \VolunteerProfile($this->dbData['participant']);
		0 ignored issues – show Bug introduced 2020-01-15 05:08 UTC by Report Bug Copy Issue Report The property `participantObj` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
79		}
80		else
81		{
82		$this->participantObj = false;
83		}
84		}
85		return $this->participantObj;
86	View Code Duplication	case 'webParticipantName':
		0 ignored issues – show Duplication introduced 2020-01-15 05:08 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
87		if($this->webParticipantName === null)
88		{
89		if(isset($this->dbData['participant']))
90		{
91		$tmp = new \VolunteerProfile($this->dbData['participant']);
92		$this->webParticipantName = $tmp->getDisplayName();
93		}
94		else
95		{
96		$this->webParticipantName = "";
97		}
98		}
99		return $this->webParticipantName;
100	View Code Duplication	case 'scheduleParticipantName':
		0 ignored issues – show Duplication introduced 2020-01-15 05:08 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
101		if($this->scheduleParticipantName === null)
102		{
103		if(isset($this->dbData['participant']))
104		{
105		$tmp = new \VolunteerProfile($this->dbData['participant']);
106		$this->scheduleParticipantName = $tmp->getDisplayName('paperName');
		0 ignored issues – show Bug introduced 2020-01-15 05:08 UTC by Report Bug Copy Issue Report The property `scheduleParticipantName` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
107		}
108		else
109		{
110		$this->scheduleParticipantName = "";
111		}
112		}
113		return $this->scheduleParticipantName;
114		default:
115		return $this->dbData[$propName];
116		}
117		}
118
119		public function isSame($shift)
120		{
121		return $this->dbData['_id'] === $shift->dbData['_id'];
122		}
123
124		public function overlaps($shift)
125		{
126		if($this->isSame($shift))
127		{
128		return false;
129		}
130		if($this->startTimeWithMod > $shift->startTimeWithMod && $this->startTimeWithMod < $shift->endTimeWithMod)
		0 ignored issues – show Bug introduced 2019-06-25 16:42 UTC by Report Bug Copy Issue Report The property `startTimeWithMod` does not seem to exist. Did you mean `startTime`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
131		{
132		return true;
133		}
134		if($this->endTimeWithMod < $shift->endTimeWithMod && $this->endTimeWithMod > $shift->startTimeWithMod)
		0 ignored issues – show Bug introduced 2019-06-25 16:42 UTC by Report Bug Copy Issue Report The property `endTimeWithMod` does not seem to exist. Did you mean `endTime`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
135		{
136		return true;
137		}
138		return false;
139		}
140
141		public function isFilled()
142		{
143		return isset($this->dbData['status']) && ($this->dbData['status'] === 'pending' \|\| $this->dbData['status'] === 'filled' \|\| $this->dbData['status'] === 'groupPending');
144		}
145
146		public function findOverlaps($uid, $shortCircuit = false)
147		{
148		static $userShifts = null;
149		static $count = 0;
150		if($userShifts === null)
151		{
152		$dataTable = DataSetFactory::getDataTableByNames('fvs', 'shifts');
153		$filter = new \Data\Filter("participant eq '$uid'");
154		$userShifts = $dataTable->read($filter);
155		$count = count($userShifts);
156		for($i = 0; $i < $count; $i++)
157		{
158		$userShifts[$i] = new VolunteerShift(false, $userShifts[$i]);
159		}
160		}
161		$res = array();
162		for($i = 0; $i < $count; $i++)
163		{
164		if($this->overlaps($userShifts[$i]))
165		{
166		if($shortCircuit === true)
167		{
168		return true;
169		}
170		array_push($res, $userShifts[$i]);
171		}
172		}
173		if($shortCircuit === true)
174		{
175		return false;
176		}
177		return $res;
178		}
179		}
180

BurningFlipside / VolunteerSystem

Push — master ( 470265...410c93 )

VolunteerShift::__get() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like