Home | Classes | Modules | Annotated | Functions | Files

Lob.php

Go to the documentation of this file.

<?php
/*
 *  $Id: Lob.php,v 1.2 2004/03/29 18:46:46 micha 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>.
 */

//
// STATUS:
// - ported:   y
// - compiled: y
// - tested:   n
//

class Lob {

  var /*protected*/  $data;

  var /*protected*/  $outFile;

  var /*protected*/  $inFile;

    var /*private*/ $modified = null;

//    public function __construct($data = null)
    function Lob($data = null)
    {
        if ($data !== null) {
            $this->setContents($data);
        }
    }

  function getContents()
  {
    if ($this->data === null && $this->isFromFile()) {
        $this->readFromFile();
    }
    return $this->data;
  }

  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;
        }
  }

  function dump()
  {
    trigger_error("Lob::dump(): abstract function has to be reimplemented !", E_USER_ERROR);
  }

  function setInputFile($filePath)
  {
    $this->inFile = $filePath;
  }

  function & getInputFile()
  {
    return $this->inFile;
  }

  function setOutputFile($filePath)
  {
    $this->outFile = $filePath;
  }

  function & getOutputFile()
  {
    return $this->outFile;
  }

  function isFromFile()
  {
    return ($this->inFile !== null);
  }

  function & readFromFile($file = null)
  {
        if ($file !== null) {
            $this->setInputFile($file);
        }
    if (!$this->inFile) {
      return new Exception(CREOLE_ERROR, 'No file specified for read.');
    }
    $data = @file_get_contents($this->inFile);
    if ($data === false) {
      return new Exception(CREOLE_ERROR, 'Unable to read from file: '.$this->inFile);
    }
    $this->setContents($data);
  }


  function writeToFile($file = null)
  {
    if ($file !== null) {
      $this->setOutputFile($file);
    }
    if (!$this->outFile) {
      return new Exception(CREOLE_ERROR, 'No file specified for write');
    }
    if ($this->data === null) {
      return new Exception(CREOLE_ERROR, 'No data to write to file');
    }
    if (false === @file_put_contents($this->outFile, $this->data)) {
      return new Exception(CREOLE_ERROR, 'Unable to write to file: '.$this->outFile);
    }
  }

    function & __toString()
    {
        return $this->getContents();
    }

    function setModified($b)
    {
        $this->modified = $b;
    }

    function isModified()
    {
        // cast it so that NULL will also eval to false
        return (boolean) $this->modified;
    }
}

---

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