Pickles Framework v2.1.19 API Document

publish
in package

PX Commands "publish"

PX=publish
パブリッシュのホーム画面を表示します。
PX=publish.run
パブリッシュを実行します。
PX=publish.version
Pickles Framework のバージョン番号を JSON 形式の文字列で返します。

Table of Contents

$domain  : mixed
ドメイン設定
$flg_keep_cache  : mixed
キャッシュを消去しないフラグ
$path_controot  : mixed
パス設定
$path_lockfile  : mixed
ロックファイルの格納パス
$path_publish_dir  : mixed
パス設定
$path_tmp_publish  : mixed
パス設定
$paths_done  : mixed
処理済みのパス一覧
$paths_ignore  : mixed
パブリッシュ対象外範囲設定
$paths_queue  : mixed
処理待ちのパス一覧
$paths_region  : mixed
パブリッシュ範囲設定
$plugin_conf  : mixed
プラグイン設定
$preg_exts  : mixed
Extension をマッチさせる正規表現
$px  : mixed
Picklesオブジェクト
__construct()  : mixed
constructor
exec_home()  : mixed
execute home
register()  : mixed
Before content function
add_queue()  : bool
add queue
alert_log()  : bool
パブリッシュアラートログ
cleanup_tmp_publish_dir()  : mixed
一時パブリッシュディレクトリをクリーニング
clearcache()  : mixed
clearcache
cli_footer()  : mixed
print CLI footer
cli_header()  : mixed
print CLI header
cli_report()  : mixed
report
exec_publish()  : mixed
execute publish
get_path_publish_dir()  : mixed
パブリッシュ先ディレクトリを取得
get_region_root_path()  : string
パブリッシュ範囲のルートパスを得る
is_ignore_path()  : bool
パブリッシュ対象か調べる
is_locked()  : bool
パブリッシュがロックされているか確認する。
is_region_path()  : bool
パブリッシュ範囲内か調べる
lock()  : bool
パブリッシュをロックする。
log()  : bool
パブリッシュログ
make_list_by_dir_scan()  : bool
make list by directory scan
make_list_by_sitemap()  : bool
make list by sitemap
sync_dir()  : bool
ディレクトリを同期する。
sync_dir_compare_and_cleanup()  : bool
ディレクトリの内部を比較し、$comparisonに含まれない要素を$targetから削除する。
sync_dir_copy_r()  : bool
ディレクトリを複製する(下層ディレクトリも全てコピー)
touch_lockfile()  : bool
パブリッシュロックファイルの更新日を更新する。
unlock()  : bool
パブリッシュロックを解除する。
validate()  : mixed
validate

Properties

$domain

ドメイン設定

private mixed $domain

$flg_keep_cache

キャッシュを消去しないフラグ

private mixed $flg_keep_cache = false

$path_controot

パス設定

private mixed $path_controot

$path_lockfile

ロックファイルの格納パス

private mixed $path_lockfile

$path_publish_dir

パス設定

private mixed $path_publish_dir

$path_tmp_publish

パス設定

private mixed $path_tmp_publish

$paths_done

処理済みのパス一覧

private mixed $paths_done = array()

$paths_ignore

パブリッシュ対象外範囲設定

private mixed $paths_ignore = array()

$paths_queue

処理待ちのパス一覧

private mixed $paths_queue = array()

$paths_region

パブリッシュ範囲設定

private mixed $paths_region = array()

$plugin_conf

プラグイン設定

private mixed $plugin_conf

$preg_exts

Extension をマッチさせる正規表現

private mixed $preg_exts

$px

Picklesオブジェクト

private mixed $px

Methods

__construct()

constructor

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

Picklesオブジェクト

$options : object

プラグイン設定

Return values
mixed —

exec_home()

execute home

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

Picklesオブジェクト

Return values
mixed —

register()

Before content function

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

Picklesオブジェクト

$options : object = null

プラグイン設定

{
	"paths_ignore": [
		// パブリッシュ対象から常に除外するパスを設定する。
		// (ここに設定されたパスは、動的なプレビューは可能)
		"/sample_pages/no_publish/*"
	]
}
Return values
mixed —

