DeprecatedEvent::__construct() - Code Metrics - Inspection of "Fix: do not call the global functions" - datasift/storyplayer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 264bc7...d8ccfa )

by Stuart

created 2015-12-29 21:50 UTC

DeprecatedEvent::__construct() A

↳ Parent: DeprecatedEvent

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	19
rs	9.4286
c	1
b	0
f	0
cc	1
eloc	12
nc	1
nop	5

<?php

/**
 * Copyright (c) 2011-present Mediasift Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   StoryplayerInternals/Modules/Deprecated
 * @author    Stuart Herbert <[email protected]>
 * @copyright 2011-present Mediasift Ltd www.datasift.com
 * @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://datasift.github.io/storyplayer
 */

namespace StoryplayerInternals\SPv2\Modules\Deprecated;

use GanbaroDigital\Reflection\Requirements\RequireInteger;
use GanbaroDigital\Reflection\Requirements\RequireStringy;
use StoryplayerInternals\SPv2\Modules\Events\Event;

/**
 * @method string getWhat()
 * @method string getFile()
 * @method int getLine()
 * @method string getSince()
 * @method string getUrl()
 */
class DeprecatedEvent extends Event
{
    /**
     * @param string $what
     *        what has been deprecated?
     * @param string $file
     *        where was this called? use __FILE__ constant
     * @param string $line
     *        where was this called? use __LINE__ constant
     * @param string $since
     *        which version of Storyplayer was it deprecated in?
     * @param string $url
     *        where can the user go to learn more?
     */
    public function __construct($what, $file, $line, $since, $url)
    {
        // robustness
        RequireStringy::check($what);
        RequireStringy::check($file);
        RequireInteger::check($line);
        RequireStringy::check($since);
        RequireStringy::check($url);

        // remember the values
        $this->setWhat($what);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setFile($file);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setLine($line);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setSince($since);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->setUrl($url);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }

        // no more changes
        $this->makeReadOnly();
    }

    /**
     * where was the deprecated feature called from?
     * @return string
     */
    public function getCalledFrom()
    {
        return $this->getFile() . '@' . $this->getLine();
    }
}


1			<?php
2
3			/**
4			* Copyright (c) 2011-present Mediasift Ltd
5			* All rights reserved.
6			*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions
9			* are met:
10			*
11			* * Redistributions of source code must retain the above copyright
12			* notice, this list of conditions and the following disclaimer.
13			*
14			* * Redistributions in binary form must reproduce the above copyright
15			* notice, this list of conditions and the following disclaimer in
16			* the documentation and/or other materials provided with the
17			* distribution.
18			*
19			* * Neither the names of the copyright holders nor the names of his
20			* contributors may be used to endorse or promote products derived
21			* from this software without specific prior written permission.
22			*
23			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26			* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27			* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28			* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29			* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30			* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31			* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33			* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34			* POSSIBILITY OF SUCH DAMAGE.
35			*
36			* @category Libraries
37			* @package StoryplayerInternals/Modules/Deprecated
38			* @author Stuart Herbert <[email protected]>
39			* @copyright 2011-present Mediasift Ltd www.datasift.com
40			* @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
41			* @license http://www.opensource.org/licenses/bsd-license.php BSD License
42			* @link http://datasift.github.io/storyplayer
43			*/
44
45			namespace StoryplayerInternals\SPv2\Modules\Deprecated;
46
47			use GanbaroDigital\Reflection\Requirements\RequireInteger;
48			use GanbaroDigital\Reflection\Requirements\RequireStringy;
49			use StoryplayerInternals\SPv2\Modules\Events\Event;
50
51			/**
52			* @method string getWhat()
53			* @method string getFile()
54			* @method int getLine()
55			* @method string getSince()
56			* @method string getUrl()
57			*/
58			class DeprecatedEvent extends Event
59			{
60			/**
61			* @param string $what
62			* what has been deprecated?
63			* @param string $file
64			* where was this called? use __FILE__ constant
65			* @param string $line
66			* where was this called? use __LINE__ constant
67			* @param string $since
68			* which version of Storyplayer was it deprecated in?
69			* @param string $url
70			* where can the user go to learn more?
71			*/
72			public function __construct($what, $file, $line, $since, $url)
73			{
74			// robustness
75			RequireStringy::check($what);
76			RequireStringy::check($file);
77			RequireInteger::check($line);
78			RequireStringy::check($since);
79			RequireStringy::check($url);
80
81			// remember the values
82			$this->setWhat($what);
			0 ignored issues – show Documentation Bug introduced 2015-12-29 21:58 UTC by Report Bug Copy Issue Report The method `setWhat` does not exist on `object<StoryplayerIntern...ecated\DeprecatedEvent>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
83			$this->setFile($file);
			0 ignored issues – show Documentation Bug introduced 2015-12-29 21:58 UTC by Report Bug Copy Issue Report The method `setFile` does not exist on `object<StoryplayerIntern...ecated\DeprecatedEvent>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
84			$this->setLine($line);
			0 ignored issues – show Documentation Bug introduced 2015-12-29 21:58 UTC by Report Bug Copy Issue Report The method `setLine` does not exist on `object<StoryplayerIntern...ecated\DeprecatedEvent>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
85			$this->setSince($since);
			0 ignored issues – show Documentation Bug introduced 2015-12-29 21:58 UTC by Report Bug Copy Issue Report The method `setSince` does not exist on `object<StoryplayerIntern...ecated\DeprecatedEvent>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
86			$this->setUrl($url);
			0 ignored issues – show Documentation Bug introduced 2015-12-29 21:58 UTC by Report Bug Copy Issue Report The method `setUrl` does not exist on `object<StoryplayerIntern...ecated\DeprecatedEvent>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
87
88			// no more changes
89			$this->makeReadOnly();
90			}
91
92			/**
93			* where was the deprecated feature called from?
94			* @return string
95			*/
96			public function getCalledFrom()
97			{
98			return $this->getFile() . '@' . $this->getLine();
99			}
100			}
101

datasift / storyplayer

GitHub Access Token became invalid

Push — develop ( 264bc7...d8ccfa )

DeprecatedEvent::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like