Inheritance diagram for SplFileObject:

Public Member Functions
	__construct (string $filename, string $mode="r", bool $useIncludePath=false, $context=null)

	rewind ()

	eof ()

	valid ()

	fgets ()

	fread (int $length)

	fgetcsv (string $separator=",", string $enclosure="\"", string $escape="\\")

	fputcsv (array $fields, string $separator=",", string $enclosure="\"", string $escape="\\", string $eol="\n")

	setCsvControl (string $separator=",", string $enclosure="\"", string $escape="\\")

	getCsvControl ()

	flock (int $operation, &$wouldBlock=null)

	fflush ()

	ftell ()

	fseek (int $offset, int $whence=SEEK_SET)

	fgetc ()

	fpassthru ()

	fscanf (string $format, mixed &... $vars)

	fwrite (string $data, int $length=0)

	fstat ()

	ftruncate (int $size)

	current ()

	key ()

	next ()

	setFlags (int $flags)

	getFlags ()

	setMaxLineLen (int $maxLength)

	getMaxLineLen ()

	hasChildren ()

	getChildren ()

	seek (int $line)

	getCurrentLine ()

	__toString ()

Public Member Functions inherited from SplFileInfo
	__construct (string $filename)

	getPath ()

	getFilename ()

	getExtension ()

	getBasename (string $suffix="")

	getPathname ()

	getPerms ()

	getInode ()

	getSize ()

	getOwner ()

	getGroup ()

	getATime ()

	getMTime ()

	getCTime ()

	getType ()

	isWritable ()

	isReadable ()

	isExecutable ()

	isFile ()

	isDir ()

	isLink ()

	getLinkTarget ()

	getRealPath ()

	getFileInfo (?string $class=null)

	getPathInfo (?string $class=null)

	openFile (string $mode="r", bool $useIncludePath=false, $context=null)

	setFileClass (string $class=SplFileObject::class)

	setInfoClass (string $class=SplFileInfo::class)

	__debugInfo ()

	_bad_state_ex ()

Data Fields
const int	DROP_NEW_LINE = UNKNOWN

const int	READ_AHEAD = UNKNOWN

const int	SKIP_EMPTY = UNKNOWN

const int	READ_CSV = UNKNOWN

Detailed Description

Definition at line 223 of file spl_directory.stub.php.

Constructor & Destructor Documentation

◆ __construct()

SplFileObject::__construct	(	string	$filename,
		string	$mode = "r",
		bool	$useIncludePath = false,
			$context = null )

Parameters

resource | null $context

Definition at line 235 of file spl_directory.stub.php.

Member Function Documentation

◆ __toString()

SplFileObject::__toString ( )

@implementation-alias SplFileInfo\getPathname

Reimplemented from SplFileInfo.

Definition at line 333 of file spl_directory.stub.php.

◆ current()

SplFileObject::current ( )

@tentative-return-type

Implements Iterator.

Definition at line 298 of file spl_directory.stub.php.

◆ eof()

SplFileObject::eof ( )

@tentative-return-type

Definition at line 241 of file spl_directory.stub.php.

◆ fflush()

SplFileObject::fflush ( )

@tentative-return-type

Definition at line 271 of file spl_directory.stub.php.

◆ fgetc()

SplFileObject::fgetc ( )

@tentative-return-type

Definition at line 280 of file spl_directory.stub.php.

◆ fgetcsv()

SplFileObject::fgetcsv	(	string	$separator = ",",
		string	$enclosure = "\"",
		string	$escape = "\\" )

@tentative-return-type

Definition at line 253 of file spl_directory.stub.php.

◆ fgets()

SplFileObject::fgets ( )

@tentative-return-type

Definition at line 247 of file spl_directory.stub.php.

◆ flock()

SplFileObject::flock	(	int	$operation,
		&	$wouldBlock = null )

Parameters

int $wouldBlock @tentative-return-type

Definition at line 268 of file spl_directory.stub.php.

◆ fpassthru()

SplFileObject::fpassthru ( )

@tentative-return-type

Definition at line 283 of file spl_directory.stub.php.

◆ fputcsv()

SplFileObject::fputcsv	(	array	$fields,
		string	$separator = ",",
		string	$enclosure = "\"",
		string	$escape = "\\",
		string	$eol = "\n" )

@tentative-return-type

Definition at line 256 of file spl_directory.stub.php.

◆ fread()

SplFileObject::fread ( int $length )

@tentative-return-type

Definition at line 250 of file spl_directory.stub.php.

◆ fscanf()

SplFileObject::fscanf	(	string	$format,
		mixed &...	$vars )

@tentative-return-type

Definition at line 286 of file spl_directory.stub.php.

◆ fseek()

SplFileObject::fseek	(	int	$offset,
		int	$whence = SEEK_SET )

