+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
* $Id$
*
*/
-Class CRM_Core_Form_Date {
+class CRM_Core_Form_Date {
/**
- * Various Date Formats
+ * Various Date Formats.
*/
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;
/**
- * This function is to build the date-format form
+ * build the date-format form
*
- * @param CRM_Core_Form $form the form object that we are operating on
+ * @param CRM_Core_Form $form
+ * The form object that we are operating on.
*
- * @static
*/
public static function buildAllowedDateFormats(&$form) {
/**
- * This function is to retrieve the date range - relative or absolute
+ * retrieve the date range - relative or absolute
* and assign it to the form
*
- * @param CRM_Core_Form $form - the form the dates should be added to
+ * @param CRM_Core_Form $form
+ * The form the dates should be added to.
* @param string $fieldName
- * @param integer $count
+ * @param int $count
* @param string $from
* @param string $to
* @param string $fromLabel
- * @param boolean $required
- * @param array $operators Additional value pairs to add
+ * @param bool $required
+ * @param array $operators
+ * Additional value pairs to add.
* @param string $dateFormat
* @param bool|string $displayTime
*
- *
- * @static
*/
-
- static function buildDateRange(
+ public static function buildDateRange(
&$form, $fieldName, $count = 1,
$from = '_from', $to = '_to', $fromLabel = 'From:',
$required = FALSE, $operators = array(),
$dateFormat = 'searchDate', $displayTime = FALSE
) {
- $selector =
- CRM_Core_Form_Date::returnDateRangeSelector(
+ $selector
+ = CRM_Core_Form_Date::returnDateRangeSelector(
$form, $fieldName, $count,
$from, $to, $fromLabel,
$required, $operators,
}
/**
- * This function is to build the date range array that will provide the form option values
+ * build the date range array that will provide the form option values.
* It can be - relative or absolute
*
- * @param CRM_Core_Form $form the form object that we are operating on
+ * @param CRM_Core_Form $form
+ * The form object that we are operating on.
* @param string $fieldName
- * @param integer $count
- * @param String $from
- * @param String $to
- * @param String $fromLabel
- * @param Boolean $required
- * @param Array $operators Additional Operator Selections to add
- * @param String $dateFormat
- * @param Boolean $displayTime
- * @return array Values for Selector
+ * @param int $count
+ * @param string $from
+ * @param string $to
+ * @param string $fromLabel
+ * @param bool $required
+ * @param array $operators
+ * Additional Operator Selections to add.
+ * @param string $dateFormat
+ * @param bool $displayTime
+ * @return array
+ * Values for Selector
*/
- static function returnDateRangeSelector(
+ public static function returnDateRangeSelector(
&$form, $fieldName, $count = 1,
$from = '_from', $to = '_to', $fromLabel = 'From:',
$required = FALSE, $operators = array(),
$dateFormat = 'searchDate', $displayTime = FALSE
) {
- $selector =
- array(
- '' => ts('- any -'),
- 0 => ts('Choose Date Range'),
- 'previous_2.year' => ts('Previous 2 Years'),
- 'previous_2.quarter' => ts('Previous 2 Quarters'),
- 'previous_2.month' => ts('Previous 2 Months'),
- 'previous_2.week' => ts('Previous 2 Weeks'),
- 'previous_2.day' => ts('Previous 2 Days'),
-
- 'previous_before.year' => ts('Prior to Previous Year'),
- 'previous_before.quarter' => ts('Prior to Previous Quarter'),
- 'previous_before.month' => ts('Prior to Previous Month'),
- 'previous_before.week' => ts('Prior to Previous Week'),
- 'previous_before.day' => ts('Prior to Previous Day'),
-
- 'previous.year' => ts('Previous Year'),
- 'previous.fiscal_year' => ts('Previous Fiscal Year'),
- 'previous.quarter' => ts('Previous Quarter'),
- 'previous.month' => ts('Previous Month'),
- 'previous.week' => ts('Previous Week'),
-
- 'earlier.year' => ts('To End of Previous Year'),
- 'earlier.quarter' => ts('To End of Previous Quarter'),
- 'earlier.month' => ts('To End of Previous Month'),
- 'earlier.week' => ts('To End of Previous Week'),
- 'earlier.day' => ts('To End of Previous Day'),
-
- 'greater_previous.year' => ts('From End of Previous Year'),
- 'greater_previous.quarter' => ts('From End of Previous Quarter'),
- 'greater_previous.month' => ts('From End of Previous Month'),
- 'greater_previous.week' => ts('From End of Previous Week'),
-
- 'greater.year' => ts('From Start of Current Year'),
- 'greater.quarter' => ts('From Start of Current Quarter'),
- 'greater.month' => ts('From Start of Current Month'),
- 'greater.week' => ts('From Start of Current Week'),
- 'greater.day' => ts('From Start of Current Day'),
-
- 'current.year' => ts('Current Year to-date'),
- 'current.quarter' => ts('Current Quarter to-date'),
- 'current.month' => ts('Current Month to-date'),
- 'current.week' => ts('Current Week to-date'),
-
- 'ending_3.year' => ts('Last 3 Years'),
- 'ending_2.year' => ts('Last 2 Years'),
- 'ending.year' => ts('Last 12 Months'),
- 'ending.quarter' => ts('Last 3 Months'),
- 'ending.month' => ts('Last Month'),
- 'ending.week' => ts('Last 7 days'),
- 'previous.day' => ts('Yesterday'),
-
- 'this.year' => ts('This Year'),
- 'this.fiscal_year' => ts('This Fiscal Year'),
- 'this.quarter' => ts('This Quarter'),
- 'this.month' => ts('This Month'),
- 'this.week' => ts('This Week'),
- 'this.day' => ts('Today'),
-
- 'starting.day' => ts('Tomorrow'),
- 'starting.week' => ts('Upcoming 7 days'),
- 'starting.month' => ts('Upcoming Month'),
- 'starting.year' => ts('Upcoming 12 Months'),
-
- 'less.year' => ts('To End of Current Year'),
- 'less.quarter' => ts('To End of Current Quarter'),
- 'less.month' => ts('To End of Current Month'),
- 'less.week' => ts('To End of Current Week'),
-
- 'next.week' => ts('Next Week'),
- 'next.month' => ts('Next Month'),
- 'next.quarter' => ts('Next Quarter'),
- 'next.fiscal_year' => ts('Next Fiscal Year'),
- 'next.year' => ts('Next Year'),
-
- );
+ $selector = array(
+ '' => ts('- any -'),
+ 0 => ts('Choose Date Range'),
+ 'previous_2.year' => ts('Previous 2 Years'),
+ 'previous_2.quarter' => ts('Previous 2 Quarters'),
+ 'previous_2.month' => ts('Previous 2 Months'),
+ 'previous_2.week' => ts('Previous 2 Weeks'),
+ 'previous_2.day' => ts('Previous 2 Days'),
+ 'previous_before.year' => ts('Prior to Previous Year'),
+ 'previous_before.quarter' => ts('Prior to Previous Quarter'),
+ 'previous_before.month' => ts('Prior to Previous Month'),
+ 'previous_before.week' => ts('Prior to Previous Week'),
+ 'previous_before.day' => ts('Prior to Previous Day'),
+ 'previous.year' => ts('Previous Year'),
+ 'previous.fiscal_year' => ts('Previous Fiscal Year'),
+ 'previous.quarter' => ts('Previous Quarter'),
+ 'previous.month' => ts('Previous Month'),
+ 'previous.week' => ts('Previous Week'),
+ 'earlier.year' => ts('To End of Previous Year'),
+ 'earlier.quarter' => ts('To End of Previous Quarter'),
+ 'earlier.month' => ts('To End of Previous Month'),
+ 'earlier.week' => ts('To End of Previous Week'),
+ 'earlier.day' => ts('To End of Previous Day'),
+ 'greater_previous.year' => ts('From End of Previous Year'),
+ 'greater_previous.quarter' => ts('From End of Previous Quarter'),
+ 'greater_previous.month' => ts('From End of Previous Month'),
+ 'greater_previous.week' => ts('From End of Previous Week'),
+ 'greater.year' => ts('From Start of Current Year'),
+ 'greater.quarter' => ts('From Start of Current Quarter'),
+ 'greater.month' => ts('From Start of Current Month'),
+ 'greater.week' => ts('From Start of Current Week'),
+ 'greater.day' => ts('From Start of Current Day'),
+ 'current.year' => ts('Current Year to-date'),
+ 'current.quarter' => ts('Current Quarter to-date'),
+ 'current.month' => ts('Current Month to-date'),
+ 'current.week' => ts('Current Week to-date'),
+ 'ending_3.year' => ts('Last 3 Years'),
+ 'ending_2.year' => ts('Last 2 Years'),
+ 'ending.year' => ts('Last 12 Months'),
+ 'ending.quarter' => ts('Last 3 Months'),
+ 'ending.month' => ts('Last Month'),
+ 'ending.week' => ts('Last 7 days'),
+ 'previous.day' => ts('Yesterday'),
+ 'this.year' => ts('This Year'),
+ 'this.fiscal_year' => ts('This Fiscal Year'),
+ 'this.quarter' => ts('This Quarter'),
+ 'this.month' => ts('This Month'),
+ 'this.week' => ts('This Week'),
+ 'this.day' => ts('Today'),
+ 'starting.day' => ts('Tomorrow'),
+ 'starting.week' => ts('Upcoming 7 days'),
+ 'starting.month' => ts('Upcoming Month'),
+ 'starting.year' => ts('Upcoming 12 Months'),
+ 'less.year' => ts('To End of Current Year'),
+ 'less.quarter' => ts('To End of Current Quarter'),
+ 'less.month' => ts('To End of Current Month'),
+ 'less.week' => ts('To End of Current Week'),
+ 'next.week' => ts('Next Week'),
+ 'next.month' => ts('Next Month'),
+ 'next.quarter' => ts('Next Quarter'),
+ 'next.fiscal_year' => ts('Next Fiscal Year'),
+ 'next.year' => ts('Next Year'),
+ );
if (is_array($operators)) {
$selector = array_merge($selector, $operators);
}
/**
- * This function is to build the date range - relative or absolute
+ * build the date range - relative or absolute
*
- * @param CRM_Core_Form $form the form object that we are operating on
+ * @param CRM_Core_Form $form
+ * The form object that we are operating on.
* @param string $fieldName
- * @param Array $selector array of option values to add
- * @param string $from Label
+ * @param array $selector
+ * Array of option values to add.
+ * @param string $from
+ * Label.
* @param string|\stringe $to
* @param string $fromLabel
- * @param boolean $required
+ * @param bool $required
* @param string $dateFormat
- * @param boolean $displayTime
- *
- * @return null
+ * @param bool $displayTime
*/
public static function addDateRangeToForm(&$form, $fieldName, $selector, $from = '_from', $to = '_to', $fromLabel = 'From:', $required = FALSE, $dateFormat = 'searchDate', $displayTime = FALSE) {
$form->add('select',
$selector,
$required,
array('class' => 'crm-select2')
- );
+ );
- $form->addDateRange($fieldName, $from, $to, $fromLabel, $dateFormat, FALSE, $displayTime);
+ $form->addDateRange($fieldName, $from, $to, $fromLabel, $dateFormat, FALSE, $displayTime);
}
}
projects / civicrm-core.git / blobdiff