|
SPL-StandardPHPLibrary
|


Public Member Functions | |
| __construct ($file_name, $open_mode= 'r', $use_include_path=false, $context=NULL) | |
| __toString () | |
| current () | |
| eof () | |
| fflush () | |
| fgetc () | |
| fgetcsv ($delimiter=NULL, $enclosure=NULL) | |
| fgets () | |
| fgetss ($allowable_tags=NULL) | |
| flock ($operation, &$wouldblock) | |
| fpassthru () | |
| fscanf ($format) | |
| fseek ($pos, $whence=SEEK_SET) | |
| fstat () | |
| ftell () | |
| ftruncate ($size) | |
| fwrite ($str, $length=NULL) | |
| getATime () | |
| getChildren () | |
| getCsvControl ($delimiter= ',', $enclosure= '"') | |
| getCTime () | |
| getCurrentLine () | |
| getFileInfo (string class_name=NULL) | |
| getFilename () | |
| getFlags () | |
| getGroup () | |
| getInode () | |
| getLinkTarget () | |
| getMaxLineLen () | |
| getMTime () | |
| getOwner () | |
| getPath () | |
| getPathInfo (string class_name=NULL) | |
| getPathname () | |
| getPerms () | |
| getRealPath () | |
| getSize () | |
| getType () | |
| hasChildren () | |
| isDir () | |
| isExecutable () | |
| isFile () | |
| isLink () | |
| isReadable () | |
| isWritable () | |
| key () | |
| next () | |
| openFile ($mode= 'r', $use_include_path=false, $context=NULL) | |
| rewind () | |
| seek ($line_pos) | |
| setCsvControl ($delimiter= ';', $enclosure= '"') | |
| setFileClass (string class_name="SplFileObject") | |
| setFlags ($flags) | |
| setInfoClass (string class_name="SplFileInfo") | |
| setMaxLineLen ($max_len) | |
| valid () | |
Public Attributes | |
| const | DROP_NEW_LINE = 0x00000001 |
Private Member Functions | |
| freeLine () | |
| readLine () | |
Private Attributes | |
| $delimiter = ',' | |
| $enclosure = '"' | |
| $flags = 0 | |
| $fname | |
| $fp | |
| $line = NULL | |
| $lnum = 0 | |
| $max_len = 0 | |
Object representation for any stream.
Definition at line 18 of file splfileobject.inc.
| SplFileObject::__construct | ( | $ | file_name, |
| $ | open_mode = 'r', |
||
| $ | use_include_path = false, |
||
| $ | context = NULL |
||
| ) |
Constructs a new file object.
| $file_name | The name of the stream to open |
| $open_mode | The file open mode |
| $use_include_path | Whether to search in include paths |
| $context | A stream context |
| RuntimeException | If file cannot be opened (e.g. insufficient access rights). |
Definition at line 42 of file splfileobject.inc.
{
$this->fp = fopen($file_name, $open_mode, $use_include_path, $context);
if (!$this->fp)
{
throw new RuntimeException("Cannot open file $file_name");
}
$this->fname = $file_name;
}
| SplFileObject::__toString | ( | ) |
Reimplemented from SplFileInfo.
Definition at line 359 of file splfileobject.inc.
References current().
{
return current();
}

| SplFileObject::current | ( | ) |
Implements Iterator.
Definition at line 284 of file splfileobject.inc.
References getCurrentLine().
Referenced by __toString().
{
if (is_null($this->line))
{
$this->line = getCurrentLine();
}
return $this->line;
}

| SplFileObject::eof | ( | ) |
Definition at line 55 of file splfileobject.inc.
Referenced by getCurrentLine(), readLine(), seek(), and valid().
{
return eof($this->fp);
}
| SplFileObject::fflush | ( | ) |
Flush current data.
Definition at line 127 of file splfileobject.inc.
{
return fflush($this->fp);
}
| SplFileObject::fgetc | ( | ) |
Definition at line 155 of file splfileobject.inc.
References freeLine().

| SplFileObject::fgetcsv | ( | $ | delimiter = NULL, |
| $ | enclosure = NULL |
||
| ) |
| delimiter | character used as field separator |
| enclosure | end of |
Definition at line 77 of file splfileobject.inc.
References $delimiter, $enclosure, and freeLine().
{
$this->freeLine();
$this->lnum++;
switch(fun_num_args())
{
case 0:
$delimiter = $this->delimiter;
case 1:
$enclosure = $this->enclosure;
default:
case 2:
break;
}
return fgetcsv($this->fp, $this->max_len, $delimiter, $enclosure);
}

| SplFileObject::fgets | ( | ) |
increase current line number
Definition at line 63 of file splfileobject.inc.
References freeLine().
Referenced by readLine().