@tentative-return-type

Definition at line 277 of file spl_directory.stub.php.

◆ fstat()

SplFileObject::fstat ( )

@tentative-return-type

Definition at line 292 of file spl_directory.stub.php.

◆ ftell()

SplFileObject::ftell ( )

@tentative-return-type

Definition at line 274 of file spl_directory.stub.php.

◆ ftruncate()

SplFileObject::ftruncate ( int $size )

@tentative-return-type

Definition at line 295 of file spl_directory.stub.php.

◆ fwrite()

SplFileObject::fwrite	(	string	$data,
		int	$length = 0 )

@tentative-return-type

Definition at line 289 of file spl_directory.stub.php.

◆ getChildren()

SplFileObject::getChildren ( )

@tentative-return-type

Implements RecursiveIterator.

Definition at line 322 of file spl_directory.stub.php.

◆ getCsvControl()

SplFileObject::getCsvControl ( )

@tentative-return-type

Definition at line 262 of file spl_directory.stub.php.

◆ getCurrentLine()

SplFileObject::getCurrentLine ( )

@tentative-return-type @alias SplFileObject\fgets

Definition at line 331 of file spl_directory.stub.php.

◆ getFlags()

SplFileObject::getFlags ( )

@tentative-return-type

Definition at line 310 of file spl_directory.stub.php.

◆ getMaxLineLen()

SplFileObject::getMaxLineLen ( )

@tentative-return-type

Definition at line 316 of file spl_directory.stub.php.

◆ hasChildren()

SplFileObject::hasChildren ( )

@tentative-return-type

Implements RecursiveIterator.

Definition at line 319 of file spl_directory.stub.php.

◆ key()

SplFileObject::key ( )

@tentative-return-type

Implements Iterator.

Definition at line 301 of file spl_directory.stub.php.

◆ next()

SplFileObject::next ( )

@tentative-return-type

Implements Iterator.

Definition at line 304 of file spl_directory.stub.php.

◆ rewind()

SplFileObject::rewind ( )

@tentative-return-type

Implements Iterator.

Definition at line 238 of file spl_directory.stub.php.

◆ seek()

SplFileObject::seek ( int $line )

@tentative-return-type

Implements SeekableIterator.

Definition at line 325 of file spl_directory.stub.php.

◆ setCsvControl()

SplFileObject::setCsvControl	(	string	$separator = ",",
		string	$enclosure = "\"",
		string	$escape = "\\" )

@tentative-return-type

Definition at line 259 of file spl_directory.stub.php.

◆ setFlags()

SplFileObject::setFlags ( int $flags )

@tentative-return-type

Definition at line 307 of file spl_directory.stub.php.

◆ setMaxLineLen()

SplFileObject::setMaxLineLen ( int $maxLength )

@tentative-return-type

Definition at line 313 of file spl_directory.stub.php.

◆ valid()

SplFileObject::valid ( )

@tentative-return-type

Implements Iterator.

Definition at line 244 of file spl_directory.stub.php.

Field Documentation

◆ DROP_NEW_LINE

const int SplFileObject::DROP_NEW_LINE = UNKNOWN

@cvalue SPL_FILE_OBJECT_DROP_NEW_LINE

Definition at line 226 of file spl_directory.stub.php.

◆ READ_AHEAD

const int SplFileObject::READ_AHEAD = UNKNOWN

@cvalue SPL_FILE_OBJECT_READ_AHEAD

Definition at line 228 of file spl_directory.stub.php.

◆ READ_CSV

const int SplFileObject::READ_CSV = UNKNOWN

@cvalue SPL_FILE_OBJECT_READ_CSV

Definition at line 232 of file spl_directory.stub.php.

◆ SKIP_EMPTY

const int SplFileObject::SKIP_EMPTY = UNKNOWN

@cvalue SPL_FILE_OBJECT_SKIP_EMPTY

Definition at line 230 of file spl_directory.stub.php.

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

ext/spl/spl_directory.stub.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ current()

◆ eof()

◆ fflush()

◆ fgetc()

◆ fgetcsv()

◆ fgets()

◆ flock()

◆ fpassthru()

◆ fputcsv()

◆ fread()

◆ fscanf()

◆ fseek()

◆ fstat()

◆ ftell()

◆ ftruncate()

◆ fwrite()

◆ getChildren()

◆ getCsvControl()

◆ getCurrentLine()

◆ getFlags()

◆ getMaxLineLen()

◆ hasChildren()

◆ key()

◆ next()

◆ rewind()

◆ seek()

◆ setCsvControl()

◆ setFlags()

◆ setMaxLineLen()

◆ valid()

Field Documentation

◆ DROP_NEW_LINE

◆ READ_AHEAD

◆ READ_CSV

◆ SKIP_EMPTY