xref: /PHP-7.4/ext/date/php_date.h (revision 26b1572d)
1 /*
2    +----------------------------------------------------------------------+
3    | PHP Version 7                                                        |
4    +----------------------------------------------------------------------+
5    | Copyright (c) The PHP Group                                          |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 3.01 of the PHP license,      |
8    | that is bundled with this package in the file LICENSE, and is        |
9    | available through the world-wide-web at the following url:           |
10    | http://www.php.net/license/3_01.txt                                  |
11    | If you did not receive a copy of the PHP license and are unable to   |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@php.net so we can mail you a copy immediately.               |
14    +----------------------------------------------------------------------+
15    | Authors: Derick Rethans <derick@derickrethans.nl>                    |
16    +----------------------------------------------------------------------+
17 */
18 
19 #ifndef PHP_DATE_H
20 #define PHP_DATE_H
21 
22 #include "lib/timelib.h"
23 #include "Zend/zend_hash.h"
24 
25 #include "php_version.h"
26 #define PHP_DATE_VERSION PHP_VERSION
27 
28 extern zend_module_entry date_module_entry;
29 #define phpext_date_ptr &date_module_entry
30 
31 PHP_FUNCTION(date);
32 PHP_FUNCTION(idate);
33 PHP_FUNCTION(gmdate);
34 PHP_FUNCTION(strtotime);
35 
36 PHP_FUNCTION(mktime);
37 PHP_FUNCTION(gmmktime);
38 
39 PHP_FUNCTION(checkdate);
40 PHP_FUNCTION(strftime);
41 PHP_FUNCTION(gmstrftime);
42 PHP_FUNCTION(time);
43 PHP_FUNCTION(localtime);
44 PHP_FUNCTION(getdate);
45 
46 /* Advanced Interface */
47 PHP_METHOD(DateTime, __construct);
48 PHP_METHOD(DateTime, __wakeup);
49 PHP_METHOD(DateTime, __set_state);
50 PHP_METHOD(DateTime, createFromImmutable);
51 PHP_FUNCTION(date_create);
52 PHP_FUNCTION(date_create_immutable);
53 PHP_FUNCTION(date_create_from_format);
54 PHP_FUNCTION(date_create_immutable_from_format);
55 PHP_FUNCTION(date_parse);
56 PHP_FUNCTION(date_parse_from_format);
57 PHP_FUNCTION(date_get_last_errors);
58 PHP_FUNCTION(date_format);
59 PHP_FUNCTION(date_modify);
60 PHP_FUNCTION(date_add);
61 PHP_FUNCTION(date_sub);
62 PHP_FUNCTION(date_timezone_get);
63 PHP_FUNCTION(date_timezone_set);
64 PHP_FUNCTION(date_offset_get);
65 PHP_FUNCTION(date_diff);
66 
67 PHP_FUNCTION(date_time_set);
68 PHP_FUNCTION(date_date_set);
69 PHP_FUNCTION(date_isodate_set);
70 PHP_FUNCTION(date_timestamp_set);
71 PHP_FUNCTION(date_timestamp_get);
72 
73 PHP_METHOD(DateTimeImmutable, __construct);
74 PHP_METHOD(DateTimeImmutable, __set_state);
75 PHP_METHOD(DateTimeImmutable, modify);
76 PHP_METHOD(DateTimeImmutable, add);
77 PHP_METHOD(DateTimeImmutable, sub);
78 PHP_METHOD(DateTimeImmutable, setTimezone);
79 PHP_METHOD(DateTimeImmutable, setTime);
80 PHP_METHOD(DateTimeImmutable, setDate);
81 PHP_METHOD(DateTimeImmutable, setISODate);
82 PHP_METHOD(DateTimeImmutable, setTimestamp);
83 PHP_METHOD(DateTimeImmutable, createFromMutable);
84 
85 PHP_METHOD(DateTimeZone, __construct);
86 PHP_METHOD(DateTimeZone, __wakeup);
87 PHP_METHOD(DateTimeZone, __set_state);
88 PHP_FUNCTION(timezone_open);
89 PHP_FUNCTION(timezone_name_get);
90 PHP_FUNCTION(timezone_name_from_abbr);
91 PHP_FUNCTION(timezone_offset_get);
92 PHP_FUNCTION(timezone_transitions_get);
93 PHP_FUNCTION(timezone_location_get);
94 PHP_FUNCTION(timezone_identifiers_list);
95 PHP_FUNCTION(timezone_abbreviations_list);
96 PHP_FUNCTION(timezone_version_get);
97 
98 PHP_METHOD(DateInterval, __construct);
99 PHP_METHOD(DateInterval, __wakeup);
100 PHP_METHOD(DateInterval, __set_state);
101 PHP_FUNCTION(date_interval_format);
102 PHP_FUNCTION(date_interval_create_from_date_string);
103 
104 PHP_METHOD(DatePeriod, __construct);
105 PHP_METHOD(DatePeriod, __wakeup);
106 PHP_METHOD(DatePeriod, __set_state);
107 PHP_METHOD(DatePeriod, getStartDate);
108 PHP_METHOD(DatePeriod, getEndDate);
109 PHP_METHOD(DatePeriod, getDateInterval);
110 PHP_METHOD(DatePeriod, getRecurrences);
111 
112 /* Options and Configuration */
113 PHP_FUNCTION(date_default_timezone_set);
114 PHP_FUNCTION(date_default_timezone_get);
115 
116 /* Astro functions */
117 PHP_FUNCTION(date_sunrise);
118 PHP_FUNCTION(date_sunset);
119 PHP_FUNCTION(date_sun_info);
120 
121 PHP_RINIT_FUNCTION(date);
122 PHP_RSHUTDOWN_FUNCTION(date);
123 PHP_MINIT_FUNCTION(date);
124 PHP_MSHUTDOWN_FUNCTION(date);
125 PHP_MINFO_FUNCTION(date);
126 ZEND_MODULE_POST_ZEND_DEACTIVATE_D(date);
127 
128 typedef struct _php_date_obj php_date_obj;
129 typedef struct _php_timezone_obj php_timezone_obj;
130 typedef struct _php_interval_obj php_interval_obj;
131 typedef struct _php_period_obj php_period_obj;
132 
133 struct _php_date_obj {
134 	timelib_time *time;
135 	zend_object   std;
136 };
137 
php_date_obj_from_obj(zend_object * obj)138 static inline php_date_obj *php_date_obj_from_obj(zend_object *obj) {
139 	return (php_date_obj*)((char*)(obj) - XtOffsetOf(php_date_obj, std));
140 }
141 
142 #define Z_PHPDATE_P(zv)  php_date_obj_from_obj(Z_OBJ_P((zv)))
143 
144 struct _php_timezone_obj {
145 	int             initialized;
146 	int             type;
147 	union {
148 		timelib_tzinfo   *tz;         /* TIMELIB_ZONETYPE_ID */
149 		timelib_sll       utc_offset; /* TIMELIB_ZONETYPE_OFFSET */
150 		timelib_abbr_info z;          /* TIMELIB_ZONETYPE_ABBR */
151 	} tzi;
152 	zend_object std;
153 };
154 
php_timezone_obj_from_obj(zend_object * obj)155 static inline php_timezone_obj *php_timezone_obj_from_obj(zend_object *obj) {
156 	return (php_timezone_obj*)((char*)(obj) - XtOffsetOf(php_timezone_obj, std));
157 }
158 
159 #define Z_PHPTIMEZONE_P(zv)  php_timezone_obj_from_obj(Z_OBJ_P((zv)))
160 
161 struct _php_interval_obj {
162 	timelib_rel_time *diff;
163 	int               initialized;
164 	zend_object       std;
165 };
166 
php_interval_obj_from_obj(zend_object * obj)167 static inline php_interval_obj *php_interval_obj_from_obj(zend_object *obj) {
168 	return (php_interval_obj*)((char*)(obj) - XtOffsetOf(php_interval_obj, std));
169 }
170 
171 #define Z_PHPINTERVAL_P(zv)  php_interval_obj_from_obj(Z_OBJ_P((zv)))
172 
173 struct _php_period_obj {
174 	timelib_time     *start;
175 	zend_class_entry *start_ce;
176 	timelib_time     *current;
177 	timelib_time     *end;
178 	timelib_rel_time *interval;
179 	int               recurrences;
180 	int               initialized;
181 	int               include_start_date;
182 	zend_object       std;
183 };
184 
php_period_obj_from_obj(zend_object * obj)185 static inline php_period_obj *php_period_obj_from_obj(zend_object *obj) {
186 	return (php_period_obj*)((char*)(obj) - XtOffsetOf(php_period_obj, std));
187 }
188 
189 #define Z_PHPPERIOD_P(zv)  php_period_obj_from_obj(Z_OBJ_P((zv)))
190 
191 ZEND_BEGIN_MODULE_GLOBALS(date)
192 	char                    *default_timezone;
193 	char                    *timezone;
194 	HashTable               *tzcache;
195 	timelib_error_container *last_errors;
196 	int                     timezone_valid;
197 ZEND_END_MODULE_GLOBALS(date)
198 
199 #define DATEG(v) ZEND_MODULE_GLOBALS_ACCESSOR(date, v)
200 
201 PHPAPI time_t php_time();
202 
203 /* Backwards compatibility wrapper */
204 PHPAPI zend_long php_parse_date(char *string, zend_long *now);
205 PHPAPI void php_mktime(INTERNAL_FUNCTION_PARAMETERS, int gmt);
206 PHPAPI int php_idate(char format, time_t ts, int localtime);
207 
208 #define _php_strftime php_strftime
209 
210 PHPAPI void php_strftime(INTERNAL_FUNCTION_PARAMETERS, int gm);
211 PHPAPI zend_string *php_format_date(char *format, size_t format_len, time_t ts, int localtime);
212 
213 /* Mechanism to set new TZ database */
214 PHPAPI void php_date_set_tzdb(timelib_tzdb *tzdb);
215 PHPAPI timelib_tzinfo *get_timezone_info(void);
216 
217 /* Grabbing CE's so that other exts can use the date objects too */
218 PHPAPI zend_class_entry *php_date_get_date_ce(void);
219 PHPAPI zend_class_entry *php_date_get_immutable_ce(void);
220 PHPAPI zend_class_entry *php_date_get_interface_ce(void);
221 PHPAPI zend_class_entry *php_date_get_timezone_ce(void);
222 PHPAPI zend_class_entry *php_date_get_interval_ce(void);
223 PHPAPI zend_class_entry *php_date_get_period_ce(void);
224 
225 /* Functions for creating DateTime objects, and initializing them from a string */
226 PHPAPI zval *php_date_instantiate(zend_class_entry *pce, zval *object);
227 PHPAPI int php_date_initialize(php_date_obj *dateobj, /*const*/ char *time_str, size_t time_str_len, char *format, zval *timezone_object, int ctor);
228 
229 
230 #endif /* PHP_DATE_H */
231