Output escaping object decorator that intercepts all method calls and
escapes their return values.
Method Summary
-
int
count()
Returns the size of the object if it implements Countable (is required by
the Countable interface).
-
mixed
getRaw($key)
Returns the result of calling the get() method on the object, bypassing
any escaping, if that method exists.
-
mixed
__call($method, $args)
Magic PHP method that intercepts method calls, calls them on the objects
that is being escaped and escapes the result.
-
string
__toString()
Try to call decorated object __toString() method if exists.
get , getRaw
escape , getRawValue , isClassMarkedAsSafe , markClassAsSafe , markClassesAsSafe , unescape , __construct , __get
Method Details
-
Returns the size of the object if it implements Countable (is required by
the Countable interface).
It returns 1 if other cases (which is the default PHP behavior in such a case).
returns The size of the object
-
| $key |
The parameter to be passed to the get() get method
|
Returns the result of calling the get() method on the object, bypassing
any escaping, if that method exists.
If there is not a callable get() method this will throw an exception.
returns The unescaped value returned
throws sfException if the object does not have a callable get() method
-
(mixed) __call ($method, $args)
Browse code
| $method |
The method on the object to be called
|
| $args |
An array of arguments to be passed to the method
|
Magic PHP method that intercepts method calls, calls them on the objects
that is being escaped and escapes the result.
The calling of the method is changed slightly to accommodate passing a specific escaping strategy. An additional parameter is appended to the argument list which is the escaping strategy. The decorator will remove and use this parameter as the escaping strategy if it begins with 'esc_' (the prefix all escaping helper functions have). For example if an object, $o, implements methods a() and b($arg): $o->a() // Escapes the return value of a() $o->a(ESC_RAW) // Uses the escaping method ESC_RAW with a() $o->b('a') // Escapes the return value of b('a') $o->b('a', ESC_RAW); // Uses the escaping method ESC_RAW with b('a')
returns The escaped value returned by the method
-
(string) __toString ()
Browse code
Try to call decorated object __toString() method if exists.
|
