<?php
/*
 *  $Id: Parser.php 1080 2007-02-10 18:17:08Z jwage $
 *
 * 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
 * OWNER 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.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information, see
 * <http://www.doctrine-project.org>.
 */

/**
 * Doctrine_Parser
 *
 * @package     Doctrine
 * @subpackage  Parser
 * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
 * @link        www.doctrine-project.org
 * @since       1.0
 * @version     $Revision: 1080 $
 * @author      Jonathan H. Wage <jwage@mac.com>
 */
abstract class Doctrine_Parser
{
    /**
     * loadData
     *
     * Override in the parser driver
     *
     * @param string $array 
     * @return void
     * @author Jonathan H. Wage
     */
    abstract public function loadData($array);

    /**
     * dumpData
     *
     * Override in the parser driver
     *
     * @param string $array 
     * @param string $path 
     * @param string $charset The charset of the data being dumped
     * @return void
     * @author Jonathan H. Wage
     */
    abstract public function dumpData($array, $path = null, $charset = null);

    /**
     * getParser
     *
     * Get instance of the specified parser
     *
     * @param string $type 
     * @return void
     * @author Jonathan H. Wage
     */
    static public function getParser($type)
    {
        $class = 'Doctrine_Parser_'.ucfirst($type);

        return new $class;
    }

    /**
     * load
     *
     * Interface for loading and parsing data from a file
     *
     * @param string $path 
     * @param string $type 
     * @return void
     * @author Jonathan H. Wage
     */
    static public function load($path, $type = 'xml')
    {
        $parser = self::getParser($type);

        return (array) $parser->loadData($path);
    }

    /**
     * dump
     *
     * Interface for pulling and dumping data to a file
     *
     * @param string $array 
     * @param string $path 
     * @param string $type 
     * @param string $charset The charset of the data being dumped
     * @return void
     * @author Jonathan H. Wage
     */
    static public function dump($array, $type = 'xml', $path = null, $charset = null)
    {
        $parser = self::getParser($type);

        return $parser->dumpData($array, $path, $charset);
    }

    /**
     * doLoad
     *
     * Get contents whether it is the path to a file file or a string of txt.
     * Either should allow php code in it.
     *
     * @param string $path 
     * @return void
     */
    public function doLoad($path)
    {
        ob_start();
        if ( ! file_exists($path)) {
            $contents = $path;
            $path = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'dparser_' . microtime();

            file_put_contents($path, $contents);
        }

        include($path);
        
        // Fix #1569. Need to check if it's still all valid
        $contents = ob_get_clean(); //iconv("UTF-8", "UTF-8", ob_get_clean());

        return $contents;
    }

    /**
     * doDump
     *
     * @param string $data 
     * @param string $path 
     * @return void
     */
    public function doDump($data, $path = null)
    {
      if ($path !== null) {
            return file_put_contents($path, $data);
        } else {
            return $data;
        }
    }
}
