Appendix C. PHP Reference

PHP is the language SearchMonkey supports for mapping your XML data to your application's various visual components, such as the title, summary, thumbnail, and links. This section provides more background about how to use PHP to extract and display search data. It includes:

“SearchMonkey PHP Whitelist” — lists the subset of PHP classes and functions permitted for extracting and mapping data in SearchMonkey
“The Data Class” — describes the Data class, an instantiation of the XML returned by your data services

For a detailed example of using PHP to write a SearchMonkey application, refer to “Creating a Presentation Application”. For documentation about the associative array used to construct applications, refer to “Presentation Application PHP Structure”.

	Note
	All user PHP code is run inside a class. If you write your own functions, you must call them using `self::function()` instead of just `function()`.

SearchMonkey PHP Whitelist

SearchMonkey supports a limited subset of PHP for mapping data to your presentation application. SearchMonkey's PHP functionality includes classes and functions designed to:

manipulate the DOM
manipulate strings
manipulate dates
manipulate arrays
execute regular expressions
perform operations on variables
perform mathematical operations
encode and decode JSON data

and more.

All language constructs except the backtick operator, alias to shell_exec(), are available. Note that __FILE__ and __DIR__ return a value without an error, but the value they return is an empty string. You cannot read or write to the filesystem, access network sockets, or execute processes.

DOM Class Whitelist

`domdocument`	`domnodelist`	`domelement`
`domxpath`	`domattr`	`xsltprocessor`

Other Class Whitelist

datetimezone

String Functions Whitelist

`addcslashes`	`str_pad`
`addslashes`	`str_repeat`
`bin2hex`	`str_replace`
`chop`	`str_rot13`
`chr`	`str_shuffle`
`chunk_split`	`str_split`
`convert_cyr_string`	`str_word_count`
`convert_uudecode`	`strcasecmp`
`convert_uuencode`	`strchr`
`count_chars`	`strcmp`
`crc32`	`strcoll`
`crypt`	`strcspn`
`explode`	`strip_tags`
`get_html_translation_table`	`stripcslashes`
`hebrev`	`stripos`
`hebrevc`	`stripslashes`
`html_entity_decode`	`stristr`
`htmlentities`	`strlen`
`htmlspecialchars_decode`	`strnatcasecmp`
`htmlspecialchars`	`strnatcmp`
`implode`	`strncasecmp`
`join`	`strncmp`
`levenshtein`	`strpbrk`
`localeconv`	`strpos`
`ltrim`	`strrchr`
`md5`	`strrev`
`metaphone`	`strripos`
`money_format`	`strrpos`
`nl_langinfo`	`strspn`
`nl2br`	`strstr`
`number_format`	`strtok`
`ord`	`strtolower`
`parse_str`	`strtoupper`
`quoted_printable_decode`	`strtr`
`quotemeta`	`substr_compare`
`rtrim`	`substr_count`
`setlocale`	`substr_replace`
`sha1`	`substr`
`similar_text`	`trim`
`soundex`	`ucfirst`
`sprintf`	`ucwords`
`sscanf`	`vprintf`
`str_getcsv`	`vsprintf`
`str_ireplace`	`wordwrap`

Array Functions Whitelist

`is_array`	`array_merge`	`asort`
`count`	`array_multisort`	`compact`
`array_push`	`array_pad`	`count`
`array`	`array_pop`	`current`
`array_rand`	`array_product`	`each`
`array_change_key_case`	`array_push`	`end`
`array_chunk`	`array_rand`	`extract`
`array_combine`	`array_reduce`	`in_array`
`array_count_values`	`array_reverse`	`key`
`array_diff_assoc`	`array_search`	`krsort`
`array_diff_key`	`array_shift`	`ksort`
`array_diff_uassoc`	`array_slice`	`list`
`array_diff_ukey`	`array_splice`	`natcasesort`
`array_diff`	`array_sum`	`natsort`
`array_fill_keys`	`array_udiff_assoc`	`next`
`array_fill`	`array_udiff_uassoc`	`pos`
`array_filter`	`array_udiff`	`prev`
`array_flip`	`array_uintersect_assoc`	`range`
`array_intersect_assoc`	`array_uintersect_uassoc`	`reset`
`array_intersect_key`	`array_uintersect`	`rsort`
`array_intersect_uassoc`	`array_unique`	`shuffle`
`array_intersect_ukey`	`array_unshift`	`sizeof`
`array_intersect`	`array_values`	`sort`
`array_key_exists`	`array_walk_recursive`	`uasort`
`array_keys`	`array_walk`	`uksort`
`array_map`	`array`	`usort`
`array_merge_recursive`	`arsort`

Variable Functions Whitelist

`doubleval`	`is_double`	`is_scalar`
`empty`	`is_float`	`is_string`
`floatval`	`is_int`	`is_unicode`
`gettype`	`is_integer`	`isset`
`intval`	`is_long`	`serialize`
`is_array`	`is_null`	`settype`
`is_binary`	`is_numeric`	`strval`
`is_bool`	`is_object`	`unserialize`
`is_buffer`	`is_real`	`unset`
`is_callable`	`is_resource`	`set`

Output Functions Whitelist

`print_r`	`echo`
`print`	`var_dump`

Date Functions Whitelist

`checkdate`	`gmdate`
`date_create`	`gmmktime`
`date_date_set`	`gmstrftime`
`date_default_timezone_get`	`idate`
`date_default_timezone_set`	`localtime`
`date_format`	`microtime`
`date_isodate_set`	`mktime`
`date_modify`	`strftime`
`date_offset_get`	`strptime`
`date_parse`	`strtotime`
`date_sun_info`	`time`
`date_sunrise`	`timezone_abbreviations_list`
`date_sunset`	`timezone_identifiers_list`
`date_timezone_ get`	`timezone_name_from_abbr`
`date_timezone_set`	`timezone_name_get`
`date`	`timezone_offset_get`
`getdate`	`timezone_open`
`gettimeofday`	`timezone_transitions_get`

Regex Functions Whitelist

`preg_grep`	`preg_replace_callback`	`eregi_replace`
`preg_last_error`	`preg_replace`	`eregi`
`preg_match_all`	`preg_split`	`split`
`preg_match`	`ereg_replace`	`spliti`
`preg_quote`	`ereg`	`sql_regcase`

JSON Functions Whitelist

json_encode json_decode

Math Functions Whitelist

`abs`	`deg2rad`	`min`
`acos`	`exp`	`mt_getrandmax`
`acosh`	`expm1`	`mt_rand`
`asin`	`floor`	`mt_srand`
`asinh`	`fmod`	`octdec`
`atan2`	`getrandmax`	`pi`
`atan`	`hexdec`	`pow`
`atanh`	`hypot`	`rad2deg`
`base_convert`	`is_finite`	`rand`
`bindec`	`is_infinite`	`round`
`ceil`	`is_nan`	`sin`
`cos`	`lcg_value`	`sinh`
`cosh`	`log10`	`sqrt`
`decbin`	`log1p`	`srand`
`dechex`	`log`	`tan`
`decoct`	`max`	`tanh`

Reflection Functions Whitelist

class_exists is_a

Other Functions Whitelist

`define`	`http_build_query`	`urldecode`
`urlencode`	`parse_url`	`uniqid`
`base64_decode`	`rawurldecode`
`base64_encode`	`rawurlencode`

SearchMonkey Guide