| SplFileObject::fgetss | ( | $ | allowable_tags = NULL | ) |
Get a line from the file and strip HTML tags.
| $allowable_tags | tags to keep in the string |
Definition at line 175 of file splfileobject.inc.
{
return fgetss($this->fp, $allowable_tags);
}
| SplFileObject::flock | ( | $ | operation, |
| &$ | wouldblock | ||
| ) |
| operation | lock operation (LOCK_SH, LOCK_EX, LOCK_UN, LOCK_NB) |
| $wouldblock | whether the operation would block |
Definition at line 118 of file splfileobject.inc.
{
return flock($this->fp, $operation, $wouldblock);
}
| SplFileObject::fpassthru | ( | ) |
Read and return remaining part of stream.
Definition at line 167 of file splfileobject.inc.
{
return fpassthru($this->fp);
}
| SplFileObject::freeLine | ( | ) | [private] |
Free the current line buffer and increment the line counter.
Definition at line 334 of file splfileobject.inc.
Referenced by fgetc(), fgetcsv(), fgets(), fscanf(), getCurrentLine(), next(), readLine(), and rewind().
{
if ($this->line) {
$this->line = NULL;
}
}
| SplFileObject::fscanf | ( | $ | format | ) |
Scan the next line.
| $format | string specifying format to parse |
Definition at line 183 of file splfileobject.inc.
References freeLine().

| SplFileObject::fseek | ( | $ | pos, |
| $ | whence = SEEK_SET |
||
| ) |
| pos | new file position |
| whence | seek method (SEEK_SET, SEEK_CUR, SEEK_END) |
Definition at line 146 of file splfileobject.inc.
{
return fseek($this->fp, $pos, $whence);
}
| SplFileObject::fstat | ( | ) |
Definition at line 202 of file splfileobject.inc.
{
return fstat($this->fp);
}
| SplFileObject::ftell | ( | ) |
Definition at line 135 of file splfileobject.inc.
{
return ftell($this->fp);
}
| SplFileObject::ftruncate | ( | $ | size | ) |
| $size | new size to truncate file to |
Definition at line 210 of file splfileobject.inc.
{
return ftruncate($this->fp, $size);
}
| SplFileObject::fwrite | ( | $ | str, |
| $ | length = NULL |
||
| ) |
| $str | to write |
| $length | maximum line length to write |
Definition at line 194 of file splfileobject.inc.
References $length.
| SplFileInfo::getATime | ( | ) | [inherited] |
| SplFileObject::getChildren | ( | ) |
Implements RecursiveIterator.
Definition at line 258 of file splfileobject.inc.
{
return NULL;
}
| SplFileObject::getCsvControl | ( | $ | delimiter = ',', |
| $ | enclosure = '"' |
||
| ) |
Definition at line 109 of file splfileobject.inc.
{
return array($this->delimiter, $this->enclosure);
}
| SplFileInfo::getCTime | ( | ) | [inherited] |
| SplFileObject::getCurrentLine | ( | ) |
Definition at line 346 of file splfileobject.inc.
References eof(), freeLine(), and readLine().
Referenced by current(), and seek().
{
$this->freeLine();
if ($this->eof())
{
throw new RuntimeException("Cannot read from file " . $this->fname);
}
$this->readLine();
}

| SplFileInfo::getFileInfo | ( | string | class_name = NULL | ) | [inherited] |
| class_name | name of class to instantiate |
Definition at line 876 of file spl.php.
{}
| SplFileInfo::getFilename | ( | ) | [inherited] |
| SplFileObject::getFlags | ( | ) |
Definition at line 226 of file splfileobject.inc.
{
return $this->flags;
}
| SplFileInfo::getGroup | ( | ) | [inherited] |
| SplFileInfo::getInode | ( | ) | [inherited] |
| SplFileInfo::getLinkTarget | ( | ) | [inherited] |
| SplFileObject::getMaxLineLen | ( | ) |
Definition at line 242 of file splfileobject.inc.
{
return $this->max_len;
}
| SplFileInfo::getMTime | ( | ) | [inherited] |
| SplFileInfo::getOwner | ( | ) | [inherited] |
| SplFileInfo::getPath | ( | ) | [inherited] |
| SplFileInfo::getPathInfo | ( | string | class_name = NULL | ) | [inherited] |
| class_name | name of class to instantiate |
Definition at line 886 of file spl.php.
{}
| SplFileInfo::getPathname | ( | ) | [inherited] |
| SplFileInfo::getPerms | ( | ) | [inherited] |
| SplFileInfo::getRealPath | ( | ) | [inherited] |
| SplFileInfo::getSize | ( | ) | [inherited] |
| SplFileInfo::getType | ( | ) | [inherited] |
| SplFileObject::hasChildren | ( | ) |
Implements RecursiveIterator.
Definition at line 250 of file splfileobject.inc.
{
return false;
}
| SplFileInfo::isDir | ( | ) | [inherited] |
| SplFileInfo::isExecutable | ( | ) | [inherited] |
| SplFileInfo::isFile | ( | ) | [inherited] |
| SplFileInfo::isLink | ( | ) | [inherited] |
Reimplemented in DirectoryIterator.
Definition at line 946 of file spl.php.
{}
| SplFileInfo::isReadable | ( | ) | [inherited] |
| SplFileInfo::isWritable | ( | ) | [inherited] |
| SplFileObject::key | ( | ) |
Implements Iterator.
Definition at line 301 of file splfileobject.inc.
{
return $this->lnum;
}
| SplFileObject::next | ( | ) |
Invalidate current line buffer.
Implements Iterator.
Definition at line 308 of file splfileobject.inc.
References freeLine().
{
$this->freeLine();
}

