PHP Class BcBaserHelper

テーマより利用される事を前提としたヘルパーで、テーマで必要となる機能をひと通り提供する。
Inheritance: extends AppHelper
Exibir arquivo Open project: baserproject/basercms Class Usage Examples

Public Properties

Property Type Description
$helpers array ヘルパー
$siteConfig array サイト基本設定データ

Protected Properties

Property Type Description
$_Page Page 一度初期化した後に再利用し、処理速度を向上する為にコンストラクタでセットする。
$_Permission Permission 一度初期化した後に再利用し、処理速度を向上する為にコンストラクタでセットする。
$_categoryTitle カテゴリタイトル
$_categoryTitleOn パンくず用の配列を取得する際、カテゴリのタイトルを取得するかどうかの判定を保持
$_pluginBasers array BcBaserHelper::_initPluginBasers() で自動的に初期化される。

Public Methods

Method Description
__call ( string $method, array $params ) : mixed PluginBaserHelper 用マジックメソッド
__construct ( View $View, array $settings = [] ) コンストラクタ
addCrumb ( string $name, string $link = null, mixed $options = [] ) : void パンくずリストの要素を追加する
afterRender ( string $viewFile ) After Render
baseUrl ( ) : void ベースとなるURLを出力する
cacheHeader ( string | integer | float $expire = null, string $type = 'html' ) : void ブラウザにキャッシュさせる為のヘッダーを出力する
charset ( string $charset = null ) : void charset メタタグを出力する
checkUpdate ( ) : boolean アップデート処理が必要かチェックする
content ( ) : void コンテンツ本体を出力する
contentsMenu ( mixed $id = null, integer $level = null, string $currentId = null ) : string コンテンツメニューを出力する
contentsName ( boolean $detail = false, array $options = [] ) : void コンテンツを特定する文字列を出力する
contentsNavi ( array $data = [], array $options = [] ) : void コンテンツナビを出力する
contentsTitle ( ) : void コンテンツのタイトルを出力する
copyYear ( integer $begin ) : void コピーライト用の年を出力する
crumbs ( string $separator = '»', string | boolean $startText = false, $onSchema = false ) : void パンくずリストを出力する
crumbsList ( array $data = [], array $options = [] ) : void パンくずリストを出力する
css ( string $path, mixed $options = [] ) : void CSS タグを出力する
docType ( string $type = 'xhtml-trans' ) : void ドキュメントタイプを指定するタグを出力する
editLink ( ) : void 編集画面へのリンクを出力する
element ( string $name, array $data = [], array $options = [] ) : void エレメントテンプレートを出力する
existsEditLink ( ) : boolean 編集画面へのリンクが存在するかチェックする
existsPublishLink ( ) : boolean 公開ページへのリンクが存在するかチェックする
flash ( string $key = 'flash' ) : void セッションに保存したメッセージを出力する
footer ( array $data = [], array $options = [] ) : void フッターテンプレートを出力する
func ( ) : void ツールバーエレメントや CakePHP のデバッグ出力を表示
getBaseUrl ( ) : string ベースとなるURLを取得する
getBlogs ( string $name = '', array $options = [] ) : array Blogの基本情報を全て取得する
getContentCreatedDate ( $format = 'Y/m/d H:i' ) : null | string コンテンツ作成日を取得
getContentModifiedDate ( string $format = 'Y/m/d H:i' ) : null | string コンテンツ更新日を取得
getContentsMenu ( mixed $id = null, integer $level = null, string $currentId = null ) : string メニューを出力する
getContentsName ( boolean $detail = false, array $options = [] ) : string コンテンツを特定する文字列を取得する
getContentsTitle ( ) : string コンテンツタイトルを取得する
getCrumbs ( mixed $categoryTitleOn = null ) : array パンくず用の配列を取得する
getCurrentContent ( ) : mixed | null 現在のコンテンツ情報を取得する
getCurrentPrefix ( ) : string 現在のサイトプレフィックスを取得する
getDescription ( ) : string meta タグ用のページ説明文を取得する
getElement ( string $name, array $data = [], array $options = [] ) : string エレメントテンプレートのレンダリング結果を取得する
getGlobalMenu ( array $level = 1, array $options = [] ) : string グローバルメニューを取得する
getGoogleMaps ( array $data = [], array $options = [] ) : void Google Maps を取得する
getHere ( ) : string 現在のページの純粋なURLを取得する
getImg ( string $path, array $options = [] ) : string 画像タグを取得する
getKeywords ( ) : string meta タグ用のキーワードを取得する
getLink ( string $title, mixed $url = null, array $options = [], boolean $confirmMessage = false ) : string アンカータグを取得する
getParams ( ) : array 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'
getRelatedSiteLinks ( integer $id = null, $excludeIds = [] ) 関連サイトのリンク一覧を取得
getRoot ( ) : string baserCMSが設置されているパスを取得する
getSiteName ( ) : string WEBサイト名を取得する
getSitePrefix ( )
getSiteSearchForm ( array $data = [], array $options = [] ) : string サイト内検索フォームを取得
getSiteUrl ( $ssl = false ) : string WEBサイトURLを取得する
getSitemap ( integer $siteId ) : string サイトマップを取得する
getSubMenu ( array $data = [], array $options = [] ) : string サブメニューを取得する
getThemeUrl ( ) : string 現在のテーマのURLを取得する
getTitle ( string $separator = '|', array $options = [] ) : string タイトルタグを取得する
getUpdateInfo ( ) 更新情報を取得する
getUri ( mixed $url, boolean $sessionId = true ) : string プロトコルから始まるURLを取得する
getUrl ( mixed $url = null, boolean $full = false, boolean $sessionId = true ) : string baserCMSの設置フォルダを考慮したURLを取得する
getUserName ( array $user ) : string ユーザー名を整形して取得する
getWidgetArea ( integer $no = null, array $options = [] ) : string ウィジェットエリアを取得する
globalMenu ( array $level = 1, array $options = [] ) : void グローバルメニューを出力する
googleAnalytics ( array $data = [], array $options = [] ) : void Google Analytics のトラッキングコードを出力する
googleMaps ( array $data = [], array $options = [] ) : void Google Maps を出力する
header ( array $data = [], array $options = [] ) : void ヘッダーテンプレートを出力する
icon ( ) : void アイコン(favicon)タグを出力する
img ( array $path, array $options = [] ) : void 画像タグを出力する
includeCore ( string $name, array $data = [], array $options = [] ) : void baserCMSのコアテンプレートを読み込む
isAdminUser ( integer $userGroupId = null ) : boolean 管理者グループかどうかチェックする
isBlog ( ) : boolean 現在のページがブログプラグインかどうかを判定する
isCategoryTop ( ) : boolean 現在のページがページカテゴリのトップかどうかを判定する 判定は、URLからのみで行う
isCurrentUrl ( string $url ) : boolean 指定したURLが現在のURLと同じかどうか判定する
isHome ( ) : boolean 現在のページがトップページかどうかを判定する
isMail ( ) : boolean 現在のページがメールプラグインかどうかを判定する
isPage ( ) : boolean 現在のページが固定ページかどうかを判定する
isSSL ( ) : boolean SSL通信かどうか判定する
js ( string | array $url, boolean $inline = true, $options = [] ) : void Javascript タグを出力する
link ( string $title, mixed $url = null, array $htmlAttributes = [], boolean $confirmMessage = false ) : void アンカータグを出力する
listNum ( array $data = [], array $options = [] ) : void 表示件数設定機能を出力する
logo ( array $options = [] ) : void ロゴを出力する
mainImage ( array $options = [] ) : void メインイメージを出力する
mark ( string $search, string $text, string $name = 'strong', array $attributes = [], boolean $escape = false ) : string 文字列を検索しマークとしてタグをつける
metaDescription ( ) : void ページ説明文用のメタタグを出力する
metaKeywords ( ) : void キーワード用のメタタグを出力する
page ( string $url, array $params = [], array $options = [] ) : void 固定ページをエレメントとして読み込む
pagination ( string $name = 'default', array $data = [], array $options = [] ) : void ページネーションを出力する
publishLink ( ) : void 公開ページへのリンクを出力する
relatedSiteLinks ( integer $id = null, $excludeIds = [] ) 関連サイトのリンク一覧を表示
root ( ) : void baserCMSが設置されているパスを出力する
rss ( string $title, string $link ) : void RSSフィードのリンクタグを出力する
scripts ( ) : void コンテンツ内で設定した CSS や javascript をレイアウトテンプレートに出力し、ログイン中の場合、ツールバー用のCSSも出力する また、テーマ用のCSSが存在する場合には出力する
set ( string $key, mixed $value ) : void レイアウトで利用する為の変数を設定する
setCategoryTitle ( boolean | string | array $on = true ) : void タイトルへのカテゴリタイトルの出力有無を設定する
setDescription ( string $description ) : void meta タグの説明文を設定する
setHomeTitle ( $title = null ) トップページのタイトルをセットする
setKeywords ( string $keywords ) : void meta タグのキーワードを設定する
setPageEditLink ( string $id ) : void 編集画面へのリンクを設定する
setSubMenus ( array $submenus ) : void サブメニューを設定する(管理画面用)
setTitle ( string $title, mixed $categoryTitleOn = null ) : void タイトルを設定する
siteName ( ) : void WEBサイト名を出力する
siteSearchForm ( array $data = [], array $options = [] ) : void サイト内検索フォームを出力
siteUrl ( $ssl = false ) : void WEBサイトURLを出力する
sitemap ( integer $siteId ) サイトマップを出力する
subMenu ( array $data = [], array $options = [] ) : void サブメニューを出力する
swf ( string $path, string $id, integer $width, integer $height, array $options = [] ) : string Flashを表示する
themeUrl ( ) : void 現在のテーマのURLを出力する
title ( string $separator = '|', string $categoryTitleOn = null ) : void タイトルタグを出力する
updateInfo ( ) 更新情報を出力する
url ( mixed $url = null, boolean $full = false, boolean $sessionId = true ) : void baserCMSの設置フォルダを考慮したURLを出力する
webClipIcon ( string $fileName = 'apple-touch-icon-precomposed.png', boolean $useGloss = false ) スマートフォン用のウェブクリップアイコン用のタグを出力する
widgetArea ( integer $no = null, array $options = [] ) : void ウィジェットエリアを出力する
xmlHeader ( array $attrib = [] ) : void XMLヘッダタグを出力する

