Alpha Framework alpha--util
[ class tree: alpha--util ] [ index: alpha--util ] [ all elements ]

Class: MarkdownFacade

Source Location: /util/MarkdownFacade.inc

Class MarkdownFacade

Class Overview

A facade class for the Markdown library

Located in /util/MarkdownFacade.inc [line 51]



		
				Author(s):
		
  • John Collins <dev@alphaframework.org>
Information Tags:
Version:  $Id: MarkdownFacade.inc 1454 2011-12-04 15:14:05Z johnc $
Copyright:  

Copyright (c) 2011, 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.

Since:  1.0
License:  The BSD License

Methods

[ Top ]
Method Summary
MarkdownFacade   __construct()   The constructor
boolean   checkCache()   Used to check the HTML cache for the BO cache file
string   getContent()   Getter for the content
void   loadCache()   Method to load the content of the cache file to the $content attribute of this object
string   markdown()   Facade method which will invoke our custom markdown class rather than the standard one

[ Top ]
Methods
Constructor __construct  [line 83]

  MarkdownFacade __construct( AlphaDAO $BO, [boolean $useCache = true]  )

The constructor

Parameters:
AlphaDAO   $BO: 
boolean   $useCache: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
checkCache  [line 220]

  boolean checkCache( )

Used to check the HTML cache for the BO cache file


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
getContent  [line 190]

  string getContent( )

Getter for the content


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
loadCache  [line 229]

  void loadCache( )

Method to load the content of the cache file to the $content attribute of this object


API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
markdown  [line 164]

  string markdown( $text  )

Facade method which will invoke our custom markdown class rather than the standard one

Parameters:
   $text: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]

Documentation generated on Tue, 13 Dec 2011 20:27:15 +0000 by phpDocumentor 1.4.3