<?php
/**
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @version //autogen//
 * @filesource
 * @package Reflection
 * @subpackage Tests
 */

class ezcReflectionParameterTest extends ezcTestCase
{

    /**
     * Expected parameters of certain methods or functions
     * @var array<string,ReflectionParameter[]>
     */
    protected $expected = array();

    /**
     * Actual parameters of the same methods or functions as in $this->expected
     * @var array<string,ezcReflectionParameter[]>
     */
    protected $actual = array();

    /**#@+
     * @var ezcReflectionParameter
     * @deprecated
     */
    protected $actualParamsOfM1;
    protected $actualParamsOf_TestMethods_m3;
    protected $actualParamsOf_ezcReflection_setReflectionTypeFactory;
    protected $actualParamsOf_functionWithTypeHint;
    /**#@-*/

    public function setUp() {
        // function with three parameters that have type annotations but no type hints
        //$this->expectedFunctionM1 = new ReflectionFunction( 'm1' );
        //$this->expectedParamsOfM1 = $this->expectedFunctionM1->getParameters();

        // method with one undocumented parameter
        //$this->expectedMethod_TestMethods_m3 = new ReflectionMethod( 'TestMethods', 'm3' );
        //$this->expectedParamsOfMethod_TestMethods_m3 = $this->expectedMethod_TestMethods_m3->getParameters();

        $this->expected = $this->getExpectedFixtures(); 
        $this->setUpFixtures();
        $this->actual['m1'] = $this->actualParamsOfM1;
        $this->actual['TestMethods::m3'] = $this->actualParamsOf_TestMethods_m3;
        $this->actual['ezcReflection::setReflectionTypeFactory'] = $this->actualParamsOf_ezcReflection_setReflectionTypeFactory;
        $this->actual['functionWithTypeHint'] = $this->actualParamsOf_functionWithTypeHint;
    }

    public function setUpFixtures() {
        // function with undocumented parameter $t that has default value 'foo'
        $this->actual['mmm'][0] = new ezcReflectionParameter( 'mmm', 0 );

        // function with three parameters that have type annotations but no type hints
        $paramTypes = array( 'string', 'ezcReflection', 'ReflectionClass' );
        for ( $i = 0; $i <= 2; ++$i ) {
            $this->actualParamsOfM1[$i]
                = new ezcReflectionParameter( 'm1', $i, $paramTypes[$i] );
        }

        // method with one undocumented parameter
        $this->actualParamsOf_TestMethods_m3[]
            = new ezcReflectionParameter( array( 'TestMethods', 'm3' ), 0 );

        // method with parameter that has type hint
        $this->actualParamsOf_ezcReflection_setReflectionTypeFactory[]
            = new ezcReflectionParameter( array( 'ezcReflection', 'setReflectionTypeFactory' ), 0, 'ezcReflectionTypeFactory' );

        // function with parameter that has type hint only
        $this->actualParamsOf_functionWithTypeHint[]
            = new ezcReflectionParameter( 'functionWithTypeHint', 0, 'ReflectionClass' );
    }
    
    public function getExpectedFixtures() {
        $expected = array();

        // function with undocumented parameter $t that has default value 'foo'
        $expected['mmm'][0] = new ReflectionParameter( 'mmm', 0 );

        // function with three parameters that have type annotations but no type hints
        $paramTypes = array( 'string', 'ezcReflection', 'ReflectionClass' );
        for ( $i = 0; $i <= 2; ++$i ) {
            $expected['m1'][$i]
                = new ReflectionParameter( 'm1', $i );
        }

        // method with one undocumented parameter
        $expected['TestMethods::m3'][]
            = new ReflectionParameter( array( 'TestMethods', 'm3' ), 0 );

        // method with parameter that has type hint
        $expected['ezcReflection::setReflectionTypeFactory'][]
            = new ReflectionParameter( array( 'ezcReflection', 'setReflectionTypeFactory' ), 0 );

        // function with parameter that has type hint only
        $expected['functionWithTypeHint'][]
            = new ReflectionParameter( 'functionWithTypeHint', 0 );

        return $expected;
    }

