Class MarkdownFacade

A facade class for the Markdown library.

Namespace: Alpha\Util\Extension
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Alpha Framework nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </pre>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at Util/Extension/MarkdownFacade.php

Methods summary
`public`	# `__construct( Alpha\Model\ActiveRecord $BO, boolean $useCache = true )` The constructor. The constructor. Parameters `$BO` Alpha\Model\ActiveRecord $BO `$useCache` bool $useCache Since 1.0
`public string`	# `markdown( mixed $text )` Facade method which will invoke our custom markdown class rather than the standard one. Facade method which will invoke our custom markdown class rather than the standard one. Returns `string` string Since 1.0
`public string`	# `getContent( )` Getter for the content. Getter for the content. Returns `string` string Since 1.0
`public boolean`	# `checkCache( )` Used to check the HTML cache for the BO cache file. Used to check the HTML cache for the BO cache file. Returns `boolean` bool Since 1.0
`public`	# `loadCache( )` Method to load the content of the cache file to the $content attribute of this object. Method to load the content of the cache file to the $content attribute of this object. Throws `Alpha\Exception\AlphaException` Alpha\Exception\AlphaException Since 1.0

Namespaces

Classes

Class MarkdownFacade

Parameters

Since

Returns

Since

Returns

Since

Returns

Since

Throws

Since