Home | Classes | Modules | Annotated | Hierarchy | Functions | Files

Lob.php

Go to the documentation of this file.

<?php
/*
 *  $Id: Lob.php,v 1.10 2004/03/20 04:16:50 hlellelid Exp $
 *
 * 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 please see
 * <http://creole.phpdb.org>.
 */

abstract class Lob {

    protected $data;
    
    protected $outFile;
    
    protected $inFile;
    
    private $modified = null;
    
    public function __construct($data = null)
    {
        if ($data !== null) {
            $this->setContents($data);
        }
    }
    
    public function getContents()
    {
        if ($this->data === null && $this->isFromFile()) {
            $this->readFromFile();
        }
        return $this->data;
    }
    
    public function setContents($data)
    {
        $this->data = $data;
               
        if ($this->modified === null) {
             // if modified bit hasn't been set yet,
            // then it should now be set to FALSE, since
            // we just did inital population
            $this->modified = false;
        } elseif ($this->modified === false) {
            // if it was already FALSE, then it should
            // now be set to TRUE, since this is a subsequent
            // modfiication.
            $this->modified = true;
        }
    }
        
    abstract public function dump();
    
    public function setInputFile($filePath)
    {
        $this->inFile = $filePath;
    }    

    public function getInputFile()
    {
        return $this->inFile;
    }    
    
    public function setOutputFile($filePath)
    {
        $this->outFile = $filePath;        
    }
    
    public function getOutputFile()
    {
        return $this->outFile;
    }

    public function isFromFile()
    {
        return ($this->inFile !== null);
    }
    
    public function readFromFile($file = null)
    {
        if ($file !== null) {
            $this->setInputFile($file);
        }
        if (!$this->inFile) {
            throw Exception('No file specified for read.');
        }        
        $data = @file_get_contents($this->inFile);
        if ($data === false) {
            throw new Exception('Unable to read from file: '.$this->inFile);
        }        
        $this->setContents($data);                
    }
    
    
    public function writeToFile($file = null)
    {
        if ($file !== null) {
            $this->setOutputFile($file);
        }        
        if (!$this->outFile) {
            throw new Exception('No file specified for write');
        }
        if ($this->data === null) {
            throw new Exception('No data to write to file');
        }        
        if (false === @file_put_contents($this->outFile, $this->data)) {
            throw new Exception('Unable to write to file: '.$this->outFile);
        }
    }
    
    public function __toString()
    {
        return $this->getContents();
    }
    
    public function setModified($b)
    {
        $this->modified = $b;
    }
    
    public function isModified()
    {
        // cast it so that NULL will also eval to false
        return (boolean) $this->modified;
    }
}

---

This file is part of the Creole[php5] library.