Docs For Class Xyster_Container_Parameter

Description

Implements interfaces:

Xyster_Container_Parameter

Used to pass in "constant" arguments to constructors and methods

This includes strings, integers, or any other objects that is not registered in the container.

copyright: Copyright (c) 2007-2008 Irrational Logic (http://irrationallogic.net)
license: New BSD License

Located in /Container/Parameter/Constant.php (line 31)

Method Summary

Xyster_Container_Parameter_Constant __construct (mixed $value)

void accept (Xyster_Container_Visitor $visitor)

boolean isResolvable (Xyster_Container_Interface $container, Xyster_Container_Adapter $adapter, $expectedType, Xyster_Container_NameBinding $expectedNameBinding, boolean $useNames)

mixed resolveInstance (Xyster_Container_Interface $container, Xyster_Container_Adapter $adapter, $expectedType, Xyster_Container_NameBinding $expectedNameBinding, boolean $useNames)

void verify (Xyster_Container_Interface $container, Xyster_Container_Adapter $adapter, $expectedType, Xyster_Container_NameBinding $expectedNameBinding, boolean $useNames)

boolean _checkPrimitive ( $expectedType)

Methods

Constructor __construct (line 40)

Creates a new constant value parameter

access: public

Xyster_Container_Parameter_Constant __construct (mixed $value)

mixed $value

accept (line 50)

Accepts a visitor for this Parameter

access: public

void accept (Xyster_Container_Visitor $visitor)

Xyster_Container_Visitor $visitor: the visitor

Implementation of:

Xyster_Container_Parameter::accept(): Accepts a visitor for this Parameter

isResolvable (line 65)

Check if the Parameter can statisfy the expected type using the container.

return:
1. true
if the component parameter can be resolved.
access: public

boolean isResolvable (Xyster_Container_Interface $container, Xyster_Container_Adapter $adapter, $expectedType, Xyster_Container_NameBinding $expectedNameBinding, boolean $useNames)

Xyster_Container_Interface $container: the container from which dependencies are resolved.
Xyster_Container_Adapter $adapter: the Component Adapter that is asking for the instance
Xyster_Type $expectedType: the required type
Xyster_Container_NameBinding $expectedNameBinding: the expected parameter name
boolean $useNames

Implementation of:

Xyster_Container_Parameter::isResolvable(): Check if the Parameter can statisfy the expected type using the container.

resolveInstance (line 85)

Retrieve the object from the Parameter that statisfies the expected type.

return: the instance or
1. null
if no suitable instance can be found.
access: public

mixed resolveInstance (Xyster_Container_Interface $container, Xyster_Container_Adapter $adapter, $expectedType, Xyster_Container_NameBinding $expectedNameBinding, boolean $useNames)

Xyster_Container_Interface $container: the container from which dependencies are resolved.
Xyster_Container_Adapter $adapter: the Component Adapter that is asking for the instance
Xyster_Type $expectedType: the required type
Xyster_Container_NameBinding $expectedNameBinding: the expected parameter name
boolean $useNames

Implementation of:

Xyster_Container_Parameter::resolveInstance(): Retrieve the object from the Parameter that statisfies the expected type.

verify (line 100)

Verify that the Parameter can statisfied the expected type using the container

throws: Xyster_Container_Parameter_Exception if parameter and its dependencies cannot be resolved
access: public

void verify (Xyster_Container_Interface $container, Xyster_Container_Adapter $adapter, $expectedType, Xyster_Container_NameBinding $expectedNameBinding, boolean $useNames)

Xyster_Container_Interface $container: the container from which dependencies are resolved.
Xyster_Container_Adapter $adapter: the Component Adapter that is asking for the verification
Xyster_Type $expectedType: the required type
Xyster_Container_NameBinding $expectedNameBinding: the expected parameter name
boolean $useNames

Implementation of:

Xyster_Container_Parameter::verify(): Verify that the Parameter can statisfied the expected type using the container

_checkPrimitive (line 114)

Checks if a type is considered primative

access: protected

boolean _checkPrimitive ( $expectedType)

Xyster_Type $expectedType

Class Xyster_Container_Parameter_Constant