Pickles Framework v2.1.19 API Document

bowl
in package

Bowl

Pickles 2 のコアオブジェクトの1つ $bowl のオブジェクトクラスです。 このオブジェクトは、Pickles 2 の初期化処理の中で自動的に生成され、$px の内部に格納されます。

メソッド $px->bowl() を通じてアクセスします。

Tags
author

Tomoya Koyanagi tomk79@gmail.com

Table of Contents

$contents_bowl  : mixed
コンテンツボウル
__construct()  : mixed
Constructor
each()  : object
全ボウルのコンテンツに同じ加工を施す。
get()  : mixed
コンテンツボウルからコンテンツの複製を取り出す。
get_clean()  : mixed
コンテンツボウルからコンテンツを取り出す。
get_keys()  : array<string|int, mixed>
コンテンツボウルにあるコンテンツの索引を取得する。
pull()  : mixed
コンテンツボウルからコンテンツを引き出す。(deprecated)
put()  : bool
コンテンツボウルにコンテンツを入れる。
replace()  : bool
コンテンツボウルのコンテンツを置き換える。
send()  : bool
コンテンツボウルにコンテンツを送る。 (deprecated)

Properties

$contents_bowl

コンテンツボウル

private mixed $contents_bowl = array()

Methods

__construct()

Constructor

public __construct() : mixed
Return values
mixed —

each()

全ボウルのコンテンツに同じ加工を施す。

public each(callable $func) : object
Parameters
$func : callable

加工処理関数

Return values
object —

$bowlオブジェクト

get()

コンテンツボウルからコンテンツの複製を取り出す。

public get([string $content_name = 'main' ]) : mixed

取り出したコンテンツは、ボウル内にも残ります。

Parameters
$content_name : string = 'main'

ボウルの格納名。(省略時 main)

Return values
mixed —

成功時、ボウルから得られたHTMLソースを返す。失敗時、false

get_clean()

コンテンツボウルからコンテンツを取り出す。

public get_clean([string $content_name = 'main' ]) : mixed

取り出したコンテンツは、ボウルから削除されます。

Parameters
$content_name : string = 'main'

ボウルの格納名。(省略時 main)

Return values
mixed —

成功時、ボウルから得られたHTMLソースを返す。失敗時、false

get_keys()

コンテンツボウルにあるコンテンツの索引を取得する。

public get_keys() : array<string|int, mixed>
Return values
array<string|int, mixed> —

ボウルのキーの一覧

pull()

コンテンツボウルからコンテンツを引き出す。(deprecated)

public pull([string $content_name = 'main' ]) : mixed

このメソッドは非推奨です。 代わりに $px->bowl()->get_clean() を使用してください。

Parameters
$content_name : string = 'main'

ボウルの格納名。(省略時 main)

Return values
mixed —

成功時、ボウルから得られたHTMLソースを返す。失敗時、false

put()

コンテンツボウルにコンテンツを入れる。

public put(string $src[, string $content_name = 'main' ]) : bool

ソースコードを $px オブジェクトに預けます。 このメソッドから預けられたコードは、同じ $content_name 値 をキーにして、 $px->bowl()->get() または $px->bowl()->get_clean() から引き出すことができます。

この機能は、コンテンツからテーマへコンテンツを渡すために使用されます。

同じ名前($content_name値)で複数回ソースを送った場合、後方に追記されます。

Parameters
$src : string

入れるHTMLソース

$content_name : string = 'main'

ボウルの格納名。(省略時 main) $px->bowl()->get() で取り出す際に使用する名称です。 任意の名称が利用できます。 Pickles 2 の標準状態では、 無名(空白文字列) = main = メインコンテンツ、 head = HEADセクション内コンテンツ(CSS等)、 foot = BODYセクション末尾コンテンツ(JavaScript等)、 の3種類が定義されています。

Return values
bool —

成功時 true、失敗時 false

replace()

コンテンツボウルのコンテンツを置き換える。

public replace(string $src[, string $content_name = 'main' ]) : bool

ソースコードを$pxオブジェクトに預けます。 $px->bowl()->put() と同じですが、複数回送信した場合に、このメソッドは追記ではなく上書きする点が異なります。

Parameters
$src : string

送るHTMLソース

$content_name : string = 'main'

ボウルの格納名。(省略時 'main') $px->bowl()->get_clean() から取り出す際に使用する名称です。 任意の名称が利用できます。PxFWの標準状態では、無名(空白文字列) = メインコンテンツ、'head' = ヘッダー内コンテンツ の2種類が定義されています。

Return values
bool —

成功時 true、失敗時 false

send()

コンテンツボウルにコンテンツを送る。 (deprecated)

public send(string $src[, string $content_name = 'main' ]) : bool

このメソッドは非推奨です。 代わりに、 $px->bowl()->put() を使用してください。

Parameters
$src : string

入れるHTMLソース

$content_name : string = 'main'

ボウルの格納名。(省略時 main) $px->bowl()->get() で取り出す際に使用する名称です。 任意の名称が利用できます。 Pickles 2 の標準状態では、 無名(空白文字列) = main = メインコンテンツ、 head = HEADセクション内コンテンツ(CSS等)、 foot = BODYセクション末尾コンテンツ(JavaScript等)、 の3種類が定義されています。

Return values
bool —

成功時 true、失敗時 false

Search results