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

Element index for package alpha--util

Package indexes

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

_

_

_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 MarkdownFacade.inc, method MarkdownFacade::__construct()
    The constructor
__construct
in file TCPDFFacade.inc, method TCPDFFacade::__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
__construct
in file AlphaKPI.inc, method AlphaKPI::__construct()
    Constructor
a

a

AlphaAgentUtils
in file AlphaAgentUtils.inc, class AlphaAgentUtils
    A utility class for carrying out various tasks on HTTP user agent strings
AlphaBackUpUtils
in file AlphaBackupUtils.inc, class AlphaBackUpUtils
    A utility class for carrying out various backup tasks
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
AlphaFileUtils
in file AlphaFileUtils.inc, class AlphaFileUtils
    A utility class for carrying out various file system tasks
AlphaImageUtils
in file AlphaImageUtils.inc, class AlphaImageUtils
    A utility class for carrying out various image file tasks
AlphaKPI
in file AlphaKPI.inc, class AlphaKPI
    A Key Performance Indicator (KPI) logging class
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
AlphaBackupUtils.inc
procedural page AlphaBackupUtils.inc
AlphaConfig.inc
procedural page AlphaConfig.inc
AlphaCronManager.inc
procedural page AlphaCronManager.inc
AlphaErrorHandlers.inc
procedural page AlphaErrorHandlers.inc
AlphaFileUtils.inc
procedural page AlphaFileUtils.inc
AlphaImageUtils.inc
procedural page AlphaImageUtils.inc
AlphaKPI.inc
procedural page AlphaKPI.inc
AlphaMarkdown.inc
procedural page AlphaMarkdown.inc
AlphaTaskInterface.inc
procedural page AlphaTaskInterface.inc
AlphaTCPDF.inc
procedural page AlphaTCPDF.inc
b

b

backUpAttachmentsAndLogs
in file AlphaBackupUtils.inc, method AlphaBackUpUtils::backUpAttachmentsAndLogs()
    Backs up the attachments and logs directories to the destination backup directory
backUpDatabase
in file AlphaBackupUtils.inc, method AlphaBackUpUtils::backUpDatabase()
    Uses the mysqldump command line program to back-up the system database into an .sql file in the supplied target directory
c

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
copy
in file AlphaFileUtils.inc, method AlphaFileUtils::copy()
    Recursively copies the indicated folder, or single file, to the desintation location
d

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 AlphaFileUtils.inc, method AlphaFileUtils::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
e

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
f

f

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

g

generateSquareThumbnail
in file AlphaImageUtils.inc, method AlphaImageUtils::generateSquareThumbnail()
    Generates a perfectly square thumbnail from the supplied original image file
get
in file AlphaConfig.inc, method AlphaConfig::get()
    Get config value
getContent
in file TCPDFFacade.inc, method TCPDFFacade::getContent()
    Fetter for the content
getContent
in file MarkdownFacade.inc, method MarkdownFacade::getContent()
    Getter 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 AlphaFileUtils.inc, method AlphaFileUtils::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.
i

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
l

l

listDirectoryContents
in file AlphaFileUtils.inc, method AlphaFileUtils::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
log
in file AlphaKPI.inc, method AlphaKPI::log()
    Writes the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does not exist.
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
logStep
in file AlphaKPI.inc, method AlphaKPI::logStep()
    Writes a step in the KPI event to a log file named logs/kpi-'.$this->name->getValue().'.csv, which will be created if it does not exist.
LogFile.inc
procedural page LogFile.inc
Logger.inc
procedural page Logger.inc
m

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
n

n

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

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.
r

r

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

s

saveImage
in file AlphaImageUtils.inc, method AlphaImageUtils::saveImage()
    Saves the GD image resource to the file path indicated
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
sql
in file Logger.inc, method Logger::sql()
    Log a SQL queries
storeStartTimeInSession
in file AlphaKPI.inc, method AlphaKPI::storeStartTimeInSession()
    Stores the current startTime for the KPI in the session, useful for multi-request KPI tracking.
t

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
w

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
z

z

zip
in file AlphaFileUtils.inc, method AlphaFileUtils::zip()
    Recursively compresses the contens of the source directory indicated to the desintation zip archive

Documentation generated on Tue, 13 Dec 2011 20:25:26 +0000 by phpDocumentor 1.4.3