default
[ class tree: default ] [ index: default ] [ all elements ]
Packages:
default
common.cache
common.container
common.controller.flow
common.datasource
common.datastructure
common.helper.dsn
common.logger
common.logger.appender
common.logger.layout
common.reader
common.storage
common.validator
Mojavi
mvc.controller
package.loader


Files:
ActiveModel.class.php
AmbiguousServiceException.class.php
ApplicationAvailabilityFilter.class.php
ApplicationController.class.php
BasicModule.class.php
BasicService.class.php
BasicServiceLocator.class.php
Chain.class.php
CompositeException.class.php
Configuration.class.php
ConfigurationException.class.php
ConstructorInjectionService.class.php
Container.iface.php
ContentTypeFilter.class.php
Controller.iface.php
DatabaseDatasource.class.php
DataTypeRule.class.php
DecoratingService.class.php
DefaultActionControllerExecutionFilter.class.php
DefaultApplicationControllerExecutionFilter.class.php
DefaultComponentExecutionFilter.class.php
DefaultExceptionHandler.class.php
DefaultRequest.class.php
DefaultSecurityFilter.class.php
DottedElementHelper.class.php
DynamicTypeView.class.php
DynamicViewActionController.class.php
example-template.php
ExceptionHandler.class.php
ExceptionHandlerFilter.class.php
Exceptions.php
ExecutionFilter.class.php
ExecutionTimeFilter.class.php
FileDatasource.class.php
FormApplicationController.class.php
ForwardFilterChain.class.php
ForwardLockException.class.php
FrameworkHelper.class.php
FrontInputController.class.php
GlobalExecutionFilter.class.php
GlobalFilterChain.class.php
GlobalModule.class.php
GlobalTemplateFilter.class.php
Helper.class.php
HelperHelper.class.php
HttpRequest.class.php
HttpResponse.class.php
IdentityRule.class.php
IgnoreTestsFilterIterator.class.php
IgnoreVersionControlDirectoriesFilterIterator.class.php
InitializationException.class.php
InstaniatedService.class.php
InvalidControllerException.class.php
InvalidModuleException.class.php
InvalidResponseException.class.php
InvalidRuleException.class.php
InvalidTargetException.class.php
InvocationWrapperFilter.class.php
Linkable.iface.php
LinkHelper.class.php
MaskRule.class.php
MaxLengthRule.class.php
MaxValueRule.class.php
Messenger.class.php
MinLengthRule.class.php
MinValueRule.class.php
Model.class.php
Module.iface.php
ModuleApplicationHelper.class.php
ModuleFactory.class.php
MojaviException.class.php
MutableContainer.iface.php
MysqlDatasource.class.php
NonexistentControllerException.class.php
NonexistentModuleException.class.php
NonexistentViewException.class.php
OnlyPackageDescriptorsFilterIterator.class.php
OnlyTestsFilterIterator.class.php
PackageException.class.php
PackageIterator.class.php
PdoDatasource.class.php
PermissionsException.class.php
PersistentContainer.iface.php
PhpRenderer.class.php
Queue.class.php
Renderer.class.php
Request.iface.php
Response.iface.php
ResponseFilter.class.php
RestGlobalExecutionFilter.class.php
RingStack.class.php
Rule.iface.php
SanitaryContainer.class.php
SecurityFilter.iface.php
SecurityUser.class.php
Service.class.php
ServiceLocator.class.php
ServiceWrapperFilter.class.php
SimpleXmlReader.class.php
SqliteDatasource.class.php
Stack.class.php
StepApplicationController.class.php
Storage.iface.php
TabledHtmlPrintingException.template.php
TestCacheRolloverTechnique.test.php
TestChain.test.php
TestDefaultContainer.test.php
TestDottedElementHelper.test.php
TestDsnHelper.test.php
TestFileCache.test.php
TestFileDatasource.test.php
TestLogger.test.php
TestMinLengthRule.test.php
TestQueue.test.php
TestRingStack.class.php
TestSerializingCache.test.php
TestSessionStorage.test.php
TestSimpleXmlReader.test.php
TestSqliteDatasource.test.php
TestStack.test.php
TestTemplateCacheTechniques.test.php
TestUser.test.php
TestValidatorManager.test.php
UnresolvableControllerException.class.php
UnresolvableServiceException.class.php
User.class.php
Validatable.iface.php
ValidValuesRule.class.php
View.iface.php

Classes:
AmbiguousServiceException
ApplicationController
BasicModule
BasicService
Chain
Configuration
ConfigurationException
ConstructorInjectionService
Container
ContentTypeFilter
Controller
CyclicException
CyclicExecutionException
DatabaseDatasource
DataTypeRule
DecoratingService
DefaultComponentExecutionFilter
DefaultExceptionHandler
DoesNotExistException
DottedElementHelper
DuplicateServiceException
ExceptionHandler
FileDatasource
FormApplicationController
ForwardFilterChain
ForwardLockException
FrameworkHelper
FrontInputController
GlobalFilterChain
GlobalModule
Helper
HelperHelper
HtmlPrintingException
IdentityRule
IgnoreTestsFilterIterator
IgnoreVersionControlDirectoriesFilterIterator
IllegalOperationException
InitializationException
InstaniatedService
InvalidArgumentException
InvalidControllerException
InvalidModuleException
InvalidPackageException
InvalidResponseException
InvalidRuleException
InvalidServiceException
InvalidStepException
InvalidTargetException
InvalidViewException
Linkable
LinkHelper
MaskRule
MaxLengthRule
MaxValueRule
MinLengthRule
MinValueRule
Module
ModuleApplicationHelper
ModuleFactory
MojaviException
MutableContainer
MysqlDatasource
NonexistentControllerException
NonexistentModuleException
NonexistentTargetException
NonexistentViewException
OnlyPackageDescriptorsFilterIterator
OnlyTestsFilterIterator
PackageException
PackageIterator
PdoDatasource
PermissionsException
PersistentContainer
PhpRenderer
PrintingException
Queue
Renderer
Request
Response
ResponseFilter
RingStack
Rule
SanitaryContainer
SecurityException
SecurityUser
Service
ServiceLocator
SimpleXmlReader
SqliteDatasource
Stack
StepApplicationController
Storage
TabledHtmlPrintingException
TestBasicContainer
TestCacheRollover
TestChainTest
TestDottedElementHelper
TestDsnHelper
TestFileCacheTest
TestFileDatasource
TestLogger
TestMinLengthRule
TestQueue
TestRingStackTest
TestSerializingCache
TestSessionStorage
TestSimpleXmlReader
TestSqliteDatasource
TestStackTest
TestTemplateCacheTechniques
TestUser
TestValidatorManager
UnavailableException
UnreadableException
UnresolvableControllerException
UnresolvableServiceException
UnwritableException
User
Validatable
ValidValuesRule
View

