API Documentation
\
CodeLapse
Controller
Database
Connection
ResultSet

\CodeLapseFile

ファイル操作関数をラップするクラス （開いたファイルは自動的にクローズされます。）

Example:

   $file = new File('path/to/open/file');
   $file->append('hello world');
   echo $file->getContents(); // -> "hello world"

Summary

Methods
Properties
Constants
__construct()
getPointer()
lock()
unlock()
getFilename()
clearContents()
putContents()
getContents()
getContentsAsArray()
write()
append()
readline()
tell()
getPosition()
seek()
setPosition()
rewind()
isEnd()
No public properties found
SEEK_SET
SEEK_ADD
SEEK_END
No protected methods found
No protected properties found
N/A
No private methods found
$filename
$pointer
N/A

Constants

SEEK_SET

SEEK_SET

SEEK_ADD

SEEK_ADD

SEEK_END

SEEK_END

Properties

$filename

$filename :

ファイルパス

Type

$pointer

$pointer :

ファイルのポインタ

Type

Methods

__construct()

__construct(string $filename, boolean|null $createfile, string|null $openMode)

Parameters

string $filename

オープンするファイル名を指定します。
boolean|null $createfile

(optional) ファイルが存在しない場合に作成するか指定します。

標準はtrueです。
string|null $openMode

(optional) ファイルのモードを指定します。

このパラメータを設定した場合 $createfileパラメータの内容は無視されます。

getPointer()

getPointer() : resource

より高度な操作のために、このインスタンスのファイルポインタを取得します。

Returns

resource

lock()

lock( $exclusion) : boolean

ファイルをロックします。<br> 成功した場合にTRUEを、失敗した場合はFALSEを返します。

Parameters

$exclusion

Returns

boolean

unlock()

unlock() : \CodeLapse\{boolean}

ファイルのロックを解除します。<br> 成功した場合にTRUEを、失敗した場合はFALSEを返します。

Returns

\CodeLapse\{boolean}

getFilename()

getFilename() : \CodeLapse\{string}

このインスタンスが担当しているファイルの名前を取得します。

Returns

\CodeLapse\{string}

clearContents()

clearContents() : boolean

ファイルの内容をすべて消去します。

Returns

boolean —

成功した場合に TRUE を、失敗した場合に FALSE を返します。

putContents()

putContents( $string) : boolean

ファイルにテキストを出力します。<br> （それまでのファイルの内容は削除されます。）

Parameters

$string

Returns

boolean —

成功時に TRUEを、失敗した時に FALSEを返します。

getContents()

getContents(integer $offset, integer $maxlen) : mixed

ファイルの内容をテキストとして取得します。

Parameters

integer $offset

読み込みを開始するオフセット位置
integer $maxlen

読み込むデータの最大バイト数

Returns

mixed —

読み込んだデータを返します。失敗した場合に FALSE を返します。

getContentsAsArray()

getContentsAsArray(boolean $rmNl, integer $offset, integer $maxlen) : mixed

ファイルの内容を一行ごとに分割した配列として取得します。

Parameters

boolean $rmNl

trueを指定されると行末の改行コードを除去します。
integer $offset

読み込みを開始するオフセット位置
integer $maxlen

読み込むデータの最大バイト数

Returns

mixed —

読み込んだデータを返します。失敗した場合に FALSE を返します。

write()

write(string $string, integer $length) : mixed

ファイルにテキストを書き込みます。

Parameters

string $string

書き込む文字列
integer $length

書き込む長さ

Returns

mixed —

成功した時に書き込んだバイト数、失敗時に FALSE を返します

append()

append(string $string, integer $length, boolean $seektoend)

ファイルにテキストを追記します。

Parameters

string $string

書き込む文字列
integer $length

書き込む長さ
boolean $seektoend

TRUE が指定された場合、ファイルポインタをファイルの終端に移動します。

readline()

readline(integer $length) : mixed

ファイルから一行取得します。

Parameters

integer $length

最大の読み出し長

Returns

mixed —

読み込みに成功した時に行の内容を、失敗した時にFALSEを返します。

tell()

tell() : mixed

現在のファイルポインタの位置を取得します。

Returns

mixed —

ファイルポインタの位置を整数値で返します。エラーが起こった場合 FALSE を返します。

getPosition()

getPosition() : mixed

tellメソッドの別名

Returns

mixed —

ファイルポインタの位置を整数値で返します。エラーが起こった場合 FALSE を返します。

seek()

seek(integer $offset, integer $whence) : boolean

ファイルポインタを移動します。 (http://www.php.net/manual/ja/function.fseek.php)

whenceの値について

  • whence の値は以下のようになります。
  • File::SEEK_SET - 位置を offset バイト目に設定する
  • File::SEEK_ADD - 現在の位置に offset を加えた位置に設定する

  • File::SEEK_END - ファイル終端に offset を加えた位置に設定する

  • ファイルの終端から数えた位置に移動するには、$whenceを File::SEEK_END として、負の値をoffsetに渡す方法があります。

Parameters

integer $offset

ファイルポインタの位置。
integer $whence

ファイルポインタの位置の計算方法。

Returns

boolean —

成功すると TRUE を返し、そうでなければ FALSE を返します。

setPosition()

setPosition(integer $offset, integer $whence) : boolean

seekメソッドの別名

Parameters

integer $offset

ファイルポインタの位置。
integer $whence

ファイルポインタの位置の計算方法。

Returns

boolean —

成功すると TRUE を返し、そうでなければ FALSE を返します。

rewind()

rewind() : boolean

ファイルポインタをファイルの先頭へ移動します。

Returns

boolean —

成功すると TRUE を返し、そうでなければ FALSE を返します。

isEnd()

isEnd() : boolean

ファイルポインタがファイル終端に達しているかどうかを調べます。

Returns

boolean