Element index for package alpha--util

Package indexes

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ l ] [ m ] [ n ] [ o ] [ r ] [ s ] [ t ] [ w ] [ _ ]

[Top]

_

_doAnchors_inline_callback: in file AlphaMarkdown.inc, method AlphaMarkdown::_doAnchors_inline_callback()
Custom _doAnchors_inline_callback that renders links to external sites with a target attribute and an icon.
_doCodeBlocks_callback: in file AlphaMarkdown.inc, method AlphaMarkdown::_doCodeBlocks_callback()
Custom version of the _doCodeBlocks_callback method which invokes a Gheshi object to render code.
_doTable_callback: in file AlphaMarkdown.inc, method AlphaMarkdown::_doTable_callback()
Custom version of the _doTable_callback(...) method which sets the table border and CSS style
__construct: in file TCPDFFacade.inc, method TCPDFFacade::__construct()
The constructor
__construct: in file MarkdownFacade.inc, method MarkdownFacade::__construct()
The constructor
__construct: in file Logger.inc, method Logger::__construct()
The constructor
__construct: in file LogFile.inc, method LogFile::__construct()
The constructor
__construct: in file AlphaCronManager.inc, method AlphaCronManager::__construct()
Constructor

[Top]

a

AlphaAgentUtils: in file AlphaAgentUtils.inc, class AlphaAgentUtils
A utility class for carrying out various tasks on HTTP user agent strings
AlphaConfig: in file AlphaConfig.inc, class AlphaConfig
A singleton config class
AlphaCronManager: in file AlphaCronManager.inc, class AlphaCronManager
The main class responsible for running custom cron tasks found under the [webapp]/tasks directory. This class should be executed from Linux cron via the CLI.
AlphaErrorHandlers: in file AlphaErrorHandlers.inc, class AlphaErrorHandlers
A pair of static methods for capturing normal PHP errors and unhandled Alpha exceptions
AlphaFileUtil: in file AlphaFileUtil.inc, class AlphaFileUtil
A utility class for carrying out various file system tasks
AlphaMarkdown: in file AlphaMarkdown.inc, class AlphaMarkdown
A custom version of the markdown class which uses the geshi library for rendering code
AlphaTaskInterface: in file AlphaTaskInterface.inc, class AlphaTaskInterface
The interface for all cron tasks placed in [webapp]/tasks
AlphaTCPDF: in file AlphaTCPDF.inc, class AlphaTCPDF
Custom version of the TCPDF library class, allowing for any required overrides.
AlphaAgentUtils.inc: procedural page AlphaAgentUtils.inc
AlphaConfig.inc: procedural page AlphaConfig.inc
AlphaCronManager.inc: procedural page AlphaCronManager.inc
AlphaErrorHandlers.inc: procedural page AlphaErrorHandlers.inc
AlphaFileUtil.inc: procedural page AlphaFileUtil.inc
AlphaMarkdown.inc: procedural page AlphaMarkdown.inc
AlphaTaskInterface.inc: procedural page AlphaTaskInterface.inc
AlphaTCPDF.inc: procedural page AlphaTCPDF.inc

[Top]

c

catchError: in file AlphaErrorHandlers.inc, method AlphaErrorHandlers::catchError()
catchException: in file AlphaErrorHandlers.inc, method AlphaErrorHandlers::catchException()
checkCache: in file MarkdownFacade.inc, method MarkdownFacade::checkCache()
Used to check the HTML cache for the BO cache file

[Top]

d

debug: in file Logger.inc, method Logger::debug()
Log a DEBUG message
decode: in file InputFilter.inc, method InputFilter::decode()
The decoding method which reverses the filters
deleteDirectoryContents: in file AlphaFileUtil.inc, method AlphaFileUtil::deleteDirectoryContents()
Recursively deletes the contents of the directory indicated.
doTask: in file AlphaTaskInterface.inc, method AlphaTaskInterface::doTask()
Runs the functional code that makes up the task

[Top]

e

encode: in file InputFilter.inc, method InputFilter::encode()
The encoding method which applies the filters
error: in file Logger.inc, method Logger::error()
Log an ERROR message

[Top]

f

fatal: in file Logger.inc, method Logger::fatal()
Log a FATAL message

[Top]

g

get: in file AlphaConfig.inc, method AlphaConfig::get()
Get config value
getContent: in file MarkdownFacade.inc, method MarkdownFacade::getContent()
Getter for the content
getContent: in file TCPDFFacade.inc, method TCPDFFacade::getContent()
Fetter for the content
getInstance: in file AlphaConfig.inc, method AlphaConfig::getInstance()
Get the config object instance
getMaxRunTime: in file AlphaTaskInterface.inc, method AlphaTaskInterface::getMaxRunTime()
Gets the maximum allowed runtime for this cron (in seconds)
getMIMETypeByExtension: in file AlphaFileUtil.inc, method AlphaFileUtil::getMIMETypeByExtension()
Method that allows you to determine a MIME type for a file which you provide the extension for.
getTaskClassNames: in file AlphaCronManager.inc, method AlphaCronManager::getTaskClassNames()
Loops over the /tasks directory and builds an array of all of the task class names in the system.

[Top]

i

Image: in file AlphaTCPDF.inc, method AlphaTCPDF::Image()
Overrides the TCPDF::Image method to decrypt encrypted $file paths from the Image widget, then pass them to the normal TCPDF::Image along with all of the other (unmodified) parameters.
info: in file Logger.inc, method Logger::info()
Log an INFO message
InputFilter: in file InputFilter.inc, class InputFilter
A filter class for filtering user input from text fields
isBot: in file AlphaAgentUtils.inc, method AlphaAgentUtils::isBot()
Static method to check if the provided user agent string matches any of the known user agent strings in the $bots array on this class.
InputFilter.inc: procedural page InputFilter.inc

[Top]

l

listDirectoryContents: in file AlphaFileUtil.inc, method AlphaFileUtil::listDirectoryContents()
Renders the contents of the directory as a HTML list.
loadCache: in file MarkdownFacade.inc, method MarkdownFacade::loadCache()
Method to load the content of the cache file to the $content attribute of this object
loadClassDef: in file AlphaCronManager.inc, method AlphaCronManager::loadClassDef()
Loads the definition for the task classname provided
LogFile: in file LogFile.inc, class LogFile
Generic log file class to encapsulate common file I/O and rendering calls
Logger: in file Logger.inc, class Logger
Log class used for debug and exception logging
LogFile.inc: procedural page LogFile.inc
Logger.inc: procedural page Logger.inc

[Top]

m

markdown: in file MarkdownFacade.inc, method MarkdownFacade::markdown()
Facade method which will invoke our custom markdown class rather than the standard one
MarkdownFacade: in file MarkdownFacade.inc, class MarkdownFacade
A facade class for the Markdown library
MarkdownFacade.inc: procedural page MarkdownFacade.inc

[Top]

n

notifyAdmin: in file Logger.inc, method Logger::notifyAdmin()
Notify the sys admin via email when a serious error occurs

[Top]

o

openHTMLTagHandler: in file AlphaTCPDF.inc, method AlphaTCPDF::openHTMLTagHandler()
Process opening tags. Overridden here to fix a bug when the image type can't be determined from the URL.

[Top]

r

renderLog: in file LogFile.inc, method LogFile::renderLog()
Renders a log file as a HTML table

[Top]

s

set: in file AlphaConfig.inc, method AlphaConfig::set()
Set config value
setLogFile: in file Logger.inc, method Logger::setLogFile()
Allows you to set the log file path to one other than the main application log.
setMaxSize: in file LogFile.inc, method LogFile::setMaxSize()
Set the max log size in megabytes
setSeperator: in file LogFile.inc, method LogFile::setSeperator()
Set the value seperator

[Top]

t

TCPDFFacade: in file TCPDFFacade.inc, class TCPDFFacade
A facade class for the TCPDF library which is used to convert some HTML content provided by the Markdown library to a PDF file using FPDF
TCPDFFacade.inc: procedural page TCPDFFacade.inc

[Top]

w

warn: in file Logger.inc, method Logger::warn()
Log a WARN message
writeLine: in file LogFile.inc, method LogFile::writeLine()
Writes a line of data to the log file

Documentation generated on Thu, 17 Mar 2011 16:43:02 +0000 by phpDocumentor 1.4.3

	alpha--util

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