Inheritance diagram for SplFileObject:

Collaboration diagram for SplFileObject:

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

Detailed Description

Object representation for any stream.

Author:: Marcus Boerger

Version:: 1.1

Since:: PHP 5.1

Definition at line 18 of file splfileobject.inc.

Constructor & Destructor Documentation

SplFileObject::__construct	(	$	file_name,
		$	open_mode = `'r'`,
		$	use_include_path = `false`,
		$	context = `NULL`
	)

Constructs a new file object.

Parameters:

$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

Exceptions:

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

Member Function Documentation

SplFileObject::__toString ( )

Returns:: current line

Reimplemented from SplFileInfo.

Definition at line 359 of file splfileobject.inc.

References current().

    {
        return current();
    }

Here is the call graph for this function:

SplFileObject::current ( )

Note:: Fill current line buffer if not done yet.

Returns:: line buffer

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

Here is the call graph for this function:

SplFileObject::eof ( )

Returns:: whether the end of the stream is reached

Definition at line 55 of file splfileobject.inc.

Referenced by getCurrentLine(), readLine(), seek(), and valid().

    {
        return eof($this->fp);
    }

SplFileObject::fflush ( )

Flush current data.

Returns:: success or failure

Definition at line 127 of file splfileobject.inc.

    {
        return fflush($this->fp);
    }

SplFileObject::fgetc ( )

Returns:: next char from file

Note:: a new line character does not increase $this->lnum

Definition at line 155 of file splfileobject.inc.

References freeLine().

    {
        $this->freeLine();
        $c = fgetc($this->fp);
        if ($c == '\n') {
            $this->lnum++;
        }
    }

Here is the call graph for this function:

SplFileObject::fgetcsv	(	$	delimiter = `NULL`,
		$	enclosure = `NULL`
	)

Parameters:

delimiter	character used as field separator
enclosure	end of

Returns:: array containing read data

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

Here is the call graph for this function:

SplFileObject::fgets ( )

increase current line number

Returns:: next line from stream

Definition at line 63 of file splfileobject.inc.

References freeLine().

Referenced by readLine().

    {
        $this->freeLine();
        $this->lnum++;
        $buf = fgets($this->fp, $this->max_len);
        
        return $buf;
    }

Here is the call graph for this function:

SplFileObject::fgetss ( $ allowable_tags = NULL )

Get a line from the file and strip HTML tags.

Parameters:

$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
	)

Parameters:

operation lock operation (LOCK_SH, LOCK_EX, LOCK_UN, LOCK_NB)

Return values:

$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.

Returns:: size of remaining part passed through

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.

Parameters:

$format string specifying format to parse

Definition at line 183 of file splfileobject.inc.

References freeLine().

    {
        $this->freeLine();
        $this->lnum++;
        return fscanf($this->fp, $format /* , ... */);
    }

Here is the call graph for this function:

SplFileObject::fseek	(	$	pos,
		$	whence = `SEEK_SET`
	)

Parameters:

pos	new file position
whence	seek method (SEEK_SET, SEEK_CUR, SEEK_END)

Returns:: Upon success, returns 0; otherwise, returns -1. Note that seeking past EOF is not considered an error.

Definition at line 146 of file splfileobject.inc.

    {
        return fseek($this->fp, $pos, $whence);
    }

SplFileObject::fstat ( )

Returns:: array of file stat information

Definition at line 202 of file splfileobject.inc.

    {
        return fstat($this->fp);
    }

SplFileObject::ftell ( )

Returns:: current file position

Definition at line 135 of file splfileobject.inc.

    {
        return ftell($this->fp);
    }

SplFileObject::ftruncate ( $ size )

Parameters:

