Pickles Framework v2.1.19 API Document

clearcache
in package

PX Commands "clearcache"

PX=clearcache
Pickles Framework 2 が生成したキャッシュファイルを削除します。
PX=clearcache.version
Pickles Framework のバージョン番号を JSON 形式の文字列で返します。

Table of Contents

$path_docroot  : mixed
ディレクトリ設定
$path_homedir  : mixed
ディレクトリ設定
$path_lockfile  : mixed
パブリッシュロックファイルのパス
$path_public_caches  : mixed
ディレクトリ設定
$px  : mixed
Picklesオブジェクト
__construct()  : mixed
constructor
exec()  : mixed
execution: clearcache 外部から直接呼び出すときはこちら。
register()  : mixed
Starting function
cleanup_dir()  : mixed
ディレクトリをクリーニング
is_publish_locked()  : bool
パブリッシュがロックされているか確認する。
kick()  : mixed
kick

Properties

$path_docroot

ディレクトリ設定

private mixed $path_docroot

$path_homedir

ディレクトリ設定

private mixed $path_homedir

$path_lockfile

パブリッシュロックファイルのパス

private mixed $path_lockfile

$path_public_caches

ディレクトリ設定

private mixed $path_public_caches

Methods

__construct()

constructor

public __construct(object $px) : mixed
Parameters
$px : object

Picklesオブジェクト

Return values
mixed

exec()

execution: clearcache 外部から直接呼び出すときはこちら。

public exec() : mixed
Return values
mixed

register()

Starting function

public static register([object $px = null ][, object $options = null ]) : mixed
Parameters
$px : object = null

Picklesオブジェクト

$options : object = null

プラグイン設定

Return values
mixed

cleanup_dir()

ディレクトリをクリーニング

private cleanup_dir(string $path[, string $localpath = null ]) : mixed
Parameters
$path : string

クリーニング対象のパス

$localpath : string = null

$pathの仮想のパス (再帰処理のために使用)

Return values
mixed

is_publish_locked()

パブリッシュがロックされているか確認する。

private is_publish_locked() : bool
Return values
bool

ロック中の場合に true、それ以外の場合に false を返します。

kick()

kick

private kick() : mixed
Return values
mixed

Search results