Protected Methods

Method Description
_getThemeImage ( string $name, array $options = [] ) : string テーマ画像を取得する
_initPluginBasers ( ) : void PluginBaserHelper を初期化する

Method Details

__call() public method

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

__construct() public method

コンストラクタ
public __construct ( View $View, array $settings = [] )
$View View ビュークラス
$settings array ヘルパ設定値(BcBaserHelper では利用していない)

_getThemeImage() protected method

テーマ画像を取得する
protected _getThemeImage ( string $name, array $options = [] ) : string
$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: 最大高さ(初期値 : '')
return string $tag テーマ画像のHTMLタグ

_initPluginBasers() protected method

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

addCrumb() public method

デフォルトでアクセス制限がかかっているリンクの場合でもタイトルを表示する $options の forceTitle キー に false を指定する事で表示しない設定も可能
public addCrumb ( string $name, string $link = null, mixed $options = [] ) : void
$name string パンくず用のテキスト
$link string パンくず用のリンク(初期値 : null)※ 指定しない場合はリンクは設定しない
$options mixed リンクタグ用の属性(初期値 : array()) ※ パラメータについては、HtmlHelper::link() を参照。
return void

afterRender() public method

After Render
public afterRender ( string $viewFile )
$viewFile string

baseUrl() public method

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

