• Home
• BcBaserHelper

PHP Class BcBaserHelper

テーマより利用される事を前提としたヘルパーで、テーマで必要となる機能をひと通り提供する。 Show file 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

Property Details