Improved documentation and fixed code violations in stream.php
Signed-off-by: Chanaka Indrajith <pe.chanaka.ck@gmail.com>
This commit is contained in:
Chanaka Indrajith
parent
ab42fd2ac9
commit
7c971c0409
@ -1,5 +1,5 @@
|
||||
<?php
|
||||
/*
|
||||
/**
|
||||
Copyright (c) 2003, 2005, 2006, 2009 Danilo Segan <danilo@kvota.net>.
|
||||
|
||||
This file is part of PHP-gettext.
|
||||
@ -21,146 +21,291 @@
|
||||
*/
|
||||
|
||||
|
||||
// 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) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// should return new position
|
||||
function seekto($position) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// returns current position
|
||||
function currentpos() {
|
||||
return false;
|
||||
}
|
||||
|
||||
// returns length of entire stream (limit for seekto()s)
|
||||
function length() {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
|
||||
class StringReader {
|
||||
var $_pos;
|
||||
var $_str;
|
||||
|
||||
function StringReader($str='') {
|
||||
$this->_str = $str;
|
||||
$this->_pos = 0;
|
||||
}
|
||||
|
||||
function read($bytes) {
|
||||
$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) {
|
||||
$this->_pos = $pos;
|
||||
if (strlen($this->_str)<$this->_pos)
|
||||
$this->_pos = strlen($this->_str);
|
||||
return $this->_pos;
|
||||
}
|
||||
|
||||
function currentpos() {
|
||||
return $this->_pos;
|
||||
}
|
||||
|
||||
function length() {
|
||||
return strlen($this->_str);
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
|
||||
class FileReader {
|
||||
var $_pos;
|
||||
var $_fd;
|
||||
var $_length;
|
||||
|
||||
function FileReader($filename) {
|
||||
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
|
||||
/**
|
||||
* Simple class to wrap file streams, string streams, etc.
|
||||
* seek is essential, and it should be byte stream
|
||||
*
|
||||
* @package PhpMyAdmin
|
||||
*/
|
||||
class StreamReader
|
||||
{
|
||||
|
||||
/**
|
||||
* Read the given stream.
|
||||
*
|
||||
* @param type $bytes The content to read.
|
||||
*
|
||||
* @todo return a string [FIXME: perhaps return array of bytes?]
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function read($bytes)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
$this->error = 2; // File doesn't exist
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function read($bytes) {
|
||||
if ($bytes) {
|
||||
fseek($this->_fd, $this->_pos);
|
||||
/**
|
||||
* Go to the position in the stream.
|
||||
*
|
||||
* @param type $position The position to go.
|
||||
*
|
||||
* @todo return new position
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function seekto($position)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// 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);
|
||||
/**
|
||||
* Get the curent postion in the stream.
|
||||
*
|
||||
* @todo return current position
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function currentpos()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
return $data;
|
||||
} else return '';
|
||||
}
|
||||
/**
|
||||
* Get the stream length.
|
||||
*
|
||||
* @todo return length of entire stream (limit for seekto()s)
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function length()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
function seekto($pos) {
|
||||
fseek($this->_fd, $pos);
|
||||
$this->_pos = ftell($this->_fd);
|
||||
return $this->_pos;
|
||||
}
|
||||
/**
|
||||
* This class is responsible for read a string.
|
||||
*
|
||||
* @package PhpMyAdmin
|
||||
*/
|
||||
class StringReader
|
||||
{
|
||||
|
||||
var $_pos;
|
||||
var $_str;
|
||||
|
||||
function currentpos() {
|
||||
return $this->_pos;
|
||||
}
|
||||
/**
|
||||
* The constructor for the StringReader class.
|
||||
*
|
||||
* @param string $str The string to do operations.
|
||||
*/
|
||||
function StringReader($str='')
|
||||
{
|
||||
$this->_str = $str;
|
||||
$this->_pos = 0;
|
||||
}
|
||||
|
||||
function length() {
|
||||
return $this->_length;
|
||||
}
|
||||
/**
|
||||
* Read the given string content.
|
||||
*
|
||||
* @param type $bytes The string content.
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function read($bytes)
|
||||
{
|
||||
$data = substr($this->_str, $this->_pos, $bytes);
|
||||
$this->_pos += $bytes;
|
||||
if (strlen($this->_str)<$this->_pos) {
|
||||
$this->_pos = strlen($this->_str);
|
||||
}
|
||||
return $data;
|
||||
}
|
||||
|
||||
function close() {
|
||||
fclose($this->_fd);
|
||||
}
|
||||
/**
|
||||
* Go to the given position in the string.
|
||||
*
|
||||
* @param int $pos The position to go.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
function seekto($pos)
|
||||
{
|
||||
$this->_pos = $pos;
|
||||
if (strlen($this->_str)<$this->_pos) {
|
||||
$this->_pos = strlen($this->_str);
|
||||
}
|
||||
return $this->_pos;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get current position in the string.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
function currentpos()
|
||||
{
|
||||
return $this->_pos;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get length of the a string.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
function length()
|
||||
{
|
||||
return strlen($this->_str);
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
// 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) {
|
||||
if (file_exists($filename)) {
|
||||
|
||||
$length=filesize($filename);
|
||||
$fd = fopen($filename,'rb');
|
||||
/**
|
||||
* This class is responsible for read a file.
|
||||
*
|
||||
* @package PhpMyAdmin
|
||||
*/
|
||||
class FileReader
|
||||
{
|
||||
|
||||
var $_pos;
|
||||
var $_fd;
|
||||
var $_length;
|
||||
|
||||
if (!$fd) {
|
||||
$this->error = 3; // Cannot read file, probably permissions
|
||||
return false;
|
||||
}
|
||||
$this->_str = fread($fd, $length);
|
||||
fclose($fd);
|
||||
/**
|
||||
* Read the given file.
|
||||
*
|
||||
* @param string $filename The file path to read.
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function FileReader($filename)
|
||||
{
|
||||
if (file_exists($filename)) {
|
||||
|
||||
} else {
|
||||
$this->error = 2; // File doesn't exist
|
||||
return false;
|
||||
$this->_length=filesize($filename);
|
||||
$this->_pos = 0;
|
||||
$this->_fd = fopen($filename, 'rb');
|
||||
if (!$this->_fd) {
|
||||
$this->error = 3; // Cannot read file, probably permissions
|
||||
return false;
|
||||
}
|
||||
} else {
|
||||
$this->error = 2; // File doesn't exist
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Read the given file content.
|
||||
*
|
||||
* @param type $bytes The file content.
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function read($bytes)
|
||||
{
|
||||
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 '';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Go to the given line in the file.
|
||||
*
|
||||
* @param int $pos The line to go.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
function seekto($pos)
|
||||
{
|
||||
fseek($this->_fd, $pos);
|
||||
$this->_pos = ftell($this->_fd);
|
||||
return $this->_pos;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get current position in the file.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
function currentpos()
|
||||
{
|
||||
return $this->_pos;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the file size.
|
||||
*
|
||||
* @return int the size of the file in bytes.
|
||||
*/
|
||||
function length()
|
||||
{
|
||||
return $this->_length;
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the file
|
||||
*/
|
||||
function close()
|
||||
{
|
||||
fclose($this->_fd);
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
/**
|
||||
* Preloads entire file in memory first, then creates a StringReader
|
||||
* over it (it assumes knowledge of StringReader internals)
|
||||
*
|
||||
* @package PhpMyAdmin
|
||||
*/
|
||||
class CachedFileReader extends StringReader
|
||||
{
|
||||
|
||||
/**
|
||||
* Read cached file.
|
||||
*
|
||||
* @param string $filename Path to the file or directory.
|
||||
*
|
||||
* @return type
|
||||
*/
|
||||
function CachedFileReader($filename)
|
||||
{
|
||||
if (file_exists($filename)) {
|
||||
|
||||
$length=filesize($filename);
|
||||
$fd = fopen($filename, 'rb');
|
||||
|
||||
if (!$fd) {
|
||||
$this->error = 3; // Cannot read file, probably permissions
|
||||
return false;
|
||||
}
|
||||
$this->_str = fread($fd, $length);
|
||||
fclose($fd);
|
||||
|
||||
} else {
|
||||
$this->error = 2; // File doesn't exist
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user
