SDP ptpscript:functions
http://sdp.soapi.com/
2009-11-12T03:08:59+01:00SDP
http://sdp.soapi.com/
http://sdp.soapi.com/lib/images/favicon.icotext/html2007-01-24T10:15:54+01:00ascii
http://sdp.soapi.com/ptpscript:functions:ascii?rev=1169633754
Get the ASCII code of a character. Syntax Number ascii( String subject ) Parameters String subject - The String to get the ASCII code of (first character only). Result Number - The ASCII code. Returns the ASCII code of the first char...text/html2007-01-24T10:15:54+01:00base
http://sdp.soapi.com/ptpscript:functions:base?rev=1169633754
Convert a Number or numeric String between numeric bases. Syntax String base( Mixed subject, Number from, Number to [, String fromchars [, String tochars ] ] ) Parameters Mixed subject - The number to convert. String - The String will be tr...text/html2007-01-24T10:15:54+01:00base64decode
http://sdp.soapi.com/ptpscript:functions:base64decode?rev=1169633754
Base64-decode a String. Syntax String base64decode( String subject ) Parameters String subject - The String to be Base64-decoded. Result String - The decoded String. Returns subject decoded with MIME Base64. ...text/html2007-01-24T10:15:54+01:00base64encode
http://sdp.soapi.com/ptpscript:functions:base64encode?rev=1169633754
Base64-encode a String. Syntax String base64encode( String subject ) Parameters String subject - The String to be Base64-encoded. Result String - The encoded String. Returns subject encoded with MIME Base64. ...text/html2007-01-24T10:15:54+01:00char
http://sdp.soapi.com/ptpscript:functions:char?rev=1169633754
Get the character with a certain ASCII code. Syntax String char( Number code ) Parameters Number code - The ASCII code. Result String - The character that has the specified ASCII code. Returns a one-character String containing the ch...text/html2007-01-24T10:15:54+01:00combine
http://sdp.soapi.com/ptpscript:functions:combine?rev=1169633754
Combine an Array of item keys with an Array of item values. Syntax Array combine( Array keys, Array values ) Parameters Array keys - The Array containing the item values to use as item keys. Array values - The Array containing the item valu...text/html2007-01-24T10:15:54+01:00compare
http://sdp.soapi.com/ptpscript:functions:compare?rev=1169633754
Compare two values. Syntax Number compare( Mixed term1, Mixed term2 [, Number method [, Number length ] ] ) Parameters Mixed term1 - The first term. Mixed term2 - The second term. Number method - Sort method options. 0 (default) - Compare...text/html2007-01-24T10:15:54+01:00count
http://sdp.soapi.com/ptpscript:functions:count?rev=1169633754
This is an alias for length(). ...text/html2007-01-24T10:15:54+01:00crc32
http://sdp.soapi.com/ptpscript:functions:crc32?rev=1169633754
Calculate the CRC32 polynomial of a String. Syntax Number crc32( String subject ) Parameters String subject - The String to calculate a polynomial for. Result String - The CRC32 polynomial. Returns the CRC32 (Cyclic Redundancy Checks...text/html2007-01-24T10:15:54+01:00crypt
http://sdp.soapi.com/ptpscript:functions:crypt?rev=1169633754
Calculate the hash of a String, using DES or alternatives on the system. Syntax String crypt( String subject [, String salt ] ) Parameters String subject - The String to calculate a hash for. String salt - An optional String to salt the enc...text/html2007-01-24T10:15:54+01:00date
http://sdp.soapi.com/ptpscript:functions:date?rev=1169633754
Formats a date/time. Syntax String date( String format [, Number time [, Boolean gmt ] ] ) Parameters String format - How to format the date/time. See the table below. Number type - The time to use, as a Unix timestamp in integer Number for...text/html2007-01-24T10:15:54+01:00dump
http://sdp.soapi.com/ptpscript:functions:dump?rev=1169633754
Dumps the contents of a value, where the value can be any data type. Syntax String dump( [ Mixed subject ] ) Parameters Mixed subject - The value to display the contents of. If omitted, the values of all variables in current scope will be di...text/html2007-02-25T22:04:10+01:00first
http://sdp.soapi.com/ptpscript:functions:first?rev=1172441050
Get the first n elements from a String. Syntax String first( String subject [, String separator [, Number limit ] ] ) Parameters String subject - The String to extract from. String separator - What to use as the boundary between elements i...text/html2007-01-24T10:15:54+01:00firstcase
http://sdp.soapi.com/ptpscript:functions:firstcase?rev=1169633754
Make the first character in a String uppercase. Syntax String firstcase( String subject ) Parameters String subject - The String to be converted to firstcase. Result String - The converted String. Returns subject with the first chara...text/html2007-02-25T22:07:03+01:00firstword
http://sdp.soapi.com/ptpscript:functions:firstword?rev=1172441223
Get the first n words from a String. Syntax String firstword( String subject [, Number limit ] ) Parameters String subject - The String to extract from. Number limit - A maximum of limit words will be extracted from the subject string. R...text/html2007-01-24T10:15:54+01:00htmldecode
http://sdp.soapi.com/ptpscript:functions:htmldecode?rev=1169633754
Convert HTML entities in a String to their corresponding characters. Syntax String htmldecode( String subject [, Number quotes [, Boolean all [, String charset ] ] ] ) Parameters String subject - The String to convert. Number quotes - How t...text/html2007-01-24T10:15:54+01:00htmlencode
http://sdp.soapi.com/ptpscript:functions:htmlencode?rev=1169633754
Convert applicable characters in a String to HTML entities. Syntax String htmlencode( String subject [, Number quotes [, Boolean all [, String charset ] ] ] ) Parameters String subject - The String to convert. Number quotes - How to convert...text/html2007-01-24T10:15:54+01:00invert
http://sdp.soapi.com/ptpscript:functions:invert?rev=1169633754
Inverts the items of an Array. Syntax Array invert( Array subject ) Parameters Array subject - The Array to invert. Result Array - An Array containing all the item values of subject as item keys, and the corresponding keys as values. Dup...text/html2007-01-24T10:15:54+01:00join
http://sdp.soapi.com/ptpscript:functions:join?rev=1169633754
Join items in an Array together. Syntax String join( Array subject [, String separator ] ) Parameters Array subject - The Array containing the items to join together. String separator - The optional String to use in between each item as the...text/html2007-01-24T10:15:54+01:00jsondecode
http://sdp.soapi.com/ptpscript:functions:jsondecode?rev=1169633754
Convert a String in JSON format to an appropriate value. Syntax Mixed jsondecode( String subject [, Boolean associative ] ) Parameters String subject - The String to be converted. Boolean associative - Whether to convert objects into associ...text/html2007-01-24T10:15:54+01:00jsonencode
http://sdp.soapi.com/ptpscript:functions:jsonencode?rev=1169633754
Convert a value to a JSON representation. Syntax String jsonencode( Mixed subject ) Parameters Mixed subject - The value to convert. Result String - The converted value. Returns subject converted into JSON format. ...text/html2007-01-24T10:15:54+01:00keys
http://sdp.soapi.com/ptpscript:functions:keys?rev=1169633754
Get all the item keys of an Array. Syntax Array keys( Array subject ) Parameters Array subject - The Array to get the item keys from. Result Array - An Array containing all the item keys of subject as item values. Returns the item ke...text/html2007-02-25T22:04:51+01:00last
http://sdp.soapi.com/ptpscript:functions:last?rev=1172441091
Get the last n elements from a String. Syntax String last( String subject [, String separator [, Number limit ] ] ) Parameters String subject - The String to extract from. String separator - What to use as the boundary between elements in ...text/html2007-02-25T22:07:31+01:00lastword
http://sdp.soapi.com/ptpscript:functions:lastword?rev=1172441251
Get the last n words from a String. Syntax String lastword( String subject [, Number limit ] ) Parameters String subject - The String to extract from. Number limit - A maximum of limit words will be extracted from the subject string. Res...text/html2007-01-24T10:15:54+01:00length
http://sdp.soapi.com/ptpscript:functions:length?rev=1169633754
Get the length of a String or Number, or the number of items in an Array. Syntax Number length( Mixed subject [, Boolean recurse ] ) Parameters Mixed subject - The entity to get the length of. This can be any PTPScript data type. String - T...text/html2007-01-24T10:15:54+01:00lowercase
http://sdp.soapi.com/ptpscript:functions:lowercase?rev=1169633754
Make a String lowercase. Syntax String lowercase( String subject ) Parameters String subject - The String to be converted to lowercase. Result String - The converted String. Returns subject with all alphabetic characters converted to...text/html2007-01-24T10:15:54+01:00md5
http://sdp.soapi.com/ptpscript:functions:md5?rev=1169633754
Calculate the MD5 hash of a String. Syntax String md5( String subject ) Parameters String subject - The String to calculate a hash for. Result String - The MD5 hash. Returns the MD5 hash of subject. The hash is a 32-character hexadec...text/html2007-01-24T10:15:54+01:00pad
http://sdp.soapi.com/ptpscript:functions:pad?rev=1169633754
Pad a String with another String, to a certain length. Syntax String pad( String subject, Number length [, String padding [, Number type ] ] ) Parameters String subject - The String to pad. Number length - The length to pad the String to. ...text/html2007-01-24T10:15:54+01:00random
http://sdp.soapi.com/ptpscript:functions:random?rev=1169633754
Generates a random Number. Syntax Number random( [ Number min, Number max ] ) Parameters Number min - The minimum number to return (if omitted, defaults to 0). Number max - The maximum number to return (if omitted, generally defaults to 327...text/html2007-01-24T10:15:54+01:00range
http://sdp.soapi.com/ptpscript:functions:range?rev=1169633754
Create an Array containing a range of elements. Syntax Array range( Mixed from, Mixed to [, Number step ] ) Parameters Mixed from - The value to start the sequence on. Number - The sequence will start on the Number given. String - The sequ...text/html2007-01-24T10:15:54+01:00replace
http://sdp.soapi.com/ptpscript:functions:replace?rev=1169633754
Replace all occurrences of a value in a String, Number, or Array with another value. Syntax Mixed replace( Mixed subject, Mixed search, Mixed replace [, Boolean strict ] ) Parameters Mixed subject - The entity to search. String - The String...text/html2007-01-24T10:15:54+01:00reverse
http://sdp.soapi.com/ptpscript:functions:reverse?rev=1169633754
Reverse a String, Number, or Array. Syntax Mixed reverse( Mixed subject [, Boolean preserve ] ) Parameters Mixed subject - The entity to reverse. String - The String will be reversed. Number - The Number will be treated as a String. Array...text/html2007-01-24T10:15:54+01:00round
http://sdp.soapi.com/ptpscript:functions:round?rev=1169633754
Rounds a Number. Syntax Number round( Number subject [, Number places [, Number method ] ] ) Parameters Number subject - The number to round. Number places - The number of places to round to. If positive, that many decimal places are used t...text/html2007-01-24T10:15:54+01:00search
http://sdp.soapi.com/ptpscript:functions:search?rev=1169633754
Search a String, Number, or Array for a value. Syntax Mixed search( Mixed subject, Mixed search [, Boolean all [, Boolean strict [, Boolean reverse [, Number start ] ] ] ] ) Parameters Mixed subject - The entity to search. String - The Stri...text/html2007-01-24T10:15:54+01:00sha1
http://sdp.soapi.com/ptpscript:functions:sha1?rev=1169633754
Calculate the SHA1 hash of a String. Syntax String sha1( String subject ) Parameters String subject - The String to calculate a hash for. Result String - The SHA1 hash. Returns the SHA1 hash of subject. The hash is a 40-character hex...text/html2007-01-24T10:15:54+01:00shuffle
http://sdp.soapi.com/ptpscript:functions:shuffle?rev=1169633754
Shuffle a String, Number, or Array. Syntax Mixed shuffle( Mixed subject [, Boolean preserve ] ) Parameters Mixed subject - The entity to shuffle. String - The String will be shuffled. Number - The Number will be treated as a String. Array...text/html2007-01-24T10:15:54+01:00slashdecode
http://sdp.soapi.com/ptpscript:functions:slashdecode?rev=1169633754
Decode a String escaped with slashes. Syntax String slashdecode( String subject ) Parameters String subject - The String to decode. Result String - The decoded String. Returns subject with backslashes stripped from it. ...text/html2007-01-24T10:15:54+01:00slashencode
http://sdp.soapi.com/ptpscript:functions:slashencode?rev=1169633754
Encode a String by escaping it with slashes. Syntax String slashencode( String subject ) Parameters String subject - The String to encode. Result String - The encoded String. Returns subject with backslashes in front of single quotes...text/html2007-01-24T10:15:54+01:00slice
http://sdp.soapi.com/ptpscript:functions:slice?rev=1169633754
Extract a part of a String, Number, or Array. Syntax Mixed slice( Mixed subject, Number start [, Number length [, Boolean preserve ] ] ) Parameters Mixed subject - The entity to slice. String - The portion of the String specified by the sta...text/html2007-01-24T10:15:54+01:00sort
http://sdp.soapi.com/ptpscript:functions:sort?rev=1169633754
Sort an Array. Syntax Array sort( Array subject [, Boolean reverse [, Boolean preserve [, Boolean byKey [, Boolean safe [, Number method ] ] ] ] ] ) Parameters Array subject - The Array to sort. Boolean reverse - Whether to reverse the sort...text/html2007-01-24T10:15:54+01:00sortmulti
http://sdp.soapi.com/ptpscript:functions:sortmulti?rev=1169633754
Sort an Array according to columns. Syntax Array sortmulti( Array subject, Array options [, Boolean preserve ] ) Array options ( Array option [, ... ] ) Array option ( Mixed column [, Boolean reverse [, Number method ] ] ) Parameters Arr...text/html2007-01-24T10:15:54+01:00splice
http://sdp.soapi.com/ptpscript:functions:splice?rev=1169633754
Remove, replace, or insert a part of a String, Number, or Array. Syntax Mixed splice( Mixed subject, Number start [, Number length [, Mixed newpart ] ] ) Parameters Mixed subject - The entity to splice. String - The portion of the String sp...text/html2007-01-24T10:15:54+01:00split
http://sdp.soapi.com/ptpscript:functions:split?rev=1169633754
Split a String into pieces. Syntax Array split( String subject [, Mixed separator [, Number limit ] ] ) Parameters String subject - The String to split. Mixed separator - What to split subject on. String - subject will be split using the ...text/html2007-01-24T10:15:54+01:00time
http://sdp.soapi.com/ptpscript:functions:time?rev=1169633754
Gets the current time. Syntax Mixed time( [ Number type ] ) Parameters Number type - How to return the time. 0 (default) - Return the time in whole seconds, as an integer Number. 1 - Return the time with microseconds, as a floating-point N...text/html2007-01-24T10:15:54+01:00titlecase
http://sdp.soapi.com/ptpscript:functions:titlecase?rev=1169633754
Make the first character in each word of a String uppercase. Syntax String titlecase( String subject ) Parameters String subject - The String to be converted to titlecase. Result String - The converted String. Returns subject with th...text/html2007-01-24T10:15:54+01:00trim
http://sdp.soapi.com/ptpscript:functions:trim?rev=1169633754
Remove whitespace from a String. Syntax String trim( String subject [, Number type [, String charlist ] ] ) Parameters String subject - The String to trim. Number type - Which side(s) to trim. 0 - Trim the left-hand side of subject. 1 - T...text/html2007-01-24T10:15:54+01:00unique
http://sdp.soapi.com/ptpscript:functions:unique?rev=1169633754
Remove duplicate values from a String, Number, or Array. Syntax Mixed unique( Mixed subject ) Parameters Mixed subject - The entity to remove duplicate values from. String - The String will be purged of duplicate characters. Number - The N...text/html2007-01-24T10:15:54+01:00uppercase
http://sdp.soapi.com/ptpscript:functions:uppercase?rev=1169633754
Make a String uppercase. Syntax String uppercase( String subject ) Parameters String subject - The String to be converted to uppercase. Result String - The converted String. Returns subject with all alphabetic characters converted to...text/html2007-01-24T10:15:54+01:00urldecode
http://sdp.soapi.com/ptpscript:functions:urldecode?rev=1169633754
URL-decode a String according to RFC 1738. Syntax String urldecode( String subject ) Parameters String subject - The String to be URL-decoded. Result String - The decoded String. Returns subject with percentage signs (%) followed by ...text/html2007-01-24T10:15:54+01:00urlencode
http://sdp.soapi.com/ptpscript:functions:urlencode?rev=1169633754
URL-encode a String according to RFC 1738. Syntax String urlencode( String subject ) Parameters String subject - The String to be URL-encoded. Result String - The encoded String. Returns subject with all non-alphanumeric characters e...text/html2007-01-24T10:15:54+01:00uudecode
http://sdp.soapi.com/ptpscript:functions:uudecode?rev=1169633754
UUdecode a String. Syntax String uudecode( String subject ) Parameters String subject - The String to be UUdecoded. Result String - The decoded String. Returns subject decoded using the UUencode algorithm. ...text/html2007-01-24T10:15:54+01:00uuencode
http://sdp.soapi.com/ptpscript:functions:uuencode?rev=1169633754
UUencode a String. Syntax String uuencode( String subject ) Parameters String subject - The String to be UUencoded. Result String - The encoded String. Returns subject encoded using the UUencode algorithm. This translates the String ...text/html2007-01-24T10:15:54+01:00values
http://sdp.soapi.com/ptpscript:functions:values?rev=1169633754
Get all the item values of an Array. Syntax Array values( Array subject ) Parameters Array subject - The Array to get the item values from. Result Array - An Array containing all the item values of subject as item values. Returns the...text/html2007-01-24T10:15:54+01:00wordcount
http://sdp.soapi.com/ptpscript:functions:wordcount?rev=1169633754
Count the number of words in a String. Syntax Mixed wordcount( String subject [, Number format [, String charlist ] ] ) Parameters String subject - The String to count the words of. Number format - The format to return results in. 0 (defau...text/html2007-01-24T10:15:54+01:00wordwrap
http://sdp.soapi.com/ptpscript:functions:wordwrap?rev=1169633754
Wrap a String to a given number of characters. Syntax String wordwrap( String subject [, Number width [, String break [, Boolean cut ] ] ] ) Parameters String subject - The String to wrap. Number width - The width at which to wrap (defaults...