Class: Convert

Source Location: /sapphire/core/Convert.php

Inheritance:

Summary: Library of conversion functions, implemented as static methods.

Methods

public `static array2json ( $val )`	Convert an array into a JSON encoded string.
public `static html2raw ( $data, [$preserveLinks = false], [$wordWrap = 60], [$config = null] )`	Simple conversion of HTML to plaintext.
public `static json2array ( $val )`	Convert a JSON string into an array.
public `static json2obj ( $val )`	Convert a JSON encoded string into an object.
public `static linkIfMatch ( $string )`	Create a link if the string is a valid URL
public `static raw2att ( $val )`	Convert a value to be suitable for an XML attribute.
public `static raw2htmlatt ( $val )`	Convert a value to be suitable for an HTML attribute.
public `static raw2js ( $val )`	Ensure that text is properly escaped for Javascript.
public `static raw2json ( $val )`	Uses the PHP 5.2 native json_encode function if available, otherwise falls back to the Services_JSON class.
public `static raw2mailto ( $data )`	There are no real specifications on correctly encoding mailto-links, but this seems to be compatible with most of the user-agents.
public `static raw2sql ( $val )`
public `static raw2xml ( $val )`	Ensure that text is properly escaped for XML.
protected `static recursiveXMLToArray ( $xml )`	Function recursively run from Convert::xml2array()
public `static xml2array ( $val )`
public `static xml2raw ( $val )`	Convert XML to raw text.

Class Details

Library of conversion functions, implemented as static methods.

The methods are all of the form (format)2(format), where the format is one of

raw: A UTF8 string attr: A UTF8 string suitable for inclusion in an HTML attribute js: A UTF8 string suitable for inclusion in a double-quoted javascript string.

array: A PHP associative array json: JavaScript object notation

html: HTML source suitable for use in a page or email text: Plain-text content, suitable for display to a user as-is, or insertion in a plaintext email.

Objects of type ViewableData can have an "escaping type", which determines if they are automatically escaped before output by SSViewer.

[ Top ]

Class Methods

public static array2json ¶

static string array2json( array $val)

[line 152]

Convert an array into a JSON encoded string.

@return JSON encoded string
@see http://pear.php.net/pepr/pepr-proposal-show.php?id=198
@uses Director::baseFolder()
@uses Services_JSON

Parameters:

array $val - Array to convert

[ Top ]

public static html2raw ¶

static void html2raw( $data $data, [$preserveLinks $preserveLinks = false], [$wordwrap $wordWrap = 60], [ $config = null])

[line 248]

Simple conversion of HTML to plaintext.

@usedby Convert::xml2raw()

Parameters:

$data $data - string
$preserveLinks $preserveLinks - boolean
$wordwrap $wordWrap - array
$config -

[ Top ]

public static json2array ¶

static array|boolean json2array( string $val)

[line 185]

Convert a JSON string into an array.

@uses Convert::json2obj()

Parameters:

string $val - JSON string to convert

[ Top ]

public static json2obj ¶

static mixed json2obj( string $val)

[line 172]

Convert a JSON encoded string into an object.

@return JSON safe string
@see http://pear.php.net/pepr/pepr-proposal-show.php?id=198
@usedby Convert::json2array()
@uses Services_JSON
@uses Director::baseFolder()

Parameters:

string $val -

[ Top ]

public static linkIfMatch ¶

static A linkIfMatch( string $string)

[line 234]

Create a link if the string is a valid URL

@return link to the URL if string is a URL

Parameters:

string $string - The string to linkify

[ Top ]

public static raw2att ¶

static array|string raw2att( array|string $val)

[line 31]

Convert a value to be suitable for an XML attribute.

@usedby Convert::raw2htmlatt()

Parameters:

array|string $val - String to escape, or array of strings

[ Top ]

public static raw2htmlatt ¶

static array|string raw2htmlatt( array|string $val)

[line 51]

Convert a value to be suitable for an HTML attribute.

This is useful for converting human readable values into a value suitable for an ID or NAME attribute.

@see type-cdata
@uses Convert::raw2att()

Parameters:

array|string $val - String to escape, or array of strings

[ Top ]

public static raw2js ¶

static array|string raw2js( array|string $val)

[line 84]

Ensure that text is properly escaped for Javascript.

Parameters:

array|string $val - String to escape, or array of strings

[ Top ]

public static raw2json ¶

static string raw2json( mixed $val)

[line 104]

Uses the PHP 5.2 native json_encode function if available, otherwise falls back to the Services_JSON class.

@return JSON safe string
@see http://pear.php.net/pepr/pepr-proposal-show.php?id=198
@uses Director::baseFolder()
@uses Services_JSON

Parameters:

mixed $val -

[ Top ]

public static raw2mailto ¶

static string raw2mailto( $data $data)

[line 331]

There are no real specifications on correctly encoding mailto-links, but this seems to be compatible with most of the user-agents.

Does nearly the same as rawurlencode(). Please only encode the values, not the whole url, e.g. "mailto:test@test.com?subject=" . Convert::raw2mailto($subject)

@see http://www.ietf.org/rfc/rfc1738.txt

Parameters:

$data $data - string

[ Top ]

public static raw2sql ¶

static void raw2sql( $val)

[line 114]

Parameters:

$val -

[ Top ]

public static raw2xml ¶

static array|string raw2xml( array|string $val)

[line 69]

Ensure that text is properly escaped for XML.

@see dt-escape

Parameters:

array|string $val - String to escape, or array of strings

[ Top ]

protected static recursiveXMLToArray ¶

static void recursiveXMLToArray( $xml)

[line 209]

Function recursively run from Convert::xml2array()

@usedby Convert::xml2array()
@uses SimpleXMLElement

Parameters:

$xml -

[ Top ]

public static xml2array ¶

static void xml2array( $val)

[line 200]

@uses Convert::recursiveXMLToArray()

Parameters:

$val -

[ Top ]

public static xml2raw ¶

static void xml2raw( $val)

[line 128]

Convert XML to raw text.

@todo Currently &#xxx; entries are stripped; they should be converted
@uses Convert::html2raw()

Parameters:

$val -

[ Top ]

Comments

Comment policy: Please use comments for tips and corrections about the described functionality. Comments are moderated, we reserve the right to remove comments that are inappropriate or are no longer relevant.
Use the Silverstripe Forum to ask questions.

API Documentation

Packages:

Classes:

Files:

Class: Convert

Methods

Variables

Constants

Class Details

Class Methods

public static array2json ¶

Parameters:

public static html2raw ¶

Parameters:

public static json2array ¶

Parameters:

public static json2obj ¶

Parameters:

public static linkIfMatch ¶

Parameters:

public static raw2att ¶

Parameters:

public static raw2htmlatt ¶

Parameters:

public static raw2js ¶

Parameters:

public static raw2json ¶

Parameters:

public static raw2mailto ¶

Parameters:

public static raw2sql ¶

Parameters:

public static raw2xml ¶

Parameters:

protected static recursiveXMLToArray ¶

Parameters:

public static xml2array ¶

Parameters:

public static xml2raw ¶

Parameters:

Comments