Class: Service

Source Location: /locator/service/Service.class.php

Class Overview

ReflectionClass
   |
   --Service

Service is a extension to the ReflectionClass which provides a series of ServiceLocator/Dependency Injection facilities


Author(s):

  • Tyler Tompkins (ttompkins@mojavi.org)

Variables

Constants

Methods

Child classes:

ConstructorInjectionService
DecoratingService
Service is a extension to the ReflectionClass which provides a series of ServiceLocator/Dependency Injection facilities
BasicService
InstaniatedService

Class Details

[line 18]
Service is a extension to the ReflectionClass which provides a series of ServiceLocator/Dependency Injection facilities



Tags:

abstract:  
author:  Tyler Tompkins (ttompkins@mojavi.org)
since:  4.0.0


[ Top ]

Class Variables

$instance =  null

[line 32]



Tags:

var:  a internal reference to the instance created by resolveInstance()
access:  protected

Type:   $instance


[ Top ]

$options = array()

[line 37]



Tags:

var:  array is a list of all set options for this service
access:  protected

Type:   $options


[ Top ]

$parameters = array()

[line 43]



Tags:

var:  stores a hash of all parameters that are to be passed on class initialization
access:  protected

Type:   $parameters


[ Top ]


Class Methods

constructor __construct [line 47]

Service __construct( mixed $arg, [mixed $options = array()])



Tags:

access:  public


[ Top ]

method getOption [line 87]

mixed getOption( string $name)

Retrieve an option for the Service



Tags:

return:  Option value on success, null otherwise
access:  public
author:  Tyler Tompkins (ttompkins@mojavi.org)


Parameters:

string   $name   An option index

[ Top ]

method getOptions [line 152]

mixed getOptions( string 0)

Retrieve a parameter for the Service



Tags:

return:  Option value on success, null otherwise
access:  public
author:  Tyler Tompkins (ttompkins@mojavi.org)


Parameters:

string   0   An option index

[ Top ]

method getParameter [line 120]

mixed getParameter( string $name)

Retrieve a parameter for the Service



Tags:

return:  Option value on success, null otherwise
access:  public
author:  Tyler Tompkins (ttompkins@mojavi.org)


Parameters:

string   $name   An option index

[ Top ]

method getParameters [line 136]

mixed getParameters( string 0)

Retrieve all Service parameters



Tags:

return:  Option value on success, null otherwise
access:  public
author:  Tyler Tompkins (ttompkins@mojavi.org)


Parameters:

string   0   An option index

[ Top ]

method resolveInstance [line 170]

stdclass resolveInstance( ServiceLocator $sl, [array $args = array()])

Perform any Service-type specific construction



Tags:

return:  an instance of the class requested on success, stdclass otherwise
access:  public
abstract:  
author:  Tyler Tompkins (ttompkins@mojavi.org)


Overridden in child classes as:

ConstructorInjectionService::resolveInstance()
Perform any Service-type specific construction
DecoratingService::resolveInstance()
Perform any Service-type specific construction
BasicService::resolveInstance()
Perform any Service-type specific construction
InstaniatedService::resolveInstance()
Perform any Service-type specific construction

Parameters:

ServiceLocator   $sl   a reference to the ServiceLocator
array   $args   An array of arguments to be passed to the object

[ Top ]

method setInstance [line 181]

void setInstance( stdclass $instance)

Explicitly set the instance



Tags:

access:  public
author:  Tyler Tompkins (ttompkins@mojavi.org)


Overridden in child classes as:

DecoratingService::setInstance()
Explicitly set the instance

Parameters:

stdclass   $instance   An object

[ Top ]

method setOption [line 71]

void setOption( string $name, [string $value = true])

Set an option for the Service



Tags:

access:  public
author:  Tyler Tompkins (ttompkins@mojavi.org)


Parameters:

string   $name   The name of the option
string   $value   The option value

[ Top ]

method setParameter [line 104]

void setParameter( string $name, string $value)

Set a parameters for the instantiation of this Service



Tags:

access:  public
author:  Tyler Tompkins (ttompkins@mojavi.org)


Parameters:

string   $name   A named parameter key
string   $value   The value to be passed for this key

[ Top ]

Class Constants

AUTOLOAD =  'autoload'

[line 24]


[ Top ]

LAZY_INC =  'lazyinc'

[line 23]


[ Top ]

SINGLETON =  'singleton'

[line 22]


[ Top ]


Documentation generated on Tue, 21 Feb 2006 02:30:00 +0900 by phpDocumentor 1.3.0RC5