3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * This class generates form components for Location Type
40 class CRM_Mailing_Form_Component
extends CRM_Core_Form
{
43 * The id of the object being edited / created
50 * The name of the BAO object for this form
56 function preProcess() {
57 $this->_id
= $this->get('id');
58 $this->_BAOName
= $this->get('BAOName');
62 * Function to build the form
67 public function buildQuickForm() {
68 $this->applyFilter('__ALL__', 'trim');
70 $this->add('text', 'name', ts('Name'),
71 CRM_Core_DAO
::getAttribute('CRM_Mailing_DAO_Component', 'name'), TRUE
73 $this->addRule('name', ts('Name already exists in Database.'), 'objectExists', array('CRM_Mailing_DAO_Component', $this->_id
));
75 $this->add('select', 'component_type', ts('Component Type'), CRM_Core_SelectValues
::mailingComponents());
77 $this->add('text', 'subject', ts('Subject'),
78 CRM_Core_DAO
::getAttribute('CRM_Mailing_DAO_Component', 'subject'),
81 $this->add('textarea', 'body_text', ts('Body - TEXT Format'),
82 CRM_Core_DAO
::getAttribute('CRM_Mailing_DAO_Component', 'body_text'),
85 $this->add('textarea', 'body_html', ts('Body - HTML Format'),
86 CRM_Core_DAO
::getAttribute('CRM_Mailing_DAO_Component', 'body_html')
89 $this->add('checkbox', 'is_default', ts('Default?'));
90 $this->add('checkbox', 'is_active', ts('Enabled?'));
92 $this->addFormRule(array('CRM_Mailing_Form_Component', 'dataRule'));
94 $this->addButtons(array(
102 'name' => ts('Cancel'),
109 * This function sets the default values for the form.
115 function setDefaultValues() {
119 if (isset($this->_id
)) {
120 $params = array('id' => $this->_id
);
121 $baoName = $this->_BAOName
;
122 $baoName::retrieve($params, $defaults);
124 $defaults['is_active'] = 1;
130 * Function to process the form
136 public function postProcess() {
137 // store the submitted values in an array
138 $params = $this->controller
->exportValues($this->_name
);
142 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
143 $ids['id'] = $this->_id
;
146 CRM_Mailing_BAO_Component
::add($params, $ids);
151 * Function for validation
153 * @param array $params (ref.) an assoc array of name/value pairs
155 * @return mixed true or array of errors
159 static function dataRule($params, $files, $options) {
160 if ($params['component_type'] == 'Header' ||
$params['component_type'] == 'Footer') {
161 $InvalidTokens = array();
164 $InvalidTokens = array('action.forward' => ts("This token can only be used in send mailing context (body, header, footer).."));
168 'text', 'html') as $type) {
169 $dataErrors = array();
170 foreach ($InvalidTokens as $token => $desc) {
171 if ($params['body_' . $type]) {
172 if (preg_match('/' . preg_quote('{' . $token . '}') . '/', $params['body_' . $type])) {
173 $dataErrors[] = '<li>' . ts('This message is having a invalid token - %1: %2', array(
174 1 => $token, 2 => $desc)) . '</li>';
178 if (!empty($dataErrors)) {
179 $errors['body_' . $type] = ts('The following errors were detected in %1 message:', array(
180 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>';
184 return empty($errors) ?
TRUE : $errors;