MediaSearch_Config
[ class tree: MediaSearch_Config ] [ index: MediaSearch_Config ] [ all elements ]

Element index for package MediaSearch_Config

[ a ] [ c ] [ d ] [ e ] [ g ] [ h ] [ i ] [ j ] [ l ] [ m ] [ p ] [ r ] [ s ] [ t ] [ _ ]

_

__construct
in file Abstract.php, method MediaSearch_Config_Abstract::__construct()
    The constructor requires the full filename to the config file.
top

a

addParseOption
in file Abstract.php, method MediaSearch_Config_Abstract::addParseOption()
addParseOption
in file Interface.php, method MediaSearch_Config_Interface::addParseOption()
    With this method you can add some parse options. These are objects
addParseOptions
in file Abstract.php, method MediaSearch_Config_Abstract::addParseOptions()
    Adds multiple parse options in an array.
applayParseOptions
in file Abstract.php, method MediaSearch_Config_Abstract::applayParseOptions()
    Apply the added parse options to the data parsed by parseData().
Abstract.php
procedural page Abstract.php
top

c

createConfig
in file Abstract.php, method MediaSearch_Config_Abstract::createConfig()
    Factory method which creates a proper config file implementation depending on its type. The type is determined by the filename extension (@see MediaSearch_File_Util::getExtension()).
top

d

$databaseName
in file Sql.php, variable MediaSearch_Config_Sql::$databaseName
    The database name the PDO should work on.
top

e

execute
in file Sql.php, method MediaSearch_Config_Sql::execute()
    MediaSearch_Interface_Command implementation.
top

g

get
in file Interface.php, method MediaSearch_Config_Interface::get()
    Returns a config value from the loaded and parsed configuration by its index. The index could be a string or integer. Thats depending on the implemention of the config file types and your parse options.
get
in file Abstract.php, method MediaSearch_Config_Abstract::get()
getFileName
in file Interface.php, method MediaSearch_Config_Interface::getFileName()
    Returns the file name of the config file.
getFileName
in file Abstract.php, method MediaSearch_Config_Abstract::getFileName()
getRawData
in file Interface.php, method MediaSearch_Config_Interface::getRawData()
    Returns the string from the loaded config file.
getRawData
in file Abstract.php, method MediaSearch_Config_Abstract::getRawData()
top

h

hasParseOptions
in file Interface.php, method MediaSearch_Config_Interface::hasParseOptions()
    Returns if the config file has parse options added.
hasParseOptions
in file Abstract.php, method MediaSearch_Config_Abstract::hasParseOptions()
top

i

Interface.php
procedural page Interface.php
top

j

Json.php
procedural page Json.php
top

l

loadRawData
in file Php.php, method MediaSearch_Config_Php::loadRawData()
loadRawData
in file Abstract.php, method MediaSearch_Config_Abstract::loadRawData()
    Loads the data by file_get_contents() from file.
top

m

MediaSearch_Config_Abstract
in file Abstract.php, class MediaSearch_Config_Abstract
    This is a default implementaion of a config file. It provides general purpose methods for the concrete config file objects.
MediaSearch_Config_Interface
in file Interface.php, class MediaSearch_Config_Interface
MediaSearch_Config_Json
in file Json.php, class MediaSearch_Config_Json
    A concrete implemetation for JSON config files. The file can contain any JSON string. The filename extensions need to be .json.
MediaSearch_Config_Php
in file Php.php, class MediaSearch_Config_Php
    A concrete implemetation for PHP config files. The file need to contain a return statement of any PHP variable. The filename extensions need to be .php.
MediaSearch_Config_Sql
in file Sql.php, class MediaSearch_Config_Sql
    A concrete implemetation for SQL config files. The file can contain any SQL statement. The filename extensions need to be .sql.
MediaSearch_Config_Text
in file Text.php, class MediaSearch_Config_Text
    A concrete implemetation for text config files. The file can contain any text string. The filename extensions need to be .txt.
top

p

$parsedData
in file Abstract.php, variable MediaSearch_Config_Abstract::$parsedData
    Contains the parsed config data after parsing.
$pdoConnection
in file Sql.php, variable MediaSearch_Config_Sql::$pdoConnection
    Optional PDO connection obejct. NEccessary for executing the config object on a database.
Php.php
procedural page Php.php
parseData
in file Interface.php, method MediaSearch_Config_Interface::parseData()
    Parses the config string. Depending on the config type.
parseData
in file Abstract.php, method MediaSearch_Config_Abstract::parseData()
    The default parse behaviour is copying the loaded file string with no modification to parsed data.
parseData
in file Json.php, method MediaSearch_Config_Json::parseData()
    Parses the data by json_decode() to an array.
top

r

$rawData
in file Abstract.php, variable MediaSearch_Config_Abstract::$rawData
    The original loaded string from the config file.
removeParseOptions
in file Abstract.php, method MediaSearch_Config_Abstract::removeParseOptions()
removeParseOptions
in file Interface.php, method MediaSearch_Config_Interface::removeParseOptions()
    Removes all parse options.
top

s

Sql.php
procedural page Sql.php
setFileName
in file Interface.php, method MediaSearch_Config_Interface::setFileName()
    Expects the full filepath to the config file you want to load.
setFileName
in file Abstract.php, method MediaSearch_Config_Abstract::setFileName()
setPdo
in file Sql.php, method MediaSearch_Config_Sql::setPdo()
    Sets PDO object and a database name. Thats neccessary if you want to execute the loaded SQL config on a databse.
top

t

Text.php
procedural page Text.php
TRACE_LELVEL
in file Php.php, class constant MediaSearch_Config_Php::TRACE_LELVEL
TRACE_LELVEL
in file Sql.php, class constant MediaSearch_Config_Sql::TRACE_LELVEL
TRACE_LELVEL
in file Json.php, class constant MediaSearch_Config_Json::TRACE_LELVEL
TRACE_LELVEL
in file Abstract.php, class constant MediaSearch_Config_Abstract::TRACE_LELVEL
TRACE_LELVEL
in file Text.php, class constant MediaSearch_Config_Text::TRACE_LELVEL
TYPE_JSON
in file Interface.php, class constant MediaSearch_Config_Interface::TYPE_JSON
    Specifies the file extions for json configurations.
TYPE_PHP
in file Interface.php, class constant MediaSearch_Config_Interface::TYPE_PHP
    Specifies the file extions for php configurations.
TYPE_SQL
in file Interface.php, class constant MediaSearch_Config_Interface::TYPE_SQL
    Specifies the file extions for sql configurations.
TYPE_TEXT
in file Interface.php, class constant MediaSearch_Config_Interface::TYPE_TEXT
    Specifies the file extions for text configurations.
top

Documentation generated on Mon, 17 Aug 2009 14:50:57 +0200 by phpDocumentor 1.4.2