pickles2/px2-multitheme 2.1.1 API Document

theme

Pickles2 Multi Theme CORE class

Table of Contents

$conf  : mixed
px2-multithemeの設定情報
$cookie_theme_switch  : mixed
テーマ名を格納するクッキー名
$page  : mixed
カレントページの情報
$param_layout_switch  : mixed
レイアウトスイッチ名
$param_theme_switch  : mixed
テーマスイッチ名
$path_theme_dir  : mixed
テーマディレクトリのパス
$px  : mixed
Picklesオブジェクト
$theme_collection  : mixed
テーマコレクション
$theme_id  : mixed
選択されるテーマID
$theme_options  : mixed
テーマのコンフィグオプション
__construct()  : mixed
constructor
exec()  : mixed
entry method
get_attr_bowl_name_by()  : string
$conf->attr_bowl_name_by 設定の値を受け取る
get_layout()  : string
選択されたレイアウト名を取得する
get_option()  : mixed
テーマごとのオプションを取得する
get_theme_id()  : string
選択されたテーマIDを取得する
is_valid_theme_id()  : bool
テーマIDとして有効な文字列か検証する
mk_theme_collection()  : array<string|int, mixed>
テーマコレクションを作成する
auto_select_theme()  : mixed
auto select theme
bind()  : string
bind content to theme
find_layout_realpath()  : string
レイアウトを選択し、ファイルのパスを取得する
get_composer_root_dir()  : string
composer のルートディレクトリのパスを取得する

Properties

$conf

px2-multithemeの設定情報

private mixed $conf

$cookie_theme_switch

テーマ名を格納するクッキー名

private mixed $cookie_theme_switch = 'THEME'

$page

カレントページの情報

private mixed $page

$param_layout_switch

レイアウトスイッチ名

private mixed $param_layout_switch = 'LAYOUT'

$param_theme_switch

テーマスイッチ名

private mixed $param_theme_switch = 'THEME'

$path_theme_dir

テーマディレクトリのパス

private mixed $path_theme_dir

$px

Picklesオブジェクト

private mixed $px

$theme_collection

テーマコレクション

private mixed $theme_collection

$theme_id

選択されるテーマID

private mixed $theme_id = 'default'

$theme_options

テーマのコンフィグオプション

private mixed $theme_options

Methods

__construct()

constructor

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

Picklesオブジェクト

$options : object = null

プラグイン設定

Return values
mixed —

exec()

entry method

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

Picklesオブジェクト

$options : object = null

プラグイン設定

Return values
mixed —

get_attr_bowl_name_by()

$conf->attr_bowl_name_by 設定の値を受け取る

public get_attr_bowl_name_by() : string

このメソッドが返す値は、 テーマのコンテンツエリアを囲うラッパー要素にセットされるべき、bowl名を格納するための属性名です。 デフォルトは data-contents-area ですが、コンフィグオプションで変更することができます。

bowl main は次のように実装します。

<div class="contents" <?= htmlspecialchars($theme->get_attr_bowl_name_by())?>="main">
	 <?= $px->bowl()->pull() ?>
</div>

独自の名前 hoge という bowl を作るには、次のように実装します。

<div class="contents" <?= htmlspecialchars($theme->get_attr_bowl_name_by())?>="hoge">
	 <?= $px->bowl()->pull('hoge') ?>
</div>

この値は、 Pickles 2 Desktop Tool のGUI編集機能が、テーマの画面から編集可能領域を探しだすために利用します。

Return values
string —

bowl名を格納するための属性名

get_layout()

選択されたレイアウト名を取得する

public get_layout() : string

レイアウトは、Pickles 2 のサイトマップCSVの layout 列に指定すると選択できます。

layout列には、拡張子を含まない値を指定してください。 レイアウト hoge.html を選択したい場合、 layout列には hoge と入力します。

layout列が空白の場合、 default.html が選択されます。

Return values
string —

レイアウト名

get_option()

テーマごとのオプションを取得する

public get_option(string $key) : mixed

コンフィグオプションに指定されたテーマ別設定の値を取り出します。

Parameters
$key : string

取り出したいオプションのキー

Return values
mixed —

テーマのオプション

get_theme_id()

選択されたテーマIDを取得する

public get_theme_id() : string
Return values
string —

Theme ID

is_valid_theme_id()

テーマIDとして有効な文字列か検証する

public is_valid_theme_id(string $theme_id) : bool
Parameters
$theme_id : string

検証対象のテーマID

Return values
bool —

有効なら true, 無効なら false

mk_theme_collection()

テーマコレクションを作成する

public mk_theme_collection() : array<string|int, mixed>

テーマコレクションディレクトリおよびvendorディレクトリを検索し、 選択可能なテーマの一覧を生成します。

Return values
array<string|int, mixed> —

テーマコレクション

auto_select_theme()

auto select theme

private auto_select_theme() : mixed
Return values
mixed —

bind()

bind content to theme

private bind(object $px) : string
Parameters
$px : object

Picklesオブジェクト

Return values
string —

テーマを実行した結果のHTMLコード

find_layout_realpath()

レイアウトを選択し、ファイルのパスを取得する

private find_layout_realpath() : string
  1. まず、パラメータ LAYOUT が指定されていて、かつレイアウトファイルが存在したら それが最優先。
  2. 次に、ページに layout 列が指定されていて、かつレイアウトファイルが存在したら それを採用。
  3. 次に、固定文字列 'default' でレイアウトファイルを探し、存在したらそれを採用。
  4. どれも該当がなければ、 固定レイアウト './default/default.html' を採用する。
Return values
string —

レイアウトファイルのパス

get_composer_root_dir()

composer のルートディレクトリのパスを取得する

private get_composer_root_dir() : string
Return values
string —

vendorディレクトリの絶対パス

Search results