document_modules
in package
document_modules.php
Table of Contents
- $main : mixed
- px2dthelper main
- $px : mixed
- Picklesオブジェクト
- __construct() : mixed
- constructor
- build_css() : string
- ドキュメントモジュール定義のスタイルシートを統合する
- build_js() : string
- ドキュメントモジュール定義のJavaScriptコードを統合する
- build_theme_css() : string
- テーマが定義するドキュメントモジュール定義のスタイルシートを統合する
- build_theme_js() : string
- テーマが定義するドキュメントモジュール定義のJavaScriptコードを統合する
- load() : string
- ドキュメントモジュール定義をロードする
- build_css_resources() : string
- CSSリソースをビルドする
- build_css_src() : string
- CSSソースをビルドする
- build_js_src() : string
- JSソースをビルドする
- is_cache() : bool
- キャッシュが読み込み可能か調べる。
- save_cache() : bool
- 結果をキャッシュに保存する。
Properties
$main
px2dthelper main
private
mixed
$main
$px
Picklesオブジェクト
private
mixed
$px
Methods
__construct()
constructor
public
__construct(object $px, object $main) : mixed
Parameters
- $px : object
-
$pxオブジェクト
- $main : object
-
main.php のインスタンス
Return values
mixed —build_css()
ドキュメントモジュール定義のスタイルシートを統合する
public
build_css() : string
モジュール定義の情報から、スタイルシートを生成します。
$conf->plugins->px2dt->paths_module_template および $conf->plugins->px2dt->path_module_templates_dir を参照します。
スタイルシートファイル(例: /common/styles/contents.css など)に、下記のようにコードを記述します。
<?php
print (new \tomk79\pickles2\px2dthelper\main($px))->document_modules()->build_css();
?>
Return values
string —CSSコード
build_js()
ドキュメントモジュール定義のJavaScriptコードを統合する
public
build_js() : string
モジュール定義の情報から、JavaScriptコードを生成します。
$conf->plugins->px2dt->paths_module_template および $conf->plugins->px2dt->path_module_templates_dir を参照します。
スクリプトファイル(例: /common/scripts/contents.js など)に、下記のようにコードを記述します。
<?php
print (new \tomk79\pickles2\px2dthelper\main($px))->document_modules()->build_js();
?>
Return values
string —JavaScriptコード
build_theme_css()
テーマが定義するドキュメントモジュール定義のスタイルシートを統合する
public
build_theme_css(string $theme_id) : string
Parameters
- $theme_id : string
-
テーマID
Return values
string —CSSコード
build_theme_js()
テーマが定義するドキュメントモジュール定義のJavaScriptコードを統合する
public
build_theme_js(string $theme_id) : string
Parameters
- $theme_id : string
-
テーマID
Return values
string —JavaScriptコード
load()
ドキュメントモジュール定義をロードする
public
load() : string
モジュール定義の情報から、スタイルシートとJavaScriptコードを生成します。
HTMLのheadセクション内に、下記のようにコードを記述します。
<?php
print (new \tomk79\pickles2\px2dthelper\main($px))->document_modules()->load();
?>
Return values
string —HTMLコード(styleタグ、およびscriptタグ)
build_css_resources()
CSSリソースをビルドする
private
build_css_resources(string $path, string $bin) : string
Parameters
- $path : string
-
CSSファイルのパス
- $bin : string
-
ビルド前のCSSコード
Return values
string —CSSコード
build_css_src()
CSSソースをビルドする
private
build_css_src(array<string|int, mixed> $array_files) : string
Parameters
- $array_files : array<string|int, mixed>
-
パッケージIDをキーにCSSファイルを格納した連想配列
Return values
string —ビルドされたCSSソース
build_js_src()
JSソースをビルドする
private
build_js_src(array<string|int, mixed> $array_files) : string
Parameters
- $array_files : array<string|int, mixed>
-
パッケージIDをキーにJSファイルを格納した連想配列
Return values
string —ビルドされたJSソース
is_cache()
キャッシュが読み込み可能か調べる。
private
is_cache(string $ext, int $newest_timestamp[, mixed $theme_id = null ]) : bool
Parameters
- $ext : string
-
対象の拡張子 (
css,js) - $newest_timestamp : int
-
対象ファイル中最新の更新日時
- $theme_id : mixed = null
Return values
bool —読み込み可能な場合に true、読み込みできない場合に false を返します。
save_cache()
結果をキャッシュに保存する。
private
save_cache(string $content, string $ext[, mixed $theme_id = null ]) : bool
Parameters
- $content : string
-
キャッシュの内容
- $ext : string
-
対象の拡張子 (
css,js) - $theme_id : mixed = null
Return values
bool —読み込み可能な場合に true、読み込みできない場合に false を返します。