Method Details

• __unset ($name)

  $name

  The variable Name

  Removes a variable for the template.

  This is just really a shortcut for:
  

  $this->getVarHolder()->remove('name')

• (mixed) getVar ($name)

  $name

  The variable name

  Gets a variable set for the template.

  returns The variable value

• (boolean) hasFlash ($name)

  $name

  The name of the flash variable

  Returns true if a flash variable of the specified name exists.

  returns true if the variable exists, false otherwise

• (mixed) __call ($method, $arguments)

  $method	The method name
  $arguments	The method arguments

  Calls methods defined via the sfMixer class.

  returns The returned value of the called method

• logMessage ($message, $priority = 'info')

  $message	String or object containing the message to log
  $priority	The priority of the message (available priorities: emerg, alert, crit, err, warning, notice, info, debug)

  Logs a message using the sfLogger object.

• (string) getRequestParameter ($name, $default = null)

  $name

  The parameter name

  Returns the value of a request parameter.

  This is a proxy method equivalent to:
  

  $this->getRequest()->getParameterHolder()->get($name)

  returns The request parameter value

• setFlash ($name, $value, $persist = true)

  $name	The name of the flash variable
  $value	The value of the flash variable
  $persist	true if the flash have to persist for the following request (true by default)

  Sets a flash variable that will be passed to the very next action.

• (string) getPresentationFor ($module, $action, $viewName = null)

  $module	A module name
  $action	An action name
  $viewName	A View class name

  Returns the rendered view presentation of a given module/action.

  This is a shortcut for
  

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

  returns The generated content

• (mixed) execute ()

  Execute any application/business logic for this component.

  In a typical database-driven application, execute() handles application logic itself and then proceeds to create a model instance. Once the model instance is initialized it handles all business logic for the action.
  A model should represent an entity in your application. This could be a user account, a shopping cart, or even a something as simple as a single product.

  returns A string containing the view name associated with this action

• (mixed) getFlash ($name)

  $name

  The name of the flash variable

  Gets a flash variable.

  returns The value of the flash variable

• (string) getModuleName ()

  Gets the module name associated with this component.

  returns A module name

• (boolean) __set ($key, $value)

  $key	The variable name
  $value	The variable value

  Sets a variable for the template.

  This is a shortcut for:
  

  $this->setVar('name', 'value')

  returns always true

• (boolean) initialize ((sfContext) $context)

  $context

  The current application context

  Initializes this component.

  returns true, if initialization completes successfully, otherwise false

• getResponse ()

  Retrieves the current sfResponse object.

  This is a proxy method equivalent to:
  

  $this->getContext()->getResponse()

  returns The current sfResponse implementation instance

• setVar ($name, $value)

  $name	The variable name
  $value	The variable value

  Sets a variable for the template.

• (boolean) hasRequestParameter ($name)

  $name

  The parameter name

  Returns true if a request parameter exists.

  This is a proxy method equivalent to:
  

  $this->getRequest()->getParameterHolder()->has($name)

  returns true if the request parameter exists, false otherwise

• debugMessage ($message)

  $message

  The message text

  Displays a message as a short message in the sfWebDebug toolbar.

• getContext ()

  Retrieves the current application context.

  returns The current sfContext instance

• (boolean) __isset ($name)

  $name

  The variable name

  Returns true if a variable for the template is set.

  This is a shortcut for:
  

  $this->getVarHolder()->has('name')

  returns true if the variable is set

• getUser ()

  Retrieves the current sfUser object.

  This is a proxy method equivalent to:
  

  $this->getContext()->getUser()

  returns The current sfUser implementation instance

• (mixed&) __get ($key)

  $key	The variable name

  Gets a variable for the template.

  This is a shortcut for:
  

  $this->getVar('name')

  returns The variable value

• (string) getActionName ()

  Gets the action name associated with this component.

  returns An action name

• getLogger ()

  Retrieves the current logger instance.

  returns The current sfLogger instance

• (string) sendEmail ($module, $action)

  $module	A module name
  $action	An action name

  Sends and email from the current action.

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

  $this->getController()->sendEmail($module, $action)

  returns The generated mail content

• getRequest ()

  Retrieves the current sfRequest object.

  This is a proxy method equivalent to:
  

  $this->getContext()->getRequest()

  returns The current sfRequest implementation instance

• getVarHolder ()

  Gets the sfParameterHolder object that stores the template variables.

  returns The variable holder.

• getController ()

  Retrieves the current sfController object.

  This is a proxy method equivalent to:
  

  $this->getContext()->getController()

  returns The current sfController implementation instance