cacheHeader() public method

ブラウザにキャッシュさせる為のヘッダーを出力する
public cacheHeader ( string | integer | float $expire = null, string $type = 'html' ) : void
$expire string | integer | float キャッシュの有効期間(初期値 : null) ※ 指定しない場合は、baserCMSコアのキャッシュ設定値
$type string どのタイプ(拡張子)に対してのキャッシュか(初期値 : 'html')
return void

charset() public method

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

checkUpdate() public method

アップデート処理が必要かチェックする
public checkUpdate ( ) : boolean
return boolean アップデートが必要な場合は true を返す

content() public method

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

contentsMenu() public method

ログインしていない場合はキャッシュする contents_menu エレメントで、HTMLカスタマイズ可能
public contentsMenu ( mixed $id = null, integer $level = null, string $currentId = null ) : string
$id mixed コンテンツID(初期値:null)
$level integer 階層(初期値:null)※ null の場合は階層指定なし
$currentId string 現在のページのコンテンツID(初期値:null)
return string コンテンツメニュー

contentsName() public method

URL を元に、第一階層までの文字列をキャメルケースで取得する ※ 利用例、出力例については BcBaserHelper::getContentsName() を参照
public contentsName ( boolean $detail = false, array $options = [] ) : void
$detail boolean 詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで出力する(初期値 : false)
$options array オプション(初期値 : array()) ※ オプションの詳細については、BcBaserHelper::getContentsName() を参照
return void

