BcBaserHelper

テーマより利用される事を前提としたヘルパーで、テーマで必要となる機能をひと通り提供する。
package Baser.View.Helper

 Methods

PluginBaserHelper 用マジックメソッド

__call(string $method, array $params) : mixed
BcBaserHelper に存在しないメソッドが呼ばれた際、プラグインで定義された PluginBaserHelper のメソッドを呼び出す call__ から __call へメソット名を変更、Helper の __call をオーバーライド

Parameters

$method

string

メソッド名

$params

array

引数

Returns

mixedPluginBaserHelper の戻り値

コンストラクタ

__construct(\View $View, array $settings = array()

Parameters

$View

\View

ビュークラス

$settings

array

ヘルパ設定値(BcBaserHelper では利用していない)

Constructor.

__construct(\View $View, $settings = array()) : void
access public

Parameters

$View

$settings

コンテンツメニューにおいてフォルダ内の index ページを除外する

_unsetIndexInContentsMenu(array $contents, bool $children = false) : mixed

Parameters

$contents

array

コンテンツデータ

$children

bool

子かどうか

Returns

mixedコンテンツデータ

パンくずリストの要素を追加する

addCrumb(string $name, string $link = null, mixed $options = array()) : void
デフォルトでアクセス制限がかかっているリンクの場合でもタイトルを表示する $options の forceTitle キー に false を指定する事で表示しない設定も可能

Parameters

$name

string

パンくず用のテキスト

$link

string

パンくず用のリンク(初期値 : null)※ 指定しない場合はリンクは設定しない

$options

mixed

リンクタグ用の属性(初期値 : array()) ※ パラメータについては、HtmlHelper::link() を参照。

afterLayout

afterLayout(\type $layoutFile) 

Parameters

$layoutFile

\type

After Render

afterRender(string $viewFile) 

Parameters

$viewFile

string

ベースとなるURLを出力する

baseUrl() : void
サブフォルダやスマートURLについて考慮されている事が前提

ブラウザにキャッシュさせる為のヘッダーを出力する

cacheHeader(string|int|float $expire = null, string $type = 'html') : void

Parameters

$expire

stringintfloat

キャッシュの有効期間(初期値 : null) ※ 指定しない場合は、baserCMSコアのキャッシュ設定値

$type

string

どのタイプ(拡張子)に対してのキャッシュか(初期値 : 'html')

charset メタタグを出力する

charset(string $charset = null) : void
モバイルの場合は、強制的に文字コードを Shift-JIS に設定

Parameters

$charset

string

文字コード(初期値 : null)

アップデート処理が必要かチェックする

checkUpdate() : bool
todo 別のヘルパに移動する

Returns

boolアップデートが必要な場合は true を返す

コンテンツ本体を出力する

content() : void
レイアウトテンプレートで利用する

コンテンツメニューを出力する

contentsMenu(mixed $id = null, int $level = null, string $currentId = null) : string
ログインしていない場合はキャッシュする contents_menu エレメントで、HTMLカスタマイズ可能

Parameters

$id

mixed

コンテンツID(初期値:null)

$level

int

階層(初期値:null)※ null の場合は階層指定なし

$currentId

string

現在のページのコンテンツID(初期値:null)

Returns

stringコンテンツメニュー

コンテンツを特定する文字列を出力する

contentsName(bool $detail = false, array $options = array()) : void
URL を元に、第一階層までの文字列をキャメルケースで取得する ※ 利用例、出力例については BcBaserHelper::getContentsName() を参照

Parameters

$detail

bool

詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで出力する(初期値 : false)

$options

array

オプション(初期値 : array()) ※ オプションの詳細については、BcBaserHelper::getContentsName() を参照

コンテンツナビを出力する

contentsNavi(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

コンテンツのタイトルを出力する

contentsTitle() : void

コピーライト用の年を出力する

copyYear(int $begin) : void
《利用例》 $this->BcBaser->copyYear(2012) 《出力例》 2012 - 2014

Parameters

$begin

int

開始年

パンくずリストを出力する

crumbs(string $separator = '»', string|bool $startText = false, $onSchema = false) : void
事前に BcBaserHelper::addCrumb() にて、パンくず情報を追加しておく必要がある。 また、アクセス制限がかかっているリンクはテキストのみ表示する

Parameters

$separator

string

パンくずの区切り文字(初期値 : »)

$startText

stringbool

トップページを先頭に追加する場合にはトップページのテキストを指定する(初期値 : false)

$onSchema

パンくずリストを出力する

crumbsList(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

CSS タグを出力する

css(string $path, mixed $options = array()) : void
《利用例》 $this->BcBaser->css('admin/import')

Parameters

$path

string

CSSファイルのパス(css フォルダからの相対パス)拡張子は省略可

$options

mixed

オプション (配列の場合)

  • rel : rel属性(初期値 : 'stylesheet')
  • inline : コンテンツ内にCSSを出力するかどうか(初期値 : true) ※ その他のパラメータについては、HtmlHelper::css() を参照。 ※ false を指定した場合、inline が false となる。

イベントを発火

dispatchEvent(string $name, array $params = array(), $options = array()) : mixed

Parameters

$name

string

$params

array

$options

Returns

mixed

ドキュメントタイプを指定するタグを出力する

docType(string $type = 'xhtml-trans') : void

Parameters

$type

string

出力ドキュメントタイプの文字列(初期値 : 'xhtml-trans')

エレメントテンプレートを出力する

element(string $name, array $data = array(), array $options = array()) : void

Parameters

$name

string

エレメント名

$data

array

エレメントで参照するデータ

$options

array

オプションのパラメータ subDir (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照

セッションに保存したメッセージを出力する

flash(string $key = 'flash') : void
メールフォームのエラーメッセージ等を出力します。

Parameters

$key

string

出力するメッセージのキー(初期状態では省略してよいです)

ツールバーエレメントや CakePHP のデバッグ出力を表示

func() : void
利用する際は、 タグの直前あたりに記述する。

ベースとなるURLを取得する

getBaseUrl() : string
サブフォルダやスマートURLについて考慮されている事が前提

Returns

stringベースURL

Blogの基本情報を全て取得する

getBlogs(string $name = '', array $options = array()) : array

Parameters

$name

string

ブログアカウント名を指定するとそのブログのみの基本情報を返す。空指定(default)で、全てのブログの基本情報。 ex) 'news' (初期値 : '')

$options

array

オプション(初期値 :array())

  • sort : データのソート順 取得出来るフィールドのどれかでソートができる ex) 'created DESC'(初期値 : 'id')
    • siteId : サブサイトIDで絞り込む場合に指定する(初期値:0)

Returns

arrayサイト基本設定配列

コンテンツ作成日を取得

getContentCreatedDate($format = 'Y/m/d H:i') : null | string

Parameters

$format

Returns

nullstring

コンテンツ更新日を取得

getContentModifiedDate(string $format = 'Y/m/d H:i') : null | string

Parameters

$format

string

Returns

nullstring

メニューを出力する

getContentsMenu(mixed $id = null, int $level = null, string $currentId = null) : string
ログインしていない場合はキャッシュする contents_menu エレメントで、HTMLカスタマイズ可能

Parameters

$id

mixed

コンテンツID(初期値:null)

$level

int

階層(初期値:null)※ null の場合は階層指定なし

$currentId

string

現在のページのコンテンツID(初期値:null)

Returns

stringコンテンツメニュー

コンテンツを特定する文字列を取得する

getContentsName(bool $detail = false, array $options = array()) : string
URL を元に、第一階層までの文字列をキャメルケースで取得する 《利用例》 $this->BcBaser->contentsName() 《出力例》 - トップページの場合 : Home - about ページの場合 : About

Parameters

$detail

bool

詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで取得する(初期値 : false)

$options

array

オプション(初期値 : array())

  • home : トップページの場合に出力する文字列(初期値 : Home)
  • default : ルート直下の下層ページの場合に出力する文字列(初期値 : Default)
  • error : エラーページの場合に出力する文字列(初期値 : Error)
    • underscore : キャメルケースではなく、アンダースコア区切りで出力する(初期値 : false)

Returns

string

コンテンツタイトルを取得する

getContentsTitle() : string

Returns

stringコンテンツタイトル

パンくず用の配列を取得する

getCrumbs(mixed $categoryTitleOn = null) : array
基本的には、コントローラーの crumbs プロパティで設定した値を取得する仕様だが 事前に setCategoryTitle メソッドで出力内容をカスタマイズする事ができる
todo HTMLレンダリングも含めた状態で取得できる、HtmlHelper::getCrumbs() とメソッド名が 同じで、 処理内容がわかりにくいので変数名のリファクタリング要。 ただし、BcBaserHelper::getCrumbs() は、テーマで利用されている可能性が高いので、 後方互換を考慮する必要がある。

Parameters

$categoryTitleOn

mixed

親カテゴリの階層を表示するかどうか

Returns

arrayパンくず用の配列

現在のコンテンツ情報を取得する

getCurrentContent() : mixed | null

Returns

mixednull

現在のサイトプレフィックスを取得する

getCurrentPrefix() : string

Returns

string

meta タグ用のページ説明文を取得する

getDescription() : string

Returns

stringmeta タグ用の説明文

エレメントテンプレートのレンダリング結果を取得する

getElement(string $name, array $data = array(), array $options = array()) : string

Parameters

$name

string

エレメント名

$data

array

エレメントで参照するデータ

$options

array

オプションのパラメータ subDir (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照

Returns

stringエレメントのレンダリング結果

グローバルメニューを取得する

getGlobalMenu(array $level = 1, array $options = array()) : string

Parameters

$level

array

取得する階層(初期値 : 1)

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

Returns

string

Google Maps を取得する

getGoogleMaps(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

現在のページの純粋なURLを取得する

getHere() : string
スマートURL、サブフォルダかどうかに依存しない、スラッシュから始まるURLを取得

Returns

stringURL

画像タグを取得する

getImg(string $path, array $options = array()) : string

Parameters

$path

string

画像のパス(img フォルダからの相対パス)

$options

array

オプション(主にHTML属性) ※ パラメータについては、HtmlHelper::image() を参照。

Returns

string画像タグ

meta タグ用のキーワードを取得する

getKeywords() : string

Returns

stringmeta タグ用のキーワード

URLのパラメータ情報を返す 主なreturnデータは http://basercms.net/news/index/example/test?name=value の場合 'plugin' => blog (利用しているプラグイン) 'pass' => [0] => 'example' [1] => 'test' 'isAjax' => (boolean)false 'query' => 'name' => 'value' 'url' => 'news/index/fuga/hoge' 'here' => '/news/index/fuga/hoge'

getParams() : array

Returns

arrayURLのパラメータ情報の配列

baserCMSが設置されているパスを取得する

getRoot() : string
画像タグやリンクタグを出力する際に、baserCMSの設置フォルダに 依存せずパスを出力する為に利用する。 《利用例》 《basercmsというフォルダに設置している場合の取得例》 /basercms/ 《basercmsというフォルダに設置し、スマートURLオフの場合の取得例》 /basercms/index.php/

Returns

string

WEBサイト名を取得する

getSiteName() : string

Returns

stringサイト基本設定のWEBサイト名

getSitePrefix()

getSitePrefix() 

サイト内検索フォームを取得

getSiteSearchForm(array $data = array(), array $options = array()) : string

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

Returns

string

WEBサイトURLを取得する

getSiteUrl($ssl = false) : string

Parameters

$ssl

Returns

stringサイト基本設定のWEBサイト名

サイトマップを取得する

getSitemap(int $siteId = 0) : string
ログインしていない場合はキャッシュする

Parameters

$siteId

int

サイトID

Returns

stringサイトマップ

サブメニューを取得する

getSubMenu(array $data = array(), array $options = array()) : string

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

Returns

string

現在のテーマのURLを取得する

getThemeUrl() : string

Returns

stringテーマのURL

タイトルタグを取得する

getTitle(string $separator = '|', array $options = array()) : string
ページタイトルと直属のカテゴリ名が同じ場合は、ページ名を省略する version 3.0.10 より第2引数 $categoryTitleOn は、 $options にまとめられました。 後方互換のために第2引数に配列型以外を指定された場合は、 $categoryTitleOn として取り扱います。

Parameters

$separator

string

区切り文字

$options

array

categoryTitleOn カテゴリタイトルを表示するかどうか boolean で指定 (初期値 : null) tag (boolean) false でタグを削除するかどうか (初期値 : true) allowableTags tagが falseの場合、削除しないタグを指定できる。詳しくは、php strip_tags のドキュメントを参考してください。 (初期値 : '')

Returns

stringメタタグ用のタイトルを返す

更新情報を取得する

getUpdateInfo() 

プロトコルから始まるURLを取得する

getUri(mixed $url, bool $sessionId = true) : string
《利用例》 $this->BcBaser->getUri('/about') 《出力例》 http://localhost/about

Parameters

$url

mixed

文字列のURL、または、配列形式のURL

$sessionId

bool

セッションIDを付加するかどうか(初期値 : true)

Returns

stringプロトコルから始まるURL

baserCMSの設置フォルダを考慮したURLを取得する

getUrl(mixed $url = null, bool $full = false, bool $sessionId = true) : string
《利用例》 会社概要

Parameters

$url

mixed

baserCMS設置フォルダからの絶対URL、もしくは配列形式のURL情報

省略した場合には、PC用のトップページのURLを取得する

$full

bool

httpから始まるURLを取得するかどうか

$sessionId

bool

セションIDを付加するかどうか

Returns

stringURL

ユーザー名を整形して取得する

getUserName(array $user) : string
姓と名を結合して取得 ニックネームがある場合にはニックネームを優先する

Parameters

$user

array

ユーザーデータ

Returns

string$userName ユーザー名

ウィジェットエリアを取得する

getWidgetArea(int $no = null, array $options = array()) : string

Parameters

$no

int

ウィジェットエリアNO(初期値 : null)※ 省略した場合は、コンテンツごとに管理システムにて設定されているウィジェットエリアを出力する

$options

array

オプション(初期値 : array())

  • loadHelpers : ヘルパーを読み込むかどうか(初期値 : false) todo loadHelpersが利用されていないのをなんとかする
  • subDir : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true)

Returns

string

グローバルメニューを出力する

globalMenu(array $level = 1, array $options = array()) : void

Parameters

$level

array

取得する階層(初期値 : 1)

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

Google Analytics のトラッキングコードを出力する

googleAnalytics(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

Google Maps を出力する

googleMaps(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

ヘッダーテンプレートを出力する

header(array $data = array(), array $options = array()) : void

Parameters

$data

array

エレメントで参照するデータ

$options

array

オプションのパラメータ subDir (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照

アイコン(favicon)タグを出力する

icon() : void

画像タグを出力する

img(array $path, array $options = array()) : void

Parameters

$path

array

画像のパス(img フォルダからの相対パス)

$options

array

オプション(主にHTML属性) ※ パラメータについては、HtmlHelper::image() を参照。

baserCMSのコアテンプレートを読み込む

includeCore(string $name, array $data = array(), array $options = array()) : void
コントローラー名より指定が必要 《利用例》 $this->BcBaser->includeCore('Users/admin/form') $this->BcBaser->includeCore('Mail.MailFields/admin/form')

Parameters

$name

string

テンプレート名

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array())

  • subDir : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true) ※ その他のパラメータについては、View::element() を参照

管理者グループかどうかチェックする

isAdminUser(int $userGroupId = null) : bool

Parameters

$userGroupId

int

ユーザーグループID(初期値 : null)※ 指定しない場合は、現在のログインユーザーについてチェックする

Returns

bool管理者グループの場合は true を返す

現在のページがブログプラグインかどうかを判定する

isBlog() : bool

Returns

bool

現在のページがページカテゴリのトップかどうかを判定する 判定は、URLからのみで行う

isCategoryTop() : bool

Returns

boolカテゴリトップの場合は、 true を返す

指定したURLが現在のURLと同じかどうか判定する

isCurrentUrl(string $url) : bool
《比較例》 /news/ | /news/ ・・・○ /news | /news/ ・・・× /news/ | /news/index ・・・○

Parameters

$url

string

比較対象URL

Returns

bool同じ場合には true を返す

現在のページがトップページかどうかを判定する

isHome() : bool
MEMO: BcRequest.(agent).aliasは廃止

Returns

bool

現在のページがメールプラグインかどうかを判定する

isMail() : bool

Returns

bool

現在のページが固定ページかどうかを判定する

isPage() : bool

Returns

bool固定ページの場合は true を返す

SSL通信かどうか判定する

isSSL() : bool

Returns

bool

Javascript タグを出力する

js(string|array $url, bool $inline = true, $options = array()) : void

Parameters

$url

stringarray

Javascriptのパス(js フォルダからの相対パス)拡張子は省略可

$inline

bool

コンテンツ内に Javascript を出力するかどうか(初期値 : true)

$options

表示件数設定機能を出力する

listNum(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

メインイメージを出力する

mainImage(array $options = array()) : void
メインイメージは管理画面のテーマ設定にて指定

Parameters

$options

array

オプション

  • all: 全ての画像を出力する。
  • num: 指定した番号の画像を出力する。all を true とした場合は、出力する枚数となる。
  • id : all を true とした場合、UL タグの id 属性を指定できる。
  • class : all を true とした場合、UL タグの class 属性を指定できる。 ※ その他の、パラメーターは、 BcBaserHelper->_getThemeImage() を参照

文字列を検索しマークとしてタグをつける

mark(string $search, string $text, string $name = 'strong', array $attributes = array(), bool $escape = false) : string
《利用例》 $this->BcBaser->mark('強調', '強調します強調します強調します') 《取得例》 強調します強調します強調します
todo TextHelperに移行を検討

Parameters

$search

string

検索文字列

$text

string

検索対象文字列

$name

string

マーク用タグ(初期値 : strong)

$attributes

array

タグの属性(初期値 : array())

$escape

bool

エスケープ有無(初期値 : false)

Returns

string$text 変換後文字列

ページ説明文用のメタタグを出力する

metaDescription() : void

キーワード用のメタタグを出力する

metaKeywords() : void

固定ページをエレメントとして読み込む

page(string $url, array $params = array(), array $options = array()) : void
※ レイアウトは読み込まずコンテンツ本体のみを読み込む

Parameters

$url

string

固定ページのURL

$params

array

固定ページに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array())

  • loadHelpers : ヘルパーを読み込むかどうか(初期値 : false) todo loadHelpersが利用されていないのをなんとかする
  • subDir : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true)
  • recursive : 固定ページ読み込みを再帰的に読み込むかどうか(初期値 : true)

ページネーションを出力する

pagination(string $name = 'default', array $data = array(), array $options = array()) : void

Parameters

$name

string

$data

array

ページネーションで参照するデータ

$options

array

オプションのパラメータ subDir (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照

baserCMSが設置されているパスを出力する

root() : void
BcBaserHelper::getRoot() をラッピングして出力するだけの処理

RSSフィードのリンクタグを出力する

rss(string $title, string $link) : void

Parameters

$title

string

RSSのタイトル

$link

string

RSSのURL

コンテンツ内で設定した CSS や javascript をレイアウトテンプレートに出力し、ログイン中の場合、ツールバー用のCSSも出力する また、テーマ用のCSSが存在する場合には出力する

scripts() : void
利用する際は、タグの直前あたりに記述する。 コンテンツ内で、レイアウトテンプレートへの出力を設定する場合には、inline オプションを false にする 《利用例》 $this->BcBaser->css('admin/layout', array('inline' => false)); $this->BcBaser->js('admin/startup', false);

レイアウトで利用する為の変数を設定する

set(string $key, mixed $value) : void
View::set() のラッパー

Parameters

$key

string

変数名

$value

mixed

タイトルへのカテゴリタイトルの出力有無を設定する

setCategoryTitle(bool|string|array $on = true) : void
コンテンツごとに個別設定をする為に利用する。 パンくずにも影響する。

Parameters

$on

boolstringarray

true を指定した場合は、コントローラーで指定した crumbs を参照し、

文字列を指定した場合には、その文字列をカテゴリとして利用する。
パンくずにリンクをつける場合には、配列で指定する。
(例) array('name' => '会社案内', 'url' => '/company/index')

meta タグの説明文を設定する

setDescription(string $description) : void

Parameters

$description

string

説明文

トップページのタイトルをセットする

setHomeTitle(mixed $title = null

Parameters

$title

meta タグのキーワードを設定する

setKeywords(string $keywords) : void

Parameters

$keywords

string

キーワード(複数の場合はカンマで区切る)

サブメニューを設定する(管理画面用)

setSubMenus(array $submenus) : void

Parameters

$submenus

array

サブメニューエレメント名を配列で指定

タイトルを設定する

setTitle(string $title, mixed $categoryTitleOn = null) : void

Parameters

$title

string

タイトル

$categoryTitleOn

mixed

カテゴリのタイトルを含むかどうか

WEBサイト名を出力する

siteName() : void

サイト内検索フォームを出力

siteSearchForm(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

WEBサイトURLを出力する

siteUrl($ssl = false) : void

Parameters

$ssl

サイトマップを出力する

sitemap(int $siteId = 0
ログインしていない場合はキャッシュする

Parameters

$siteId

int

サイトID

サブメニューを出力する

subMenu(array $data = array(), array $options = array()) : void

Parameters

$data

array

読み込むテンプレートに引き継ぐパラメータ(初期値 : array())

$options

array

オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照

Flashを表示する

swf(string $path, string $id, int $width, int $height, array $options = array()) : string

Parameters

$path

string

Flashのパス

$id

string

任意のID(divにも埋め込まれる)

$width

int

横幅

$height

int

高さ

$options

array

オプション(初期値 : array())

  • version : Flashのバージョン(初期値 : 7)
  • script : Flashを読み込むJavascriptのパス(初期値 : admin/swfobject-2.2)
  • noflash : Flashがインストールされてない場合に表示する文字列

Returns

stringFlash表示タグ

現在のテーマのURLを出力する

themeUrl() : void

タイトルタグを出力する

title(string $separator = '|', string $categoryTitleOn = null) : void

Parameters

$separator

string

区切り文字

$categoryTitleOn

string

カテゴリを表示するかどうか boolean で指定

更新情報を出力する

updateInfo() 

baserCMSの設置フォルダを考慮したURLを出力する

url(mixed $url = null, bool $full = false, bool $sessionId = true) : void
《利用例》 会社概要

Parameters

$url

mixed

baserCMS設置フォルダからの絶対URL、もしくは配列形式のURL情報

省略した場合には、PC用のトップページのURLを出力する

$full

bool

httpから始まるURLを取得するかどうか

$sessionId

bool

セションIDを付加するかどうか

Finds URL for specified action.

url(mixed $url = null, boolean $full = false, $sessionId = true) : string
Returns an URL pointing to a combination of controller and action. Param $url can be: + Empty - the method will find adress to actuall controller/action. + '/' - the method will find base URL of application. + A combination of controller/action - the method will find url for it.

Parameters

$url

mixed

Cake-relative URL, like "/products/edit/92" or "/presidents/elect/4"

                   or an array specifying any of the following: 'controller', 'action',
                   and/or 'plugin', in addition to named arguments (keyed array elements),
                   and standard URL arguments (indexed array elements)

$full

boolean

If true, the full base URL will be prepended to the result

$sessionId

Returns

stringFull translated URL with base path.

スマートフォン用のウェブクリップアイコン用のタグを出力する

webClipIcon(string $fileName = 'apple-touch-icon-precomposed.png', bool $useGloss = false

Parameters

$fileName

string

ファイル名(webroot に配置する事が前提)

$useGloss

bool

光沢有無

Checks if a file exists when theme is used, if no file is found default location is returned

webroot(string $file) : string
PENDING Core Hack

Parameters

$file

string

Returns

string$webPath web path to file.

ウィジェットエリアを出力する

widgetArea(int $no = null, array $options = array()) : void

Parameters

$no

int

ウィジェットエリアNO(初期値 : null)※ 省略した場合は、コンテンツごとに管理システムにて設定されているウィジェットエリアを出力する

$options

array

オプション(初期値 : array())

  • loadHelpers : ヘルパーを読み込むかどうか(初期値 : false) todo loadHelpersが利用されていないのをなんとかする
  • subDir : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true)

XMLヘッダタグを出力する

xmlHeader(array $attrib = array()) : void

Parameters

$attrib

array

属性

テーマ画像を取得する

_getThemeImage(string $name, array $options = array()) : string

Parameters

$name

string

テーマ画像名( log or main_image )

$options

array

オプション(初期値 :array())

  • num : main_imageの場合の番号指定(初期値 : '')
  • thumb: サムネイルを取得する(初期値 : false)
  • class: 画像に設定する class 属性(初期値 : '')
  • popup: ポップアップリンクを指定(初期値 : false)
  • alt : 画像に設定する alt 属性。リンクの title 属性にも設定される。(初期値 : テーマ設定で設定された値)
  • link : リンク先URL。popup を true とした場合、オリジナルの画像へのリンクとなる。(初期値 : テーマ設定で設定された値)
  • `maxWidth : 最大横幅(初期値 : '')
  • `maxHeight: 最大高さ(初期値 : '')
  • `width : 最大横幅(初期値 : '')
  • `height: 最大高さ(初期値 : '')

Returns

string$tag テーマ画像のHTMLタグ

PluginBaserHelper を初期化する

_initPluginBasers() : void
BcBaserHelperに定義されていないメソッドをプラグイン内のヘルパに定義する事で BcBaserHelperから呼び出せるようになる仕組みを提供する。 プラグインのヘルパメソッドを BcBaserHelper 経由で直接呼び出せる為、 コア側のコントローラーでいちいちヘルパの定義をしなくてよくなり、 プラグインを導入するだけでテンプレート上でプラグインのメソッドが呼び出せるようになる。 例えば固定ページ機能のWYSIWYG内にプラグインのメソッドを書き込む事ができる。 《PluginBaserHelper の命名規則》 {プラグイン名}BaserHelper 《利用例》 - Feedプラグインに FeedBaserHelper::feed() が定義されている場合 $this->BcBaser->feed(1);

 Properties

 

BcArrayヘルパ

$BcArray : \BcArrayHelper

Default

magic
property BcArrayヘルパ
 

$BcContents

$BcContents : \BcContentsHelper

Default

magic
property
 

BcHtmlヘルパ

$BcHtml : \BcHtmlHelper

Default

magic
property BcHtmlヘルパ
 

BcPageヘルパ

$BcPage : \BcPageHelper

Default

magic
property BcPageヘルパ
 

BcXmlヘルパ

$BcXml : \BcXmlHelper

Default

magic
property BcXmlヘルパ
 

$Flash

$Flash : \FlashHelper

Default

magic
property
 

Jsヘルパ

$Js : \JsHelper

Default

magic
property Jsヘルパ
 

Sessionヘルパ

$Session : \SessionHelper

Default

magic
property Sessionヘルパ
 

ヘルパー

$helpers : array

Default

array('BcHtml', 'Js', 'Session', 'BcXml', 'BcArray', 'BcPage', 'Flash', 'BcContents')
 

サイト基本設定データ

$siteConfig : array

Default

array()
 

ページモデル

$_Page : \Page

Default

null
一度初期化した後に再利用し、処理速度を向上する為にコンストラクタでセットする。
 

アクセス制限設定モデル

$_Permission : \Permission

Default

null
一度初期化した後に再利用し、処理速度を向上する為にコンストラクタでセットする。
 

カテゴリタイトル

$_categoryTitle : mixed

Default

true
 

カテゴリタイトル設定

$_categoryTitleOn : mixed

Default

true
パンくず用の配列を取得する際、カテゴリのタイトルを取得するかどうかの判定を保持
 

BcBaserHelper を拡張するプラグインのヘルパ

$_pluginBasers : array

Default

array()
BcBaserHelper::_initPluginBasers() で自動的に初期化される。