[ Index ]
 

Code source de Symfony 1.0.0

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/action/ -> sfComponent.class.php (sommaire)

sfComponent.

Author: Fabien Potencier <fabien.potencier@symfony-project.com>
Version: SVN: $Id: sfComponent.class.php 3379 2007-02-01 06:49:58Z fabien $
Poids: 427 lignes (11 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 25 fonctions

  getModuleName()
  getActionName()
  initialize()
  getContext()
  getLogger()
  logMessage()
  debugMessage()
  getRequestParameter()
  hasRequestParameter()
  getRequest()
  getResponse()
  getController()
  getUser()
  setVar()
  getVar()
  getVarHolder()
  __set()
  __isset()
  __unset()
  setFlash()
  getFlash()
  hasFlash()
  sendEmail()
  getPresentationFor()
  __call()

Fonctions
Fonctions qui ne font pas partie d'une Classe:

getModuleName()   X-Ref
Gets the module name associated with this component.

return: string A module name

getActionName()   X-Ref
Gets the action name associated with this component.

return: string An action name

initialize($context)   X-Ref
Initializes this component.

param: sfContext The current application context
return: boolean true, if initialization completes successfully, otherwise false

getContext()   X-Ref
Retrieves the current application context.

return: sfContext The current sfContext instance

getLogger()   X-Ref
Retrieves the current logger instance.

return: sfLogger The current sfLogger instance

logMessage($message, $priority = 'info')   X-Ref
Logs a message using the sfLogger object.

param: mixed  String or object containing the message to log
param: string The priority of the message

debugMessage($message)   X-Ref
Displays a message as a short message in the sfWebDebug toolbar.

param: string The message text

getRequestParameter($name, $default = null)   X-Ref
Returns the value of a request parameter.

This is a proxy method equivalent to:

<code>$this->getRequest()->getParameterHolder()->get($name)</code>

param: string The parameter name
return: string The request parameter value

hasRequestParameter($name)   X-Ref
Returns true if a request parameter exists.

This is a proxy method equivalent to:

<code>$this->getRequest()->getParameterHolder()->has($name)</code>

param: string  The parameter name
return: boolean true if the request parameter exists, false otherwise

getRequest()   X-Ref
Retrieves the current sfRequest object.

This is a proxy method equivalent to:

<code>$this->getContext()->getRequest()</code>

return: sfRequest The current sfRequest implementation instance

getResponse()   X-Ref
Retrieves the current sfResponse object.

This is a proxy method equivalent to:

<code>$this->getContext()->getResponse()</code>

return: sfResponse The current sfResponse implementation instance

getController()   X-Ref
Retrieves the current sfController object.

This is a proxy method equivalent to:

<code>$this->getContext()->getController()</code>

return: sfController The current sfController implementation instance

getUser()   X-Ref
Retrieves the current sfUser object.

This is a proxy method equivalent to:

<code>$this->getContext()->getController()</code>

return: sfUser The current sfUser implementation instance

setVar($name, $value)   X-Ref
Sets a variable for the template.

param: string The variable name
param: mixed  The variable value

getVar($name)   X-Ref
Gets a variable set for the template.

param: string The variable name
return: mixed  The variable value

getVarHolder()   X-Ref
Gets the sfParameterHolder object that stores the template variables.

return: sfParameterHolder The variable holder.

__set($key, $value)   X-Ref
Sets a variable for the template.

This is a shortcut for:

<code>$this->setVar('name', 'value')</code>

param: string The variable name
param: string The variable value
return: boolean always true

__isset($name)   X-Ref
Pas de description

__unset($name)   X-Ref
Removes a variable for the template.

This is just really a shortcut for:

<code>$this->getVarHolder()->remove('name')</code>

param: string The variable Name

setFlash($name, $value, $persist = true)   X-Ref
Sets a flash variable that will be passed to the very next action.

param: string  The name of the flash variable
param: string  The value of the flash variable
param: boolean true if the flash have to persist for the following request (true by default)

getFlash($name)   X-Ref
Gets a flash variable.

param: string The name of the flash variable
return: mixed The value of the flash variable

hasFlash($name)   X-Ref
Returns true if a flash variable of the specified name exists.

param: string The name of the flash variable
return: boolean   true if the variable exists, false otherwise

sendEmail($module, $action)   X-Ref
Sends and email from the current action.

This methods calls a module/action with the sfMailView class.

This is a shortcut for

<code>$this->getController()->sendEmail($module, $action)</code>

param: string A module name
param: string An action name
return: string The generated mail content

getPresentationFor($module, $action, $viewName = null)   X-Ref
Returns the rendered view presentation of a given module/action.

This is a shortcut for

<code>$this->getController()->getPresentationFor($module, $action, $viewName)</code>

param: string A module name
param: string An action name
param: string A View class name
return: string The generated content

__call($method, $arguments)   X-Ref
Calls methods defined via the sfMixer class.

param: string The method name
param: array  The method arguments
return: mixed The returned value of the called method



Généré le : Fri Mar 16 22:42:14 2007 par Balluche grâce à PHPXref 0.7