DatetimeField::performReadonlyTransformation() - Code Metrics - Inspection of "Merge pull request #8214 from open-sausages/pulls/..." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3 ( d27970...2b05d8 )

by Luke

created 2018-06-25 22:35 UTC

DatetimeField::performReadonlyTransformation() A

↳ Parent: DatetimeField

Complexity

Conditions	5
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	4
nop	0
dl	0
loc	20
rs	9.2888
c	0
b	0
f	0

<?php
/**
 * A composite field for date and time entry,
 * based on {@link DateField} and {@link TimeField}.
 * Usually saves into a single {@link SS_Datetime} database column.
 * If you want to save into {@link Date} or {@link Time} columns,
 * please instanciate the fields separately.
 *
 * # Configuration
 *
 * The {@link setConfig()} method is only used to configure common properties of this field.
 * To configure the {@link DateField} and {@link TimeField} instances contained within, use their own
 * {@link setConfig()} methods.
 *
 * Example:
 * <code>
 * $field = new DatetimeField('Name', 'Label');
 * $field->setConfig('datavalueformat', 'yyyy-MM-dd HH:mm'); // global setting
 * $field->getDateField()->setConfig('showcalendar', 1); // field-specific setting
 * </code>
 *
 * - "timezone": Set a different timezone for viewing. {@link dataValue()} will still save
 * the time in PHP's default timezone (date_default_timezone_get()), its only a view setting.
 * Note that the sub-fields ({@link getDateField()} and {@link getTimeField()})
 * are not timezone aware, and will have their values set in local time, rather than server time.
 * - "datetimeorder": An sprintf() template to determine in which order the date and time values will
 * be combined. This is necessary as those separate formats are set in their invididual fields.
 *
 * @package framework
 * @subpackage forms
 */
class DatetimeField extends FormField {

	/**
	 * @var DateField
	 */
	protected $dateField = null;

	/**
	 * @var TimeField
	 */
	protected $timeField = null;

	/**
	 * @config
	 * @var array
	 */
	private static $default_config = array(
		'datavalueformat' => 'yyyy-MM-dd HH:mm:ss',
		'usertimezone' => null,
		'datetimeorder' => '%s %s',
	);

	/**
	 * @var array
	 */
	protected $config;

	public function __construct($name, $title = null, $value = ""){
		$this->config = $this->config()->default_config;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		$this->dateField = DateField::create($name . '[date]', false)
			->addExtraClass('fieldgroup-field');
		$this->timeField = TimeField::create($name . '[time]', false)
			->addExtraClass('fieldgroup-field');
		$this->timezoneField = new HiddenField($name . '[timezone]');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		parent::__construct($name, $title, $value);
	}

	public function setForm($form) {
		parent::setForm($form);

		$this->dateField->setForm($form);
		$this->timeField->setForm($form);
		$this->timezoneField->setForm($form);

		return $this;
	}

	public function setName($name) {
		parent::setName($name);

		$this->dateField->setName($name . '[date]');
		$this->timeField->setName($name . '[time]');
		$this->timezoneField->setName($name . '[timezone]');

		return $this;
	}

	/**
	 * @param array $properties
	 * @return HTMLText
	 */
	public function FieldHolder($properties = array()) {
		$config = array(
			'datetimeorder' => $this->getConfig('datetimeorder'),
		);
		$config = array_filter($config);
		$this->addExtraClass('fieldgroup');
		$this->addExtraClass(Convert::raw2json($config));

		return parent::FieldHolder($properties);
	}

	/**
	 * @param array $properties
	 * @return HTMLText
	 */
	public function Field($properties = array()) {
		Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
		return parent::Field($properties);
	}

