NonStaticMagicMethodsSniffTest

Complexity

Total Complexity

9

Size/Duplication

Total Lines	310
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	6	1
A	testCorrectImplementation()	0	4	1
B	dataCorrectImplementation()	0	86	1
A	testWrongMethodVisibility()	0	4	1
A	dataWrongMethodVisibility()	0	53	1
A	testWrongStaticMethod()	0	4	1
B	dataWrongStaticMethod()	0	32	1
A	testWrongNonStaticMethod()	0	4	1
A	dataWrongNonStaticMethod()	0	17	1

<?php
/**
 * Non Static Magic Sniff test file
 *
 * @package PHPCompatibility
 */


/**
 * Non Static Magic Sniff tests
 *
 * @uses BaseSniffTest
 * @package PHPCompatibility
 * @author Jansen Price <jansen.price@gmail.com>
 */
class NonStaticMagicMethodsSniffTest extends BaseSniffTest

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * Sniffed file
     *
     * @var PHP_CodeSniffer_File
     */
    protected $_sniffFile;

    /**
     * setUp
     *
     * @return void
     */
    public function setUp()
    {
        parent::setUp();

        $this->_sniffFile = $this->sniffFile('sniff-examples/nonstatic_magic_methods.php');
    }


    /**
     * testCorrectImplementation
     *
     * @group MagicMethods
     *
     * @dataProvider dataCorrectImplementation
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testCorrectImplementation($line)
    {
        $this->assertNoViolation($this->_sniffFile, $line);
    }

    /**
     * Data provider.
     *
     * @see testCorrectImplementation()
     *
     * @return array
     */
    public function dataCorrectImplementation()
    {
        return array(
            // Plain class.
            array(5),
            array(6),
            array(7),
            array(8),
            array(9),
            array(10),
            array(11),
            array(12),
            array(13),
            // Normal class.
            array(18),
            array(19),
            array(20),
            array(21),
            array(22),
            array(23),
            array(24),
            array(25),
            array(26),
            array(27),

            // Alternative property order & stacked.
            array(58),

            // Plain interface.
            array(71),
            array(72),
            array(73),
            array(74),
            array(75),
            array(76),
            array(77),
            array(78),
            array(79),
            // Normal interface.
            array(84),
            array(85),
            array(86),
            array(87),
            array(88),
            array(89),
            array(90),
            array(91),
            array(92),
            array(93),

            // Plain trait.
            array(121),
            array(122),
            array(123),
            array(124),
            array(125),
            array(126),
            array(127),
            array(128),
            array(129),
            // Normal trait.
            array(134),
            array(135),
            array(136),
            array(137),
            array(138),
            array(139),
            array(140),
            array(141),
            array(142),
            array(143),

            // Normal Soap.
            array(171),
            array(172),
            array(173),
            array(174),
            array(175),
            array(176),
            array(177),
            array(178),
            array(179),
            array(180),
            array(181),
        );
    }


    /**
     * testWrongMethodVisibility
     *
     * @group MagicMethods
     *
     * @dataProvider dataWrongMethodVisibility
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testWrongMethodVisibility($methodName, $desiredVisibility, $testVisibility, $line)
    {
        $this->assertError($this->_sniffFile, $line, "Visibility for magic method {$methodName} must be {$desiredVisibility}. Found: {$testVisibility}");
    }

    /**
     * Data provider.
     *
     * @see testWrongMethodVisibility()
     *
     * @return array
     */
    public function dataWrongMethodVisibility()
    {
        return array(
            // Class.
            array('__get', 'public', 'private', 32),
            array('__set', 'public', 'protected', 33),
            array('__isset', 'public', 'private', 34),
            array('__unset', 'public', 'protected', 35),
            array('__call', 'public', 'private', 36),
            array('__callStatic', 'public', 'protected', 37),
            array('__sleep', 'public', 'private', 38),
            array('__toString', 'public', 'protected', 39),

            // Alternative property order & stacked.
            array('__set', 'public', 'protected', 56),
            array('__isset', 'public', 'private', 57),
            array('__get', 'public', 'private', 65),

            // Interface.
            array('__get', 'public', 'protected', 98),
            array('__set', 'public', 'private', 99),
            array('__isset', 'public', 'protected', 100),
            array('__unset', 'public', 'private', 101),
            array('__call', 'public', 'protected', 102),
            array('__callStatic', 'public', 'private', 103),
            array('__sleep', 'public', 'protected', 104),
            array('__toString', 'public', 'private', 105),

            // Trait.
            array('__get', 'public', 'private', 148),
            array('__set', 'public', 'protected', 149),
            array('__isset', 'public', 'private', 150),
            array('__unset', 'public', 'protected', 151),
            array('__call', 'public', 'private', 152),
            array('__callStatic', 'public', 'protected', 153),
            array('__sleep', 'public', 'private', 154),
            array('__toString', 'public', 'protected', 155),

            // Soap methods.
            array('__doRequest', 'public', 'protected', 186),
            array('__getFunctions', 'public', 'private', 187),
            array('__getLastRequest', 'public', 'protected', 188),
            array('__getLastRequestHeaders', 'public', 'private', 189),
            array('__getLastResponse', 'public', 'protected', 190),
            array('__getLastResponseHeaders', 'public', 'private', 191),
            array('__getTypes', 'public', 'protected', 192),
            array('__setCookie', 'public', 'private', 193),
            array('__setLocation', 'public', 'protected', 194),
            array('__setSoapHeaders', 'public', 'private', 195),
            array('__soapCall', 'public', 'protected', 196),

        );
    }


    /**
     * testWrongStaticMethod
     *
     * @group MagicMethods
     *
     * @dataProvider dataWrongStaticMethod
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testWrongStaticMethod($methodName, $line)
    {
        $this->assertError($this->_sniffFile, $line, "Magic method {$methodName} cannot be defined as static.");
    }

    /**
     * Data provider.
     *
     * @see testWrongStaticMethod()
     *
     * @return array
     */
    public function dataWrongStaticMethod()
    {
        return array(
            // Class.
            array('__get', 44),
            array('__set', 45),
            array('__isset', 46),
            array('__unset', 47),
            array('__call', 48),

            // Alternative property order & stacked.
            array('__get', 55),
            array('__set', 56),
            array('__isset', 57),
            array('__get', 65),

            // Interface.
            array('__get', 110),
            array('__set', 111),
            array('__isset', 112),
            array('__unset', 113),
            array('__call', 114),

            // Trait.
            array('__get', 160),
            array('__set', 161),
            array('__isset', 162),
            array('__unset', 163),
            array('__call', 164),

        );
    }


    /**
     * testWrongNonStaticMethod
     *
     * @group MagicMethods
     *
     * @dataProvider dataWrongNonStaticMethod
     *
     * @param int $line The line number.
     *
     * @return void
     */
    public function testWrongNonStaticMethod($methodName, $line)
    {
        $this->assertError($this->_sniffFile, $line, "Magic method {$methodName} must be defined as static.");
    }

    /**
     * Data provider.
     *
     * @see testWrongNonStaticMethod()
     *
     * @return array
     */
    public function dataWrongNonStaticMethod()
    {
        return array(
            // Class.
            array('__callStatic', 49),
            array('__set_state', 50),

            // Interface.
            array('__callStatic', 115),
            array('__set_state', 116),

            // Trait.
            array('__callStatic', 165),
            array('__set_state', 166),

        );
    }

}