Loader/Autoloader/Resource.php

Show:

inherited

Classes
- \Zend_Loader_Autoloader_Resource

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Loader
Subpackage: Autoloader
Version: $Id$

\Zend_Loader_Autoloader_Resource
jump to top

Package: Zend_Loader\Autoloader

Resource loader

Implements
Children: \Zend_Application_Module_Autoloader
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses

Properties

string $_basePath

Base path to resource classes

Details

Type: string

array $_components = array()

Components handled within this resource

Default valuearray()Details

Type: array

string $_defaultResourceType

Default resource/component to use when using object registry

Details

Type: string

string $_namespace

Namespace of classes within this resource

Details

Type: string

array $_resourceTypes = array()

Available resource types handled by this resource autoloader

Default valuearray()Details

Type: array

Methods

__call(string $method, array $args) : mixed

Overloading: methods

Allow retrieving concrete resource object instances using 'get()' 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

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Loader_Exception	if method not beginning with 'get' or not matching a valid resource type is called

__construct(array | \Zend_Config $options) : void

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config	Configuration options for resource autoloader

addResourceType(string $type, string $path, null | string $namespace = null) : \Zend_Loader_Autoloader_Resource

Add resource type

Parameters

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

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

addResourceTypes(array $types) : \Zend_Loader_Autoloader_Resource

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

Name	Type	Description
$types	array

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

autoload(string $class) : mixed

Attempt to autoload a class

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
mixed	False if not matched, otherwise result if include operation

clearResourceTypes() : \Zend_Loader_Autoloader_Resource

Clear all resource types

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

getBasePath() : string

Get base path to this set of resources

Returns

Type	Description
string

getClassPath(string $class) : False

Helper method to calculate the correct class path

Parameters

Name	Type	Description
$class	string

Returns

Type	Description
False	if not matched other wise the correct path

getDefaultResourceType() : string | null

Get default resource type to use when calling load()

Returns

Type	Description
string \| null

getNamespace() : string

Get namespace this autoloader handles

Returns

Type	Description
string

getResourceTypes() : array

Retrieve resource type mappings

Returns

Type	Description
array

hasResourceType(string $type) : bool

Is the requested resource type defined?

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
bool

load(string $resource, string $type = null) : object

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

Name	Type	Description
$resource	string
$type	string

Returns

Type	Description
object

Throws

Exception	Description
\Zend_Loader_Exception	if resource type not specified or invalid

removeResourceType(string $type) : \Zend_Loader_Autoloader_Resource

Remove the requested resource type

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

setBasePath(string $path) : \Zend_Loader_Autoloader_Resource

Set base path for this set of resources

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

setDefaultResourceType(string $type) : \Zend_Loader_Autoloader_Resource

Set default resource type to use when calling load()

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

setNamespace(string $namespace) : \Zend_Loader_Autoloader_Resource

Set namespace that this autoloader handles

Parameters

Name	Type	Description
$namespace	string

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

setOptions(array $options) : \Zend_Loader_Autoloader_Resource

Set class state from options

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

setResourceTypes(array $types) : \Zend_Loader_Autoloader_Resource

Overwrite existing and set multiple resource types at once

Parameters

Name	Type	Description
$types	array

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

Details

See

Loader/Autoloader/Resource.php

\Zend_Loader_Autoloader_Resourcejump to top

Properties

Methods

\Zend_Loader_Autoloader_Resource
jump to top