	/**
	 * Sets the internal value to ISO date format, based on either a database value in ISO date format,
	 * or a form submssion in the user date format. Uses the individual date and time fields
	 * to take care of the actual formatting and value conversion.
	 *
	 * Value setting happens *before* validation, so we have to set the value even if its not valid.
	 *
	 * Caution: Only converts user timezones when value is passed as array data (= form submission).
	 * Weak indication, but unfortunately the framework doesn't support a distinction between
	 * setting a value from the database, application logic, and user input.
	 *
	 * @param string|array $val String expects an ISO date format. Array notation with 'date' and 'time'
	 *  keys can contain localized strings. If the 'dmyfields' option is used for {@link DateField},
	 *  the 'date' value may contain array notation was well (see {@link DateField->setValue()}).
	 */
	public function setValue($val) {
		$locale = new Zend_Locale($this->locale);

		// If timezones are enabled, assume user data needs to be reverted to server timezone
		if($this->getConfig('usertimezone')) {
			// Accept user input on timezone, but only when timezone support is enabled
			$userTz = (is_array($val) && array_key_exists('timezone', $val)) ? $val['timezone'] : null;
			if(!$userTz) $userTz = $this->getConfig('usertimezone'); // fall back to defined timezone
		} else {
			$userTz = null;
		}

		if(empty($val)) {
			$this->value = null;
			$this->dateField->setValue(null);
			$this->timeField->setValue(null);
		} else {
			// Case 1: String setting from database, in ISO date format
			if(is_string($val) && Zend_Date::isDate($val, $this->getConfig('datavalueformat'), $locale)) {
				$this->value = $val;
			}
			// Case 2: Array form submission with user date format
			elseif(is_array($val) && array_key_exists('date', $val) && array_key_exists('time', $val)) {

				$dataTz = date_default_timezone_get();
				// If timezones are enabled, assume user data needs to be converted to server timezone
				if($userTz) date_default_timezone_set($userTz);

				// Uses sub-fields to temporarily write values and delegate dealing with their normalization,
				// actual sub-field value setting happens later
				$this->dateField->setValue($val['date']);
				$this->timeField->setValue($val['time']);
				if($this->dateField->dataValue() && $this->timeField->dataValue()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
					$userValueObj = new Zend_Date(null, null, $locale);
					$userValueObj->setDate($this->dateField->dataValue(),
						$this->dateField->getConfig('datavalueformat'));
					$userValueObj->setTime($this->timeField->dataValue(),
						$this->timeField->getConfig('datavalueformat'));
					if($userTz) $userValueObj->setTimezone($dataTz);
					$this->value = $userValueObj->get($this->getConfig('datavalueformat'), $locale);
					unset($userValueObj);
				} else {
					// Validation happens later, so set the raw string in case Zend_Date doesn't accept it
					$this->value = trim(sprintf($this->getConfig('datetimeorder'), $val['date'], $val['time']));
				}

				if($userTz) date_default_timezone_set($dataTz);
			}
			// Case 3: Value is invalid, but set it anyway to allow validation by the fields later on
			else {
				$this->dateField->setValue($val);
				if(is_string($val) )$this->timeField->setValue($val);
				$this->value = $val;
			}

			// view settings (dates might differ from $this->value based on user timezone settings)
			if (Zend_Date::isDate($this->value, $this->getConfig('datavalueformat'), $locale)) {
				$valueObj = new Zend_Date($this->value, $this->getConfig('datavalueformat'), $locale);
				if($userTz) $valueObj->setTimezone($userTz);

				// Set view values in sub-fields
				if($this->dateField->getConfig('dmyfields')) {
					$this->dateField->setValue($valueObj->toArray());
				} else {
					$this->dateField->setValue(
						$valueObj->get($this->dateField->getConfig('dateformat'), $locale));
				}
				$this->timeField->setValue($valueObj->get($this->timeField->getConfig('timeformat'), $locale));
			}
		}

		return $this;
	}

	public function Value() {
		$valDate = $this->dateField->Value();
		$valTime = $this->timeField->Value();
		if(!$valTime) $valTime = '00:00:00';

		return sprintf($this->getConfig('datetimeorder'), $valDate, $valTime);
	}

	public function setDisabled($bool) {
		parent::setDisabled($bool);
		$this->dateField->setDisabled($bool);
		$this->timeField->setDisabled($bool);
		if($this->timezoneField) $this->timezoneField->setDisabled($bool);
		return $this;
	}

	public function setReadonly($bool) {
		parent::setReadonly($bool);
		$this->dateField->setReadonly($bool);
		$this->timeField->setReadonly($bool);
		if($this->timezoneField) $this->timezoneField->setReadonly($bool);
		return $this;
	}

	/**
	 * @return DateField
	 */
	public function getDateField() {
		return $this->dateField;
	}

	/**
	 * @param FormField
	 */
	public function setDateField($field) {
		$expected = $this->getName() . '[date]';
		if($field->getName() != $expected) {
			throw new InvalidArgumentException(sprintf(
				'Wrong name format for date field: "%s" (expected "%s")',
				$field->getName(),
				$expected
			));
		}

		$field->setForm($this->getForm());
		$this->dateField = $field;
		$this->setValue($this->value); // update value
	}