add_queue()

add queue

private add_queue(string $path) : bool
Parameters
$path : string

対象のパス

Return values
bool —

真偽

alert_log()

パブリッシュアラートログ

private alert_log(array<string|int, mixed> $row) : bool
Parameters
$row : array<string|int, mixed>

ログデータ

Return values
bool —

ログ書き込みの成否

cleanup_tmp_publish_dir()

一時パブリッシュディレクトリをクリーニング

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

クリーニング対象のパス

$localpath : string = null

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

Return values
mixed —

clearcache()

clearcache

private clearcache() : mixed
Return values
mixed —

cli_footer()

print CLI footer

private cli_footer() : mixed
Return values
mixed —

cli_header()

print CLI header

private cli_header() : mixed
Return values
mixed —

cli_report()

report

private cli_report() : mixed
Return values
mixed —

exec_publish()

execute publish

private exec_publish(object $px) : mixed
Parameters
$px : object

Picklesオブジェクト

Return values
mixed —

get_path_publish_dir()

パブリッシュ先ディレクトリを取得

private get_path_publish_dir() : mixed
Return values
mixed —

get_region_root_path()

パブリッシュ範囲のルートパスを得る

private get_region_root_path() : string
Return values
string —

パブリッシュ範囲のルートパス

is_ignore_path()

パブリッシュ対象か調べる

private is_ignore_path(string $path) : bool
Parameters
$path : string

対象のパス

Return values
bool —

真偽

is_locked()

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

private is_locked() : bool
Return values
bool —

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

is_region_path()

パブリッシュ範囲内か調べる

private is_region_path(string $path) : bool
Parameters
$path : string

対象のパス

Return values
bool —

真偽

lock()

パブリッシュをロックする。

private lock() : bool
Return values
bool —

ロック成功時に true、失敗時に false を返します。

log()

パブリッシュログ

private log(array<string|int, mixed> $row) : bool
Parameters
$row : array<string|int, mixed>

ログデータ

Return values
bool —

ログ書き込みの成否

make_list_by_dir_scan()

make list by directory scan

private make_list_by_dir_scan([string $path = null ]) : bool
Parameters
$path : string = null

ファイル または ディレクトリ のパス

Return values
bool —

常に真

make_list_by_sitemap()

make list by sitemap

private make_list_by_sitemap() : bool
Return values
bool —

常に true を返します。

sync_dir()

ディレクトリを同期する。

private sync_dir(string $path_sync_from, string $path_sync_to, string $path_region) : bool
Parameters
$path_sync_from : string

同期元のルートディレクトリ

$path_sync_to : string

同期先のルートディレクトリ

$path_region : string

ルート以下のパス

Return values
bool —

常に true を返します。

sync_dir_compare_and_cleanup()

ディレクトリの内部を比較し、$comparisonに含まれない要素を$targetから削除する。

private sync_dir_compare_and_cleanup(string $target, string $comparison, string $path_region) : bool

ただし、ignore指定されているパスに対しては操作を行わない。

Parameters
$target : string

クリーニング対象のディレクトリパス

$comparison : string

比較するディレクトリのパス

$path_region : string

ルート以下のパス

Return values
bool —

成功時 true、失敗時 false を返します。

sync_dir_copy_r()

ディレクトリを複製する(下層ディレクトリも全てコピー)

private sync_dir_copy_r(string $from, string $to, string $path_region[, int $perm = null ]) : bool

ただし、ignore指定されているパスに対しては操作を行わない。

Parameters
$from : string

コピー元ファイルのパス

$to : string

コピー先のパス

$path_region : string

ルート以下のパス

$perm : int = null

保存するファイルに与えるパーミッション

Return values
bool —

成功時に true、失敗時に false を返します。

touch_lockfile()

パブリッシュロックファイルの更新日を更新する。

private touch_lockfile() : bool
Return values
bool —

成功時に true、失敗時に false を返します。

unlock()

パブリッシュロックを解除する。

private unlock() : bool
Return values
bool —

ロック解除成功時に true、失敗時に false を返します。

validate()

validate

private validate() : mixed
Return values
mixed —

Search results