Merge pull request #3649 from colemanw/totten-colemanw-validate
[civicrm-core.git] / CRM / Admin / Page / MessageTemplates.php
index a2a834b7fd89b753a9da2c81146c494e571beee6..44d4f0b0c2c792dd11e19d991968c73eca15cbd8 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -52,6 +52,10 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
   // set to the id that we’re reverting at the given moment (if we are)
   protected $_revertedId;
 
+  /**
+   * @param null $title
+   * @param null $mode
+   */
   function __construct($title = NULL, $mode = NULL) {
     parent::__construct($title, $mode);
 
@@ -100,14 +104,12 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
         ),
         CRM_Core_Action::DISABLE => array(
           'name' => ts('Disable'),
-          'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_MessageTemplate' . '\',\'' . 'enable-disable' . '\' );"',
-          'ref' => 'disable-action',
+          'ref' => 'crm-enable-disable',
           'title' => ts('Disable this message template'),
         ),
         CRM_Core_Action::ENABLE => array(
           'name' => ts('Enable'),
-          'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_MessageTemplate' . '\',\'' . 'disable-enable' . '\' );"',
-          'ref' => 'enable-action',
+          'ref' => 'crm-enable-disable',
           'title' => ts('Enable this message template'),
         ),
         CRM_Core_Action::DELETE => array(
@@ -134,6 +136,14 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
     return self::$_links;
   }
 
+  /**
+   * @param CRM_Core_DAO $object
+   * @param int $action
+   * @param array $values
+   * @param array $links
+   * @param string $permission
+   * @param bool $forceAction
+   */
   function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
     if ($object->workflow_id) {
       // do not expose action link for reverting to default if the template did not diverge or we just reverted it now
@@ -170,6 +180,13 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
     }
   }
 
+  /**
+   * @param null $args
+   * @param null $pageArgs
+   * @param null $sort
+   *
+   * @throws Exception
+   */
   function run($args = NULL, $pageArgs = NULL, $sort = NULL) {
     // handle the revert action and offload the rest to parent
     if (CRM_Utils_Request::retrieve('action', 'String', $this) & CRM_Core_Action::REVERT) {
@@ -210,6 +227,8 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
   /**
    * Get user context.
    *
+   * @param null $mode
+   *
    * @return string user context.
    */
   function userContext($mode = NULL) {
@@ -219,7 +238,7 @@ class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
   /**
    * browse all entities.
    *
-   * @param int $action
+   * @internal param int $action
    *
    * @return void
    * @access public