Repository navigation
Expand file tree
/
Copy path_date_tag.plugin.php
More file actions
275 lines (246 loc) · 6.96 KB
/
Copy path_date_tag.plugin.php
File metadata and controls
275 lines (246 loc) · 6.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<?php
/**
* This file implements the Date renderer plugin for b2evolution
*
* Date formatting, like [date:server:F d, Y:-03.30.badge]
*
* b2evolution - {@link http://b2evolution.net/}
* Released under GNU GPL License - {@link http://b2evolution.net/about/gnu-gpl-license}
* @copyright (c)2003-2020 by Francois Planque - {@link http://fplanque.com/}
*
* @package plugins
*/
if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
/**
* @package plugins
*/
class date_tag_plugin extends Plugin
{
var $code = 'evo_datetag';
var $name = 'Date tag';
var $priority = 57;
var $version = '7.3.0';
var $group = 'rendering';
var $short_desc;
var $long_desc;
var $help_topic = 'date-tag-plugin';
var $number_of_installs = 1;
/**
* Init
*/
function PluginInit( & $params )
{
$this->short_desc = sprintf( T_('Date formatting e-g %s'), '<code>[date:server:F d, Y H\:i\:s:-03.30:.badge]</code>' );
$this->long_desc = sprintf( T_('This plugin allows to render date inside collection posts and comments by using the syntax %s for example'), '<code>[date:server:F d, Y H\:i\:s:-03.30:.badge]</code>' );
}
/**
* Perform rendering
*
* @see Plugin::DisplayItemAsHtml()
*/
function DisplayItemAsHtml( & $params )
{
if( isset( $params['Comment'] ) )
{ // Render for Comment:
$this->rendering_Object = $params['Comment'];
}
elseif( isset( $params['Item'] ) )
{ // Render for Item:
$this->rendering_Object = $params['Item'];
}
elseif( isset( $params['Message'] ) )
{ // Render for Message:
$this->rendering_Object = $params['Message'];
}
elseif( isset( $params['EmailCampaign'] ) )
{ // Render for EmailCampaign:
$this->rendering_Object = $params['EmailCampaign'];
}
elseif( isset( $params['Widget'] ) )
{ // Render for Widget:
$this->rendering_Object = $params['Widget'];
}
else
{ // Don't render if no proper object is provided:
return false;
}
// Render date tag:
$params['data'] = $this->render_dates( $params['data'] );
return true;
}
/**
* Do the same as for HTML.
*
* @see Plugin::DisplayItemAsXml()
*/
function DisplayItemAsXml( & $params )
{
return $this->DisplayItemAsHtml( $params );
}
/**
* Perform rendering of email
*
* @see Plugin::RenderEmailAsHtml()
*/
function RenderEmailAsHtml( & $params )
{
return $this->DisplayItemAsHtml( $params );
}
/**
* Convert inline date tags into HTML tags like:
* [date]
* [date:server]
* [date:server:F d, Y]
* [date:server:F d, Y:-03.30]
* [date:server:F d, Y:-03.30:.badge]
* [date:issued:Y-m-d H\:i\:s]
* [date:issued:F d, Y H\:i\:s:+1\:04]
* [date:modified:Y-m-d H\:i\:s]
* [date:modified:F d, Y:0\:30]
* [date:touched:F d, Y:11.30]
* [date:touched:F d, Y]
*
* @param string Source content
* @return string Rendered content
*/
function render_dates( $content )
{
return replace_outside_code_tags( '#\[date(:([^\]]+))?\]#i', array( $this, 'get_date_text' ), $content, 'replace_content_callback' );
}
/**
* Get text for date
*
* @param array Matches
* @return string Date text
*/
function get_date_text( $matches )
{
if( empty( $matches ) )
{ // No dates found
return;
}
$object_type = get_class( $this->rendering_Object );
// Get additional options:
$options = isset( $matches[2] ) ? trim( $matches[2] ) : false;
$options = empty( $options ) ? false : preg_split( '/(?<!\\\):/', $options );
// Date source:
$date_source = isset( $options[0] ) ? $options[0] : 'server';
// Date format:
if( isset( $options[1] ) )
{ // Use custom date format:
$date_format = $options[1];
}
else
{ // Use a date format from the rendering object:
switch( $object_type )
{
case 'Item':
$rendering_Item = $this->rendering_Object;
$date_locale = $rendering_Item->get( 'locale' );
break;
case 'Comment':
$rendering_Comment = $this->rendering_Object;
$rendering_comment_Item = $rendering_Comment->get_Item();
$date_locale = $rendering_comment_Item->get( 'locale' );
break;
default:
// Use current locale:
$date_locale = NULL;
}
$date_format = locale_datefmt( $date_locale );
}
// Date offset/shifting:
$date_offset = isset( $options[2] ) ? $options[2] : 0;
// Date class:
if( isset( $options[3] ) )
{ // Check class:
$date_class = trim( str_replace( '.', ' ', $options[3] ) );
}
else
{ // No class:
$date_class = false;
}
switch( $date_source )
{
case 'issued':
switch( $object_type )
{
case 'Item':
$rendering_Item = $this->rendering_Object;
$date_source = strtotime( $rendering_Item->get( 'datestart' ) );
break;
case 'Comment':
$rendering_Comment = $this->rendering_Object;
$date_source = strtotime( $rendering_Comment->get( 'date' ) );
break;
case 'Message':
$rendering_Message = $this->rendering_Object;
$date_source = strtotime( $rendering_Message->get( 'datetime' ) );
break;
case 'EmailCampaign':
$rendering_EmailCampaign = $this->rendering_Object;
$date_source = strtotime( $rendering_EmailCampaign->get( 'date_ts' ) );
break;
default:
$date_source = false;
}
break;
case 'modified':
switch( $object_type )
{
case 'Item':
$rendering_Item = $this->rendering_Object;
$date_source = strtotime( $rendering_Item->get( 'datemodified' ) );
break;
default:
$date_source = false;
}
break;
case 'touched':
switch( $object_type )
{
case 'Item':
$rendering_Item = $this->rendering_Object;
$date_source = strtotime( $rendering_Item->get( 'last_touched_ts' ) );
break;
case 'Comment':
$rendering_Comment = $this->rendering_Object;
$date_source = strtotime( $rendering_Comment->get( 'last_touched_ts' ) );
break;
default:
$date_source = false;
}
break;
default: // 'server'
global $servertimenow;
$date_source = $servertimenow;
}
if( $date_source === false )
{ // Display error if source cannot be used for the rendering object:
return get_rendering_error( sprintf( T_('%s is not valid for %s'), $matches[0], $object_type ), 'span' );
}
if( preg_match( '/-?\d{1,2}([\.,:]\d{1,2})?/', $date_offset ) && ! empty( $date_offset ) )
{ // Shift date:
$date_offset = preg_split( '/[\.,:]/', $date_offset );
$o_date_source = $date_source;
// Shift with hours:
$date_source += rtrim( $date_offset[0], '\\' ) * 3600;
if( isset( $date_offset[1] ) )
{ // Shift with minutes:
if( $date_offset[0] < 0 )
{ // Use correct sign for minutes as hours have:
$date_offset[1] = -$date_offset[1];
}
$date_source += $date_offset[1] * 60;
}
}
// Get date:
$date_text = date( $date_format, $date_source );
if( ! empty( $date_class ) )
{ // Apply class to date text if it is provided:
$date_text = '<span class="'.format_to_output( $date_class, 'htmlattr' ).'">'.$date_text.'</span>';
}
return $date_text;
}
}
?>