Files
iTop/sources/Form/Field/DateTimeField.php

142 lines
3.1 KiB
PHP

<?php
// Copyright (C) 2010-2024 Combodo SAS
//
// This file is part of iTop.
//
// iTop is free software; you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// iTop is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/>
namespace Combodo\iTop\Form\Field;
use Closure;
/**
* A field for Dates and Date & Times, supporting custom formats
*/
class DateTimeField extends StringField
{
/** @var string */
protected $sJSDateTimeFormat;
/** @var string */
protected $sPHPDateTimeFormat;
/** @var bool */
protected $bDateOnly;
/** @var string|null $sDateTimePickerWidgetParent @since 3.1 */
private ?string $sDateTimePickerWidgetParent = null;
/**
* @inheritDoc
*/
public function __construct(string $sId, Closure $onFinalizeCallback = null)
{
parent::__construct($sId, $onFinalizeCallback);
$this->bDateOnly = false;
}
/**
* Get the PHP format string
*
* @return string
*/
public function GetPHPDateTimeFormat()
{
return $this->sPHPDateTimeFormat;
}
/**
*
* @param string $sPHPDateTimeFormat
*
* @return \Combodo\iTop\Form\Field\DateTimeField
*/
public function SetPHPDateTimeFormat(string $sPHPDateTimeFormat)
{
$this->sPHPDateTimeFormat = $sPHPDateTimeFormat;
return $this;
}
/**
* @return string
*/
public function GetJSDateTimeFormat()
{
return $this->sJSDateTimeFormat;
}
/**
*
* @param string $sJSDateTimeFormat
*
* @return \Combodo\iTop\Form\Field\DateTimeField
*/
public function SetJSDateTimeFormat(string $sJSDateTimeFormat)
{
$this->sJSDateTimeFormat = $sJSDateTimeFormat;
return $this;
}
/**
* Set the DateOnly flag
*
* @param boolean $bDateOnly
*
* @return \Combodo\iTop\Form\Field\DateTimeField
*/
public function SetDateOnly(bool $bDateOnly)
{
$this->bDateOnly = $bDateOnly;
return $this;
}
/**
* @return bool
*/
public function IsDateOnly()
{
return $this->bDateOnly;
}
/**
* Allow date time picker widget popup to be positioned relative to a specific dom element.
*
* @see N°803 - Allow display & edition of attributes on n:n relations on Portal
* LinkedSetFieldRenderer allow modification of link attributes, the default widget positioning truncates the popup.
*
* @param string $sParent
*
* @return void
* @since 3.1
*
*/
public function SetDateTimePickerWidgetParent(string $sParent): DateTimeField
{
$this->sDateTimePickerWidgetParent = $sParent;
return $this;
}
/**
*
* @return string|null
* @since 3.1
*
*/
public function GetDateTimePickerWidgetParent(): ?string
{
return $this->sDateTimePickerWidgetParent;
}
}