include/generic/SugarWidgets/SugarWidgetFieldtime.php
Show:
inherited
inherited
Classes
\SugarWidgetFieldTime
Package:
Parameters
Returns
Generic Sugar widget
Properties
$assigned_user= 'null'
inheritedInherited from:
\SugarWidgetFieldDateTime::$$assigned_user
Default value
nullDetails- Type
- n/a
- Inherited_from
- \SugarWidgetFieldDateTime::$$assigned_user
$form_value= ''
inheritedInherited from:
\SugarWidget::$$form_value\SugarWidgetField::$$form_value\SugarWidgetReportField::$$form_value\SugarWidgetFieldDateTime::$$form_value
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$form_value
- Inherited_from
- \SugarWidgetField::$$form_value
- Inherited_from
- \SugarWidgetReportField::$$form_value
- Inherited_from
- \SugarWidgetFieldDateTime::$$form_value
$layout_manager= 'null'
inheritedInherited from:
\SugarWidget::$$layout_manager\SugarWidgetField::$$layout_manager\SugarWidgetReportField::$$layout_manager\SugarWidgetFieldDateTime::$$layout_manager
Default value
nullDetails- Type
- n/a
- Inherited_from
- \SugarWidget::$$layout_manager
- Inherited_from
- \SugarWidgetField::$$layout_manager
- Inherited_from
- \SugarWidgetReportField::$$layout_manager
- Inherited_from
- \SugarWidgetFieldDateTime::$$layout_manager
\SugarBean
$reporter= ''
Details
- Type
- \SugarBean
- Inherited_from
- \SugarWidgetFieldDateTime::$$reporter
$widget_id= ''
inheritedInherited from:
\SugarWidget::$$widget_id\SugarWidgetField::$$widget_id\SugarWidgetReportField::$$widget_id\SugarWidgetFieldDateTime::$$widget_id
Details
- Type
- n/a
- Inherited_from
- \SugarWidget::$$widget_id
- Inherited_from
- \SugarWidgetField::$$widget_id
- Inherited_from
- \SugarWidgetReportField::$$widget_id
- Inherited_from
- \SugarWidgetFieldDateTime::$$widget_id
Methods
SugarWidget(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidget::SugarWidget()\SugarWidgetField::SugarWidget()\SugarWidgetReportField::SugarWidget()\SugarWidgetFieldDateTime::SugarWidget()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetField(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetField::SugarWidgetField()\SugarWidgetReportField::SugarWidgetField()\SugarWidgetFieldDateTime::SugarWidgetField()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetFieldDateTime(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::SugarWidgetFieldDateTime()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
SugarWidgetReportField(
$layout_manager
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::SugarWidgetReportField()\SugarWidgetFieldDateTime::SugarWidgetReportField()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_manager |
_get_column_alias(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_alias()\SugarWidgetFieldDateTime::_get_column_alias()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
_get_column_select(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_select()\SugarWidgetFieldDateTime::_get_column_select()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
_get_column_select_special(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::_get_column_select_special()\SugarWidgetFieldDateTime::_get_column_select_special()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
_get_list_value(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::_get_list_value()\SugarWidgetReportField::_get_list_value()\SugarWidgetFieldDateTime::_get_list_value()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
display(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayDetail(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayDetail()\SugarWidgetReportField::displayDetail()\SugarWidgetFieldDateTime::displayDetail()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayDetailLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayDetailLabel()\SugarWidgetReportField::displayDetailLabel()\SugarWidgetFieldDateTime::displayDetailLabel()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayEdit(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayEdit()\SugarWidgetReportField::displayEdit()\SugarWidgetFieldDateTime::displayEdit()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayEditLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayEditLabel()\SugarWidgetReportField::displayEditLabel()\SugarWidgetFieldDateTime::displayEditLabel()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayHeaderCell(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::displayHeaderCell()\SugarWidgetFieldDateTime::displayHeaderCell()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayHeaderCellPlain(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displayHeaderCellPlain()\SugarWidgetReportField::displayHeaderCellPlain()\SugarWidgetFieldDateTime::displayHeaderCellPlain()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayInput(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::displayInput()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayList(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayListPlain(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::displayListPlain()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayListday(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::displayListday()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayListmonth(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::displayListmonth()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayListquarter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::displayListquarter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displayListyear(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::displayListyear()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displaySearch(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displaySearch()\SugarWidgetReportField::displaySearch()\SugarWidgetFieldDateTime::displaySearch()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
displaySearchLabel(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::displaySearchLabel()\SugarWidgetReportField::displaySearchLabel()\SugarWidgetFieldDateTime::displaySearchLabel()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
expandDate(
\$date $date, bool $end
=
false
)
:
\$date
This function helps to convert a date only value to have a time value as well. It first checks to see if a time value exists. If a time value exists, the function just returns the date value passed in. If the date value is the 'Today' macro then some special processing occurs as well. Finally the time portion is applied depending on whether or not this date should be for the end in which case the 23:59:59 time value is applied otherwise 00:00:00 is used.
| Name | Type | Description |
|---|---|---|
| $date | \$date | String value of the date value to expand |
| $end | bool | Boolean value indicating whether or not this is for an end time period or not |
| Type | Description |
|---|---|
| \$date | TimeDate object with time value applied |
getDisplayName(
)
:
void
getSubClass(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::getSubClass()\SugarWidgetFieldDateTime::getSubClass()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
getTruncatedColumnAlias(
$column_name
)
:
void
inherited
getTruncatedColumnAlias This function ensures that a column alias is no more than 28 characters. Should the column_name argument exceed 28 charcters, it creates an alias using the first 22 characters of the column_name plus an md5 of the first 6 characters of the lowercased column_name value.
Inherited from: \SugarWidget::getTruncatedColumnAlias()\SugarWidgetField::getTruncatedColumnAlias()\SugarWidgetReportField::getTruncatedColumnAlias()\SugarWidgetFieldDateTime::getTruncatedColumnAlias()
Parameters
| Name | Type | Description |
|---|---|---|
| $column_name |
getVardef(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetField::getVardef()\SugarWidgetReportField::getVardef()\SugarWidgetFieldDateTime::getVardef()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
getWidgetId(
)
:
\id
inherited
getSubpanelWidgetId This is a utility function to return a widget's unique id
Inherited from: \SugarWidget::getWidgetId()\SugarWidgetField::getWidgetId()\SugarWidgetReportField::getWidgetId()\SugarWidgetFieldDateTime::getWidgetId()
Returns
| Type | Description |
|---|---|
| \id | String label of the widget's unique id |
get_db_date(
int $days, \time $time
)
:
void
inherited
Get specified date and time for a particalur day, in current user's timezone.
Inherited from: \SugarWidgetFieldDateTime::get_db_date()
Parameters
| Name | Type | Description |
|---|---|---|
| $days | int | Adjust date by this number of days, negative values are valid. |
| $time | \time | string falg for desired time value, start: minimum time, end: maximum time, default: current time |
get_start_end_date_filter(
array $layout_def, string $begin, string $end
)
:
void
inherited
Get filter string for a date field.
Inherited from: \SugarWidgetFieldDateTime::get_start_end_date_filter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def | array | layout_def field def for field being filtered |
| $begin | string | start date value (in DB format) |
| $end | string | End date value (in DB format) |
get_time_part(
$date_time_value
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::get_time_part()
Parameters
| Name | Type | Description |
|---|---|---|
| $date_time_value |
get_users_current_date_time(
boolean $timestamp
=
false
)
:
void
inherited
Get assigned or logged in user's current date and time value.
Inherited from: \SugarWidgetFieldDateTime::get_users_current_date_time()
Parameters
| Name | Type | Description |
|---|---|---|
| $timestamp | boolean | Format of return value, if set to true, return unix like timestamp , else a formatted date. |
hasTime(
$date
)
:
bool
inherited
Inherited from:
\SugarWidgetFieldDateTime::hasTime()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $date |
| Type | Description |
|---|---|
| bool | false if the date is a only a date, true if the date includes time. |
query(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryDateOp(
string $arg1, string | \DateTime $arg2, string $op, string $type
)
:
void
inherited
Create query for binary operation of field of certain type Produces query like: arg1 op to_date(arg2), e.g.: date_closed < '2009-12-01'
Inherited from: \SugarWidgetFieldDateTime::queryDateOp()
Parameters
| Name | Type | Description |
|---|---|---|
| $arg1 | string | 1st arg - column name |
| $arg2 | string | \DateTime | 2nd arg - value to be converted |
| $op | string | |
| $type | string |
queryDay(
array $layout_def, \SugarDateTime $day
)
:
void
inherited
Create query from the beginning to the end of certain day
Inherited from: \SugarWidgetFieldDateTime::queryDay()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def | array | |
| $day | \SugarDateTime |
queryFilter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilter()\SugarWidgetFieldDateTime::queryFilter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterAfter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterAfter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterBefore(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterBefore()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterBetween_Dates(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterBetween_Dates()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterEmpty(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilterEmpty()\SugarWidgetFieldDateTime::queryFilterEmpty()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterIs(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilterIs()\SugarWidgetFieldDateTime::queryFilterIs()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterNot_Empty(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilterNot_Empty()\SugarWidgetFieldDateTime::queryFilterNot_Empty()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterNot_Equals_str(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterNot_Equals_str()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterOn(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterOn()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_last_30_days(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_last_30_days()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_last_7_days(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_last_7_days()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_last_month(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_last_month()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_last_year(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_last_year()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_next_30_days(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_next_30_days()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_next_7_days(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_next_7_days()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_next_month(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_next_month()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_next_year(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_next_year()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_this_month(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_this_month()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_this_quarter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_this_quarter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_this_year(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_this_year()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_today(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_today()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_tomorrow(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_tomorrow()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilterTP_yesterday(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryFilterTP_yesterday()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryFilteris_not(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetReportField::queryFilteris_not()\SugarWidgetFieldDateTime::queryFilteris_not()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryGroupBy(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryGroupBy()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryGroupByDay(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryGroupByDay()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryGroupByMonth(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryGroupByMonth()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryGroupByQuarter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryGroupByQuarter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryGroupByYear(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryGroupByYear()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
queryMonth(
array $layout_def, \SugarDateTime $month
)
:
void
inherited
Create query from the beginning to the end of certain month
Inherited from: \SugarWidgetFieldDateTime::queryMonth()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def | array | |
| $month | \SugarDateTime |
queryOrderBy(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::queryOrderBy()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
querySelect(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::querySelect()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
querySelectday(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::querySelectday()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
querySelectmonth(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::querySelectmonth()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
querySelectquarter(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::querySelectquarter()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
querySelectyear(
$layout_def
)
:
void
inherited
Inherited from:
\SugarWidgetFieldDateTime::querySelectyear()
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
setWidgetId(
\id $id
=
''
)
:
void
inherited
setSubpanelWidgetId This is a utility function to set the id for a widget
Inherited from: \SugarWidget::setWidgetId()\SugarWidgetField::setWidgetId()\SugarWidgetReportField::setWidgetId()\SugarWidgetFieldDateTime::setWidgetId()
Parameters
| Name | Type | Description |
|---|---|---|
| $id | \id | String value to set the widget's unique id |