Zend_Loader_Autoloader_Resource Class Reference

Inheritance diagram for Zend_Loader_Autoloader_Resource:

Public Member Functions
	__construct ($options)
	__call ($method, $args)
	getClassPath ($class)
	autoload ($class)
	setOptions (array $options)
	setNamespace ($namespace)
	getNamespace ()
	setBasePath ($path)
	getBasePath ()
	addResourceType ($type, $path, $namespace=null)
	addResourceTypes (array $types)
	setResourceTypes (array $types)
	getResourceTypes ()
	hasResourceType ($type)
	removeResourceType ($type)
	clearResourceTypes ()
	setDefaultResourceType ($type)
	getDefaultResourceType ()
	load ($resource, $type=null)

Protected Attributes
	$_basePath
	$_components = array()
	$_defaultResourceType
	$_namespace
	$_resourceTypes = array()

Detailed Description

Definition at line 35 of file Resource.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Constructor

Parameters

array | Zend_Config

$options

Configuration options for resource autoloader

Returns

void

Definition at line 68 of file Resource.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        }
        if (!is_array($options)) {
            #require_once 'Zend/Loader/Exception.php';
            throw new Zend_Loader_Exception('Options must be passed to resource loader constructor');
        }

        $this->setOptions($options);

        $namespace = $this->getNamespace();
        if ((null === $namespace)
            || (null === $this->getBasePath())
        ) {
            #require_once 'Zend/Loader/Exception.php';
            throw new Zend_Loader_Exception('Resource loader requires both a namespace and a base path for initialization');
        }

        if (!empty($namespace)) {
            $namespace .= '_';
        }
        #require_once 'Zend/Loader/Autoloader.php';
        Zend_Loader_Autoloader::getInstance()->unshiftAutoloader($this, $namespace);
    }

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Overloading: methods

Allow retrieving concrete resource object instances using 'get<Resourcename>()' syntax. Example: $loader = new Zend_Loader_Autoloader_Resource(array( 'namespace' => 'Stuff_', 'basePath' => '/path/to/some/stuff', )) $loader->addResourceType('Model', 'models', 'Model');

$foo = $loader->getModel('Foo'); // get instance of Stuff_Model_Foo class

Parameters

string	$method
array	$args

Returns

mixed

Exceptions

Zend_Loader_Exception

if method not beginning with 'get' or not matching a valid resource type is called

Definition at line 115 of file Resource.php.

    {
        if ('get' == substr($method, 0, 3)) {
            $type  = strtolower(substr($method, 3));
            if (!$this->hasResourceType($type)) {
                #require_once 'Zend/Loader/Exception.php';
                throw new Zend_Loader_Exception("Invalid resource type $type; cannot load resource");
            }
            if (empty($args)) {
                #require_once 'Zend/Loader/Exception.php';
                throw new Zend_Loader_Exception("Cannot load resources; no resource specified");
            }
            $resource = array_shift($args);
            return $this->load($resource, $type);
        }

        #require_once 'Zend/Loader/Exception.php';
        throw new Zend_Loader_Exception("Method '$method' is not supported");
    }

addResourceType()

addResourceType	(		$type,
			$path,
			$namespace = null
	)

Add resource type

Parameters

string	$type	identifier for the resource type being loaded
string	$path	path relative to resource base path containing the resource types
null | string	$namespace	sub-component namespace to append to base namespace that qualifies this resource type

Returns

Zend_Loader_Autoloader_Resource

Definition at line 282 of file Resource.php.

    {
        $type = strtolower($type);
        if (!isset($this->_resourceTypes[$type])) {
            if (null === $namespace) {
                #require_once 'Zend/Loader/Exception.php';
                throw new Zend_Loader_Exception('Initial definition of a resource type must include a namespace');
            }
            $namespaceTopLevel = $this->getNamespace();
            $namespace = ucfirst(trim($namespace, '_'));
            $this->_resourceTypes[$type] = array(
                'namespace' => empty($namespaceTopLevel) ? $namespace : $namespaceTopLevel . '_' . $namespace,
            );
        }
        if (!is_string($path)) {
            #require_once 'Zend/Loader/Exception.php';
            throw new Zend_Loader_Exception('Invalid path specification provided; must be string');
        }
        $this->_resourceTypes[$type]['path'] = $this->getBasePath() . '/' . rtrim($path, '\/');

        $component = $this->_resourceTypes[$type]['namespace'];
        $this->_components[$component] = $this->_resourceTypes[$type]['path'];
        return $this;
    }