contentsNavi() public method

コンテンツナビを出力する
public contentsNavi ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

contentsTitle() public method

コンテンツのタイトルを出力する
public contentsTitle ( ) : void
return void

copyYear() public method

《利用例》 $this->BcBaser->copyYear(2012) 《出力例》 2012 - 2014
public copyYear ( integer $begin ) : void
$begin integer 開始年
return void

crumbs() public method

事前に BcBaserHelper::addCrumb() にて、パンくず情報を追加しておく必要がある。 また、アクセス制限がかかっているリンクはテキストのみ表示する
public crumbs ( string $separator = '»', string | boolean $startText = false, $onSchema = false ) : void
$separator string パンくずの区切り文字(初期値 : »)
$startText string | boolean トップページを先頭に追加する場合にはトップページのテキストを指定する(初期値 : false)
return void

crumbsList() public method

パンくずリストを出力する
public crumbsList ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

css() public method

《利用例》 $this->BcBaser->css('admin/import')
public css ( string $path, mixed $options = [] ) : void
$path string CSSファイルのパス(css フォルダからの相対パス)拡張子は省略可
$options mixed オプション (配列の場合) - `rel` : rel属性(初期値 : 'stylesheet') - `inline` : コンテンツ内にCSSを出力するかどうか(初期値 : true) ※ その他のパラメータについては、HtmlHelper::css() を参照。 ※ false を指定した場合、inline が false となる。
return void

docType() public method

ドキュメントタイプを指定するタグを出力する
public docType ( string $type = 'xhtml-trans' ) : void
$type string 出力ドキュメントタイプの文字列(初期値 : 'xhtml-trans')
return void

element() public method

エレメントテンプレートを出力する
public element ( string $name, array $data = [], array $options = [] ) : void
$name string エレメント名
$data array エレメントで参照するデータ
$options array オプションのパラメータ `subDir` (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照
return void

flash() public method

メールフォームのエラーメッセージ等を出力します。
public flash ( string $key = 'flash' ) : void
$key string 出力するメッセージのキー(初期状態では省略してよいです)
return void

func() public method

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

getBaseUrl() public method

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

getBlogs() public method

Blogの基本情報を全て取得する
public getBlogs ( string $name = '', array $options = [] ) : array
$name string ブログアカウント名を指定するとそのブログのみの基本情報を返す。空指定(default)で、全てのブログの基本情報。 ex) 'news' (初期値 : '')
$options array オプション(初期値 :array()) - `sort` : データのソート順 取得出来るフィールドのどれかでソートができる ex) 'created DESC'(初期値 : 'id') - `siteId` : サブサイトIDで絞り込む場合に指定する(初期値:0)
return array サイト基本設定配列

getContentCreatedDate() public method

コンテンツ作成日を取得
public getContentCreatedDate ( $format = 'Y/m/d H:i' ) : null | string
return null | string

getContentModifiedDate() public method

コンテンツ更新日を取得
public getContentModifiedDate ( string $format = 'Y/m/d H:i' ) : null | string
$format string
return null | string

