include/generic/SugarWidgets/SugarWidgetFielddatetime.php

Show:

inherited

Classes
- \SugarWidgetFieldDateTime

Table of Contents

\SugarWidgetFieldDateTime
jump to top

Package:

Generic Sugar widget

Parent(s): \SugarWidgetReportField < \SugarWidgetField < \SugarWidget
Children: \SugarWidgetFieldTime; \SugarWidgetFieldDatePicker; \SugarWidgetFieldDate; \SugarWidgetFieldDateTimecombo

Properties


                 $assigned_user= 'null'

Default valuenullDetails

Type: n/a


                 $form_value= ''

inheritedInherited from: \SugarWidget::$$form_value \SugarWidgetField::$$form_value \SugarWidgetReportField::$$form_value

Details

Type: n/a
Inherited_from: \SugarWidget::$$form_value
Inherited_from: \SugarWidgetField::$$form_value
Inherited_from: \SugarWidgetReportField::$$form_value


                 $layout_manager= 'null'

inheritedInherited from: \SugarWidget::$$layout_manager \SugarWidgetField::$$layout_manager \SugarWidgetReportField::$$layout_manager

Default valuenullDetails

Type: n/a
Inherited_from: \SugarWidget::$$layout_manager
Inherited_from: \SugarWidgetField::$$layout_manager
Inherited_from: \SugarWidgetReportField::$$layout_manager


                 $parent_bean= ''

inheritedInherited from: \SugarWidget::$$parent_bean \SugarWidgetField::$$parent_bean \SugarWidgetReportField::$$parent_bean

Details

Type: n/a
Inherited_from: \SugarWidget::$$parent_bean
Inherited_from: \SugarWidgetField::$$parent_bean
Inherited_from: \SugarWidgetReportField::$$parent_bean

\SugarBean
                 $reporter= ''

Layout manager reporter attribute

Details

Type: \SugarBean


                 $widget_id= ''

inheritedInherited from: \SugarWidget::$$widget_id \SugarWidgetField::$$widget_id \SugarWidgetReportField::$$widget_id

Details

Type: n/a
Inherited_from: \SugarWidget::$$widget_id
Inherited_from: \SugarWidgetField::$$widget_id
Inherited_from: \SugarWidgetReportField::$$widget_id

Methods

SugarWidget(
           $layout_manager
          )
        
        :
          void

inherited

Inherited from: \SugarWidget::SugarWidget()\SugarWidgetField::SugarWidget()\SugarWidgetReportField::SugarWidget()

Parameters

Name	Type	Description
$layout_manager