    public function tearDown() {
        $this->expected = array();
        $this->actual = array();
        unset(
            $this->actualParamsOfM1,
            $this->actualParamsOf_TestMethods_m3,
            $this->actualParamsOf_ezcReflection_setReflectionTypeFactory,
            $this->actualParamsOf_functionWithTypeHint
        );
    }

    public function testGetType() {
        $type = $this->actualParamsOfM1[0]->getType();
        self::assertInstanceOf('ezcReflectionType', $type);
        self::assertEquals('string', $type->getTypeName());

        $type = $this->actualParamsOfM1[1]->getType();
        self::assertInstanceOf('ezcReflectionType', $type);
        self::assertEquals('ezcReflection', $type->getTypeName());

        $type = $this->actualParamsOfM1[2]->getType();
        self::assertInstanceOf('ezcReflectionType', $type);
        self::assertEquals('ReflectionClass', $type->getTypeName());

        // this method has both a type hint and a type annotation
        $type = $this->actualParamsOf_ezcReflection_setReflectionTypeFactory[0]->getType();
        self::assertInstanceOf('ezcReflectionType', $type);
        self::assertEquals('ezcReflectionTypeFactory', $type->getTypeName());

        // testing a param that only has a type hint
        $type = $this->actualParamsOf_functionWithTypeHint[0]->getType();
        self::assertInstanceOf('ezcReflectionType', $type);
        self::assertEquals('ReflectionClass', $type->getTypeName());

        self::assertNull($this->actualParamsOf_TestMethods_m3[0]->getType());
    }

    public function testGetClass() {
        self::assertNull( $this->actualParamsOfM1[0]->getClass() );
        self::assertNull( $this->actualParamsOfM1[1]->getClass() );
        self::assertNull( $this->actualParamsOfM1[2]->getClass() );
        self::assertNull( $this->actualParamsOf_TestMethods_m3[0]->getClass() );
        self::assertEquals( 'ezcReflectionTypeFactory',
            $this->actualParamsOf_ezcReflection_setReflectionTypeFactory[0]->getClass()->getName() );
    }

    public function testGetDeclaringFunction() {
        $params = $this->actualParamsOfM1;

		$decFunc = $params[0]->getDeclaringFunction();
		self::assertTrue($decFunc instanceof ezcReflectionFunction);
        self::assertEquals('m1', $decFunc->getName());

        $decFunc = $this->actual['TestMethods::m3'][0]->getDeclaringFunction();
        self::assertInstanceOf('ezcReflectionMethod', $decFunc);
        self::assertEquals('TestMethods', $decFunc->getDeclaringClass()->getName());
        self::assertEquals('m3', $decFunc->getName());
        
        $decFunc = $this->actual['ezcReflection::setReflectionTypeFactory'][0]->getDeclaringFunction();
        self::assertInstanceOf('ezcReflectionMethod', $decFunc);
        self::assertEquals('ezcReflection', $decFunc->getDeclaringClass()->getName());
        self::assertEquals('setReflectionTypeFactory', $decFunc->getName());

        $decFunc = $this->actual['functionWithTypeHint'][0]->getDeclaringFunction();
        self::assertInstanceOf('ezcReflectionFunction', $decFunc);
        self::assertEquals('functionWithTypeHint', $decFunc->getName());
    }

    public function testGetDeclaringClass() {
        $params = $this->actualParamsOf_TestMethods_m3;

        $class = $params[0]->getDeclaringClass();
		self::assertTrue($class instanceof ezcReflectionClass);
        self::assertEquals('TestMethods', $class->getName());

        self::assertNull( $this->actual['mmm'][0]->getDeclaringClass() );
    }

    public function testGetName() {
        self::assertEquals('test', $this->actualParamsOfM1[0]->getName());
        self::assertEquals('test2', $this->actualParamsOfM1[1]->getName());
        self::assertEquals('test3', $this->actualParamsOfM1[2]->getName());
	}

    public function testIsPassedByReference() {
        $params = $this->actualParamsOfM1;
		self::assertFalse($params[0]->isPassedByReference());
		self::assertTrue($params[2]->isPassedByReference());
	}