getContentsMenu() public method

ログインしていない場合はキャッシュする contents_menu エレメントで、HTMLカスタマイズ可能
public getContentsMenu ( mixed $id = null, integer $level = null, string $currentId = null ) : string
$id mixed コンテンツID(初期値:null)
$level integer 階層(初期値:null)※ null の場合は階層指定なし
$currentId string 現在のページのコンテンツID(初期値:null)
return string コンテンツメニュー

getContentsName() public method

URL を元に、第一階層までの文字列をキャメルケースで取得する 《利用例》 $this->BcBaser->contentsName() 《出力例》 - トップページの場合 : Home - about ページの場合 : About
public getContentsName ( boolean $detail = false, array $options = [] ) : string
$detail boolean 詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで取得する(初期値 : false)
$options array オプション(初期値 : array()) - `home` : トップページの場合に出力する文字列(初期値 : Home) - `default` : ルート直下の下層ページの場合に出力する文字列(初期値 : Default) - `error` : エラーページの場合に出力する文字列(初期値 : Error) - `underscore` : キャメルケースではなく、アンダースコア区切りで出力する(初期値 : false)
return string

getContentsTitle() public method

コンテンツタイトルを取得する
public getContentsTitle ( ) : string
return string コンテンツタイトル

getCrumbs() public method

基本的には、コントローラーの crumbs プロパティで設定した値を取得する仕様だが 事前に setCategoryTitle メソッドで出力内容をカスタマイズする事ができる
public getCrumbs ( mixed $categoryTitleOn = null ) : array
$categoryTitleOn mixed 親カテゴリの階層を表示するかどうか
return array パンくず用の配列

getCurrentContent() public method

現在のコンテンツ情報を取得する
public getCurrentContent ( ) : mixed | null
return mixed | null

getCurrentPrefix() public method

現在のサイトプレフィックスを取得する
public getCurrentPrefix ( ) : string
return string

getDescription() public method

meta タグ用のページ説明文を取得する
public getDescription ( ) : string
return string meta タグ用の説明文

getElement() public method

