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   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    * @access public
  66    */
  67   public function buildQuickForm() {
  68     $this->applyFilter('__ALL__', 'trim');
  69
  70     $this->add('text', 'name', ts('Name'),
  71       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'name'), TRUE
  72     );
  73     $this->addRule('name', ts('Name already exists in Database.'), 'objectExists', array('CRM_Mailing_DAO_Component', $this->_id));
  74
  75     $this->add('select', 'component_type', ts('Component Type'), CRM_Core_SelectValues::mailingComponents());
  76
  77     $this->add('text', 'subject', ts('Subject'),
  78       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'subject'),
  79       TRUE
  80     );
  81     $this->add('textarea', 'body_text', ts('Body - TEXT Format'),
  82       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'body_text'),
  83       TRUE
  84     );
  85     $this->add('textarea', 'body_html', ts('Body - HTML Format'),
  86       CRM_Core_DAO::getAttribute('CRM_Mailing_DAO_Component', 'body_html')
  87     );
  88
  89     $this->add('checkbox', 'is_default', ts('Default?'));
  90     $this->add('checkbox', 'is_active', ts('Enabled?'));
  91
  92     $this->addFormRule(array('CRM_Mailing_Form_Component', 'dataRule'));
  93
  94     $this->addButtons(array(
  95         array(
  96           'type' => 'next',
  97           'name' => ts('Save'),
  98           'isDefault' => TRUE,
  99         ),
 100         array(
 101           'type' => 'cancel',
 102           'name' => ts('Cancel'),
 103         ),
 104       )
 105     );
 106   }
 107
 108   /**
 109    * Set default values for the form.
 110    *
 111    * @access public
 112    *
 113    * @return void
 114    */
 115   function setDefaultValues() {
 116     $defaults = array();
 117     $params = array();
 118
 119     if (isset($this->_id)) {
 120       $params = array('id' => $this->_id);
 121       $baoName = $this->_BAOName;
 122       $baoName::retrieve($params, $defaults);
 123     }
 124     $defaults['is_active'] = 1;
 125
 126     return $defaults;
 127   }
 128
 129   /**
 130    * Process the form submission
 131    *
 132    * @access public
 133    *
 134    * @return void
 135    */
 136   public function postProcess() {
 137     // store the submitted values in an array
 138     $params = $this->controller->exportValues($this->_name);
 139
 140     if ($this->_action & CRM_Core_Action::UPDATE) {
 141       $params['id'] = $this->_id;
 142     }
 143
 144     $component = CRM_Mailing_BAO_Component::add($params);
 145     CRM_Core_Session::setStatus(ts('The mailing component \'%1\' has been saved.', array(
 146         1 => $component->name
 147       )
 148     ), ts('Saved'), 'success');
 149
 150   }
 151
 152   /**
 153    * Validation
 154    *
 155    * @param array $params (ref.) an assoc array of name/value pairs
 156    *
 157    * @param $files
 158    * @param $options
 159    *
 160    * @return mixed true or array of errors
 161    * @access public
 162    * @static
 163    */
 164   static function dataRule($params, $files, $options) {
 165     if ($params['component_type'] == 'Header' || $params['component_type'] == 'Footer') {
 166       $InvalidTokens = array();
 167     }
 168     else {
 169       $InvalidTokens = array('action.forward' => ts("This token can only be used in send mailing context (body, header, footer).."));
 170     }
 171     $errors = array();
 172     foreach (array(
 173       'text', 'html') as $type) {
 174       $dataErrors = array();
 175       foreach ($InvalidTokens as $token => $desc) {
 176         if ($params['body_' . $type]) {
 177           if (preg_match('/' . preg_quote('{' . $token . '}') . '/', $params['body_' . $type])) {
 178             $dataErrors[] = '<li>' . ts('This message is having a invalid token - %1: %2', array(
 179               1 => $token, 2 => $desc)) . '</li>';
 180           }
 181         }
 182       }
 183       if (!empty($dataErrors)) {
 184         $errors['body_' . $type] = ts('The following errors were detected in %1 message:', array(
 185           1 => $type)) . '<ul>' . implode('', $dataErrors) . '</ul><br /><a href="' . CRM_Utils_System::docURL2('Tokens', TRUE, NULL, NULL, NULL, "wiki") . '">' . ts('More information on tokens...') . '</a>';
 186       }
 187     }
 188
 189     return empty($errors) ? TRUE : $errors;
 190   }
 191 }
 192