BlueShoes Application Framework made with PHP http://www.blueshoes.org/


Packageindex Classtrees Modulegroups Elementlist Report XML Files
File: C:/usr/local/lib/php/blueshoes-4.2/core/html/Bs_HtmlUtil.class.php
BlueShoes Application Framework - html

Bs_HtmlUtil

Bs_Object
   |
  +-- Bs_HtmlUtil

This static class provides many useful html methods.

 

public class Bs_HtmlUtil extends Bs_Object

This static class provides many useful html methods.
no dependencies here.

Authors
Version4.0.$Id: Bs_HtmlUtil.html,v 1.1.1.1 2003/07/04 15:17:18 andrej Exp $
Copyrightblueshoes.org
 

Methods inherited from Bs_Object
isex, isexception, tostring, tohtml, persist, unpersist, bs_object, bbsetoutput, bbawake, bbisawake, bbxmsg, bbxfunctionstart, bbxfunctionend, bbxecho, bbxvar, bbxvardump, bbforcetrace, bbbufferstart, bbbufferget, bbbufferendflush, bbbufferendclean

Public Method Summary
string

charToHtml([ string $param, string $reverse ])

Convert a real string into an 'html' string, eg convert AB to AB
string

filterForJavaScript(string $param)

Converts an ordinary string to a client-side JavaScript friendly version
string

filterForHtml(string $param, string $quoteTrans)

This function is useful in preventing user-supplied text from containing
string

jsAlert(string $value)

returns $value as a javascript popup. sometimes echo is not suitable
string

arrayToJsArray(array $array, [ string $nameOfJsArray, string $firstCall ])

takes a php array and creates a js array definition that
string

arrayToHtmlSelect(array $myArray, [ mixed $selected ])

Takes any array and returns a string with the options to seed an html select field.
string

htmlEntitiesUndo(string $string)

Convert all HTML entities to applicable characters.
array

&parseStyleStr(string &$styleStr)

Parse a style string of a format like below to a hash array
array

&parseAttrStr(string &$attrStr)

Parse a attr string of a format like below to a hash array
void

Bs_HtmlUtil()

Warning: documentation is missing.

Private Method Summary
void

htmlEntities2( $string)

synonyme of htmlEntitiesUndo().
void

htmlspecialchars( $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $quoteTrans, $quoteTrans, $quoteTrans, $quoteTrans, $quoteTrans, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, string $quoteTrans, string $param, string $param, $quoteTrans, string $replaceWith, $param, $param, $param, $param, $param, $param, $param, $replaceWith, $value, $value, $value, $value, $value, $value, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $value, $value, $value, $value, $value, $value, $value, $value, $value, $value, $value, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $value, $value, $value, $value, $value, $value, $value, $value, $value, string $ret, $ret, $ret, $this, $this, $this, $this, $value, $value, $value, $value, $value, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $nameOfJsArray, $nameOfJsArray, $firstCall, $firstCall, $firstCall, $firstCall, $firstCall, $firstCall, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, string $nameOfJsArray, string $firstCall, $firstCall, $firstCall, string $ret, string $ret, $array, $array, $array, $array, $array, string $key, $val, $val, $val, $val, $val, $val, $val, $val, $ret, $ret, $ret, $ret, $this, $this, $array, $array, $array, $key, $key, $nameOfJsArray, $this, $this, $this, $key, $key, $key, $key, $key, $key, $key, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, string $val, string $val, $this, $val, $val, $val, $val, $val, $val, $val, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $nameOfJsArray})

Warning: documentation is missing.

Private Constant Summary
BS_HTMLUTIL_VERSION >>4.0.$x$<< Warning: documentation is missing.

Public Method Details

charToHtml

public string charToHtml( [ string $param, string $reverse ] )
  Convert a real string into an 'html' string, eg convert AB to &#65;&#66;
this function is useful to 'decrypt' email addresses so email spiders won'tdetect them, hopefully.NOTE: not all characters will be converted, only 0-9 a-z A-Z and @ will be done.

Parameter
string $param = >>''<<
the string you want to convert from plaintext to html.
string $reverse = >>FALSE<<
(optional, default FALSE)do reverse.
Returns string

the converted string.

filterForJavaScript

public string filterForJavaScript( string $param )
  Converts an ordinary string to a client-side JavaScript friendly version
to be written out on the client webpageif you want to write out javascript code with javascript strings, use thisfunction for the values of the js strings.

Parameter
string $param
to be filtered
Returns string

filtered string
See Also filterForHtml()

filterForHtml

public string filterForHtml( string $param, string $quoteTrans )
  This function is useful in preventing user-supplied text from containing
HTML markup, such as in a message board or guest book application.The optional second argument, quoteTrans, tells the function what to dowith single and double quote characters.Otherwise something like this may occur:<input type="text" name="blah" value="this is a "buggy" default value">Older browsers will fail and only display "this is a " as default value.(IE5.5 can handle this in textarea fields. but... please use this function.)The default mode, ENT_COMPAT, is the backwards compatible mode which onlytranslates the double-quote character and leaves the single-quote untranslated.If ENT_QUOTES is set, both single and double quotes are translated and ifENT_NOQUOTES is set neither single nor double quotes are translated.The only difference to PHP's built in function htmlspecialchars() is that'\n' (line feed) and '\r' (carriage return) are also translated.Tranformation characters:'&' (ampersand) becomes '&''"' (double quote) becomes '"' when ENT_NOQUOTES is not set.''' (single quote) becomes '&#039;' only when ENT_QUOTES is set.'<' (less than) becomes '<''>' (greater than) becomes '>''\n' (line feed) becomes '&#10;''\r' (carriage return) becomes '&#13;'

