Inheritance diagram for Datetime:

Public Member Functions
	getHtml ()

	getEscapedValue ($index=null)

Public Member Functions inherited from Date
	__construct (\Magento\Backend\Block\Context $context, \Magento\Framework\DB\Helper $resourceHelper, \Magento\Framework\Math\Random $mathRandom, \Magento\Framework\Locale\ResolverInterface $localeResolver, DateTimeFormatterInterface $dateTimeFormatter, array $data=[])

	getHtml ()

	getEscapedValue ($index=null)

	getValue ($index=null)

	getCondition ()

	setValue ($value)

Public Member Functions inherited from AbstractFilter
	__construct (\Magento\Backend\Block\Context $context, \Magento\Framework\DB\Helper $resourceHelper, array $data=[])

	setColumn ($column)

	getColumn ()

	getEscapedValue ($index=null)

	getCondition ()

	getHtml ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Backend\Block\Context $context, array $data=[])

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from BlockInterface
	toHtml ()

Data Fields
const	END_OF_DAY_IN_SECONDS = 86399

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Protected Member Functions
	_convertDate ($date)

Protected Member Functions inherited from Date
	_convertDate ($date)

Protected Member Functions inherited from AbstractFilter
	_getHtmlName ()

	_getHtmlId ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Protected Attributes inherited from Date
	$mathRandom

	$localeResolver

	$dateTimeFormatter

Protected Attributes inherited from AbstractFilter
	$_column

	$_resourceHelper

Protected Attributes inherited from AbstractBlock
	$_authorization

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Date grid column filter

Author: Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Todo:: date format

Definition at line 15 of file Datetime.php.

Member Function Documentation

◆ _convertDate()

_convertDate ( $date )

protected

Convert given date to default (UTC) timezone

Parameters

string $date

Returns: \DateTime|null

Definition at line 64 of file Datetime.php.

     {
         if ($this->getColumn()->getFilterTime()) {
             try {
                 $timezone = $this->getColumn()->getTimezone() !== false
                     ? $this->_localeDate->getConfigTimezone() : 'UTC';
                 $adminTimeZone = new \DateTimeZone($timezone);
                 $simpleRes = new \DateTime($date, $adminTimeZone);
                 $simpleRes->setTimezone(new \DateTimeZone('UTC'));
                 return $simpleRes;
             } catch (\Exception $e) {
                 return null;
             }
         }
         return parent::_convertDate($date);
     }

◆ getEscapedValue()

getEscapedValue ( $index = null )

Return escaped value for calendar

Parameters

string | null $index

Returns: array|string|int|float|null

Definition at line 145 of file Datetime.php.

     {
         if ($this->getColumn()->getFilterTime()) {
             $value = $this->getValue($index);
             if ($value instanceof \DateTimeInterface) {
                 return $this->_localeDate->formatDateTime($value);
             }
 
             if (is_string($value)) {
                 return $this->escapeHtml($value);
             }
 
             return $value;
         }
 
         return parent::getEscapedValue($index);
     }

◆ getHtml()

getHtml ( )

Render filter html

Returns: string

Implements FilterInterface.

Definition at line 86 of file Datetime.php.

     {
         $htmlId = $this->mathRandom->getUniqueHash($this->_getHtmlId());
         $format = $this->_localeDate->getDateFormat(\IntlDateFormatter::SHORT);
         $timeFormat = '';
 
         if ($this->getColumn()->getFilterTime()) {
             $timeFormat = $this->_localeDate->getTimeFormat(
                 \IntlDateFormatter::SHORT
             );
         }
 
         $html =
             '<div class="range" id="' . $htmlId . '_range"><div class="range-line date">' . '<input type="text" name="'
             . $this->_getHtmlName() . '[from]" id="' . $htmlId . '_from"' . ' value="' . $this->getEscapedValue('from')
             . '" class="input-text admin__control-text no-changes" placeholder="' . __(
                 'From'
             ) . '" ' . $this->getUiId(
                 'filter',
                 $this->_getHtmlName(),
                 'from'
             ) . '/>' . '</div>';
         $html .= '<div class="range-line date">' . '<input type="text" name="' . $this->_getHtmlName() . '[to]" id="'
             . $htmlId . '_to"' . ' value="' . $this->getEscapedValue(
                 'to'
             ) . '" class="input-text admin__control-text no-changes" placeholder="' . __(
                 'To'
             ) . '" ' . $this->getUiId(
                 'filter',
                 $this->_getHtmlName(),
                 'to'
             ) . '/>' . '</div></div>';
         $html .= '<input type="hidden" name="' . $this->_getHtmlName() . '[locale]"' . ' value="'
             . $this->localeResolver->getLocale() . '"/>';
         $html .= '<script>
             require(["jquery", "mage/calendar"],function($){
                     $("#' . $htmlId . '_range").dateRange({
                         dateFormat: "' . $format . '",
                         timeFormat: "' . $timeFormat . '",
                         showsTime: ' . ($this->getColumn()->getFilterTime() ? 'true' : 'false') . ',
                         buttonText: "' . $this->escapeHtml(__('Date selector')) . '",
                         from: {
                             id: "' . $htmlId . '_from"
                         },
                         to: {
                             id: "' . $htmlId . '_to"
                         }
                     })
             });
         </script>';
         return $html;
     }

Field Documentation

◆ END_OF_DAY_IN_SECONDS

const END_OF_DAY_IN_SECONDS = 86399

full day is 86400, we need 23 hours:59 minutes:59 seconds = 86399

Definition at line 20 of file Datetime.php.

The documentation for this class was generated from the following file:

vendor/magento/module-backend/Block/Widget/Grid/Column/Filter/Datetime.php

Public Member Functions

Data Fields

Protected Member Functions