addResourceTypes()

addResourceTypes

(

array

$types

)

Add multiple resources at once

$types should be an associative array of resource type => specification pairs. Each specification should be an associative array containing minimally the 'path' key (specifying the path relative to the resource base path) and optionally the 'namespace' key (indicating the subcomponent namespace to append to the resource namespace).

As an example: $loader->addResourceTypes(array( 'model' => array( 'path' => 'models', 'namespace' => 'Model', ), 'form' => array( 'path' => 'forms', 'namespace' => 'Form', ), ));

Parameters

array

$types

Returns

Zend_Loader_Autoloader_Resource

Definition at line 333 of file Resource.php.

    {
        foreach ($types as $type => $spec) {
            if (!is_array($spec)) {
                #require_once 'Zend/Loader/Exception.php';
                throw new Zend_Loader_Exception('addResourceTypes() expects an array of arrays');
            }
            if (!isset($spec['path'])) {
                #require_once 'Zend/Loader/Exception.php';
                throw new Zend_Loader_Exception('addResourceTypes() expects each array to include a paths element');
            }
            $paths  = $spec['path'];
            $namespace = null;
            if (isset($spec['namespace'])) {
                $namespace = $spec['namespace'];
            }
            $this->addResourceType($type, $paths, $namespace);
        }
        return $this;
    }

autoload()

autoload

(

$class

)

Attempt to autoload a class

Parameters

string

$class

Returns

mixed False if not matched, otherwise result if include operation

Implements Zend_Loader_Autoloader_Interface.

Definition at line 197 of file Resource.php.

    {
        $classPath = $this->getClassPath($class);
        if (false !== $classPath) {
            return include $classPath;
        }
        return false;
    }

clearResourceTypes()

clearResourceTypes

(

)

Clear all resource types

Returns

Zend_Loader_Autoloader_Resource

Definition at line 409 of file Resource.php.

    {
        $this->_resourceTypes = array();
        $this->_components    = array();
        return $this;
    }

getBasePath()

getBasePath

(

)

Get base path to this set of resources

Returns

string

Definition at line 269 of file Resource.php.

    {
        return $this->_basePath;
    }

getClassPath()

getClassPath

(

$class

)

Helper method to calculate the correct class path

Parameters

string

$class

Returns

False if not matched other wise the correct path

Definition at line 141 of file Resource.php.

    {
        $segments          = explode('_', $class);
        $namespaceTopLevel = $this->getNamespace();
        $namespace         = '';

        if (!empty($namespaceTopLevel)) {
            $namespace = array();
            $topLevelSegments = count(explode('_', $namespaceTopLevel));
            for ($i = 0; $i < $topLevelSegments; $i++) {
                $namespace[] = array_shift($segments);
            }
            $namespace = implode('_', $namespace);
            if ($namespace != $namespaceTopLevel) {
                // wrong prefix? we're done
                return false;
            }
        }

        if (count($segments) < 2) {
            // assumes all resources have a component and class name, minimum
            return false;
        }

        $final     = array_pop($segments);
        $component = $namespace;
        $lastMatch = false;
        do {
            $segment    = array_shift($segments);
            $component .= empty($component) ? $segment : '_' . $segment;
            if (isset($this->_components[$component])) {
                $lastMatch = $component;
            }
        } while (count($segments));

        if (!$lastMatch) {
            return false;
        }

        $final = substr($class, strlen($lastMatch) + 1);
        $path = $this->_components[$lastMatch];
        $classPath = $path . '/' . str_replace('_', '/', $final) . '.php';

        if (Zend_Loader::isReadable($classPath)) {
            return $classPath;
        }

        return false;
    }

getDefaultResourceType()

getDefaultResourceType

(

)

Get default resource type to use when calling load()

Returns

string|null

Definition at line 435 of file Resource.php.

    {
        return $this->_defaultResourceType;
    }

getNamespace()

getNamespace

(

)

Get namespace this autoloader handles

Returns

string

Definition at line 247 of file Resource.php.

    {
        return $this->_namespace;
    }

getResourceTypes()