    public function testIsArray() {
        $params = $this->actualParamsOfM1;
		self::assertFalse($params[0]->isArray());
	}

    public function testAllowsNull() {
        $params = $this->actualParamsOfM1;
		self::assertTrue($params[0]->allowsNull());
	}

    public function testIsOptional() {
		$param = $this->actual['mmm'][0];
		self::assertTrue($param->isOptional());

        $params = $this->actualParamsOfM1;
		$param = $params[0];
		self::assertFalse($param->isOptional());
	}

	public function testIsDefaultValueAvailable() {
		$param = $this->actual['mmm'][0];
		self::assertTrue($param->isDefaultValueAvailable());

        $params = $this->actualParamsOfM1;
		$param = $params[0];
		self::assertFalse($param->isDefaultValueAvailable());
	}

	public function testGetDefaultValue() {
		$param = $this->actual['mmm'][0];
		self::assertEquals('foo', $param->getDefaultValue());
	}

	/**
     * @expectedException ReflectionException
     */
	public function testGetDefaultValueThrowsReflectionException() {
        $params = $this->actualParamsOfM1;
		$param = $params[0];
		self::assertEquals(null, $param->getDefaultValue()); //should throw exception
	}

	public function testGetPosition() {
		$param = $this->actual['mmm'][0];
		self::assertEquals(0, $param->getPosition());

        $params = $this->actualParamsOfM1;
		$param = $params[1];
		self::assertEquals(1, $param->getPosition());
	}

    public function getFunctionNamesAndParamKeys() {
        $result = array();
        foreach ( $this->getExpectedFixtures() as $functionName => $expParams ) {
            foreach ( $expParams as $paramKey => $expParam ) {
                $result[]
                    = array( $functionName, $expParam->getPosition() );
            }
        }
        return $result;
    }

    /**
     * @dataProvider getFunctionNamesAndParamKeys
     */
    public function testExport( $functionName = null, $paramKey = null ) {
        if ( strpos( $functionName, '::' ) !== false ) {
            $function = explode( '::', $functionName );
        } else {
            $function = $functionName;
        }
        self::assertEquals(
            ReflectionParameter::export( $function, $paramKey, true ),
            ezcReflectionParameter::export( $function, $paramKey, true )
        );
    }

    public function getWrapperMethods() {
        $wrapperMethods = array(
            array( '__toString', array() ),
            array( 'getName', array() ),

            array( 'allowsNull', array() ),
            array( 'isOptional', array() ),
            array( 'isPassedByReference', array() ),
            array( 'isArray', array() ),
            array( 'isDefaultValueAvailable', array() ),
            array( 'getPosition', array() ),
            array( 'getDefaultValue', array() ),
            array( 'getClass', array() ),
            array( 'getDeclaringFunction', array() ),
            array( 'getDeclaringClass', array() ),
        );
        return $wrapperMethods;
    }

    /**
     * @dataProvider getWrapperMethods
     */
    public function testWrapperMethods( $method, $arguments ) {
        foreach ( $this->expected as $functionName => $expParams ) {
            foreach ( $expParams as $paramKey => $expParam ) {
                try {
                    $actual = call_user_func_array(
                        array( $this->actual[ $functionName ][ $paramKey ], $method ), $arguments
                    );
                    $expected = call_user_func_array(
                        array( $this->expected[ $functionName ][ $paramKey ], $method ), $arguments
                    );
                    if ( $expected instanceOf Reflector ) {
                        self::assertEquals( (string) $expected, (string) $actual );
                    } else {
                        self::assertEquals( $expected, $actual );
                    }
                } catch ( ReflectionException $e ) {
                    if ( !(
                        $method == 'getDefaultValue'
                        and $expParam->isDefaultValueAvailable() == false
                        and $e->getMessage() == 'Parameter is not optional'
                    ) ) {
                        self::fail( 'Unexpected ReflectionException: ' . $e->getMessage() );
                    }
                }
            }
        }
    }

    public static function suite()
    {
         return new PHPUnit_Framework_TestSuite( "ezcReflectionParameterTest" );
    }
}
?>