Reflection/src/reflection.php

<?php
/**
 * File containing the ezcReflection class.
 *
 * 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.
 *
 * @package Reflection
 * @version //autogen//
 * @copyright Copyright (C) 2005-2010 eZ Systems AS. All rights reserved.
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

/**
 * Holds type factory for generating type objects by given name
 *
 * @package Reflection
 * @version //autogen//
 * @author Stefan Marr <mail@stefan-marr.de>
 * @author Falko Menge <mail@falko-menge.de>
 */
class ezcReflection {

	/**
	 * @var ezcReflectionTypeFactory
	 */
	protected static $reflectionTypeFactory = null;

	/**
	 * @var ezcReflectionDocCommentParser
     *      Current documentation parser used by all ezcReflection classes
	 */
	protected static $docParser = null;

	/**
	 * Don't allow objects, it is just a static factory
	 */
    // @codeCoverageIgnoreStart
    private function __construct() {}
    // @codeCoverageIgnoreEnd

    /**
     * Returns a copy of the current documentation parser used by all
     * ezcReflection classes
     *
     * @return ezcReflectionDocCommentParser
     */
    public static function getDocCommentParser()
    {
    	if ( !( self::$docParser instanceof ezcReflectionDocCommentParser ) ) {
    		self::$docParser = new ezcReflectionDocCommentParserImpl();
    	}
    	return clone self::$docParser;
    }

    /**
     * Sets the documentation parser used by all ezcReflection classes
     *
     * @param ezcReflectionDocCommentParser $docParser Parser for documentation blocks
     * @return void
     */
    public static function setDocCommentParser(ezcReflectionDocCommentParser $docParser)
    {
    	self::$docParser = $docParser;
    }

    /**
     * Returns a copy of the current factory used to create type objects
     *
     * @return ezcReflectionTypeFactory
     */
    public static function getReflectionTypeFactory()
    {
        if ( !( self::$reflectionTypeFactory instanceof ezcReflectionTypeFactory ) ) {
            self::$reflectionTypeFactory = new ezcReflectionTypeFactoryImpl();
        }
    	return clone self::$reflectionTypeFactory;
    }

    /**
     * Sets the factory used to create type objects
     *
     * @param ezcReflectionTypeFactory $factory Factory for type objects
     * @return void
     */
    public static function setReflectionTypeFactory(ezcReflectionTypeFactory $factory)
    {
        self::$reflectionTypeFactory = $factory;
    }

    /**
     * Returns a ezcReflectionType object for the given type name
     *
     * @param string $typeName
     * @return ezcReflectionType
     */
    public static function getTypeByName($typeName)
    {
        return self::getReflectionTypeFactory()->getType($typeName);
    }

    /**
     * Returns an array with the ezcReflectionClass objects for all declared
     * classes
     *
     * @return ezcReflectionClass[] all declared classes
     */
    public static function getClasses() {
        $classes = array();
        foreach( get_declared_classes() as $className ) {
            $classes[$className] = new ezcReflectionClass( $className );
        }
        return $classes;
    }

    /**
     * Returns an array with the ezcReflectionClass objects for all declared
     * interfaces
     *
     * @return ezcReflectionClass[] all declared interfaces
     */
    public static function getInterfaces() {
        $interfaces = array();
        foreach( get_declared_interfaces() as $interfaceName ) {
            $interfaces[$interfaceName] = new ezcReflectionClass( $interfaceName );
        }
        return $interfaces;
    }

    /**
     * Returns an array with the ezcReflectionFunction objects for all
     * user-defined functions
     *
     * @return ezcReflectionFunction[] all user-defined functions
     */
    public static function getUserDefinedFunctions() {
        $functions = array();
        $functionNames = get_defined_functions();
        foreach( $functionNames['user'] as $functionName ) {
            $functions[$functionName] = new ezcReflectionFunction( $functionName );
        }
        return $functions;
    }

    /**
     * Returns an array with the ezcReflectionFunction objects for all
     * available internal functions
     *
     * @return ezcReflectionFunction[] all internal functions
     */
    public static function getInternalFunctions() {
        $functions = array();
        $functionNames = get_defined_functions();
        foreach( $functionNames['internal'] as $functionName ) {
            $functions[$functionName] = new ezcReflectionFunction( $functionName );
        }
        return $functions;
    }

    /**
     * Returns an array with the ezcReflectionFunction objects for all
     * internal and user-defined functions
     *
     * @return ezcReflectionFunction[] all internal and user-defined functions
     */
    public static function getFunctions() {
        $functions = array();
        $functionNames = get_defined_functions();
        foreach( $functionNames['internal'] as $functionName ) {
            $functions[$functionName] = new ezcReflectionFunction( $functionName );
        }
        foreach( $functionNames['user'] as $functionName ) {
            $functions[$functionName] = new ezcReflectionFunction( $functionName );
        }
        return $functions;
    }
}
?>