--- product: Chilkat product_version: 11.7.0 language: phpext language_label: PHP Extension class: DtObj class_name: CkDtObj license: free deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/phpCkDtObjRef.html --- # Chilkat DtObj — PHP Extension — v11.7.0 > Chilkat 11.7.0 · language=phpext · class=DtObj (CkDtObj) > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/DtObj.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/phpext/guide.md`. ## Purpose **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** Store and edit the year, month, day, hour, minute, and second as individual properties. **UTC or local time** Use the UTC flag to indicate whether the stored fields represent UTC or local time. **Struct tm compatibility** Use alternate month and year properties when working with `struct tm`-style date/time conventions. **Serialize and restore** Save and restore the object using Chilkat's compact internal serialized date/time representation. **Used by other classes** Pass `DtObj` values to Chilkat methods that require explicit date/time fields or return date/time information. **Small and focused** Use this class as a simple container rather than a full date/time calculation or timezone-conversion engine. **Common pattern:** Create or receive a `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. For an extended overview, see [DtObj Class Overview](https://www.chilkatsoft.com/dtobj_class_overview.asp). ## Object creation, unlocking and error handling **Object Creation** ```php $obj = new CkDtObj(); ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PHP Extension. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `string debugLogFilePath(); void put_DebugLogFilePath(string strVal);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastErrorHtml` | `(read-only) string lastErrorHtml();` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `(read-only) string lastErrorText();` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `(read-only) string lastErrorXml();` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `bool get_LastMethodSuccess() void put_LastMethodSuccess(bool boolVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. | | `Utf8` | `bool get_Utf8() void put_Utf8(bool boolVal);` | read/write | When set to `true`, all `string` arguments and return values are interpreted as UTF-8 strings. | | `VerboseLogging` | `bool get_VerboseLogging() void put_VerboseLogging(bool boolVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `(read-only) string version();` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `Day` | property, read/write | `int get_Day() void put_Day(int intVal);` | | `Hour` | property, read/write | `int get_Hour() void put_Hour(int intVal);` | | `Minute` | property, read/write | `int get_Minute() void put_Minute(int intVal);` | | `Month` | property, read/write | `int get_Month() void put_Month(int intVal);` | | `Second` | property, read/write | `int get_Second() void put_Second(int intVal);` | | `StructTmMonth` | property, read/write | `int get_StructTmMonth() void put_StructTmMonth(int intVal);` | | `StructTmYear` | property, read/write | `int get_StructTmYear() void put_StructTmYear(int intVal);` | | `Utc` | property, read/write | `bool get_Utc() void put_Utc(bool boolVal);` | | `Year` | property, read/write | `int get_Year() void put_Year(int intVal);` | | `DeSerialize` | method | `void DeSerialize(string $serializedDtObj);` | | `Serialize` | method | `bool Serialize(CkString outStr); string serialize();` | ## Properties ### DtObj.Day `Chilkat 11.7.0 · phpext · DtObj · Day · property · read/write` ```php int get_Day() void put_Day(int intVal); ``` The day of the month. The valid values for this member are 1 through 31. ### DtObj.Hour `Chilkat 11.7.0 · phpext · DtObj · Hour · property · read/write` ```php int get_Hour() void put_Hour(int intVal); ``` The hour. The valid values for this member are 0 through 23. ### DtObj.Minute `Chilkat 11.7.0 · phpext · DtObj · Minute · property · read/write` ```php int get_Minute() void put_Minute(int intVal); ``` The minute. The valid values for this member are 0 through 59. ### DtObj.Month `Chilkat 11.7.0 · phpext · DtObj · Month · property · read/write` ```php int get_Month() void put_Month(int intVal); ``` The month. The valid values for this member are 1 through 12 where 1 = January and 12 = December. ### DtObj.Second `Chilkat 11.7.0 · phpext · DtObj · Second · property · read/write` ```php int get_Second() void put_Second(int intVal); ``` The second. The valid values for this member are 0 through 59. ### DtObj.StructTmMonth `Chilkat 11.7.0 · phpext · DtObj · StructTmMonth · property · read/write` ```php int get_StructTmMonth() void put_StructTmMonth(int intVal); ``` The month. The valid values for this member are 0 through 11 where 0 = January and 11 = December. ### DtObj.StructTmYear `Chilkat 11.7.0 · phpext · DtObj · StructTmYear · property · read/write` ```php int get_StructTmYear() void put_StructTmYear(int intVal); ``` The year represented as the number of years since 1900. ### DtObj.Utc `Chilkat 11.7.0 · phpext · DtObj · Utc · property · read/write` ```php bool get_Utc() void put_Utc(bool boolVal); ``` `true` if this is a UTC time, otherwise `false` if this is a local time. ### DtObj.Year `Chilkat 11.7.0 · phpext · DtObj · Year · property · read/write` ```php int get_Year() void put_Year(int intVal); ``` The year, such as 2012. ## Methods ### DtObj.DeSerialize `Chilkat 11.7.0 · phpext · DtObj · DeSerialize · method` ```php void DeSerialize(string $serializedDtObj); ``` 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. ### DtObj.Serialize `Chilkat 11.7.0 · phpext · DtObj · Serialize · method` ```php bool Serialize(CkString outStr); string serialize(); ``` 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. Returns true for success, false for failure.