DtObj Chilkat2 PHP Reference Documentation
DtObj
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.DtObj
Store and edit the year, month, day, hour, minute, and second as
individual properties.
Use the UTC flag to indicate whether the stored fields represent UTC or
local time.
Use alternate month and year properties when working with
Save and restore the object using Chilkat's compact internal serialized
date/time representation.
Pass
Use this class as a simple container rather than a full date/time
calculation or timezone-conversion engine.
For an extended overview, see
DtObj Class Overview.
Represent a date/time as simple editable fields.
Chilkat.DtObj is a lightweight date/time value object used by
Chilkat methods that need to pass or return individual date and time fields.
It stores values such as year, month, day, hour, minute, and second, along
with a flag indicating whether the value represents UTC or local time. It
also provides a compact serialization format for saving and restoring the
date/time value.
Simple date fields
UTC or local time
Struct tm compatibility
struct tm-style date/time conventions.
Serialize and restore
Used by other classes
DtObj values to Chilkat methods that require explicit
date/time fields or return date/time information.
Small and focused
DtObj, set or read the individual date/time
fields, check whether the value is UTC or local time, and pass the object to
another Chilkat method. Use serialization only when the date/time value needs
to be saved and restored in Chilkat's compact internal format.
Object Creation
use Chilkat2\DtObj;
try {
$dtObj = new DtObj();
// ... use $dtObj ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new DtObj(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.
There is no close(): PHP frees the object when its last reference goes (unset($dtObj), $dtObj = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyDtObj extends \Chilkat2\DtObj); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\DtObj') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
Day
The day of the month. The valid values for this member are 1 through 31.
topDebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Hour
The hour. The valid values for this member are 0 through 23.
topLastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Minute
The minute. The valid values for this member are 0 through 59.
topMonth
The month. The valid values for this member are 1 through 12 where 1 = January and 12 = December.
topSecond
The second. The valid values for this member are 0 through 59.
topStructTmMonth
The month. The valid values for this member are 0 through 11 where 0 = January and 11 = December.
topStructTmYear
The year represented as the number of years since 1900.
topUtc
true if this is a UTC time, otherwise false if this is a local time.
VerboseLogging
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Year
The year, such as 2012.
topMethods
DeSerialize
Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.
topSerialize
Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method. The format of the string returned by this method is not intended to match any published standard. It is formatted to a string with SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.