(PHP 5 >= 5.1.0, PHP 7)
はじめに
SplFileObject クラスはファイルのためのオブジェクト指向のインターフェイスを提供します。
クラス概要
SplFileObject extends SplFileInfo implements RecursiveIterator , SeekableIterator {
const
int
DROP_NEW_LINE
= 1
const
int
READ_AHEAD
= 2
const
int
SKIP_EMPTY
= 4
const
int
READ_CSV
= 8
/* メソッド */
public __construct
( string $filename
[, string $open_mode = "r"
[, bool $use_include_path = false
[, resource $context
]]] )
public current ( ) : string|array
public eof ( ) : bool
public fflush ( ) : bool
public fgetc ( ) : string
public fgetcsv
([ string $delimiter = ","
[, string $enclosure = "\""
[, string $escape = "\\"
]]] ) : array
public fgets ( ) : string
public fgetss
([ string $allowable_tags
] ) : string
public flock
( int $operation
[, int &$wouldblock
] ) : bool
public fpassthru ( ) : int
public fputcsv
( array $fields
[, string $delimiter = ","
[, string $enclosure = '"'
[, string $escape = "\\"
]]] ) : int|false
public fread
( int $length
) : string|false
public fseek
( int $offset
[, int $whence = SEEK_SET
] ) : int
public fstat ( ) : array
public ftell ( ) : int
public ftruncate
( int $size
) : bool
public fwrite
( string $str
[, int $length
] ) : int
public getChildren ( ) : void
public getCsvControl ( ) : array
public getFlags ( ) : int
public getMaxLineLen ( ) : int
public hasChildren ( ) : bool
public key ( ) : int
public next ( ) : void
public rewind ( ) : void
public seek
( int $line_pos
) : void
public setCsvControl
([ string $delimiter = ","
[, string $enclosure = "\""
[, string $escape = "\\"
]]] ) : void
public setFlags
( int $flags
) : void
public setMaxLineLen
( int $max_len
) : void
public valid ( ) : bool
/* 継承したメソッド */
public SplFileInfo::getATime ( ) : int
public SplFileInfo::getBasename
([ string $suffix
] ) : string
public SplFileInfo::getCTime ( ) : int
public SplFileInfo::getExtension ( ) : string
public SplFileInfo::getFileInfo
([ string $class_name
] ) : SplFileInfo
public SplFileInfo::getFilename ( ) : string
public SplFileInfo::getGroup ( ) : int
public SplFileInfo::getInode ( ) : int
public SplFileInfo::getLinkTarget ( ) : string
public SplFileInfo::getMTime ( ) : int
public SplFileInfo::getOwner ( ) : int
public SplFileInfo::getPath ( ) : string
public SplFileInfo::getPathInfo
([ string $class_name
] ) : SplFileInfo
public SplFileInfo::getPathname ( ) : string
public SplFileInfo::getPerms ( ) : int
public SplFileInfo::getRealPath ( ) : string
public SplFileInfo::getSize ( ) : int
public SplFileInfo::getType ( ) : string
public SplFileInfo::isDir ( ) : bool
public SplFileInfo::isExecutable ( ) : bool
public SplFileInfo::isFile ( ) : bool
public SplFileInfo::isLink ( ) : bool
public SplFileInfo::isReadable ( ) : bool
public SplFileInfo::isWritable ( ) : bool
public SplFileInfo::openFile
([ string $open_mode = "r"
[, bool $use_include_path = false
[, resource $context = null
]]] ) : SplFileObject
public SplFileInfo::setFileClass
([ string $class_name = "SplFileObject"
] ) : void
public SplFileInfo::setInfoClass
([ string $class_name = "SplFileInfo"
] ) : void
public SplFileInfo::__toString ( ) : string
}
定義済み定数
SplFileObject::DROP_NEW_LINE- 行末の改行を読み飛ばします。
SplFileObject::READ_AHEAD- 先読み/巻き戻しで読み出します。
SplFileObject::SKIP_EMPTY- ファイルの空行を読み飛ばします。期待通りに動作させるには、
READ_AHEADフラグを有効にしないといけません。 SplFileObject::READ_CSV- CSV 列として行を読み込みます。
変更履歴
| バージョン | 説明 |
|---|---|
| 5.3.9 | SplFileObject::SKIP_EMPTY の値が 4
に変わりました。前のバージョンでは、値は 6 でした。 |
目次
- SplFileObject::__construct — 新しいファイルオブジェクトを作成する
- SplFileObject::current — ファイルの現在の行を取得する
- SplFileObject::eof — ファイルの終端に到達しているか調べる
- SplFileObject::fflush — 出力をファイルにフラッシュする
- SplFileObject::fgetc — ファイルから文字を取り出す
- SplFileObject::fgetcsv — ファイルから行を取り出し CSV フィールドとして処理する
- SplFileObject::fgets — ファイルから 1 行取り出す
- SplFileObject::fgetss — ファイルから 1 行取り出し HTML タグを取り除く
- SplFileObject::flock — 簡易なファイルロックを行う
- SplFileObject::fpassthru — ファイルポインタに残っているデータをすべて出力する
- SplFileObject::fputcsv — フィールドの配列を CSV の行として書き出す
- SplFileObject::fread — ファイルから読み取る
- SplFileObject::fscanf — フォーマットに従ってファイルからの入力をパースする
- SplFileObject::fseek — ファイルポインタを移動させる
- SplFileObject::fstat — ファイルの情報を得る
- SplFileObject::ftell — ファイルポインタの現在位置を返す
- SplFileObject::ftruncate — ファイルを指定した長さに丸める
- SplFileObject::fwrite — ファイルに書き込む
- SplFileObject::getChildren — 用途はなし
- SplFileObject::getCsvControl — CSV の区切り、囲み文字、エスケープ文字を取得する
- SplFileObject::getCurrentLine — SplFileObject::fgets のエイリアス
- SplFileObject::getFlags — SplFileObject のフラグを取得する
- SplFileObject::getMaxLineLen — 行の最大バイト数を取得する
- SplFileObject::hasChildren — SplFileObject は子を持ちません
- SplFileObject::key — 行番号を取得する
- SplFileObject::next — 次の行を読み出す
- SplFileObject::rewind — ファイルポインタを先頭に巻き戻す
- SplFileObject::seek — ファイルポインタを指定行に移動させる
- SplFileObject::setCsvControl — CSV の区切り文字、囲み文字、エスケープ文字をセットする
- SplFileObject::setFlags — SplFileObject のフラグをセットする
- SplFileObject::setMaxLineLen — 読み込む行の最大バイト数をセットする
- SplFileObject::__toString — SplFileObject::fgets のエイリアス
- SplFileObject::valid — ファイル終端でないかチェックする
/* 定数 */