ArrayPath
in package
Table of Contents
Properties
- $currentIndex : int
- $minCurrentIndex : int
- $paths : array<string|int, string>
- $separator : string
Methods
- down() : bool
- 現在位置から1つ下の階層に移動します
- getCurrentIndex() : int
- 現在位置の階層を取得します
- getPaths() : array<string|int, string>
- 配列の階層情報を取得します。
- setCurrentPath() : bool
- key名を設定します
- toArray() : array<string|int, string>
- 文字列形式の階層表現を配列形式に変換します
- toString() : string
- 配列形式の階層表現を文字列形式に変換します
- up() : bool
- 現在位置から1つ上の階層に移動します
Properties
$currentIndex
private
int
$currentIndex
= 0
階層の深さ
$minCurrentIndex
private
int
$minCurrentIndex
= 0
$paths
private
array<string|int, string>
$paths
= []
$separator
private
static string
$separator
= '.'
Methods
down()
現在位置から1つ下の階層に移動します
public
down() : bool
Return values
bool —常にtrueを返します
getCurrentIndex()
現在位置の階層を取得します
public
getCurrentIndex() : int
Return values
int —現在位置の階層を返します
getPaths()
配列の階層情報を取得します。
public
getPaths() : array<string|int, string>
Return values
array<string|int, string> —配列の階層情報を返します
setCurrentPath()
key名を設定します
public
setCurrentPath(string $name) : bool
Parameters
- $name : string
-
key名を渡します
Return values
bool —成功した場合はtrueを、それ以外の場合はfalseを返します
toArray()
文字列形式の階層表現を配列形式に変換します
public
static toArray(string $path) : array<string|int, string>
Parameters
- $path : string
-
文字列形式の階層表現文字列を渡します
Return values
array<string|int, string> —配列形式の階層表現配列を返します
toString()
配列形式の階層表現を文字列形式に変換します
public
static toString(array<string|int, string> $paths) : string
Parameters
- $paths : array<string|int, string>
-
配列形式の階層表現配列を渡します
Return values
string —文字列形式の階層表現文字列を返します
up()
現在位置から1つ上の階層に移動します
public
up() : bool
Return values
bool —成功した場合はtrueを、それ以外の場合はfalseを返します