mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]
Packages:
mojavi


Files:
mojavi.php
version.php

subpackage action
Action.class.php
ActionStack.class.php
ActionStackEntry.class.php

subpackage config
AutoloadConfigHandler.class.php
CompileConfigHandler.class.php
ConfigCache.class.php
ConfigHandler.class.php
DatabaseConfigHandler.class.php
DefineConfigHandler.class.php
FactoryConfigHandler.class.php
FilterConfigHandler.class.php
IniConfigHandler.class.php
LoggingConfigHandler.class.php
ModuleConfigHandler.class.php
ParameterParser.class.php
RootConfigHandler.class.php
ValidatorConfigHandler.class.php

subpackage controller
ConsoleController.class.php
Controller.class.php
FrontWebController.class.php
PageWebController.class.php
WebController.class.php

subpackage core
Context.class.php
MojaviObject.class.php

subpackage database
CreoleDatabase.class.php
Database.class.php
DatabaseManager.class.php
MySQLDatabase.class.php
PDODatabase.class.php
PostgreSQLDatabase.class.php

subpackage exception
AutoloadException.class.php
CacheException.class.php
ConfigurationException.class.php
ControllerException.class.php
DatabaseException.class.php
FactoryException.class.php
FileException.class.php
FilterException.class.php
ForwardException.class.php
InitializationException.class.php
LoggingException.class.php
MojaviException.class.php
ParseException.class.php
RenderException.class.php
SecurityException.class.php
StorageException.class.php
ValidatorException.class.php
ViewException.class.php

subpackage filter
BasicSecurityFilter.class.php
ExecutionFilter.class.php
ExecutionTimeFilter.class.php
Filter.class.php
FilterChain.class.php
SecurityFilter.class.php

subpackage logging
Appender.class.php
ErrorLogger.class.php
FileAppender.class.php
Layout.class.php
Logger.class.php
LoggerManager.class.php
MailAppender.class.php
Message.class.php
PatternLayout.class.php
StderrAppender.class.php
StdoutAppender.class.php

subpackage model
Model.class.php

subpackage request
ConsoleRequest.class.php
Request.class.php
WebRequest.class.php

subpackage storage
MySQLSessionStorage.class.php
PostgreSQLSessionStorage.class.php
SessionStorage.class.php
Storage.class.php

subpackage user
BasicSecurityUser.class.php
SecurityUser.class.php
User.class.php

subpackage util
ConversionPattern.class.php
ParameterHolder.class.php
Toolkit.class.php

subpackage validator
DateValidator.class.php
EmailValidator.class.php
NumberValidator.class.php
RegexValidator.class.php
StringValidator.class.php
Validator.class.php
ValidatorManager.class.php

subpackage view
PHPView.class.php
SmartyView.class.php
View.class.php

Classes:
action
   Action
   ActionStack
   ActionStackEntry
logging
   Appender
   ErrorLogger
   FileAppender
   Layout
   Logger
   LoggerManager
   MailAppender
   Message
   PatternLayout
   StderrAppender
   StdoutAppender
config
   AutoloadConfigHandler
   CompileConfigHandler
   ConfigCache
   ConfigHandler
   DatabaseConfigHandler
   DefineConfigHandler
   FactoryConfigHandler
   FilterConfigHandler
   IniConfigHandler
   LoggingConfigHandler
   ModuleConfigHandler
   ParameterParser
   RootConfigHandler
   ValidatorConfigHandler
exception
   AutoloadException
   CacheException
   ConfigurationException
   ControllerException
   DatabaseException
   FactoryException
   FileException
   FilterException
   ForwardException
   InitializationException
   LoggingException
   MojaviException
   ParseException
   RenderException
   SecurityException
   StorageException
   ValidatorException
   ViewException
filter
   BasicSecurityFilter
   ExecutionFilter
   ExecutionTimeFilter
   Filter
   FilterChain
   SecurityFilter
user
   BasicSecurityUser
   SecurityUser
   User
controller
   ConsoleController
   Controller
   FrontWebController
   PageWebController
   WebController
request
   ConsoleRequest
   Request
   WebRequest
core
   Context
   MojaviObject
util
   ConversionPattern
   ParameterHolder
   Toolkit
database
   CreoleDatabase
   Database
   DatabaseManager
   MySQLDatabase
   PDODatabase
   PostgreSQLDatabase
validator
   DateValidator
   EmailValidator
   NumberValidator
   RegexValidator
   StringValidator
   Validator
   ValidatorManager
model
   Model
storage
   MySQLSessionStorage
   PostgreSQLSessionStorage
   SessionStorage
   Storage
view
   PHPView
   SmartyView
   View

Class: ParameterHolder

Source Location: /util/ParameterHolder.class.php

Class Overview




ParameterHolder provides a base class for managing parameters.




Author(s):


    
                                  
  • Sean Kerr (skerr@mojavi.org)
    • 
      





        
              
      

Version:


    
  
  • $Id: ParameterHolder.class.php 762 2005-01-29 06:30:25Z seank $
    • 




Copyright:







Variables







Methods















Child classes:






Validator

	
Validator allows you to apply constraints to user entered parameters.