SugarWidgetField(
           $layout_manager
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::SugarWidgetField()\SugarWidgetReportField::SugarWidgetField()

Parameters

Name	Type	Description
$layout_manager

SugarWidgetFieldDateTime(
           $layout_manager
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_manager

SugarWidgetReportField(
           $layout_manager
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::SugarWidgetReportField()

Parameters

Name	Type	Description
$layout_manager

_get_column_alias(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::_get_column_alias()

Parameters

Name	Type	Description
$layout_def

_get_column_select(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::_get_column_select()

Parameters

Name	Type	Description
$layout_def

_get_column_select_special(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::_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()

Parameters

Name	Type	Description
$layout_def

display(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::display()

Parameters

Name	Type	Description
$layout_def

displayDetail(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::displayDetail()\SugarWidgetReportField::displayDetail()

Parameters

Name	Type	Description
$layout_def

displayDetailLabel(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::displayDetailLabel()\SugarWidgetReportField::displayDetailLabel()

Parameters

Name	Type	Description
$layout_def

displayEdit(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::displayEdit()\SugarWidgetReportField::displayEdit()

Parameters

Name	Type	Description
$layout_def

displayEditLabel(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::displayEditLabel()\SugarWidgetReportField::displayEditLabel()

Parameters

Name	Type	Description
$layout_def

displayHeaderCell(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::displayHeaderCell()

Parameters

Name	Type	Description
$layout_def

displayHeaderCellPlain(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::displayHeaderCellPlain()\SugarWidgetReportField::displayHeaderCellPlain()

Parameters

Name	Type	Description
$layout_def

displayInput(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

displayList(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

displayListPlain(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

displayListday(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

displayListmonth(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

displayListquarter(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

displayListyear(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

displaySearch(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::displaySearch()\SugarWidgetReportField::displaySearch()

Parameters

Name	Type	Description
$layout_def

displaySearchLabel(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::displaySearchLabel()\SugarWidgetReportField::displaySearchLabel()

Parameters

Name	Type	Description
$layout_def

expandDate(
          \$date $date, bool $end
              =
              false
          )
        
        :
          \$date

expandDate

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.

Parameters

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

Returns

Type	Description
\$date	TimeDate object with time value applied

getAssignedUser(
          
          )
        
        :
          void

getDisplayName(
          
          )
        
        :
          void

inherited

Inherited from: \SugarWidget::getDisplayName()\SugarWidgetField::getDisplayName()\SugarWidgetReportField::getDisplayName()

getParentBean(
          
          )
        
        :
          void

inherited

Inherited from: \SugarWidget::getParentBean()\SugarWidgetField::getParentBean()\SugarWidgetReportField::getParentBean()

getReporter(
          
          )
        
        :
          void

Details

Deprecated

getSubClass(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::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()

Parameters

Name	Type	Description
$column_name

getVardef(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetField::getVardef()\SugarWidgetReportField::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()

Returns

Type	Description
\id	String label of the widget's unique id

get_db_date(
          int $days, \time $time
          )
        
        :
          void

Get specified date and time for a particalur day, in current user's timezone.

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

Get filter string for a date field.

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

Parameters

Name	Type	Description
$date_time_value

get_users_current_date_time(
          boolean $timestamp
              =
              false
          )
        
        :
          void

Get assigned or logged in user's current date and time value.

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

Parameters

Name	Type	Description
$date

Returns

Type	Description
bool	false if the date is a only a date, true if the date includes time.

now(
          
          )
        
        :
          \SugarDateTime

Return current date in required user's TZ

Returns

Type	Description
\SugarDateTime

query(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::query()

Parameters

Name	Type	Description
$layout_def

queryDateOp(
          string $arg1, string | \DateTime $arg2, string $op, string $type
          )
        
        :
          void

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'

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

Create query from the beginning to the end of certain day

Parameters

Name	Type	Description
$layout_def	array
$day	\SugarDateTime

queryFilter(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::queryFilter()

Parameters

Name	Type	Description
$layout_def

queryFilterAfter(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterBefore(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterBetween_Dates(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterEmpty(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::queryFilterEmpty()

Parameters

Name	Type	Description
$layout_def

queryFilterIs(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::queryFilterIs()

Parameters

Name	Type	Description
$layout_def

queryFilterNot_Empty(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::queryFilterNot_Empty()

Parameters

Name	Type	Description
$layout_def

queryFilterNot_Equals_str(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterOn(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_last_30_days(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_last_7_days(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_last_month(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_last_year(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_next_30_days(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_next_7_days(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_next_month(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_next_year(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_this_month(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_this_quarter(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_this_year(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_today(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_tomorrow(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilterTP_yesterday(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryFilteris_not(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetReportField::queryFilteris_not()

Parameters

Name	Type	Description
$layout_def

queryGroupBy(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryGroupByDay(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryGroupByMonth(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryGroupByQuarter(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryGroupByYear(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

queryMonth(
          array $layout_def, \SugarDateTime $month
          )
        
        :
          void

Create query from the beginning to the end of certain month

Parameters

Name	Type	Description
$layout_def	array
$month	\SugarDateTime

queryOrderBy(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

querySelect(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

querySelectday(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

querySelectdayreal(
          \$layout_def $layout_def
          )
        
        :
          string

Select addon datetime field for "day" field in reports

Parameters

Name	Type	Description
$layout_def	\$layout_def	array definition of new field

Returns

Type	Description
string	piece for creation "select" query

querySelectmonth(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

querySelectquarter(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

querySelectyear(
           $layout_def
          )
        
        :
          void

Parameters

Name	Type	Description
$layout_def

setParentBean(
           $parent_bean
          )
        
        :
          void

inherited

Inherited from: \SugarWidget::setParentBean()\SugarWidgetField::setParentBean()\SugarWidgetReportField::setParentBean()

Parameters

Name	Type	Description
$parent_bean

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()

Parameters

Name	Type	Description
$id	\id	String value to set the widget's unique id

include/generic/SugarWidgets/SugarWidgetFielddatetime.php

\SugarWidgetFieldDateTimejump to top

Properties

Methods

\SugarWidgetFieldDateTime
jump to top