エレメントテンプレートのレンダリング結果を取得する
public getElement ( string $name, array $data = [], array $options = [] ) : string
$name string エレメント名
$data array エレメントで参照するデータ
$options array オプションのパラメータ `subDir` (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照
return string エレメントのレンダリング結果

getGlobalMenu() public method

グローバルメニューを取得する
public getGlobalMenu ( array $level = 1, array $options = [] ) : string
$level array 取得する階層(初期値 : 1)
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return string

getGoogleMaps() public method

Google Maps を取得する
public getGoogleMaps ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

getHere() public method

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

getImg() public method

画像タグを取得する
public getImg ( string $path, array $options = [] ) : string
$path string 画像のパス(img フォルダからの相対パス)
$options array オプション(主にHTML属性) ※ パラメータについては、HtmlHelper::image() を参照。
return string 画像タグ

getKeywords() public method

meta タグ用のキーワードを取得する
public getKeywords ( ) : string
return string meta タグ用のキーワード

getParams() public method

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'
public getParams ( ) : array
return array URLのパラメータ情報の配列

getRoot() public method

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

getSiteName() public method

WEBサイト名を取得する
public getSiteName ( ) : string
return string サイト基本設定のWEBサイト名

getSitePrefix() public method

public getSitePrefix ( )

getSiteSearchForm() public method

サイト内検索フォームを取得
public getSiteSearchForm ( array $data = [], array $options = [] ) : string
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return string

getSiteUrl() public method

WEBサイトURLを取得する
public getSiteUrl ( $ssl = false ) : string
return string サイト基本設定のWEBサイト名

getSitemap() public method

ログインしていない場合はキャッシュする
public getSitemap ( integer $siteId ) : string
$siteId integer サイトID
return string サイトマップ

getSubMenu() public method

サブメニューを取得する
public getSubMenu ( array $data = [], array $options = [] ) : string
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return string

getThemeUrl() public method

現在のテーマのURLを取得する
public getThemeUrl ( ) : string
return string テーマのURL

getTitle() public method

ページタイトルと直属のカテゴリ名が同じ場合は、ページ名を省略する version 3.0.10 より第2引数 $categoryTitleOn は、 $options にまとめられました。 後方互換のために第2引数に配列型以外を指定された場合は、 $categoryTitleOn として取り扱います。
public getTitle ( string $separator = '|', array $options = [] ) : string
$separator string 区切り文字
$options array `categoryTitleOn` カテゴリタイトルを表示するかどうか boolean で指定 (初期値 : null) `tag` (boolean) false でタグを削除するかどうか (初期値 : true) `allowableTags` tagが falseの場合、削除しないタグを指定できる。詳しくは、php strip_tags のドキュメントを参考してください。 (初期値 : '')
return string メタタグ用のタイトルを返す

getUpdateInfo() public method

更新情報を取得する
public getUpdateInfo ( )

getUri() public method

《利用例》 $this->BcBaser->getUri('/about') 《出力例》 http://localhost/about
public getUri ( mixed $url, boolean $sessionId = true ) : string
$url mixed 文字列のURL、または、配列形式のURL
$sessionId boolean セッションIDを付加するかどうか(初期値 : true)
return string プロトコルから始まるURL

getUrl() public method

《利用例》 会社概要
public getUrl ( mixed $url = null, boolean $full = false, boolean $sessionId = true ) : string
$url mixed baserCMS設置フォルダからの絶対URL、もしくは配列形式のURL情報 省略した場合には、PC用のトップページのURLを取得する
$full boolean httpから始まるURLを取得するかどうか
$sessionId boolean セションIDを付加するかどうか
return string URL

getUserName() public method

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

getWidgetArea() public method

ウィジェットエリアを取得する
public getWidgetArea ( integer $no = null, array $options = [] ) : string
$no integer ウィジェットエリアNO(初期値 : null)※ 省略した場合は、コンテンツごとに管理システムにて設定されているウィジェットエリアを出力する
$options array オプション(初期値 : array()) - `loadHelpers` : ヘルパーを読み込むかどうか(初期値 : false) todo loadHelpersが利用されていないのをなんとかする - `subDir` : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true)
return string

globalMenu() public method

グローバルメニューを出力する
public globalMenu ( array $level = 1, array $options = [] ) : void
$level array 取得する階層(初期値 : 1)
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

googleAnalytics() public method

Google Analytics のトラッキングコードを出力する
public googleAnalytics ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

googleMaps() public method

Google Maps を出力する
public googleMaps ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

header() public method

ヘッダーテンプレートを出力する
public header ( array $data = [], array $options = [] ) : void
$data array エレメントで参照するデータ
$options array オプションのパラメータ `subDir` (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照
return void

icon() public method

アイコン(favicon)タグを出力する
public icon ( ) : void
return void

img() public method

画像タグを出力する
public img ( array $path, array $options = [] ) : void
$path array 画像のパス(img フォルダからの相対パス)
$options array オプション(主にHTML属性) ※ パラメータについては、HtmlHelper::image() を参照。
return void

includeCore() public method

コントローラー名より指定が必要 《利用例》 $this->BcBaser->includeCore('Users/admin/form') $this->BcBaser->includeCore('Mail.MailFields/admin/form')
public includeCore ( string $name, array $data = [], array $options = [] ) : void
$name string テンプレート名
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) - `subDir` : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true) ※ その他のパラメータについては、View::element() を参照
return void

isAdminUser() public method

管理者グループかどうかチェックする
public isAdminUser ( integer $userGroupId = null ) : boolean
$userGroupId integer ユーザーグループID(初期値 : null)※ 指定しない場合は、現在のログインユーザーについてチェックする
return boolean 管理者グループの場合は true を返す

isBlog() public method

現在のページがブログプラグインかどうかを判定する
public isBlog ( ) : boolean
return boolean

isCategoryTop() public method

現在のページがページカテゴリのトップかどうかを判定する 判定は、URLからのみで行う
public isCategoryTop ( ) : boolean
return boolean カテゴリトップの場合は、 true を返す

isCurrentUrl() public method