Filter

	
Filter provides a way for you to intercept incoming requests or outgoing  responses.






Message

	






Request

	
Request provides methods for manipulating client request information such  as attributes, errors and parameters. It is also possible to manipulate the  request method originally sent by the user.






Storage

	
Storage allows you to customize the way Mojavi stores its persistent data.






Database

	
Database is a base abstraction class that allows you to setup any type of  database connection via a configuration file.






ConfigHandler

	
ConfigHandler allows a developer to create a custom formatted configuration  file pertaining to any information they like and still have it auto-generate  PHP code.






User

	
User wraps a client session and provides accessor methods for user  attributes. It also makes storing and retrieving multiple page form data  rather easy by allowing user attributes to be stored in namespaces, which  help organize data.

















Class Details



[line 23]

ParameterHolder provides a base class for managing parameters.





Tags:





  

    abstract:  
  

  

    version:  $Id: ParameterHolder.class.php 762 2005-01-29 06:30:25Z seank $
  

  

    since:  3.0.0
  

  

    copyright:  (c) Sean Kerr, http://www.mojavi.org
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










[ Top ]







Class Variables



	
	

	
$parameters = array()

	
[line 31]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
method clearParameters [line 45]

	

    

    

		void clearParameters(
)
    

    


	
		Clear all parameters associated with this request.





Tags:





  

    access:  public
  

  

    since:  3.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
[ Top ]

  

  

	
	
method getParameter [line 67]

	

    

    

		mixed &getParameter(
string
$name, [mixed
$default = null])
    

    


	
		Retrieve a parameter.





Tags:





  

    return:  A parameter value, if the parameter exists, otherwise                null.
  

  

    access:  public
  

  

    since:  3.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
Parameters:

    

    

          

        string  
        $name  
        A parameter name.
      

          

        mixed  
        $default  
        A default parameter value.
      

        

    


        
[ Top ]

  

  

	
	
method getParameterNames [line 93]

	

    

    

		array getParameterNames(
)
    

    


	
		Retrieve an array of parameter names.





Tags:





  

    return:  An indexed array of parameter names.
  

  

    access:  public
  

  

    since:  3.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
[ Top ]

  

  

	
	
method getParameters [line 110]

	

    

    

		array &getParameters(
)
    

    


	
		Retrieve an array of parameters.





Tags:





  

    return:  An associative array of parameters.
  

  

    access:  public
  

  

    since:  3.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
[ Top ]

  

  

	
	
method hasParameter [line 129]

	

    

    

		bool hasParameter(
string
$name)
    

    


	
		Indicates whether or not a parameter exists.





Tags:





  

    return:  true, if the parameter exists, otherwise false.
  

  

    access:  public
  

  

    since:  3.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
Parameters:

    

    

          

        string  
        $name  
        A parameter name.
      

        

    


        
[ Top ]

  

  

	
	
method removeParameter [line 149]

	

    

    

		string &removeParameter(
string
$name)
    

    


	
		Remove a parameter.





Tags:





  

    return:  A parameter value, if the parameter was removed,                 otherwise null.
  

  

    access:  public
  

  

    since:  1.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
Parameters:

    

    

          

        string  
        $name  
        A parameter name.
      

        

    


        
[ Top ]

  

  

	
	
method setParameter [line 182]

	

    

    

		void setParameter(
string
$name, mixed
$value)
    

    


	
		Set a parameter.

If a parameter with the name already exists the value will be overridden.





Tags:





  

    access:  public
  

  

    since:  2.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
Parameters:

    

    

          

        string  
        $name  
        A parameter name.
      

          

        mixed  
        $value  
        A parameter value.
      

        

    


        
[ Top ]

  

  

	
	
method setParameterByRef [line 205]

	

    

    

		void setParameterByRef(
string
$name, mixed
$value)
    

    


	
		Set a parameter by reference.

If a parameter with the name already exists the value will be  overridden.





Tags:





  

    access:  public
  

  

    since:  2.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
Parameters:

    

    

          

        string  
        $name  
        A parameter name.
      

          

        mixed  
        $value  
        A reference to a parameter value.
      

        

    


        
[ Top ]

  

  

	
	
method setParameters [line 228]

	

    

    

		void setParameters(
array
$parameters)
    

    


	
		Set an array of parameters.

If an existing parameter name matches any of the keys in the supplied  array, the associated value will be overridden.





Tags:





  

    access:  public
  

  

    since:  3.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
Parameters:

    

    

          

        array  
        $parameters  
        An associative array of parameters and their associated               values.
      

        

    


        
[ Top ]

  

  

	
	
method setParametersByRef [line 251]

	

    

    

		void setParametersByRef(
array
&$parameters)
    

    


	
		Set an array of parameters by reference.

If an existing parameter name matches any of the keys in the supplied  array, the associated value will be overridden.





Tags:





  

    access:  public
  

  

    since:  3.0.0
  

  

    author:  Sean Kerr (skerr@mojavi.org)
  










        
Parameters:

    

    

          

        array  
        &$parameters  
        An associative array of parameters and references to their               associated values.
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 21 Feb 2006 01:45:23 +0900 by phpDocumentor 1.3.0RC5