Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
0f03f337 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
0f03f337 | 31 | * @copyright CiviCRM LLC (c) 2004-2017 |
6a488035 | 32 | */ |
2aa397bc | 33 | class CRM_Core_Form_Date { |
6a488035 TO |
34 | |
35 | /** | |
fe482240 | 36 | * Various Date Formats. |
6a488035 | 37 | */ |
7da04cde | 38 | const DATE_yyyy_mm_dd = 1, DATE_mm_dd_yy = 2, DATE_mm_dd_yyyy = 4, DATE_Month_dd_yyyy = 8, DATE_dd_mon_yy = 16, DATE_dd_mm_yyyy = 32; |
6a488035 TO |
39 | |
40 | /** | |
8eedd10a | 41 | * Build the date-format form. |
6a488035 | 42 | * |
6a0b768e TO |
43 | * @param CRM_Core_Form $form |
44 | * The form object that we are operating on. | |
6a488035 | 45 | */ |
00be9182 | 46 | public static function buildAllowedDateFormats(&$form) { |
6a488035 TO |
47 | |
48 | $dateOptions = array(); | |
49 | ||
ac4410cd | 50 | if (CRM_Utils_System::getClassName($form) == 'CRM_Activity_Import_Form_DataSource') { |
6a488035 TO |
51 | $dateText = ts('yyyy-mm-dd OR yyyy-mm-dd HH:mm OR yyyymmdd OR yyyymmdd HH:mm (1998-12-25 OR 1998-12-25 15:33 OR 19981225 OR 19981225 10:30 OR ( 2008-9-1 OR 2008-9-1 15:33 OR 20080901 15:33)'); |
52 | } | |
53 | else { | |
54 | $dateText = ts('yyyy-mm-dd OR yyyymmdd (1998-12-25 OR 19981225) OR (2008-9-1 OR 20080901)'); | |
55 | } | |
56 | ||
57 | $dateOptions[] = $form->createElement('radio', NULL, NULL, $dateText, self::DATE_yyyy_mm_dd); | |
58 | ||
59 | $dateOptions[] = $form->createElement('radio', NULL, NULL, ts('mm/dd/yy OR mm-dd-yy (12/25/98 OR 12-25-98) OR (9/1/08 OR 9-1-08)'), self::DATE_mm_dd_yy); | |
60 | $dateOptions[] = $form->createElement('radio', NULL, NULL, ts('mm/dd/yyyy OR mm-dd-yyyy (12/25/1998 OR 12-25-1998) OR (9/1/2008 OR 9-1-2008)'), self::DATE_mm_dd_yyyy); | |
61 | $dateOptions[] = $form->createElement('radio', NULL, NULL, ts('Month dd, yyyy (December 12, 1998)'), self::DATE_Month_dd_yyyy); | |
62 | $dateOptions[] = $form->createElement('radio', NULL, NULL, ts('dd-mon-yy OR dd/mm/yy (25-Dec-98 OR 25/12/98)'), self::DATE_dd_mon_yy); | |
63 | $dateOptions[] = $form->createElement('radio', NULL, NULL, ts('dd/mm/yyyy (25/12/1998) OR (1/9/2008)'), self::DATE_dd_mm_yyyy); | |
64 | $form->addGroup($dateOptions, 'dateFormats', ts('Date Format'), '<br/>'); | |
65 | $form->setDefaults(array('dateFormats' => self::DATE_yyyy_mm_dd)); | |
66 | } | |
67 | ||
bc3f7f04 | 68 | |
6a488035 | 69 | /** |
8eedd10a | 70 | * Retrieve the date range - relative or absolute and assign it to the form. |
77b97be7 | 71 | * |
6a0b768e TO |
72 | * @param CRM_Core_Form $form |
73 | * The form the dates should be added to. | |
bc3f7f04 | 74 | * @param string $fieldName |
6a0b768e | 75 | * @param int $count |
bc3f7f04 | 76 | * @param string $from |
77 | * @param string $to | |
78 | * @param string $fromLabel | |
6a0b768e TO |
79 | * @param bool $required |
80 | * @param array $operators | |
81 | * Additional value pairs to add. | |
bc3f7f04 | 82 | * @param string $dateFormat |
77b97be7 | 83 | * @param bool|string $displayTime |
49d4d222 | 84 | * @param array $attributes |
6a488035 | 85 | */ |
8d7a9d07 | 86 | public static function buildDateRange( |
634e1a1a DL |
87 | &$form, $fieldName, $count = 1, |
88 | $from = '_from', $to = '_to', $fromLabel = 'From:', | |
89 | $required = FALSE, $operators = array(), | |
49d4d222 | 90 | $dateFormat = 'searchDate', $displayTime = FALSE, |
91 | $attributes = array('class' => 'crm-select2') | |
634e1a1a | 92 | ) { |
8d7a9d07 CB |
93 | $selector |
94 | = CRM_Core_Form_Date::returnDateRangeSelector( | |
634e1a1a DL |
95 | $form, $fieldName, $count, |
96 | $from, $to, $fromLabel, | |
97 | $required, $operators, | |
98 | $dateFormat, $displayTime | |
99 | ); | |
100 | CRM_Core_Form_Date::addDateRangeToForm( | |
101 | $form, $fieldName, $selector, | |
102 | $from, $to, $fromLabel, | |
49d4d222 | 103 | $required, $dateFormat, $displayTime, |
104 | $attributes | |
634e1a1a | 105 | ); |
f119bedd | 106 | } |
107 | ||
108 | /** | |
8eedd10a | 109 | * Build the date range array that will provide the form option values. |
110 | * | |
111 | * It can be - relative or absolute. | |
f119bedd | 112 | * |
6a0b768e TO |
113 | * @param CRM_Core_Form $form |
114 | * The form object that we are operating on. | |
f119bedd | 115 | * @param string $fieldName |
6a0b768e TO |
116 | * @param int $count |
117 | * @param string $from | |
118 | * @param string $to | |
119 | * @param string $fromLabel | |
120 | * @param bool $required | |
121 | * @param array $operators | |
122 | * Additional Operator Selections to add. | |
123 | * @param string $dateFormat | |
124 | * @param bool $displayTime | |
8eedd10a | 125 | * |
a6c01b45 CW |
126 | * @return array |
127 | * Values for Selector | |
f119bedd | 128 | */ |
8d7a9d07 | 129 | public static function returnDateRangeSelector( |
634e1a1a DL |
130 | &$form, $fieldName, $count = 1, |
131 | $from = '_from', $to = '_to', $fromLabel = 'From:', | |
132 | $required = FALSE, $operators = array(), | |
133 | $dateFormat = 'searchDate', $displayTime = FALSE | |
134 | ) { | |
8d7a9d07 CB |
135 | $selector = array( |
136 | '' => ts('- any -'), | |
137 | 0 => ts('Choose Date Range'), | |
8d7a9d07 | 138 | ); |
7537a84b J |
139 | // CRM-16195 Pull relative date filters from an option group |
140 | $selector = $selector + CRM_Core_OptionGroup::values('relative_date_filters'); | |
180214e9 DL |
141 | |
142 | if (is_array($operators)) { | |
143 | $selector = array_merge($selector, $operators); | |
144 | } | |
bc3f7f04 | 145 | |
6a488035 TO |
146 | $config = CRM_Core_Config::singleton(); |
147 | //if fiscal year start on 1 jan then remove fiscal year task | |
148 | //form list | |
149 | if ($config->fiscalYearStart['d'] == 1 & $config->fiscalYearStart['M'] == 1) { | |
150 | unset($selector['this.fiscal_year']); | |
151 | unset($selector['previous.fiscal_year']); | |
152 | } | |
f119bedd | 153 | return $selector; |
154 | } | |
6a488035 | 155 | |
f119bedd | 156 | /** |
8eedd10a | 157 | * Build the date range - relative or absolute. |
f119bedd | 158 | * |
6a0b768e TO |
159 | * @param CRM_Core_Form $form |
160 | * The form object that we are operating on. | |
f119bedd | 161 | * @param string $fieldName |
6a0b768e TO |
162 | * @param array $selector |
163 | * Array of option values to add. | |
164 | * @param string $from | |
165 | * Label. | |
8eedd10a | 166 | * @param string $to |
da6b46f4 | 167 | * @param string $fromLabel |
6a0b768e | 168 | * @param bool $required |
f119bedd | 169 | * @param string $dateFormat |
6a0b768e | 170 | * @param bool $displayTime |
49d4d222 | 171 | * @param array $attributes |
f119bedd | 172 | */ |
49d4d222 | 173 | public static function addDateRangeToForm( |
174 | &$form, | |
175 | $fieldName, | |
176 | $selector, | |
177 | $from = '_from', | |
178 | $to = '_to', | |
179 | $fromLabel = 'From:', | |
180 | $required = FALSE, | |
181 | $dateFormat = 'searchDate', | |
182 | $displayTime = FALSE, | |
183 | $attributes | |
184 | ) { | |
6a488035 TO |
185 | $form->add('select', |
186 | "{$fieldName}_relative", | |
187 | ts('Relative Date Range'), | |
1eef83c9 CW |
188 | $selector, |
189 | $required, | |
49d4d222 | 190 | $attributes |
353ffa53 | 191 | ); |
6a488035 | 192 | |
2aa397bc | 193 | $form->addDateRange($fieldName, $from, $to, $fromLabel, $dateFormat, FALSE, $displayTime); |
6a488035 | 194 | } |
f119bedd | 195 | |
6a488035 | 196 | } |