| SplFileInfo::openFile | ( | $ | mode = 'r', |
| $ | use_include_path = false, |
||
| $ | context = NULL |
||
| ) | [inherited] |
Open the current file as a SplFileObject instance.
| mode | open mode |
| use_include_path | whether to search include paths (don't use) |
| context | resource context to pased to open function |
| RuntimeException | if file cannot be opened (e.g. insufficient access rights). |
Definition at line 973 of file spl.php.
{}
| SplFileObject::readLine | ( | ) | [private] |
Definition at line 316 of file splfileobject.inc.
References eof(), fgets(), and freeLine().
Referenced by getCurrentLine().
{
if ($this->eof())
{
$this->freeLine();
throw new RuntimeException("Cannot read from file " . $this->fname);
}
if ($this->line) {
$this->lnum++;
}
$this->freeLine();
$this->line = fgets($this->fp, $this->max_len);
return $this->line;
}

| SplFileObject::rewind | ( | ) |
Invalidate current line buffer and set line number to 0.
Implements Iterator.
Definition at line 266 of file splfileobject.inc.
References freeLine().
Referenced by seek().
{
$this->freeLine();
$this->lnum = 0;
}

| SplFileObject::seek | ( | $ | line_pos | ) |
| $line_pos | Seek to this line |
Implements SeekableIterator.
Definition at line 367 of file splfileobject.inc.
References eof(), getCurrentLine(), and rewind().
{
$this->rewind();
while($this->lnum < $line_pos && !$this->eof())
{
$this->getCurrentLine();
}
}

| SplFileObject::setCsvControl | ( | $ | delimiter = ';', |
| $ | enclosure = '"' |
||
| ) |
Set the delimiter and enclosure character used in fgetcsv.
| delimiter | new delimiter, defaults to ',' |
| enclosure | new enclosure, defaults to '"' |
Definition at line 100 of file splfileobject.inc.
References $delimiter, and $enclosure.
{
$this->delimiter = $delimiter;
$this->enclosure = $enclosure;
}
| SplFileInfo::setFileClass | ( | string | class_name = "SplFileObject" | ) | [inherited] |
| class_name | name of class used with openFile(). Must be derived from SPLFileObject. |
Definition at line 978 of file spl.php.
{}
| SplFileObject::setFlags | ( | $ | flags | ) |
| $flags | new flag set |
Definition at line 218 of file splfileobject.inc.
References $flags.
{
$this->flags = $flags;
}
| SplFileInfo::setInfoClass | ( | string | class_name = "SplFileInfo" | ) | [inherited] |
| class_name | name of class used with getFileInfo(), getPathInfo(). Must be derived from SplFileInfo. |
Definition at line 983 of file spl.php.
{}
| SplFileObject::setMaxLineLen | ( | $ | max_len | ) |
| $max_len | set the maximum line length read |
Definition at line 234 of file splfileobject.inc.
References $max_len.
{
$this->max_len = $max_len;
}
| SplFileObject::valid | ( | ) |
Implements Iterator.
Definition at line 275 of file splfileobject.inc.
References eof().
{
return !$this->eof();
}

SplFileObject::$delimiter = ',' [private] |
Definition at line 29 of file splfileobject.inc.
Referenced by fgetcsv(), and setCsvControl().
SplFileObject::$enclosure = '"' [private] |
Definition at line 30 of file splfileobject.inc.
Referenced by fgetcsv(), and setCsvControl().
SplFileObject::$flags = 0 [private] |
Definition at line 28 of file splfileobject.inc.
Referenced by setFlags().
SplFileObject::$fname [private] |
Definition at line 24 of file splfileobject.inc.
SplFileObject::$fp [private] |
Definition at line 23 of file splfileobject.inc.
SplFileObject::$line = NULL [private] |
Definition at line 25 of file splfileobject.inc.
SplFileObject::$lnum = 0 [private] |
Definition at line 26 of file splfileobject.inc.
SplFileObject::$max_len = 0 [private] |
Definition at line 27 of file splfileobject.inc.
Referenced by setMaxLineLen().
| const SplFileObject::DROP_NEW_LINE = 0x00000001 |
Flag: wheter to suppress new lines.
Definition at line 21 of file splfileobject.inc.
1.7.5.1