Public Method Details |
stx_get_section_template |
public string stx_get_section_template( object Section &$section )
|
|
so the Section object can be regenerated if its properties change. Useful for inheriting templates from parents.
|
Parameter |
|
|
Returns |
string |
|
get_section_template |
public string get_section_template( object Section &$section )
|
|
|
Parameter |
|
|
Returns |
string |
|
stx_find_last_date |
public int stx_find_last_date( int $month, int $year )
|
|
|
Parameter |
|
int |
$month |
|
|
to have last date found for |
|
|
int |
$year |
|
|
to make sure leap year is calculated correctly |
|
Returns |
int last date of given month |
Author(s) |
Sandy Smith <ssmith@forumone.com> |
|
find_last_day |
public int find_last_day( int $month, int $year )
|
|
|
Parameter |
|
int |
$month |
|
|
to have last date found for |
|
|
int |
$year |
|
|
to make sure leap year is calculated correctly |
|
Returns |
int last date of given month |
|
stx_obfuscate_ascii |
public string stx_obfuscate_ascii( string $text )
|
|
Useful for obfuscating e-mail addresses to prevent them from being harvested by spambots. Note--this will not work well with entities or non-ASCII characters.
|
Parameter |
|
string |
$text |
|
|
Plain ASCII text to be obfuscated |
|
Returns |
string obfuscated text |
|
obfuscate_ascii |
public string obfuscate_ascii( string $text )
|
|
|
Parameter |
|
string |
$text |
|
|
Plain ASCII text to be obfuscated |
|
Returns |
string obfuscated text |
|
stx_get_image_link |
public string stx_get_image_link( string $url, [ constant $restrict, string $class, string $alt ] )
|
|
and returns an HTML img tag. Only works on local images.
|
Parameter |
|
string |
$url |
|
|
The local URL (everything after the domain) |
|
|
constant |
$restrict |
= >>array('by'<< |
|
Associative array. Valid keys are 'by' (string 'width' or 'height') and 'max' (int) |
|
|
string |
$class |
= >>null<< |
|
CSS class |
|
|
string |
$alt |
= >>null<< |
|
Alt text |
|
Returns |
string The img tag. |
|
get_image_link |
public string get_image_link( string $url, [ constant $restrict, string $class, string $alt ] )
|
|
|
Parameter |
|
string |
$url |
|
|
The local URL (everything after the domain) |
|
|
constant |
$restrict |
= >>array('by'<< |
|
Associative array. Valid keys are 'by' (string 'width' or 'height') and 'max' (int) |
|
|
string |
$class |
= >>null<< |
|
CSS class |
|
|
string |
$alt |
= >>null<< |
|
Alt text |
|
Returns |
string The img tag. |
|
&stx_list_from_picktable |
public object ListWidget &stx_list_from_picktable( string $name, string $picktable, [ array $prepend ] )
|
|
a Syntax pick table object.
|
Parameter |
|
string |
$name |
|
|
, name of list widget |
|
|
string |
$picktable |
|
|
, name of pick table |
|
|
array |
$prepend |
= >>null<< |
|
, optional array of values to prepend to options array |
|
Returns |
object ListWidget |
|
&list_from_picktable |
public object ListWidget &list_from_picktable( string $name, string $picktable, [ array $prepend ] )
|
|
|
Parameter |
|
string |
$name |
|
|
, name of list widget |
|
|
string |
$picktable |
|
|
, name of pick table |
|
|
array |
$prepend |
= >>null<< |
|
, optional array of values to prepend to options array |
|
Returns |
object ListWidget |
|
&stx_list_from_picktable_tree |
public object ListWidget &stx_list_from_picktable_tree( string $name, string $picktable, [ array $prepend ], $depth_label )
|
|
a Syntax pick table object.
|
Parameter |
|
string |
$name |
|
|
, name of list widget |
|
|
string |
$picktable |
|
|
, name of pick table |
|
|
array |
$prepend |
= >>null<< |
|
, optional array of values to prepend to options array |
|
|
|
$depth_label |
|
|
Warning: documentation is missing. |
|
Returns |
object ListWidget |
|
&list_from_picktable_tree |
public object ListWidget &list_from_picktable_tree( string $name, string $picktable, [ array $prepend ], $depth_label )
|
|
|
Parameter |
|
string |
$name |
|
|
, name of list widget |
|
|
string |
$picktable |
|
|
, name of pick table |
|
|
array |
$prepend |
= >>null<< |
|
, optional array of values to prepend to options array |
|
|
|
$depth_label |
|
|
Warning: documentation is missing. |
|
Returns |
object ListWidget |
|