ShibbolethAttributesResolverTrait::getArrayAttribute() - Code Metrics - MetalArend/authentication-bundle - Measure and Improve Code Quality continuously with Scrutinizer

getArrayAttribute() A
last analyzed 2016-09-14 12:22 UTC

↳ Parent: ShibbolethAttributesResolverTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
nop	1

<?php

namespace Kuleuven\AuthenticationBundle\Traits;

trait ShibbolethAttributesResolverTrait
{
    /**
     * @var array
     */
    protected $attributes = [];

    /**
     * Returns the attributes.
     *
     * @return array The attributes
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Sets the attributes.
     *
     * @param array $attributes The attributes
     */
    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;
    }

    /**
     * Returns true if the attribute exists.
     *
     * @param string $name The attribute name
     * @return bool true if the attribute exists, false otherwise
     */
    public function hasAttribute($name)
    {
        return array_key_exists($name, $this->attributes);
    }

    /**
     * Returns an attribute value.
     *
     * @param string $name The attribute name
     * @return mixed The attribute value
     * @throws \InvalidArgumentException When attribute doesn't exist
     */
    public function getAttribute($name)
    {
        if (!array_key_exists($name, $this->attributes)) {
            return null;
        }

        return $this->attributes[$name];
    }

    /**
     * Sets an attribute.
     *
     * @param string $name  The attribute name
     * @param mixed  $value The attribute value
     */
    public function setAttribute($name, $value)
    {
        $this->attributes[$name] = $value;
    }

    /**
     * Returns attribute value. If it's a multivalue, the first value is returned, or the value at the specified index.
     *
     * @param string $name
     * @param null   $index
     * @return mixed
     */
    public function getSingleAttribute($name, $index = null)
    {
        $value = $this->getAttribute($name);
        if (!is_array($value)) {
            return $value;
        }
        return (null === $index ? reset($value) : $value[$index]);
    }

    /**
     * Returns an attribute as an array of values.
     *
     * @param string $name
     * @return array
     */
    public function getArrayAttribute($name)
    {
        $value = $this->getAttribute($name);
        return (is_array($value) ? $value : [$value]);
    }

    /**
     * Returns true if attribute exists (if value is given, it will also check the value).
     *
     * @param string      $name
     * @param null|string $value
     * @return bool
     */
    public function hasAttributeValue($name, $value = null)
    {
        if (!$this->hasAttribute($name)) return false;
        return (empty($value) ? true : (array_search($value, $this->getArrayAttribute($name)) !== false));
    }

    /**
     * @return string uid
     */
    public function getUID()
    {
        return $this->getAttribute('Shib-Person-uid');
    }

    /**
     * Alias for cn
     *
     * @return string cn
     */
    public function getCommonName()
    {
        return $this->getAttribute('Shib-Person-commonName');
    }

    /**
     * Alias for cn
     *
     * @return string cn
     */
    public function getFullName()
    {
        return $this->getCommonName();
    }

    /**
     * @return string givenName
     */
    public function getGivenName()
    {
        return $this->getAttribute('Shib-Person-givenName');
    }

    /**
     * Alias for givenName
     *
     * @return string givenName
     */
    public function getFirstName()
    {
        return $this->getGivenName();
    }

    /**
     * @return string sn
     */
    public function getSurname()
    {
        return $this->getAttribute('Shib-Person-surname');
    }

    /**
     * Alias for sn
     *
     * @return string sn
     */
    public function getLastName()
    {
        return $this->getSurname();
    }

    /**
     * Alias for cn, fallback to uid
     *
     * @return string cn|uid
     */
    public function getDisplayName()
    {
        return ($this->hasAttribute('Shib-Person-commonName')) ? $this->getCommonName() : $this->getUID();
    }

    /**
     * @return string mail
     */
    public function getMail()
    {
        return $this->getAttribute('Shib-Person-mail');
    }

    /**
     * Alias for mail
     *
     * @return string mail
     */
    public function getEmail()
    {
        return $this->getMail();
    }

    /**
     * @return string mail
     */
    public function getMails()
    {
        return $this->getArrayAttribute('Shib-Person-mail');
    }

    /**
     * @return string affiliation
     */
    public function getAffiliation()
    {
        return $this->getAttribute('Shib-EP-UnscopedAffiliation');
    }

    /**
     * @return string scopedAffiliation
     */
    public function getScopedAffiliation()
    {
        return $this->getAttribute('Shib-EP-ScopedAffiliation');
    }

    /**
     * @param null|string $value
     * @return bool
     */
    public function hasAffiliation($value = null)
    {
        return $this->hasAttributeValue('Shib-EP-UnscopedAffiliation', $value);
    }

    /**
     * @param null|string $value
     * @return bool
     */
    public function hasScopedAffiliation($value = null)
    {
        return $this->hasAttributeValue('Shib-EP-ScopedAffiliation', $value);
    }

    /**
     * @param null|string $scope
     * @return bool
     */
    public function isMember($scope = null)
    {
        return (empty($scope) ? $this->hasAffiliation('member') : $this->hasScopedAffiliation('member@' . $scope));
    }

    /**
     * @param null|string $scope
     * @return bool
     */
    public function isEmployee($scope = null)
    {
        return (empty($scope) ? $this->hasAffiliation('employee') : $this->hasScopedAffiliation('employee@' . $scope));
    }

    /**
     * @param null|string $scope
     * @return bool
     */
    public function isStudent($scope = null)
    {
        return (empty($scope) ? $this->hasAffiliation('student') : $this->hasScopedAffiliation('student@' . $scope));
    }

    /**
     * @param null|string $scope
     * @return bool
     */
    public function isStaff($scope = null)
    {
        return (empty($scope) ? $this->hasAffiliation('staff') : $this->hasScopedAffiliation('staff@' . $scope));
    }

    /**
     * @param null|string $scope
     * @return bool
     */
    public function isFaculty($scope = null)
    {
        return (empty($scope) ? $this->hasAffiliation('faculty') : $this->hasScopedAffiliation('faculty@' . $scope));
    }

    /**
     * @return string logoutURL
     */
    public function getLogoutURL()
    {
        return $this->getAttribute('Shib-logoutURL');
    }
}