	/**
	 * @return TimeField
	 */
	public function getTimeField() {
		return $this->timeField;
	}

	/**
	 * @param FormField
	 */
	public function setTimeField($field) {
		$expected = $this->getName() . '[time]';
		if($field->getName() != $expected) {
			throw new InvalidArgumentException(sprintf(
				'Wrong name format for time field: "%s" (expected "%s")',
				$field->getName(),
				$expected
			));
		}

		$field->setForm($this->getForm());
		$this->timeField = $field;
		$this->setValue($this->value); // update value
	}

	/**
	 * @return FormField
	 */
	public function getTimezoneField() {
		return $this->timezoneField;
	}

	public function setLocale($locale) {
		$this->dateField->setLocale($locale);
		$this->timeField->setLocale($locale);
		return $this;
	}

	public function getLocale() {
		return $this->dateField->getLocale();
	}

	/**
	 * Note: Use {@link getDateField()} and {@link getTimeField()}
	 * to set field-specific config options.
	 *
	 * @param string $name
	 * @param mixed $val
	 */
	public function setConfig($name, $val) {
		$this->config[$name] = $val;

		if($name == 'usertimezone') {
			$this->timezoneField->setValue($val);
			$this->setValue($this->dataValue());
		}

		return $this;
	}

	/**
	 * Note: Use {@link getDateField()} and {@link getTimeField()}
	 * to get field-specific config options.
	 *
	 * @param String $name Optional, returns the whole configuration array if empty
	 * @return mixed
	 */
	public function getConfig($name = null) {
		if($name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			return isset($this->config[$name]) ? $this->config[$name] : null;
		} else {
			return $this->config;
		}
	}

	public function validate($validator) {
		$dateValid = $this->dateField->validate($validator);
		$timeValid = $this->timeField->validate($validator);

		return ($dateValid && $timeValid);
	}

	public function performReadonlyTransformation() {
		$field = $this->castedCopy('DatetimeField_Readonly');
		$field->setValue($this->dataValue());

		$dateFieldConfig = $this->getDateField()->getConfig();
		if($dateFieldConfig) {
			foreach($dateFieldConfig as $k => $v) {
				$field->getDateField()->setConfig($k, $v);
			}
		}

		$timeFieldConfig = $this->getTimeField()->getConfig();
		if($timeFieldConfig) {
			foreach($timeFieldConfig as $k => $v) {
				$field->getTimeField()->setConfig($k, $v);
			}
		}

		return $field;
	}

	public function __clone() {
		$this->dateField = clone $this->dateField;
		$this->timeField = clone $this->timeField;
	}
}

/**
 * The readonly class for our {@link DatetimeField}.
 *
 * @package forms
 * @subpackage fields-datetime
 */
class DatetimeField_Readonly extends DatetimeField {

	protected $readonly = true;

	public function Field($properties = array()) {
		$valDate = $this->dateField->dataValue();
		$valTime = $this->timeField->dataValue();

		if($valDate && $valTime) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$format = sprintf(
				$this->getConfig('datetimeorder'),
				$this->dateField->getConfig('dateformat'),
				$this->timeField->getConfig('timeformat')
			);
			$valueObj = new Zend_Date(
				sprintf($this->getConfig('datetimeorder'), $valDate, $valTime),
				$this->getConfig('datavalueformat'),
				$this->dateField->getLocale()
			);
			$val = $valueObj->toString($format);

		} else {
			$val = sprintf('<em>%s</em>', _t('DatetimeField.NOTSET', 'Not set'));
		}

		return "<span class=\"readonly\" id=\"" . $this->id() . "\">$val</span>";
	}

}


