ph_htmlescape1 PowerHome formula function
Description
This function accepts a string and searches
for HTML reserved characters and substitutes them as
needed.
Syntax
ph_htmlescape1 ( input, flags
)
| Argument |
Description |
| input |
String. The data you'd like to have HTML reserved characters
replaced. |
|
flags
|
Integer. A numeric value specifying
which type of HTML characters will be replaced. See usage below
for details
|
Return value
String. Returns the string with the HTML
reserved characters replaced.
Usage
The table below details the flags
parameter. Add each number together for each type of replacement desired to get
the value for the flags parameter.
| 1 |
Less than (<), greater than (>), and double quote (")
characters will be replaced with <, >, " |
| 2 |
Ampersand (&) characters will be replaced with
& |
| 4 |
Space characters will be replaced with |
|
8
|
Carriage return/line feed pairs will be
replaced
with <br>
|
Examples
The following examples demonstrate typical syntax/usage for this function.
ph_htmlescape("Mike & Ike are
home.",6)
The above example will replace & and space characters (2 and 4
added together = 6) with HTML equivalents. The return value will be:
Mike & Ike are home.