File Source for Abstract.php

<?php
/**
* MediaSearch
*
* LICENSE
*
* "THE BEER-WARE LICENSE" (Revision 42):
* "Sven Strittmatter" <ausserirdisch@sven-space.de> wrote this file.
* As long as you retain this notice you can do whatever you want with
* this stuff. If we meet some day, and you think this stuff is worth it,
* you can buy me a beer in return.
*
* $Author$
* $Revision$
*
* @category MediaSearch
* @package MediaSearch_Config
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
/**
* @see MediaSearch_Config_Interface
*/
require_once('MediaSearch/Config/Interface.php');
/**
* @see MediaSearch_File_Util
*/
require_once('MediaSearch/File/Util.php');
/**
* This is a default implementaion of a config file. It provides general
* purpose methods for the concrete config file objects.
*
* @abstract
* @category MediaSearch
* @package MediaSearch_Config
* @copyright Copyright (c) 2009 Sven Strittmatter
*/
abstract class MediaSearch_Config_Abstract implements MediaSearch_Config_Interface {
const TRACE_LELVEL = 9;
/**
* The full filepath to the config file which will be loaded and parsed.
*
* @access private
* @var string
*/
private $fileName;
/**
* The original loaded string from the config file.
*
* @access protected
* @var string
*/
protected $rawData;
/**
* Contains the parsed config data after parsing.
*
* @access protected
* @var array
*/
protected $parsedData;
/**
* Contains optiona parse option objects of type MediaSearch_Config_ParseOptions_Interface.
*
* @access private
* @var array
*/
private $parseOptions;
/**
* The constructor requires the full filename to the config file.
* Optional you can add an array with some parse option objects
* (@see MediaSearch_Config_ParseOptions_Interface).
*
* The constructor will call load() to initiaize the config.
*
* @access public
* @param string $fileName
* @param array $parseOptions Optional, default is null.
*/
public function __construct($fileName, array $parseOptions = null) {
$this->setFileName($fileName);
$this->removeParseOptions();
$this->addParseOptions($parseOptions);
$this->parseData();
}
/**
* @see MediaSearch_Config_Interface
*/
public function addParseOption(MediaSearch_Config_ParseOptions_Interface $option) {
$this->parseOptions[] = $option;
}
/**
* Adds multiple parse options in an array.
*
* @access public
* @param array $options Array of MediaSearch_Config_ParseOptions_Interface
*/
public function addParseOptions(array $options) {
if (count($options) === 0) {
return;
}
foreach ($options as $option) {
$this->addParseOption($option);
}
}
/**
* @see MediaSearch_Config_Interface
*/
public function removeParseOptions() {
$this->parseOptions = array();
}
/**
* @see MediaSearch_Config_Interface
*/
public function hasParseOptions() {
return count($this->parseOptions) > 0;
}
/**
* @see MediaSearch_Config_Interface
*/
public function setFileName($fileName) {
$this->fileName = $fileName;
}
/**
* @see MediaSearch_Config_Interface
*/
public function getFileName() {
$this->fileName;
}
/**
* @see MediaSearch_Config_Interface
*
* Implements lazy loading and loads the
* raw data on first use.
*
* @access public
*/
public function getRawData() {
if (null === $this->rawData) {
$this->loadRawData();
}
return $this->rawData;
}
/**
* Loads the data by file_get_contents() from file.
*
* @access protected
*/
protected function loadRawData() {
$this->rawData = file_get_contents($this->fileName);
}
/**
* @see MediaSearch_Config_Interface
*
* Returns nulll if the given $name is not found in the config.
*
* @access public
* @param string $name Optional, returns the whole parsed data if not set.
* @return mixed
*/
public function get($name = null) {
if (null === $name) {
return $this->parsedData;
}
if (isset($this->parsedData[$name])) {
return $this->parsedData[$name];
}
return null;
}
/**
* 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()).
*
* @static
* @access public
* @throws InvalidArgumentException If unsoported file type is fiven.
* @param string $fileName The full file path to the config file.
* @param array $parseOptions Array of optional parse option obejcts.
* @return MediaSearch_Config_Abstract
*/
public static function createConfig($fileName, array $parseOptions = null) {
switch(MediaSearch_File_Util::getExtension($fileName)) {
case self::TYPE_TEXT:
return new MediaSearch_Config_Text($fileName, $parseOptions);
case self::TYPE_JSON:
$rawData = file_get_contents($fileName, $parseOptions);
return new MediaSearch_Config_Json($fileName, $parseOptions);
case self::TYPE_PHP:
return new MediaSearch_Config_Php($fileName, $parseOptions);
case self::TYPE_SQL:
return new MediaSearch_Config_Sql($fileName, $parseOptions);
default:
$message = "Cant discover config file type for $fileName";
throw new InvalidArgumentException($message);
}
}
/**
* The default parse behaviour is copying the loaded file string with no
* modification to parsed data.
*
* This behaviour could be modified by overwriting in the concrete
* implementations.
*
* Attend that after that applayParseOptions() is called.
*
* @access public
*/
public function parseData() {
$this->parsedData = $this->getRawData();
$this->applayParseOptions();
}
/**
* Apply the added parse options to the data parsed by parseData().
*
* @access protected
*/
protected function applayParseOptions() {
if (!$this->hasParseOptions()) {
return;
}
foreach ($this->parseOptions as $option) {
$this->parsedData = $option->process($this->parsedData);
}
}
}

Source for file Abstract.php