1			<?php
2			/**
3			* A composite field for date and time entry,
4			* based on {@link DateField} and {@link TimeField}.
5			* Usually saves into a single {@link SS_Datetime} database column.
6			* If you want to save into {@link Date} or {@link Time} columns,
7			* please instanciate the fields separately.
8			*
9			* # Configuration
10			*
11			* The {@link setConfig()} method is only used to configure common properties of this field.
12			* To configure the {@link DateField} and {@link TimeField} instances contained within, use their own
13			* {@link setConfig()} methods.
14			*
15			* Example:
16			* <code>
17			* $field = new DatetimeField('Name', 'Label');
18			* $field->setConfig('datavalueformat', 'yyyy-MM-dd HH:mm'); // global setting
19			* $field->getDateField()->setConfig('showcalendar', 1); // field-specific setting
20			* </code>
21			*
22			* - "timezone": Set a different timezone for viewing. {@link dataValue()} will still save
23			* the time in PHP's default timezone (date_default_timezone_get()), its only a view setting.
24			* Note that the sub-fields ({@link getDateField()} and {@link getTimeField()})
25			* are not timezone aware, and will have their values set in local time, rather than server time.
26			* - "datetimeorder": An sprintf() template to determine in which order the date and time values will
27			* be combined. This is necessary as those separate formats are set in their invididual fields.
28			*
29			* @package framework
30			* @subpackage forms
31			*/
32			class DatetimeField extends FormField {
33
34			/**
35			* @var DateField
36			*/
37			protected $dateField = null;
38
39			/**
40			* @var TimeField
41			*/
42			protected $timeField = null;
43
44			/**
45			* @config
46			* @var array
47			*/
48			private static $default_config = array(
49			'datavalueformat' => 'yyyy-MM-dd HH:mm:ss',
50			'usertimezone' => null,
51			'datetimeorder' => '%s %s',
52			);
53
54			/**
55			* @var array
56			*/
57			protected $config;
58
59			public function __construct($name, $title = null, $value = ""){
60			$this->config = $this->config()->default_config;
			0 ignored issues – show Documentation introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report The property `default_config` does not exist on `object<Config_ForClass>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
61
62			$this->dateField = DateField::create($name . '[date]', false)
63			->addExtraClass('fieldgroup-field');
64			$this->timeField = TimeField::create($name . '[time]', false)
65			->addExtraClass('fieldgroup-field');
66			$this->timezoneField = new HiddenField($name . '[timezone]');
			0 ignored issues – show Documentation introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report The property `timezoneField` does not exist on `object<DatetimeField>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
67
68			parent::__construct($name, $title, $value);
69			}
70
71			public function setForm($form) {
72			parent::setForm($form);
73
74			$this->dateField->setForm($form);
75			$this->timeField->setForm($form);
76			$this->timezoneField->setForm($form);
77
78			return $this;
79			}
80
81			public function setName($name) {
82			parent::setName($name);
83
84			$this->dateField->setName($name . '[date]');
85			$this->timeField->setName($name . '[time]');
86			$this->timezoneField->setName($name . '[timezone]');
87
88			return $this;
89			}
90
91			/**
92			* @param array $properties
93			* @return HTMLText
94			*/
95			public function FieldHolder($properties = array()) {
96			$config = array(
97			'datetimeorder' => $this->getConfig('datetimeorder'),
98			);
99			$config = array_filter($config);
100			$this->addExtraClass('fieldgroup');
101			$this->addExtraClass(Convert::raw2json($config));
102
103			return parent::FieldHolder($properties);
104			}
105
106			/**
107			* @param array $properties
108			* @return HTMLText
109			*/
110			public function Field($properties = array()) {
111			Requirements::css(FRAMEWORK_DIR . '/css/DatetimeField.css');
112			return parent::Field($properties);
113			}
114
115			/**
116			* Sets the internal value to ISO date format, based on either a database value in ISO date format,
117			* or a form submssion in the user date format. Uses the individual date and time fields
118			* to take care of the actual formatting and value conversion.
119			*
120			* Value setting happens before validation, so we have to set the value even if its not valid.
121			*
122			* Caution: Only converts user timezones when value is passed as array data (= form submission).
123			* Weak indication, but unfortunately the framework doesn't support a distinction between
124			* setting a value from the database, application logic, and user input.
125			*
126			* @param string\|array $val String expects an ISO date format. Array notation with 'date' and 'time'
127			* keys can contain localized strings. If the 'dmyfields' option is used for {@link DateField},
128			* the 'date' value may contain array notation was well (see {@link DateField->setValue()}).
129			*/
130			public function setValue($val) {
131			$locale = new Zend_Locale($this->locale);
132
133			// If timezones are enabled, assume user data needs to be reverted to server timezone
134			if($this->getConfig('usertimezone')) {
135			// Accept user input on timezone, but only when timezone support is enabled
136			$userTz = (is_array($val) && array_key_exists('timezone', $val)) ? $val['timezone'] : null;
137			if(!$userTz) $userTz = $this->getConfig('usertimezone'); // fall back to defined timezone
138			} else {
139			$userTz = null;
140			}
141
142			if(empty($val)) {
143			$this->value = null;
144			$this->dateField->setValue(null);
145			$this->timeField->setValue(null);
146			} else {
147			// Case 1: String setting from database, in ISO date format
148			if(is_string($val) && Zend_Date::isDate($val, $this->getConfig('datavalueformat'), $locale)) {
149			$this->value = $val;
150			}
151			// Case 2: Array form submission with user date format
152			elseif(is_array($val) && array_key_exists('date', $val) && array_key_exists('time', $val)) {
153
154			$dataTz = date_default_timezone_get();
155			// If timezones are enabled, assume user data needs to be converted to server timezone
156			if($userTz) date_default_timezone_set($userTz);
157
158			// Uses sub-fields to temporarily write values and delegate dealing with their normalization,
159			// actual sub-field value setting happens later
160			$this->dateField->setValue($val['date']);
161			$this->timeField->setValue($val['time']);
162			if($this->dateField->dataValue() && $this->timeField->dataValue()) {
			0 ignored issues – show Bug Best Practice introduced 2016-09-06 06:21 UTC by Report Bug Copy Issue Report The expression `$this->dateField->dataValue()` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2016-09-06 06:21 UTC by Report Bug Copy Issue Report The expression `$this->timeField->dataValue()` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
163			$userValueObj = new Zend_Date(null, null, $locale);
164			$userValueObj->setDate($this->dateField->dataValue(),
165			$this->dateField->getConfig('datavalueformat'));
166			$userValueObj->setTime($this->timeField->dataValue(),
167			$this->timeField->getConfig('datavalueformat'));
168			if($userTz) $userValueObj->setTimezone($dataTz);
169			$this->value = $userValueObj->get($this->getConfig('datavalueformat'), $locale);
170			unset($userValueObj);
171			} else {
172			// Validation happens later, so set the raw string in case Zend_Date doesn't accept it
173			$this->value = trim(sprintf($this->getConfig('datetimeorder'), $val['date'], $val['time']));
174			}
175
176			if($userTz) date_default_timezone_set($dataTz);
177			}
178			// Case 3: Value is invalid, but set it anyway to allow validation by the fields later on
179			else {
180			$this->dateField->setValue($val);
181			if(is_string($val) )$this->timeField->setValue($val);
182			$this->value = $val;
183			}
184
185			// view settings (dates might differ from $this->value based on user timezone settings)
186			if (Zend_Date::isDate($this->value, $this->getConfig('datavalueformat'), $locale)) {
187			$valueObj = new Zend_Date($this->value, $this->getConfig('datavalueformat'), $locale);
188			if($userTz) $valueObj->setTimezone($userTz);
189
190			// Set view values in sub-fields
191			if($this->dateField->getConfig('dmyfields')) {
192			$this->dateField->setValue($valueObj->toArray());
193			} else {
194			$this->dateField->setValue(
195			$valueObj->get($this->dateField->getConfig('dateformat'), $locale));
196			}
197			$this->timeField->setValue($valueObj->get($this->timeField->getConfig('timeformat'), $locale));
198			}
199			}
200
201			return $this;
202			}
203
204			public function Value() {
205			$valDate = $this->dateField->Value();
206			$valTime = $this->timeField->Value();
207			if(!$valTime) $valTime = '00:00:00';
208
209			return sprintf($this->getConfig('datetimeorder'), $valDate, $valTime);
210			}
211
212			public function setDisabled($bool) {
213			parent::setDisabled($bool);
214			$this->dateField->setDisabled($bool);
215			$this->timeField->setDisabled($bool);
216			if($this->timezoneField) $this->timezoneField->setDisabled($bool);
217			return $this;
218			}
219
220			public function setReadonly($bool) {
221			parent::setReadonly($bool);
222			$this->dateField->setReadonly($bool);
223			$this->timeField->setReadonly($bool);
224			if($this->timezoneField) $this->timezoneField->setReadonly($bool);
225			return $this;
226			}
227
228			/**
229			* @return DateField
230			*/
231			public function getDateField() {
232			return $this->dateField;
233			}
234
235			/**
236			* @param FormField
237			*/
238			public function setDateField($field) {
239			$expected = $this->getName() . '[date]';
240			if($field->getName() != $expected) {
241			throw new InvalidArgumentException(sprintf(
242			'Wrong name format for date field: "%s" (expected "%s")',
243			$field->getName(),
244			$expected
245			));
246			}
247
248			$field->setForm($this->getForm());
249			$this->dateField = $field;
250			$this->setValue($this->value); // update value
251			}
252
253			/**
254			* @return TimeField
255			*/
256			public function getTimeField() {
257			return $this->timeField;
258			}
259
260			/**
261			* @param FormField
262			*/
263			public function setTimeField($field) {
264			$expected = $this->getName() . '[time]';
265			if($field->getName() != $expected) {
266			throw new InvalidArgumentException(sprintf(
267			'Wrong name format for time field: "%s" (expected "%s")',
268			$field->getName(),
269			$expected
270			));
271			}
272
273			$field->setForm($this->getForm());
274			$this->timeField = $field;
275			$this->setValue($this->value); // update value
276			}
277
278			/**
279			* @return FormField
280			*/
281			public function getTimezoneField() {
282			return $this->timezoneField;
283			}
284
285			public function setLocale($locale) {
286			$this->dateField->setLocale($locale);
287			$this->timeField->setLocale($locale);
288			return $this;
289			}
290
291			public function getLocale() {
292			return $this->dateField->getLocale();
293			}
294
295			/**
296			* Note: Use {@link getDateField()} and {@link getTimeField()}
297			* to set field-specific config options.
298			*
299			* @param string $name
300			* @param mixed $val
301			*/
302			public function setConfig($name, $val) {
303			$this->config[$name] = $val;
304
305			if($name == 'usertimezone') {
306			$this->timezoneField->setValue($val);
307			$this->setValue($this->dataValue());
308			}
309
310			return $this;
311			}
312
313			/**
314			* Note: Use {@link getDateField()} and {@link getTimeField()}
315			* to get field-specific config options.
316			*
317			* @param String $name Optional, returns the whole configuration array if empty
318			* @return mixed
319			*/
320			public function getConfig($name = null) {
321			if($name) {
			0 ignored issues – show Bug Best Practice introduced 2016-11-01 00:55 UTC by Report Bug Copy Issue Report The expression `$name` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
322			return isset($this->config[$name]) ? $this->config[$name] : null;
323			} else {
324			return $this->config;
325			}
326			}
327
328			public function validate($validator) {
329			$dateValid = $this->dateField->validate($validator);
330			$timeValid = $this->timeField->validate($validator);
331
332			return ($dateValid && $timeValid);
333			}
334
335			public function performReadonlyTransformation() {
336			$field = $this->castedCopy('DatetimeField_Readonly');
337			$field->setValue($this->dataValue());
338
339			$dateFieldConfig = $this->getDateField()->getConfig();
340			if($dateFieldConfig) {
341			foreach($dateFieldConfig as $k => $v) {
342			$field->getDateField()->setConfig($k, $v);
343			}
344			}
345
346			$timeFieldConfig = $this->getTimeField()->getConfig();
347			if($timeFieldConfig) {
348			foreach($timeFieldConfig as $k => $v) {
349			$field->getTimeField()->setConfig($k, $v);
350			}
351			}
352
353			return $field;
354			}
355
356			public function __clone() {
357			$this->dateField = clone $this->dateField;
358			$this->timeField = clone $this->timeField;
359			}
360			}
361
362			/**
363			* The readonly class for our {@link DatetimeField}.
364			*
365			* @package forms
366			* @subpackage fields-datetime
367			*/
368			class DatetimeField_Readonly extends DatetimeField {
369
370			protected $readonly = true;
371
372			public function Field($properties = array()) {
373			$valDate = $this->dateField->dataValue();
374			$valTime = $this->timeField->dataValue();
375
376			if($valDate && $valTime) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report The expression `$valDate` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history... Bug Best Practice introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report The expression `$valTime` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
377			$format = sprintf(
378			$this->getConfig('datetimeorder'),
379			$this->dateField->getConfig('dateformat'),
380			$this->timeField->getConfig('timeformat')
381			);
382			$valueObj = new Zend_Date(
383			sprintf($this->getConfig('datetimeorder'), $valDate, $valTime),
384			$this->getConfig('datavalueformat'),
385			$this->dateField->getLocale()
386			);
387			$val = $valueObj->toString($format);
388
389			} else {
390			$val = sprintf('<em>%s</em>', _t('DatetimeField.NOTSET', 'Not set'));
391			}
392
393			return "<span class=\"readonly\" id=\"" . $this->id() . "\">$val</span>";
394			}
395
396			}
397

silverstripe / silverstripe-framework

Push — 3 ( d27970...2b05d8 )

DatetimeField::performReadonlyTransformation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like