Class Flay
Text-to-HTML parser.
Text-to-html parser, similar to Textile or RedCloth, only with a little different syntax.
- Object
-
Flay
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: flay.php
Properties summary
-
$allow_htmlpublicbooleanSet this to allow HTML in the markup. -
$textpublicstringText to be parsed.
Inherited Properties
Method Summary
-
__construct() public
Constructor. -
colorMark() public
Returns string with EM elements with color classes added. -
extractWords() public
Return the words of the string as an array. -
fragment() public
Return a fragment of a text, up to $length characters long, with an ellipsis after it. -
markedSnippets() public
Return given string with words in array colorMarked, up to a number of times (defaults to 5). -
toClean() public
Returns given text with tags stripped out. -
toHtml() public
Returns given text translated to HTML using the Flay syntax. -
toParsedAndClean() public
Return parsed text with tags stripped out.
Method Detail
__construct() public ¶
__construct( string $text = null )
Constructor.
Parameters
- string $text optional null
- Text to transform
Overrides
colorMark() public ¶
colorMark( array $words , string $string )
Returns string with EM elements with color classes added.
Parameters
- array $words
- Array of words to be colorized
- string $string
- Text in which the words might be found
Returns
String with words colorized
extractWords() public ¶
extractWords( string $string )
Return the words of the string as an array.
Parameters
- string $string
Returns
Array of words
fragment() public ¶
fragment( string $text , integer $length , string $ellipsis = '...' )
Return a fragment of a text, up to $length characters long, with an ellipsis after it.
Parameters
- string $text
- Text to be truncated.
- integer $length
- Max length of text.
- string $ellipsis optional '...'
- Sign to print after truncated text.
Returns
Fragment
markedSnippets() public ¶
markedSnippets( array $words , string $string , integer $max_snippets = 5 )
Return given string with words in array colorMarked, up to a number of times (defaults to 5).
Parameters
- array $words
- Words to look for and markup
- string $string
- String to look in
- integer $max_snippets optional 5
- Max number of snippets to extract
Returns
String with words marked
See
toClean() public ¶
toClean( string $text )
Returns given text with tags stripped out.
Parameters
- string $text
- Text to clean
Returns
Cleaned text
toHtml() public ¶
toHtml( string $text = null , boolean $bare = false , boolean $allowHtml = false )
Returns given text translated to HTML using the Flay syntax.
Parameters
- string $text optional null
- String to format
- boolean $bare optional false
Set this to only do
<
p> transforms and > to >, no typography additions.
- boolean $allowHtml optional false
- Set this to trim whitespace and disable all HTML
Returns
Formatted text
toParsedAndClean() public ¶
toParsedAndClean( string $text )
Return parsed text with tags stripped out.
Parameters
- string $text
- Text to parse and clean
Returns
Cleaned text
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
dispatchMethod() public ¶
dispatchMethod( string $method , array $params = array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
API for logging events.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class