$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`
	)

Parameters:

$str	to write
$length	maximum line length to write

Definition at line 194 of file splfileobject.inc.

References $length.

    {
        return fwrite($this->fp, $length);
    }

SplFileInfo::getATime ( ) [inherited]

Returns:: The current entry's last access time.

Definition at line 910 of file spl.php.

{}

SplFileObject::getChildren ( )

Returns:: false

Implements RecursiveIterator.

Definition at line 258 of file splfileobject.inc.

    {
        return NULL;
    }

SplFileObject::getCsvControl	(	$	delimiter = `','`,
		$	enclosure = `'"'`
	)

Returns:: array(delimiter, enclosure) as used in fgetcsv

Definition at line 109 of file splfileobject.inc.

    {
        return array($this->delimiter, $this->enclosure);
    }

SplFileInfo::getCTime ( ) [inherited]

Returns:: The current entry's last change time.

Definition at line 918 of file spl.php.

{}

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

Here is the call graph for this function:

SplFileInfo::getFileInfo ( string class_name = NULL ) [inherited]

Returns:: SplFileInfo created for the file

Parameters:

class_name name of class to instantiate

See also:: SplFileInfo::setInfoClass()

Definition at line 876 of file spl.php.

{}

SplFileInfo::getFilename ( ) [inherited]

Returns:: the filename only.

Definition at line 870 of file spl.php.

{}

SplFileObject::getFlags ( )

Returns:: current set of flags

Definition at line 226 of file splfileobject.inc.

    {
        return $this->flags;
    }

SplFileInfo::getGroup ( ) [inherited]

Returns:: The current entry's group name.

Definition at line 906 of file spl.php.

{}

SplFileInfo::getInode ( ) [inherited]

Returns:: The current entry's inode.

Definition at line 894 of file spl.php.

{}

SplFileInfo::getLinkTarget ( ) [inherited]

Returns:: target of link.

Definition at line 950 of file spl.php.

{}

SplFileObject::getMaxLineLen ( )

Returns:: current setting for max line

Definition at line 242 of file splfileobject.inc.

    {
        return $this->max_len;
    }

SplFileInfo::getMTime ( ) [inherited]

Returns:: The current entry's last modification time.

Definition at line 914 of file spl.php.

{}

SplFileInfo::getOwner ( ) [inherited]

Returns:: The current entry's owner name.

Definition at line 902 of file spl.php.

{}

SplFileInfo::getPath ( ) [inherited]

Returns:: the path part only.

Definition at line 866 of file spl.php.

{}

SplFileInfo::getPathInfo ( string class_name = NULL ) [inherited]

Returns:: SplFileInfo created for the path

Parameters:

class_name name of class to instantiate

See also:: SplFileInfo::setInfoClass()

Definition at line 886 of file spl.php.

{}

SplFileInfo::getPathname ( ) [inherited]

Returns:: The current entries path and file name.

Definition at line 880 of file spl.php.

{}

SplFileInfo::getPerms ( ) [inherited]

Returns:: The current entry's permissions.

Definition at line 890 of file spl.php.

{}

SplFileInfo::getRealPath ( ) [inherited]

Returns:: The resolved path

Definition at line 954 of file spl.php.

{}

SplFileInfo::getSize ( ) [inherited]

Returns:: The current entry's size in bytes .

Definition at line 898 of file spl.php.

{}

SplFileInfo::getType ( ) [inherited]

Returns:: The current entry's file type.

Definition at line 922 of file spl.php.

{}

SplFileObject::hasChildren ( )

Returns:: false

Implements RecursiveIterator.

Definition at line 250 of file splfileobject.inc.

    {
        return false;
    }

SplFileInfo::isDir ( ) [inherited]

Returns:: Whether the current entry is a directory.

Definition at line 942 of file spl.php.

{}

SplFileInfo::isExecutable ( ) [inherited]

Returns:: Whether the current entry is executable.

Definition at line 934 of file spl.php.

{}

SplFileInfo::isFile ( ) [inherited]

Returns:: Whether the current entry is .

Definition at line 938 of file spl.php.

{}

SplFileInfo::isLink ( ) [inherited]

Returns:: whether the current entry is a link.

Reimplemented in DirectoryIterator.

Definition at line 946 of file spl.php.

{}

SplFileInfo::isReadable ( ) [inherited]

Returns:: Whether the current entry is readable.

Definition at line 930 of file spl.php.

{}

SplFileInfo::isWritable ( ) [inherited]

Returns:: Whether the current entry is writeable.

Definition at line 926 of file spl.php.

{}

SplFileObject::key ( )

Returns:: line number

Note:: fgetc() will increase the line number when reaing a new line char. This has the effect key() called on a read a new line will already return the increased line number.; Line counting works as long as you only read the file and do not use fseek().

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

Here is the call graph for this function:

SplFileInfo::openFile	(	$	mode = `'r'`,
		$	use_include_path = `false`,
		$	context = `NULL`
	)		`[inherited]`

Open the current file as a SplFileObject instance.

Parameters:

mode	open mode
use_include_path	whether to search include paths (don't use)
context	resource context to pased to open function

Exceptions:

RuntimeException if file cannot be opened (e.g. insufficient access rights).

Returns:: The opened file as a SplFileObject instance

See also:: SplFileObject; SplFileInfo::setFileClass(); file()

Definition at line 973 of file spl.php.

{}

SplFileObject::readLine ( ) [private]

Returns:: next line read from file and increase the line counter

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

Here is the call graph for this function:

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

Here is the call graph for this function:

SplFileObject::seek ( $ line_pos )

Parameters:

$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();
        }
    }

Here is the call graph for this function:

SplFileObject::setCsvControl	(	$	delimiter = `';'`,
		$	enclosure = `'"'`
	)

Set the delimiter and enclosure character used in fgetcsv.

Parameters:

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]

Parameters:

class_name name of class used with openFile(). Must be derived from SPLFileObject.

Definition at line 978 of file spl.php.

{}

SplFileObject::setFlags ( $ flags )

Parameters:

$flags new flag set

Definition at line 218 of file splfileobject.inc.

References $flags.

    {
        $this->flags = $flags;
    }

SplFileInfo::setInfoClass ( string class_name = "SplFileInfo" ) [inherited]

Parameters:

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 )

Parameters:

$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 ( )

Returns:: whether more data can be read

Implements Iterator.

Definition at line 275 of file splfileobject.inc.

References eof().

    {
        return !$this->eof();
    }

Here is the call graph for this function:

Member Data Documentation

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.

The documentation for this class was generated from the following file:

splfileobject.inc

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation