CRM/Mailing/Form/Component.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Location Type
  38  *
  39  */
  40 class CRM_Mailing_Form_Component extends CRM_Core_Form {
  41
  42   /**
  43    * The id of the object being edited / created
  44    *
  45    * @var int
  46    */
  47   protected $_id;
  48
  49   /**
  50    * The name of the BAO object for this form.
  51    *
  52    * @var string
  53    */
  54   protected $_BAOName;
  55
  56   public function preProcess() {
  57     $this->_id = $this->get('id');
  58     $this->_BAOName = $this->get('BAOName');
  59   }
  60
  61   /**
  62    * Build the form object.
  63    *
  64    * @return void
  65    */
  66   public function buildQuickForm() {
  67     $this->applyFilter('__ALL__', 'trim');
  68
  69     $this->add('text', 'name', ts('Name'),
  70       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'name'), TRUE
  71     );
  72     $this->addRule('name', ts('Name already exists in Database.'), 'objectExists', array(
  73         'CRM_Mailing_DAO_Component',
  74         $this->_id,
  75       ));
  76
  77     $this->add('select', 'component_type', ts('Component Type'), CRM_Core_SelectValues::mailingComponents());
  78
  79     $this->add('text', 'subject', ts('Subject'),
  80       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'subject'),
  81       TRUE
  82     );
  83     $this->add('textarea', 'body_text', ts('Body - TEXT Format'),
  84       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'body_text'),
  85       TRUE
  86     );
  87     $this->add('textarea', 'body_html', ts('Body - HTML Format'),
  88       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'body_html')
  89     );
  90
  91     $this->addYesNo('is_default', ts('Default?'));
  92     $this->addYesNo('is_active', ts('Enabled?'));
  93
  94     $this->addFormRule(array('CRM_Mailing_Form_Component', 'dataRule'));
  95
  96     $this->addButtons(array(
  97         array(
  98           'type' => 'next',
  99           'name' => ts('Save'),
 100           'isDefault' => TRUE,
 101         ),
 102         array(
 103           'type' => 'cancel',
 104           'name' => ts('Cancel'),
 105         ),
 106       )
 107     );
 108   }
 109
 110   /**
 111    * Set default values for the form.
 112    *
 113    *
 114    * @return void
 115    */
 116   public function setDefaultValues() {
 117     $defaults = array();
 118     $params = array();
 119
 120     if (isset($this->_id)) {
 121       $params = array('id' => $this->_id);
 122       $baoName = $this->_BAOName;
 123       $baoName::retrieve($params, $defaults);
 124     }
 125     else {
 126       $defaults['is_active'] = 1;
 127     }
 128
 129     return $defaults;
 130   }
 131
 132   /**
 133    * Process the form submission.
 134    *
 135    *
 136    * @return void
 137    */
 138   public function postProcess() {
 139     // store the submitted values in an array
 140     $params = $this->controller->exportValues($this->_name);
 141
 142     if ($this->_action & CRM_Core_Action::UPDATE) {
 143       $params['id'] = $this->_id;
 144     }
 145
 146     $component = CRM_Mailing_BAO_Component::add($params);
 147     CRM_Core_Session::setStatus(ts('The mailing component \'%1\' has been saved.', array(
 148         1 => $component->name,
 149       )
 150     ), ts('Saved'), 'success');
 151
 152   }
 153
 154   /**
 155    * Validation.
 156    *
 157    * @param array $params
 158    *   (ref.) an assoc array of name/value pairs.
 159    *
 160    * @param $files
 161    * @param $options
 162    *
 163    * @return bool|array
 164    *   mixed true or array of errors
 165    */
 166   public static function dataRule($params, $files, $options) {
 167     if ($params['component_type'] == 'Header' || $params['component_type'] == 'Footer') {
 168       $InvalidTokens = array();
 169     }
 170     else {
 171       $InvalidTokens = array('action.forward' => ts("This token can only be used in send mailing context (body, header, footer).."));
 172     }
 173     $errors = array();
 174     foreach (array(
 175                'text',
 176                'html',
 177              ) as $type) {
 178       $dataErrors = array();
 179       foreach ($InvalidTokens as $token => $desc) {
 180         if ($params['body_' . $type]) {
 181           if (preg_match('/' . preg_quote('{' . $token . '}') . '/', $params['body_' . $type])) {
 182             $dataErrors[] = '<li>' . ts('This message is having a invalid token - %1: %2', array(
 183                 1 => $token,
 184                 2 => $desc,
 185               )) . '</li>';
 186           }
 187         }
 188       }
 189       if (!empty($dataErrors)) {
 190         $errors['body_' . $type] = ts('The following errors were detected in %1 message:', array(
 191             1 => $type,
 192           )) . '<ul>' . implode('', $dataErrors) . '</ul><br /><a href="' . CRM_Utils_System::docURL2('Tokens', TRUE, NULL, NULL, NULL, "wiki") . '">' . ts('More information on tokens...') . '</a>';
 193       }
 194     }
 195
 196     return empty($errors) ? TRUE : $errors;
 197   }
 198
 199 }