codysnider / tt-rss

lib/gettext/streams.php

<?php
/*
   Copyright (c) 2003, 2005, 2006, 2009 Danilo Segan <danilo@kvota.net>.

   This file is part of PHP-gettext.

   PHP-gettext is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   PHP-gettext is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with PHP-gettext; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/


    // Simple class to wrap file streams, string streams, etc.
    // seek is essential, and it should be byte stream
class StreamReader {
    // should return a string [FIXME: perhaps return array of bytes?]
    function read($bytes) {

It is generally recommended to explicitly declare the visibility for methods.

The parameter $bytes is not used and could be removed.

    return false;
    }

    // should return new position
    function seekto($position) {

It is generally recommended to explicitly declare the visibility for methods.

The parameter $position is not used and could be removed.

    return false;
    }

    // returns current position
    function currentpos() {

It is generally recommended to explicitly declare the visibility for methods.

    return false;
    }

    // returns length of entire stream (limit for seekto()s)
    function length() {

It is generally recommended to explicitly declare the visibility for methods.

    return false;
    }
};

class StringReader {
    var $_pos;
    var $_str;

    function StringReader($str = '') {

It is generally recommended to explicitly declare the visibility for methods.

    $this->_str = $str;
    $this->_pos = 0;
    }

    function read($bytes) {

It is generally recommended to explicitly declare the visibility for methods.

    $data = substr($this->_str, $this->_pos, $bytes);
    $this->_pos += $bytes;
    if (strlen($this->_str) < $this->_pos) {
            $this->_pos = strlen($this->_str);
    }

    return $data;
    }

    function seekto($pos) {

It is generally recommended to explicitly declare the visibility for methods.

    $this->_pos = $pos;
    if (strlen($this->_str) < $this->_pos) {
            $this->_pos = strlen($this->_str);
    }
    return $this->_pos;
    }

    function currentpos() {

It is generally recommended to explicitly declare the visibility for methods.

    return $this->_pos;
    }

    function length() {

It is generally recommended to explicitly declare the visibility for methods.

    return strlen($this->_str);
    }

};


class FileReader {
    var $_pos;
    var $_fd;
    var $_length;

    function FileReader($filename) {

It is generally recommended to explicitly declare the visibility for methods.

    if (file_exists($filename)) {

        $this->_length = filesize($filename);
        $this->_pos = 0;
        $this->_fd = fopen($filename, 'rb');
        if (!$this->_fd) {
        $this->error = 3; // Cannot read file, probably permissions

The property error does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return false;
        }
    } else {
        $this->error = 2; // File doesn't exist
        return false;
    }
    }

    function read($bytes) {

It is generally recommended to explicitly declare the visibility for methods.

    if ($bytes) {
        fseek($this->_fd, $this->_pos);

        // PHP 5.1.1 does not read more than 8192 bytes in one fread()
        // the discussions at PHP Bugs suggest it's the intended behaviour
        $data = '';
        while ($bytes > 0) {
        $chunk  = fread($this->_fd, $bytes);
        $data  .= $chunk;
        $bytes -= strlen($chunk);
        }
        $this->_pos = ftell($this->_fd);

        return $data;
    } else {
        return '';
    }
    }

    function seekto($pos) {

It is generally recommended to explicitly declare the visibility for methods.

    fseek($this->_fd, $pos);
    $this->_pos = ftell($this->_fd);
    return $this->_pos;
    }

    function currentpos() {

It is generally recommended to explicitly declare the visibility for methods.

    return $this->_pos;
    }

    function length() {

It is generally recommended to explicitly declare the visibility for methods.

    return $this->_length;
    }

    function close() {

It is generally recommended to explicitly declare the visibility for methods.

    fclose($this->_fd);
    }

};

// Preloads entire file in memory first, then creates a StringReader
// over it (it assumes knowledge of StringReader internals)
class CachedFileReader extends StringReader {
    function CachedFileReader($filename) {

It is generally recommended to explicitly declare the visibility for methods.

    if (file_exists($filename)) {

        $length = filesize($filename);
        $fd = fopen($filename, 'rb');

        if (!$fd) {

$fd is of type false|resource, thus it always evaluated to false.

        $this->error = 3; // Cannot read file, probably permissions

The property error does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return false;
        }
        $this->_str = fread($fd, $length);
        fclose($fd);

    } else {
        $this->error = 2; // File doesn't exist
        return false;
    }
    }
};


?>

It is not recommended to use PHP's closing tag ?> in files other than templates.