# Class MarkdownFacade

A facade class for the Markdown library

Package: alpha::util
Copyright: Copyright (c) 2013, John Collins (founder of Alpha Framework). All rights reserved.

    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.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: MarkdownFacade.inc 1659 2013-07-06 12:31:08Z alphadevx $
Since: 1.0
Located at util/MarkdownFacade.inc

Methods summary
`public` | # `__construct( `AlphaDAO` $BO, boolean $useCache = true )` The constructor The constructor #### Parameters $BO ``AlphaDAO`` $BO $useCache `boolean` $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` #### Since 1.0
`public string` | # `getContent( )` Getter for the content Getter for the content #### Returns `string` #### Since 1.0
`private` | # `cache( )` Saves the HTML generated by Markdown to the cache directory Saves the HTML generated by Markdown to the cache directory #### 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` #### 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 #### Since 1.0

Properties summary
`private string` | $content | `` | # The markdown-format content that we will render The markdown-format content that we will render #### Since 1.0
`private `AlphaDAO`` | $BO | `null` | # The business object that stores the content will be rendered to Markdown The business object that stores the content will be rendered to Markdown #### Since 1.0
`private string` | $filename | `` | # The auto-generated name of the Markdown HTML cache file for the BO The auto-generated name of the Markdown HTML cache file for the BO #### Since 1.0