1. sfAction.class.php
  2. /**
 * sfAction executes all the logic for the current request.
 *
 * @package    symfony
 * @subpackage action
 * @author     Fabien Potencier 
 * @author     Sean Kerr 
 * @version    SVN: $Id: sfAction.class.php 24279 2009-11-23 15:21:18Z fabien $
 */
  3. abstract class sfAction extends sfComponent
  4. {
  5.   protected
  6.     $security = array();
  8.   /**
  9.    * Initializes this action.
  10.    *
  11.    * @param sfContext $context    The current application context.
  12.    * @param string    $moduleName The module name.
  13.    * @param string    $actionName The action name.
  14.    *
  15.    * @return bool true, if initialization completes successfully, otherwise false
  16.    */
  17.   public function initialize($context, $moduleName, $actionName)
  18.   {
  19.     parent::initialize($context, $moduleName, $actionName);
  21.     // include security configuration
  22.     if ($file = $context->getConfigCache()->checkConfig('modules/'.$this->getModuleName().'/config/security.yml', true))
  23.     {
  24.       require($file);
  25.     }
  26.   }
  28.   /**
  29.    * Executes an application defined process prior to execution of this sfAction object.
  30.    *
  31.    * By default, this method is empty.
  32.    */
  33.   public function preExecute()
  34.   {
  35.   }
  37.   /**
  38.    * Execute an application defined process immediately after execution of this sfAction object.
  39.    *
  40.    * By default, this method is empty.
  41.    */
  42.   public function postExecute()
  43.   {
  44.   }
  46.   /**
  47.    * Forwards current action to the default 404 error action.
  48.    *
  49.    * @param string $message Message of the generated exception
  50.    *
  51.    * @throws sfError404Exception
  52.    *
  53.    */
  54.   public function forward404($message = null)
  55.   {
  56.     throw new sfError404Exception($this->get404Message($message));
  57.   }
  59.   /**
  60.    * Forwards current action to the default 404 error action unless the specified condition is true.
  61.    *
  62.    * @param bool    $condition  A condition that evaluates to true or false
  63.    * @param string  $message    Message of the generated exception
  64.    *
  65.    * @throws sfError404Exception
  66.    */
  67.   public function forward404Unless($condition, $message = null)
  68.   {
  69.     if (!$condition)
  70.     {
  71.       throw new sfError404Exception($this->get404Message($message));
  72.     }
  73.   }
  75.   /**
  76.    * Forwards current action to the default 404 error action if the specified condition is true.
  77.    *
  78.    * @param bool    $condition  A condition that evaluates to true or false
  79.    * @param string  $message    Message of the generated exception
  80.    *
  81.    * @throws sfError404Exception
  82.    */
  83.   public function forward404If($condition, $message = null)
  84.   {
  85.     if ($condition)
  86.     {
  87.       throw new sfError404Exception($this->get404Message($message));
  88.     }
  89.   }
  91.   /**
  92.    * Redirects current action to the default 404 error action (with browser redirection).
  93.    *
  94.    * This method stops the current code flow.
  95.    */
  96.   public function redirect404()
  97.   {
  98.     return $this->redirect('/'.sfConfig::get('sf_error_404_module').'/'.sfConfig::get('sf_error_404_action'));
  99.   }
  101.   /**
  102.    * Forwards current action to a new one (without browser redirection).
  103.    *
  104.    * This method stops the action. So, no code is executed after a call to this method.
  105.    *
  106.    * @param  string  $module  A module name
  107.    * @param  string  $action  An action name
  108.    *
  109.    * @throws sfStopException
  110.    */
  111.   public function forward($module, $action)
  112.   {
  113.     if (sfConfig::get('sf_logging_enabled'))
  114.     {
  115.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Forward to action "%s/%s"', $module, $action))));
  116.     }
  118.     $this->getController()->forward($module, $action);
  120.     throw new sfStopException();
  121.   }
  123.   /**
  124.    * If the condition is true, forwards current action to a new one (without browser redirection).
  125.    *
  126.    * This method stops the action. So, no code is executed after a call to this method.
  127.    *
  128.    * @param  bool   $condition  A condition that evaluates to true or false
  129.    * @param  string $module     A module name
  130.    * @param  string $action     An action name
  131.    *
  132.    * @throws sfStopException
  133.    */
  134.   public function forwardIf($condition, $module, $action)
  135.   {
  136.     if ($condition)
  137.     {
  138.       $this->forward($module, $action);
  139.     }
  140.   }
  142.   /**
  143.    * Unless the condition is true, forwards current action to a new one (without browser redirection).
  144.    *
  145.    * This method stops the action. So, no code is executed after a call to this method.
  146.    *
  147.    * @param  bool   $condition  A condition that evaluates to true or false
  148.    * @param  string $module     A module name
  149.    * @param  string $action     An action name
  150.    *
  151.    * @throws sfStopException
  152.    */
  153.   public function forwardUnless($condition, $module, $action)
  154.   {
  155.     if (!$condition)
  156.     {
  157.       $this->forward($module, $action);
  158.     }
  159.   }
  161.   /**
  162.    * Redirects current request to a new URL.
  163.    *
  164.    * 2 URL formats are accepted :
  165.    *  - a full URL: http://www.google.com/
  166.    *  - an internal URL (url_for() format): module/action
  167.    *
  168.    * This method stops the action. So, no code is executed after a call to this method.
  169.    *
  170.    * @param  string $url         Url
  171.    * @param  string $statusCode  Status code (default to 302)
  172.    *
  173.    * @throws sfStopException
  174.    */
  175.   public function redirect($url, $statusCode = 302)
  176.   {
  177.     // compatibility with url_for2() style signature
  178.     if (is_object($statusCode) || is_array($statusCode))
  179.     {
  180.       $url = array_merge(array('sf_route' => $url), is_object($statusCode) ? array('sf_subject' => $statusCode) : $statusCode);
  181.       $statusCode = func_num_args() >= 3 ? func_get_arg(2) : 302;
  182.     }
  184.     $this->getController()->redirect($url, 0, $statusCode);
  186.     throw new sfStopException();
  187.   }
  189.   /**
  190.    * Redirects current request to a new URL, only if specified condition is true.
  191.    *
  192.    * This method stops the action. So, no code is executed after a call to this method.
  193.    *
  194.    * @param  bool   $condition  A condition that evaluates to true or false
  195.    * @param  string $url        Url
  196.    * @param  string $statusCode Status code (default to 302)
  197.    *
  198.    * @throws sfStopException
  199.    *
  200.    * @see redirect
  201.    */
  202.   public function redirectIf($condition, $url, $statusCode = 302)
  203.   {
  204.     if ($condition)
  205.     {
  206.       // compatibility with url_for2() style signature
  207.       $arguments = func_get_args();
  208.       call_user_func_array(array($this, 'redirect'), array_slice($arguments, 1));
  209.     }
  210.   }
  212.   /**
  213.    * Redirects current request to a new URL, unless specified condition is true.
  214.    *
  215.    * This method stops the action. So, no code is executed after a call to this method.
  216.    *
  217.    * @param  bool   $condition  A condition that evaluates to true or false
  218.    * @param  string $url        Url
  219.    * @param  string $statusCode Status code (default to 302)
  220.    *
  221.    * @throws sfStopException
  222.    *
  223.    * @see redirect
  224.    */
  225.   public function redirectUnless($condition, $url, $statusCode = 302)
  226.   {
  227.     if (!$condition)
  228.     {
  229.       // compatibility with url_for2() style signature
  230.       $arguments = func_get_args();
  231.       call_user_func_array(array($this, 'redirect'), array_slice($arguments, 1));
  232.     }
  233.   }
  235.   /**
  236.    * Appends the given text to the response content and bypasses the built-in view system.
  237.    *
  238.    * This method must be called as with a return:
  239.    *
  240.    * <code>return $this->renderText('some text')</code>
  241.    *
  242.    * @param string $text Text to append to the response
  243.    *
  244.    * @return sfView::NONE
  245.    */
  246.   public function renderText($text)
  247.   {
  248.     $this->getResponse()->setContent($this->getResponse()->getContent().$text);
  250.     return sfView::NONE;
  251.   }
  253.   /**
  254.    * Returns the partial rendered content.
  255.    *
  256.    * If the vars parameter is omitted, the action's internal variables
  257.    * will be passed, just as it would to a normal template.
  258.    *
  259.    * If the vars parameter is set then only those values are
  260.    * available in the partial.
  261.    *
  262.    * @param  string $templateName partial name
  263.    * @param  array  $vars         vars
  264.    *
  265.    * @return string The partial content
  266.    */
  267.   public function getPartial($templateName, $vars = null)
  268.   {
  269.     $this->getContext()->getConfiguration()->loadHelpers('Partial');
  271.     $vars = null !== $vars ? $vars : $this->varHolder->getAll();
  273.     return get_partial($templateName, $vars);
  274.   }
  276.   /**
  277.    * Appends the result of the given partial execution to the response content.
  278.    *
  279.    * This method must be called as with a return:
  280.    *
  281.    * <code>return $this->renderPartial('foo/bar')</code>
  282.    *
  283.    * @param  string $templateName partial name
  284.    * @param  array  $vars         vars
  285.    *
  286.    * @return sfView::NONE
  287.    *
  288.    * @see    getPartial
  289.    */
  290.   public function renderPartial($templateName, $vars = null)
  291.   {
  292.     return $this->renderText($this->getPartial($templateName, $vars));
  293.   }
  295.   /**
  296.    * Returns the component rendered content.
  297.    *
  298.    * If the vars parameter is omitted, the action's internal variables
  299.    * will be passed, just as it would to a normal template.
  300.    *
  301.    * If the vars parameter is set then only those values are
  302.    * available in the component.
  303.    *
  304.    * @param  string  $moduleName    module name
  305.    * @param  string  $componentName  component name
  306.    * @param  array   $vars          vars
  307.    *
  308.    * @return string  The component rendered content
  309.    */
  310.   public function getComponent($moduleName, $componentName, $vars = null)
  311.   {
  312.     $this->getContext()->getConfiguration()->loadHelpers('Partial');
  314.     $vars = null !== $vars ? $vars : $this->varHolder->getAll();
  316.     return get_component($moduleName, $componentName, $vars);
  317.   }
  319.   /**
  320.    * Appends the result of the given component execution to the response content.
  321.    *
  322.    * This method must be called as with a return:
  323.    *
  324.    * <code>return $this->renderComponent('foo', 'bar')</code>
  325.    *
  326.    * @param  string  $moduleName    module name
  327.    * @param  string  $componentName  component name
  328.    * @param  array   $vars          vars
  329.    *
  330.    * @return sfView::NONE
  331.    *
  332.    * @see    getComponent
  333.    */
  334.   public function renderComponent($moduleName, $componentName, $vars = null)
  335.   {
  336.     return $this->renderText($this->getComponent($moduleName, $componentName, $vars));
  337.   }
  339.   /**
  340.    * Returns the security configuration for this module.
  341.    *
  342.    * @return string Current security configuration as an array
  343.    */
  344.   public function getSecurityConfiguration()
  345.   {
  346.     return $this->security;
  347.   }
  349.   /**
  350.    * Overrides the current security configuration for this module.
  351.    *
  352.    * @param array $security The new security configuration
  353.    */
  354.   public function setSecurityConfiguration($security)
  355.   {
  356.     $this->security = $security;
  357.   }
  359.   /**
  360.    * Returns a value from security.yml.
  361.    *
  362.    * @param string $name    The name of the value to pull from security.yml
  363.    * @param mixed  $default The default value to return if none is found in security.yml
  364.    *
  365.    * @return mixed
  366.    */
  367.   public function getSecurityValue($name, $default = null)
  368.   {
  369.     $actionName = strtolower($this->getActionName());
  371.     if (isset($this->security[$actionName][$name]))
  372.     {
  373.       return $this->security[$actionName][$name];
  374.     }
  376.     if (isset($this->security['all'][$name]))
  377.     {
  378.       return $this->security['all'][$name];
  379.     }
  381.     return $default;
  382.   }
  384.   /**
  385.    * Indicates that this action requires security.
  386.    *
  387.    * @return bool true, if this action requires security, otherwise false.
  388.    */
  389.   public function isSecure()
  390.   {
  391.     return $this->getSecurityValue('is_secure', false);
  392.   }
  394.   /**
  395.    * Gets credentials the user must have to access this action.
  396.    *
  397.    * @return mixed An array or a string describing the credentials the user must have to access this action
  398.    */
  399.   public function getCredential()
  400.   {
  401.     return $this->getSecurityValue('credentials');
  402.   }
  404.   /**
  405.    * Sets an alternate template for this sfAction.
  406.    *
  407.    * See 'Naming Conventions' in the 'Symfony View' documentation.
  408.    *
  409.    * @param string $name    Template name
  410.    * @param string $module  The module (current if null)
  411.    */
  412.   public function setTemplate($name, $module = null)
  413.   {
  414.     if (sfConfig::get('sf_logging_enabled'))
  415.     {
  416.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Change template to "%s/%s"', null === $module ? 'CURRENT' : $module, $name))));
  417.     }
  419.     if (null !== $module)
  420.     {
  421.       $name = sfConfig::get('sf_app_dir').'/modules/'.$module.'/templates/'.$name;
  422.     }
  424.     sfConfig::set('symfony.view.'.$this->getModuleName().'_'.$this->getActionName().'_template', $name);
  425.   }
  427.   /**
  428.    * Gets the name of the alternate template for this sfAction.
  429.    *
  430.    * WARNING: It only returns the template you set with the setTemplate() method,
  431.    *          and does not return the template that you configured in your view.yml.
  432.    *
  433.    * See 'Naming Conventions' in the 'Symfony View' documentation.
  434.    *
  435.    * @return string Template name. Returns null if no template has been set within the action
  436.    */
  437.   public function getTemplate()
  438.   {
  439.     return sfConfig::get('symfony.view.'.$this->getModuleName().'_'.$this->getActionName().'_template');
  440.   }
  442.   /**
  443.    * Sets an alternate layout for this sfAction.
  444.    *
  445.    * To de-activate the layout, set the layout name to false.
  446.    *
  447.    * To revert the layout to the one configured in the view.yml, set the template name to null.
  448.    *
  449.    * @param mixed $name Layout name or false to de-activate the layout
  450.    */
  451.   public function setLayout($name)
  452.   {
  453.     if (sfConfig::get('sf_logging_enabled'))
  454.     {
  455.       $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Change layout to "%s"', $name))));
  456.     }
  458.     sfConfig::set('symfony.view.'.$this->getModuleName().'_'.$this->getActionName().'_layout', $name);
  459.   }
  461.   /**
  462.    * Gets the name of the alternate layout for this sfAction.
  463.    *
  464.    * WARNING: It only returns the layout you set with the setLayout() method,
  465.    *          and does not return the layout that you configured in your view.yml.
  466.    *
  467.    * @return mixed Layout name. Returns null if no layout has been set within the action
  468.    */
  469.   public function getLayout()
  470.   {
  471.     return sfConfig::get('symfony.view.'.$this->getModuleName().'_'.$this->getActionName().'_layout');
  472.   }
  474.   /**
  475.    * Changes the default view class used for rendering the template associated with the current action.
  476.    *
  477.    * @param string $class View class name
  478.    */
  479.   public function setViewClass($class)
  480.   {
  481.     sfConfig::set('mod_'.strtolower($this->getModuleName()).'_view_class', $class);
  482.   }
  484.   /**
  485.    * Returns the current route for this request
  486.    *
  487.    * @return sfRoute The route for the request
  488.    */
  489.   public function getRoute()
  490.   {
  491.     return $this->getRequest()->getAttribute('sf_route');
  492.   }
  494.   /**
  495.    * Returns a formatted message for a 404 error.
  496.    *
  497.    * @param  string $message An error message (null by default)
  498.    *
  499.    * @return string The error message or a default one if null
  500.    */
  501.   protected function get404Message($message = null)
  502.   {
  503.     return null === $message ? sprintf('This request has been forwarded to a 404 error page by the action "%s/%s".', $this->getModuleName(), $this->getActionName()) : $message;
  504.   }
  505. }
Debug toolbar