1			<?php
2
3			namespace Kuleuven\AuthenticationBundle\Traits;
4
5			trait ShibbolethAttributesResolverTrait
6			{
7			/**
8			* @var array
9			*/
10			protected $attributes = [];
11
12			/**
13			* Returns the attributes.
14			*
15			* @return array The attributes
16			*/
17			public function getAttributes()
18			{
19			return $this->attributes;
20			}
21
22			/**
23			* Sets the attributes.
24			*
25			* @param array $attributes The attributes
26			*/
27			public function setAttributes(array $attributes)
28			{
29			$this->attributes = $attributes;
30			}
31
32			/**
33			* Returns true if the attribute exists.
34			*
35			* @param string $name The attribute name
36			* @return bool true if the attribute exists, false otherwise
37			*/
38			public function hasAttribute($name)
39			{
40			return array_key_exists($name, $this->attributes);
41			}
42
43			/**
44			* Returns an attribute value.
45			*
46			* @param string $name The attribute name
47			* @return mixed The attribute value
48			* @throws \InvalidArgumentException When attribute doesn't exist
49			*/
50			public function getAttribute($name)
51			{
52			if (!array_key_exists($name, $this->attributes)) {
53			return null;
54			}
55
56			return $this->attributes[$name];
57			}
58
59			/**
60			* Sets an attribute.
61			*
62			* @param string $name The attribute name
63			* @param mixed $value The attribute value
64			*/
65			public function setAttribute($name, $value)
66			{
67			$this->attributes[$name] = $value;
68			}
69
70			/**
71			* Returns attribute value. If it's a multivalue, the first value is returned, or the value at the specified index.
72			*
73			* @param string $name
74			* @param null $index
75			* @return mixed
76			*/
77			public function getSingleAttribute($name, $index = null)
78			{
79			$value = $this->getAttribute($name);
80			if (!is_array($value)) {
81			return $value;
82			}
83			return (null === $index ? reset($value) : $value[$index]);
84			}
85
86			/**
87			* Returns an attribute as an array of values.
88			*
89			* @param string $name
90			* @return array
91			*/
92			public function getArrayAttribute($name)
93			{
94			$value = $this->getAttribute($name);
95			return (is_array($value) ? $value : [$value]);
96			}
97
98			/**
99			* Returns true if attribute exists (if value is given, it will also check the value).
100			*
101			* @param string $name
102			* @param null\|string $value
103			* @return bool
104			*/
105			public function hasAttributeValue($name, $value = null)
106			{
107			if (!$this->hasAttribute($name)) return false;
108			return (empty($value) ? true : (array_search($value, $this->getArrayAttribute($name)) !== false));
109			}
110
111			/**
112			* @return string uid
113			*/
114			public function getUID()
115			{
116			return $this->getAttribute('Shib-Person-uid');
117			}
118
119			/**
120			* Alias for cn
121			*
122			* @return string cn
123			*/
124			public function getCommonName()
125			{
126			return $this->getAttribute('Shib-Person-commonName');
127			}
128
129			/**
130			* Alias for cn
131			*
132			* @return string cn
133			*/
134			public function getFullName()
135			{
136			return $this->getCommonName();
137			}
138
139			/**
140			* @return string givenName
141			*/
142			public function getGivenName()
143			{
144			return $this->getAttribute('Shib-Person-givenName');
145			}
146
147			/**
148			* Alias for givenName
149			*
150			* @return string givenName
151			*/
152			public function getFirstName()
153			{
154			return $this->getGivenName();
155			}
156
157			/**
158			* @return string sn
159			*/
160			public function getSurname()
161			{
162			return $this->getAttribute('Shib-Person-surname');
163			}
164
165			/**
166			* Alias for sn
167			*
168			* @return string sn
169			*/
170			public function getLastName()
171			{
172			return $this->getSurname();
173			}
174
175			/**
176			* Alias for cn, fallback to uid
177			*
178			* @return string cn\|uid
179			*/
180			public function getDisplayName()
181			{
182			return ($this->hasAttribute('Shib-Person-commonName')) ? $this->getCommonName() : $this->getUID();
183			}
184
185			/**
186			* @return string mail
187			*/
188			public function getMail()
189			{
190			return $this->getAttribute('Shib-Person-mail');
191			}
192
193			/**
194			* Alias for mail
195			*
196			* @return string mail
197			*/
198			public function getEmail()
199			{
200			return $this->getMail();
201			}
202
203			/**
204			* @return string mail
205			*/
206			public function getMails()
207			{
208			return $this->getArrayAttribute('Shib-Person-mail');
209			}
210
211			/**
212			* @return string affiliation
213			*/
214			public function getAffiliation()
215			{
216			return $this->getAttribute('Shib-EP-UnscopedAffiliation');
217			}
218
219			/**
220			* @return string scopedAffiliation
221			*/
222			public function getScopedAffiliation()
223			{
224			return $this->getAttribute('Shib-EP-ScopedAffiliation');
225			}
226
227			/**
228			* @param null\|string $value
229			* @return bool
230			*/
231			public function hasAffiliation($value = null)
232			{
233			return $this->hasAttributeValue('Shib-EP-UnscopedAffiliation', $value);
234			}
235
236			/**
237			* @param null\|string $value
238			* @return bool
239			*/
240			public function hasScopedAffiliation($value = null)
241			{
242			return $this->hasAttributeValue('Shib-EP-ScopedAffiliation', $value);
243			}
244
245			/**
246			* @param null\|string $scope
247			* @return bool
248			*/
249			public function isMember($scope = null)
250			{
251			return (empty($scope) ? $this->hasAffiliation('member') : $this->hasScopedAffiliation('member@' . $scope));
252			}
253
254			/**
255			* @param null\|string $scope
256			* @return bool
257			*/
258			public function isEmployee($scope = null)
259			{
260			return (empty($scope) ? $this->hasAffiliation('employee') : $this->hasScopedAffiliation('employee@' . $scope));
261			}
262
263			/**
264			* @param null\|string $scope
265			* @return bool
266			*/
267			public function isStudent($scope = null)
268			{
269			return (empty($scope) ? $this->hasAffiliation('student') : $this->hasScopedAffiliation('student@' . $scope));
270			}
271
272			/**
273			* @param null\|string $scope
274			* @return bool
275			*/
276			public function isStaff($scope = null)
277			{
278			return (empty($scope) ? $this->hasAffiliation('staff') : $this->hasScopedAffiliation('staff@' . $scope));
279			}
280
281			/**
282			* @param null\|string $scope
283			* @return bool
284			*/
285			public function isFaculty($scope = null)
286			{
287			return (empty($scope) ? $this->hasAffiliation('faculty') : $this->hasScopedAffiliation('faculty@' . $scope));
288			}
289
290			/**
291			* @return string logoutURL
292			*/
293			public function getLogoutURL()
294			{
295			return $this->getAttribute('Shib-logoutURL');
296			}
297			}
298

MetalArend / authentication-bundle

getArrayAttribute() A last analyzed 2016-09-14 12:22 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

getArrayAttribute() A
last analyzed 2016-09-14 12:22 UTC