<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.6 |
+ | CiviCRM version 4.7 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* Redefine the display action.
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * @copyright CiviCRM LLC (c) 2004-2015
*/
class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
/**
- * The template to display the required "red" asterick
+ * The template to display the required "red" asterick.
* @var string
*/
static $_requiredTemplate = NULL;
/**
- * The template to display error messages inline with the form element
+ * The template to display error messages inline with the form element.
* @var string
*/
static $_errorTemplate = NULL;
/**
- * Class constructor
+ * Class constructor.
*
* @param object $stateMachine
* Reference to state machine object.
* @param string $actionName
* Current action name, as one Action object can serve multiple actions.
*
- * @return void
+ * @return object|void
*/
public function perform(&$page, $actionName) {
$pageName = $page->getAttribute('id');
}
/**
- * Render the page using a custom templating system
+ * Render the page using a custom templating system.
*
* @param CRM_Core_Form $page
* The CRM_Core_Form page.
- *
- *
- * @return void
*/
public function renderForm(&$page) {
$this->_setRenderTemplates($page);
}
/**
- * Set the various rendering templates
+ * Set the various rendering templates.
*
* @param CRM_Core_Form $page
* The CRM_Core_Form page.
- *
- * @return void
*/
public function _setRenderTemplates(&$page) {
if (self::$_requiredTemplate === NULL) {
}
/**
- * Initialize the various templates
- *
- * @return void
+ * Initialize the various templates.
*/
public function initializeTemplates() {
if (self::$_requiredTemplate !== NULL) {
self::$_requiredTemplate = file_get_contents($templateDir . '/CRM/Form/label.tpl');
self::$_errorTemplate = file_get_contents($templateDir . '/CRM/Form/error.tpl');
}
+
}