《比較例》 news/ | /news/ ・・・○ news | /news/ ・・・× news/ | /news/index ・・・○
public isCurrentUrl ( string $url ) : boolean
$url string 比較対象URL
return boolean 同じ場合には true を返す

isHome() public method

MEMO: BcRequest.(agent).aliasは廃止
public isHome ( ) : boolean
return boolean

isMail() public method

現在のページがメールプラグインかどうかを判定する
public isMail ( ) : boolean
return boolean

isPage() public method

現在のページが固定ページかどうかを判定する
public isPage ( ) : boolean
return boolean 固定ページの場合は true を返す

isSSL() public method

SSL通信かどうか判定する
public isSSL ( ) : boolean
return boolean

js() public method

Javascript タグを出力する
public js ( string | array $url, boolean $inline = true, $options = [] ) : void
$url string | array Javascriptのパス(js フォルダからの相対パス)拡張子は省略可
$inline boolean コンテンツ内に Javascript を出力するかどうか(初期値 : true)
return void

listNum() public method

表示件数設定機能を出力する
public listNum ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

mainImage() public method

メインイメージは管理画面のテーマ設定にて指定
public mainImage ( array $options = [] ) : void
$options array オプション - `all`: 全ての画像を出力する。 - `num`: 指定した番号の画像を出力する。all を true とした場合は、出力する枚数となる。 - `id` : all を true とした場合、UL タグの id 属性を指定できる。 - `class` : all を true とした場合、UL タグの class 属性を指定できる。 ※ その他の、パラメーターは、 BcBaserHelper->_getThemeImage() を参照
return void

mark() public method

《利用例》 $this->BcBaser->mark('強調', '強調します強調します強調します') 《取得例》 強調します強調します強調します
public mark ( string $search, string $text, string $name = 'strong', array $attributes = [], boolean $escape = false ) : string
$search string 検索文字列
$text string 検索対象文字列
$name string マーク用タグ(初期値 : strong)
$attributes array タグの属性(初期値 : array())
$escape boolean エスケープ有無(初期値 : false)
return string $text 変換後文字列

metaDescription() public method

ページ説明文用のメタタグを出力する
public metaDescription ( ) : void
return void

metaKeywords() public method

キーワード用のメタタグを出力する
public metaKeywords ( ) : void
return void

page() public method

※ レイアウトは読み込まずコンテンツ本体のみを読み込む
public page ( string $url, array $params = [], array $options = [] ) : void
$url string 固定ページのURL
$params array 固定ページに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) - `loadHelpers` : ヘルパーを読み込むかどうか(初期値 : false) todo loadHelpersが利用されていないのをなんとかする - `subDir` : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true) - `recursive` : 固定ページ読み込みを再帰的に読み込むかどうか(初期値 : true)
return void

pagination() public method

ページネーションを出力する
public pagination ( string $name = 'default', array $data = [], array $options = [] ) : void
$name string
$data array ページネーションで参照するデータ
$options array オプションのパラメータ `subDir` (boolean) エレメントのパスについてプレフィックスによるサブディレクトリを追加するかどうか ※ その他のパラメータについては、View::element() を参照
return void

root() public method

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

rss() public method

RSSフィードのリンクタグを出力する
public rss ( string $title, string $link ) : void
$title string RSSのタイトル
$link string RSSのURL
return void

scripts() public method

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

set() public method

View::set() のラッパー
public set ( string $key, mixed $value ) : void
$key string 変数名
$value mixed
return void

setCategoryTitle() public method

コンテンツごとに個別設定をする為に利用する。 パンくずにも影響する。
public setCategoryTitle ( boolean | string | array $on = true ) : void
$on boolean | string | array true を指定した場合は、コントローラーで指定した crumbs を参照し、 文字列を指定した場合には、その文字列をカテゴリとして利用する。 パンくずにリンクをつける場合には、配列で指定する。 (例) array('name' => '会社案内', 'url' => '/company/index')
return void

setDescription() public method

meta タグの説明文を設定する
public setDescription ( string $description ) : void
$description string 説明文
return void

setHomeTitle() public method

トップページのタイトルをセットする
public setHomeTitle ( $title = null )
$title