getResourceTypes

(

)

Retrieve resource type mappings

Returns

array

Definition at line 372 of file Resource.php.

    {
        return $this->_resourceTypes;
    }

hasResourceType()

hasResourceType

(

$type

)

Is the requested resource type defined?

Parameters

string

$type

Returns

bool

Definition at line 383 of file Resource.php.

    {
        return isset($this->_resourceTypes[$type]);
    }

load()

load	(		$resource,
			$type = null
	)

Object registry and factory

Loads the requested resource of type $type (or uses the default resource type if none provided). If the resource has been loaded previously, returns the previous instance; otherwise, instantiates it.

Parameters

string	$resource
string	$type

Returns

object

Exceptions

Zend_Loader_Exception

if resource type not specified or invalid

Definition at line 452 of file Resource.php.

    {
        if (null === $type) {
            $type = $this->getDefaultResourceType();
            if (empty($type)) {
                #require_once 'Zend/Loader/Exception.php';
                throw new Zend_Loader_Exception('No resource type specified');
            }
        }
        if (!$this->hasResourceType($type)) {
            #require_once 'Zend/Loader/Exception.php';
            throw new Zend_Loader_Exception('Invalid resource type specified');
        }
        $namespace = $this->_resourceTypes[$type]['namespace'];
        $class     = $namespace . '_' . ucfirst($resource);
        if (!isset($this->_resources[$class])) {
            $this->_resources[$class] = new $class;
        }
        return $this->_resources[$class];
    }

removeResourceType()

removeResourceType

(

$type

)

Remove the requested resource type

Parameters

string

$type

Returns

Zend_Loader_Autoloader_Resource

Definition at line 394 of file Resource.php.

    {
        if ($this->hasResourceType($type)) {
            $namespace = $this->_resourceTypes[$type]['namespace'];
            unset($this->_components[$namespace]);
            unset($this->_resourceTypes[$type]);
        }
        return $this;
    }

setBasePath()

setBasePath

(

$path

)

Set base path for this set of resources

Parameters

string

$path

Returns

Zend_Loader_Autoloader_Resource

Definition at line 258 of file Resource.php.

    {
        $this->_basePath = (string) $path;
        return $this;
    }

setDefaultResourceType()

setDefaultResourceType

(

$type

)

Set default resource type to use when calling load()

Parameters

string

$type

Returns

Zend_Loader_Autoloader_Resource

Definition at line 422 of file Resource.php.

    {
        if ($this->hasResourceType($type)) {
            $this->_defaultResourceType = $type;
        }
        return $this;
    }

setNamespace()

setNamespace

(

$namespace

)

Set namespace that this autoloader handles

Parameters

string

$namespace

Returns

Zend_Loader_Autoloader_Resource

Definition at line 236 of file Resource.php.

    {
        $this->_namespace = rtrim((string) $namespace, '_');
        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set class state from options

Parameters

array

$options

Returns

Zend_Loader_Autoloader_Resource

Definition at line 212 of file Resource.php.

    {
        // Set namespace first, see ZF-10836
        if (isset($options['namespace'])) {
            $this->setNamespace($options['namespace']);
            unset($options['namespace']);
        }

        $methods = get_class_methods($this);
        foreach ($options as $key => $value) {
            $method = 'set' . ucfirst($key);
            if (in_array($method, $methods)) {
                $this->$method($value);
            }
        }
        return $this;
    }

setResourceTypes()

setResourceTypes

(

array

$types

)

Overwrite existing and set multiple resource types at once

See also

Zend_Loader_Autoloader_Resource::addResourceTypes()

Parameters

array

$types

Returns

Zend_Loader_Autoloader_Resource

Definition at line 361 of file Resource.php.

    {
        $this->clearResourceTypes();
        return $this->addResourceTypes($types);
    }

Field Documentation

$_basePath

$_basePath

protected

Definition at line 40 of file Resource.php.

$_components

$_components = array()

protected

Definition at line 45 of file Resource.php.

$_defaultResourceType

$_defaultResourceType

protected

Definition at line 50 of file Resource.php.

$_namespace

$_namespace

protected

Definition at line 55 of file Resource.php.

$_resourceTypes

$_resourceTypes = array()

protected

Definition at line 60 of file Resource.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Loader/Autoloader/Resource.php