API Documentation
\

\BEAR_Pager

ページャー

データを分割して表示するページャークラスです。

Summary

Methods
Properties
Constants
__construct()
onInject()
setConfig()
getConfig()
setService()
getPagerOptions()
makePager()
makeLinks()
setOption()
setOptions()
getResult()
getLinks()
setPagerLinks()
$pager
$optionsPc
$optionsMobile
PAGER_NUM
PAGER_CLASS
_exception()
$_config
N/A
No private methods found
$_options
$_pagerResult
$_links
N/A

Constants

PAGER_NUM

PAGER_NUM

ページャーキー

PAGER_CLASS

PAGER_CLASS

ページャーCSSクラス

Properties

$pager

$pager : \PEAR:pager

PEARページャークラス

Type

\PEAR:pager

$optionsPc

$optionsPc : array

PC用ページャーオプション

Type

array

$optionsMobile

$optionsMobile : array

モバイル用ページャーオプション

Type

array

$_config

$_config : array

Class config

Type

array

$_options

$_options : array

ページャーオプション

Type

array

$_pagerResult

$_pagerResult : array

ページャーでスライスされたビュー

Type

array

$_links

$_links : string

ページャーリンクHTML

Type

string

Methods

__construct()

__construct(array  $config)

Constructor

エージェントに応じて（PC,携帯）ページャーオプションを変えます。

Parameters

array $config

ユーザー設定値

onInject()

onInject() : void

Inject

設定にしたがってサービスをインジェクトします。

setConfig()

setConfig(mixed  $config, mixed  $values = null) : self

Set config

Parameters

mixed $config

(string) 設定キー | (array) 設定配列
mixed $values

(string) $configの時の設定値

Returns

self

getConfig()

getConfig(string  $key = null) : mixed

Get config

Parameters

string $key

設定キー、指定なければ全ての設定を取得

Returns

mixed

setService()

setService(string  $name, mixed  $service) : void

Set service

Parameters

string $name

サービスキー
mixed $service

サービス

getPagerOptions()

getPagerOptions() : array

ページャーオプションの取得

Returns

array

makePager()

makePager(array  $view) : void

ページング

ページング処理します。 ページングされた結果とページナビゲーションHTMLの生成をプロパティに保持します。

Parameters

array $view

ページングするデータアイテム

makeLinks()

makeLinks(string  $delta, string  $totalItems) : array

ページングリンク生成

データをページングしないでリンクのみ生成します

Parameters

string $delta

デルタオプション
string $totalItems

トータルアイテム数

Returns

array —

リンク

setOption()

setOption(string  $key, string  $option) : void

ページャーオプションの設定

オプションを１つ設定します。

Parameters

string $key

オプションキ-
string $option

オプション値

setOptions()

setOptions(array  $options) : void

ページャーオプション設定

ページャーのオプションを連想配列で指定します。

Parameters

array $options

オプション

getResult()

getResult() : array

ページング結果の取得

ページングされた結果の取得を行います。

Returns

array —

ページングされた結果

getLinks()

getLinks(mixed  $links = false) : array

ナビゲートリンクの取得

ページのナビゲートHTMLを取得します。
エージェントに応じたHTMLを生成し、携帯の場合はアクセスキーが利用できます。

Parameters

mixed $links

false | リンクHTML配列

Returns

array —

ナビゲートリンクHTML

setPagerLinks()

setPagerLinks(array  $links, array  $info) : \BEAR_Pager

ページャーリンクの登録

ページャーリンクのHTMLとメタ情報を'pager'というキーでサービスに登録します。 登録済みの場合は何もしません。

Parameters

array $links
array $info

Returns

\BEAR_Pager

_exception()

_exception(string  $msg, array  $config = array()) : \BEAR_Exception

例外の作成

Parameters

string $msg

例外メッセージ
array $config

例外config

Returns

\BEAR_Exception