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: Module

Source Location: /module/Module.iface.php

Interface Overview




















Methods
























Class Details



[line 3]






[ Top ]








Class Methods



  

	
	
method executeSetup [line 159]

	

    

    

		true executeSetup(
)
    

    


	
		Execute module setup





Tags:





  

    return:  on success, false otherwise
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method executeUninstall [line 168]

	

    

    

		true executeUninstall(
)
    

    


	
		Execute module uninstall





Tags:





  

    return:  on success, false otherwise
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getConfiguration [line 105]

	

    

    

		Configuration getConfiguration(
)
    

    


	
		Retrieve module configuration





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getController [line 16]

	

    

    

		Controller getController(
string
$name)
    

    


	
		Retrieve a controller from this module





Tags:





  

    access:  public
  

  

    throws:  InvalidControllerException
  

  

    throws:  NonexistentControllerException
  










        
Parameters:

    

    

          

        string  
        $name  
        A controller name
      

        

    


        
[ Top ]

  

  

	
	
method getControllerDirectory [line 132]

	

    

    

		mixed getControllerDirectory(
)
    

    


	
		Retrieve the controller directory





Tags:





  

    return:  string path on success, false otherwise
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getLayoutTemplate [line 57]

	

    

    

		string getLayoutTemplate(
string
$name)
    

    


	
		Retrieve a layout template





Tags:





  

    return:  the full path to the layout template
  

  

    access:  public
  

  

    throws:  NonexistentTemplateException
  










        
Parameters:

    

    

          

        string  
        $name  
        a template name
      

        

    


        
[ Top ]

  

  

	
	
method getLayoutTemplateDirectory [line 141]

	

    

    

		mixed getLayoutTemplateDirectory(
)
    

    


	
		Retrieve the layout template directory





Tags:





  

    return:  string path on success, false otherwise
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getModel [line 30]

	

    

    

		Model getModel(
string
$name)
    

    


	
		Retrieve a model





Tags:





  

    access:  public
  

  

    throws:  InvalidModelExceptionn
  

  

    throws:  NonexistentModelException
  










        
Parameters:

    

    

          

        string  
        $name  
        
      

        

    


        
[ Top ]

  

  

	
	
method getModuleDirectory [line 114]

	

    

    

		mixed getModuleDirectory(
)
    

    


	
		Retrieve the module directory





Tags:





  

    return:  string path on success, false otherwise
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getParentModule [line 96]

	

    

    

		Module getParentModule(
)
    

    


	
		Retrieve the parent module of the current module





Tags:





  

    access:  public
  

  

    throws:  NonexistentModuleException
  

  

    throws:  InvalidModuleException
  










        
[ Top ]

  

  

	
	
method getSubmodule [line 84]

	

    

    

		Module getSubmodule(
string
$name)
    

    


	
		Retrieve a submodule of the current module





Tags:





  

    access:  public
  

  

    throws:  NonexistentModuleException
  

  

    throws:  InvalidModuleException
  










        
Parameters:

    

    

          

        string  
        $name  
        a module name
      

        

    


        
[ Top ]

  

  

	
	
method getView [line 44]

	

    

    

		View getView(
string
$name)
    

    


	
		Retrieve a view





Tags:





  

    access:  public
  

  

    throws:  NonexistentViewException
  

  

    throws:  InvalidViewException
  










        
Parameters:

    

    

          

        string  
        $name  
        A view name
      

        

    


        
[ Top ]

  

  

	
	
method getViewDirectory [line 123]

	

    

    

		mixed getViewDirectory(
)
    

    


	
		Retrieve the view directory





Tags:





  

    return:  string path on success, false otherwise
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getViewTemplate [line 70]

	

    

    

		string getViewTemplate(
string
$name)
    

    


	
		Retrieve a view template





Tags:





  

    return:  the full path to the layout template
  

  

    access:  public
  

  

    throws:  NonexistentTemplateException
  










        
Parameters:

    

    

          

        string  
        $name  
        a template name
      

        

    


        
[ Top ]

  

  

	
	
method getViewTemplateDirectory [line 150]

	

    

    

		mixed getViewTemplateDirectory(
)
    

    


	
		Retrieve the view template directory





Tags:





  

    return:  string path on success, false otherwise
  

  

    access:  public
  










        
[ Top ]

  






        

		    

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