setKeywords() public method

meta タグのキーワードを設定する
public setKeywords ( string $keywords ) : void
$keywords string キーワード(複数の場合はカンマで区切る)
return void

setSubMenus() public method

サブメニューを設定する(管理画面用)
public setSubMenus ( array $submenus ) : void
$submenus array サブメニューエレメント名を配列で指定
return void

setTitle() public method

タイトルを設定する
public setTitle ( string $title, mixed $categoryTitleOn = null ) : void
$title string タイトル
$categoryTitleOn mixed カテゴリのタイトルを含むかどうか
return void

siteName() public method

WEBサイト名を出力する
public siteName ( ) : void
return void

siteSearchForm() public method

サイト内検索フォームを出力
public siteSearchForm ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

siteUrl() public method

WEBサイトURLを出力する
public siteUrl ( $ssl = false ) : void
return void

sitemap() public method

ログインしていない場合はキャッシュする
public sitemap ( integer $siteId )
$siteId integer サイトID

subMenu() public method

サブメニューを出力する
public subMenu ( array $data = [], array $options = [] ) : void
$data array 読み込むテンプレートに引き継ぐパラメータ(初期値 : array())
$options array オプション(初期値 : array()) ※ その他のパラメータについては、View::element() を参照
return void

swf() public method

Flashを表示する
public swf ( string $path, string $id, integer $width, integer $height, array $options = [] ) : string
$path string Flashのパス
$id string 任意のID(divにも埋め込まれる)
$width integer 横幅
$height integer 高さ
$options array オプション(初期値 : array()) - `version` : Flashのバージョン(初期値 : 7) - `script` : Flashを読み込むJavascriptのパス(初期値 : admin/swfobject-2.2) - `noflash` : Flashがインストールされてない場合に表示する文字列
return string Flash表示タグ

themeUrl() public method

現在のテーマのURLを出力する
public themeUrl ( ) : void
return void

title() public method

タイトルタグを出力する
public title ( string $separator = '|', string $categoryTitleOn = null ) : void
$separator string 区切り文字
$categoryTitleOn string カテゴリを表示するかどうか boolean で指定
return void

updateInfo() public method

更新情報を出力する
public updateInfo ( )

url() public method

《利用例》 会社概要
public url ( mixed $url = null, boolean $full = false, boolean $sessionId = true ) : void
$url mixed baserCMS設置フォルダからの絶対URL、もしくは配列形式のURL情報 省略した場合には、PC用のトップページのURLを出力する
$full boolean httpから始まるURLを取得するかどうか
$sessionId boolean セションIDを付加するかどうか
return void

webClipIcon() public method

スマートフォン用のウェブクリップアイコン用のタグを出力する
public webClipIcon ( string $fileName = 'apple-touch-icon-precomposed.png', boolean $useGloss = false )
$fileName string ファイル名(webroot に配置する事が前提)
$useGloss boolean 光沢有無

widgetArea() public method

ウィジェットエリアを出力する
public widgetArea ( integer $no = null, array $options = [] ) : void
$no integer ウィジェットエリアNO(初期値 : null)※ 省略した場合は、コンテンツごとに管理システムにて設定されているウィジェットエリアを出力する
$options array オプション(初期値 : array()) - `loadHelpers` : ヘルパーを読み込むかどうか(初期値 : false) todo loadHelpersが利用されていないのをなんとかする - `subDir` : テンプレートの配置場所についてプレフィックスに応じたサブフォルダを利用するかどうか(初期値 : true)
return void

xmlHeader() public method

XMLヘッダタグを出力する
public xmlHeader ( array $attrib = [] ) : void
$attrib array 属性
return void

Property Details

$_Page protected_oe property

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

$_Permission protected_oe property

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

$_categoryTitle protected_oe property

カテゴリタイトル
protected $_categoryTitle

$_categoryTitleOn protected_oe property

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

$_pluginBasers protected_oe property

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

$helpers public_oe property

ヘルパー
public array $helpers
return array

$siteConfig public_oe property

サイト基本設定データ
public array $siteConfig
return array