\tomk79\pickles2\multithemetemplate_utility

Pickles2 Multi Theme template utility class

Summary

Methods
Properties
Constants
__construct()
get_option()
get_layout()
get_attr_bowl_name_by()
mk_global_menu()
mk_shoulder_menu()
mk_sub_menu()
mk_megafooter_menu()
mk_breadcrumb()
files()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$px
$multitheme
N/A

Properties

$px

$px : 

Picklesオブジェクト

Type

$multitheme

$multitheme : 

px2-multithemeオブジェクト

Type

Methods

__construct()

__construct(object  $px, object  $multitheme) 

constructor

Parameters

object $px

Picklesオブジェクト

object $multitheme

px2-multithemeオブジェクト

get_option()

get_option(string  $key) 

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

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

Parameters

string $key

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

get_layout()

get_layout() 

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

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

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

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

get_attr_bowl_name_by()

get_attr_bowl_name_by() : string

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

このメソッドが返す値は、 テーマのコンテンツエリアを囲うラッパー要素にセットされるべき、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編集機能が、テーマの画面から編集可能領域を探しだすために利用します。

Returns

string —

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

mk_global_menu()

mk_global_menu() : string

グローバルメニューを自動生成する

サイトマップCSVに登録されたページの一覧から、グローバルメニューを自動生成し、HTMLコードを返します。

対象となるページの一覧は、 $px->site()->get_global_menu() から取得します。

Returns

string —

HTMLコード

mk_shoulder_menu()

mk_shoulder_menu() : string

ショルダーメニューを自動生成する

サイトマップCSVに登録されたページの一覧から、ショルダーメニューを自動生成し、HTMLコードを返します。

対象となるページの一覧は、 $px->site()->get_shoulder_menu() から取得します。

Returns

string —

HTMLコード

mk_sub_menu()

mk_sub_menu(string  $parent_page_id) : string

指定されたページの子階層のメニューを展開する

主にローカルナビゲーションを生成する用途を想定したメソッドです。 $parent_page_id に与えられたページを頂点として、ページの階層構造を HTML化して生成します。 カレントページの直系の祖先にあたる階層は、子階層が開かれた状態で生成され、直系に当たらない階層は隠されます。

Parameters

string $parent_page_id

親ページのページID

Returns

string —

ページリストのHTMLコード

mk_megafooter_menu()

mk_megafooter_menu() : string

メガフッターメニューを自動生成する

メガフッターに表示する項目として、グローバルメニューの一覧と、その子階層までの一覧を構造化し、HTMLコードとして生成します。

Returns

string —

メガフッターのHTMLコード

mk_breadcrumb()

mk_breadcrumb() : string

パンくずを自動生成する

このメソッドは、パンくずリストのHTMLコードを生成して返します。 祖先ページは aタグ で囲われ、カレントページは aタグの代わりに spanタグ で囲われます。

Returns

string —

パンくずのHTMLコード

files()

files(string  $path_resource) : string

テーマリソースへのパスを取得する

Parameters

string $path_resource

theme_files をルートとしたリソースのパス

Returns

string —

リソースへの実際のパス