Parameter
string $param
string to be filtered
string $quoteTrans
Warning: documentation is missing.
Returns string $quoteTrans

filtered string
See Also filterForJavaScript()

jsAlert

public string jsAlert( string $value )
  returns $value as a javascript popup. sometimes echo is not suitable
cause you're somewhere in the middle of the output, or you're in a frame,or whatever that makes it difficult to find your debug echo/vardump output.the function does not output anything itself.uses $this->filterForJavaScript().

Parameter
string $value
Returns string

a javascript string

arrayToJsArray

public string arrayToJsArray( array $array, [ string $nameOfJsArray, string $firstCall ] )
  takes a php array and creates a js array definition that
can be spitted out.method calls itself recursively.example:

Parameter
array $array
string $nameOfJsArray = >>'myArray'<<
(default is 'myArray')
string $firstCall = >>TRUE<<
(used internally only! do not touch this!)
Returns string

arrayToHtmlSelect

public string arrayToHtmlSelect( array $myArray, [ mixed $selected ] )
  Takes any array and returns a string with the options to seed an html select field.
Depending if the array is a hash- or a normal 'zerobased'-array the result looks defferent.Example I: Normal 'zerobased'-array$myArray = array('red', 'green', 'blue');$selected = 'green';arrayToHtmlSelect($myArray, $selected);<option value="red">red</option><option value="green" selected>green</option><option value="blue">blue</option>Example II: hash-array$myArray = array('ch'=>'Switzerland', 'de'=>'Germany', 'at'=>'Austria');$selected = array('ch', 'at');arrayToHtmlSelect($myArray, $selected);<option value="ch" selected>Switzerland</option><option value="de">Germany</option><option value="at" selected>Austria</option>NOTE: If you try to use an array as param $selected, make sure your <selecthas the option 'multiple' and a 'size' that is >1.

Parameter
array $myArray
can be a normal array or a hash array.
mixed $selected = >>''<<
a string with one key, or an array with more, see examples.
Returns string

returns option part of html-select string.

htmlEntitiesUndo

public string htmlEntitiesUndo( string $string )
  Convert all HTML entities to applicable characters.
This is the reversed function of php's htmlentities(). i bet it will be implemented in php soon.

Parameter
string $string
Returns string

See Also htmlspecialchars()

&parseStyleStr

public array &parseStyleStr( string &$styleStr )
  Parse a style string of a format like below to a hash array
Separator assumed: For the elements ';', for the key/value pair ':'E.g.If following is given as input :font-family: arial, helvetica; font-size: 10pt; color: #000000; key: ; key2; ;You will get an hash array as follows:array('font-family'=>'arial, helvetica', 'font-size'=>'10pt', 'color'=>'#000000', 'key'=>' ', 'key2'=>NULL)

Parameter
string &$styleStr
Returns array

&parseAttrStr

public array &parseAttrStr( string &$attrStr )
  Parse a attr string of a format like below to a hash array
Separator assumed: For the elements ' ', for the key/value pair '='E.g.If following is given as input :ALIGN = 'right' value='' bgcolor="blue" selectedYou will get an hash array as follows:array('align'=>'right', 'value'=>'', 'bgcolor'=>'blue', 'selected'=>NULL)

Parameter
string &$attrStr
Returns array

Bs_HtmlUtil

public void Bs_HtmlUtil( )
 

Warning: documentation is missing.

Returns void

Private Method Details

htmlEntities2

private void htmlEntities2( $string )
  synonyme of htmlEntitiesUndo().

Parameter
$string
Warning: documentation is missing.
Returns void

See Also htmlEntitiesUndo()

htmlspecialchars

private void htmlspecialchars( $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $quoteTrans, $quoteTrans, $quoteTrans, $quoteTrans, $quoteTrans, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, $param, string $quoteTrans, string $param, string $param, $quoteTrans, string $replaceWith, $param, $param, $param, $param, $param, $param, $param, $replaceWith, $value, $value, $value, $value, $value, $value, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $value, $value, $value, $value, $value, $value, $value, $value, $value, $value, $value, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $this, $value, $value, $value, $value, $value, $value, $value, $value, $value, string $ret, $ret, $ret, $this, $this, $this, $this, $value, $value, $value, $value, $value, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $nameOfJsArray, $nameOfJsArray, $firstCall, $firstCall, $firstCall, $firstCall, $firstCall, $firstCall, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, $array, string $nameOfJsArray, string $firstCall, $firstCall, $firstCall, string $ret, string $ret, $array, $array, $array, $array, $array, string $key, $val, $val, $val, $val, $val, $val, $val, $val, $ret, $ret, $ret, $ret, $this, $this, $array, $array, $array, $key, $key, $nameOfJsArray, $this, $this, $this, $key, $key, $key, $key, $key, $key, $key, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, $val, string $val, string $val, $this, $val, $val, $val, $val, $val, $val, $val, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $ret, $nameOfJsArray} )
 

Warning: documentation is missing.

Parameter
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$quoteTrans
Warning: documentation is missing.
$quoteTrans
Warning: documentation is missing.
$quoteTrans
Warning: documentation is missing.
$quoteTrans
Warning: documentation is missing.
$quoteTrans
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
string $quoteTrans
Warning: documentation is missing.
string $param
Warning: documentation is missing.
string $param
Warning: documentation is missing.
$quoteTrans
Warning: documentation is missing.
string $replaceWith
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$param
Warning: documentation is missing.
$replaceWith
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
string $ret
Warning: documentation is missing.
$ret
Warning: documentation is missing.
$ret
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$this
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value
Warning: documentation is missing.
$value