個人用ツール

「ver4/関数リファレンス」の版間の差分

提供: baserCMS公式ガイド

移動: 案内, 検索
行127: 行127:
  
 
- [allowPublish](/ver4/関数リファレンス/allowPublish) - 公開状態を取得する
 
- [allowPublish](/ver4/関数リファレンス/allowPublish) - 公開状態を取得する
- [beforeRender](/ver4/関数リファレンス/beforeRender) - beforeRender
 
 
- [content](/ver4/関数リファレンス/BcPage/content) - 固定ページのコンテンツを出力する
 
- [content](/ver4/関数リファレンス/BcPage/content) - 固定ページのコンテンツを出力する
- [contentsNaviAvailable](/ver4/関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック
 
- [getCategory](/ver4/関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する
 
 
- [getCategoryName](/ver4/関数リファレンス/getCategoryName) - カテゴリ名を取得する
 
- [getCategoryName](/ver4/関数リファレンス/getCategoryName) - カテゴリ名を取得する
 +
- [getNextLink](/ver4/関数リファレンス/getNextLink) - ページカテゴリ間の次の記事へのリンクを取得する
 
- [getPageList](/ver4/関数リファレンス/BcPage/getPageList) - ページリストを取得する
 
- [getPageList](/ver4/関数リファレンス/BcPage/getPageList) - ページリストを取得する
- [getParentCategory](/ver4/関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する
+
- [getPrevLink](/ver4/関数リファレンス/getPrevLink) - ページカテゴリ間の前の記事へのリンクを取得する
- [getTemplates](/ver4/関数リファレンス/getTemplates) - テンプレートを取得
+
 
- [getUrl](/ver4/関数リファレンス/BcPage/getUrl) - ページ機能用URLを取得する
 
- [getUrl](/ver4/関数リファレンス/BcPage/getUrl) - ページ機能用URLを取得する
- [nextLink](/ver4/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する
+
- [nextLink](/ver4/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを出力する
- [prevLink](/ver4/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する
+
- [prevLink](/ver4/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを出力する
 
- [treeList](/ver4/関数リファレンス/treeList) - No Description ※TODO: メソッドに説明載ってない><;
 
- [treeList](/ver4/関数リファレンス/treeList) - No Description ※TODO: メソッドに説明載ってない><;
 +
- [_getPageByNextOrPrev](/ver4/関数リファレンス/_getPageByNextOrPrev) - 指定した固定ページデータの次、または、前のデータを取得する
  
 
### BlogBaser($this->BcBaserで利用可)
 
### BlogBaser($this->BcBaserで利用可)
行159: 行157:
 
- [allowPublish](/ver4/関数リファレンス/allowPublish) - 公開状態を取得する
 
- [allowPublish](/ver4/関数リファレンス/allowPublish) - 公開状態を取得する
 
- [author](/ver4/関数リファレンス/author) - 記事の投稿者を出力する
 
- [author](/ver4/関数リファレンス/author) - 記事の投稿者を出力する
 +
- [blogName](/ver4/関数リファレンス/blogName) - ブログアカウント名を出力する
 
- [category](/ver4/関数リファレンス/category) - 記事が属するカテゴリ名を出力する
 
- [category](/ver4/関数リファレンス/category) - 記事が属するカテゴリ名を出力する
 +
- [currentBlogId](/ver4/関数リファレンス/currentBlogId) - ブログIDを出力する
 
- [description](/ver4/関数リファレンス/description) - ブログの説明文を出力する
 
- [description](/ver4/関数リファレンス/description) - ブログの説明文を出力する
 
- [descriptionExists](/ver4/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する
 
- [descriptionExists](/ver4/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する
- <strike>[editPost](/ver4/関数リファレンス/editPost) - ブログ編集ページへのリンクを出力</strike>(非推奨)
 
 
- [eyeCatch](/ver4/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する
 
- [eyeCatch](/ver4/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する
 
- [getBlogArchiveType](/ver4/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する
 
- [getBlogArchiveType](/ver4/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する
 +
- [getBlogName](/ver4/関数リファレンス/getBlogName) - ブログアカウント名を取得する
 
- [getBlogTemplates](/ver4/関数リファレンス/getBlogTemplates) - ブログテンプレートを取得
 
- [getBlogTemplates](/ver4/関数リファレンス/getBlogTemplates) - ブログテンプレートを取得
 
- [getCategory](/ver4/関数リファレンス/getCategory) - 記事が属するカテゴリ名の一覧を取得する
 
- [getCategory](/ver4/関数リファレンス/getCategory) - 記事が属するカテゴリ名の一覧を取得する
 
- [getCategoryList](/ver4/関数リファレンス/getCategoryList) - カテゴリーの一覧をリストタグで取得する
 
- [getCategoryList](/ver4/関数リファレンス/getCategoryList) - カテゴリーの一覧をリストタグで取得する
 
- [getCategoryUrl](/ver4/関数リファレンス/getCategoryUrl) - カテゴリ一覧へのURLを取得する
 
- [getCategoryUrl](/ver4/関数リファレンス/getCategoryUrl) - カテゴリ一覧へのURLを取得する
 +
- [getCurrentBlogId](/ver4/関数リファレンス/getCurrentBlogId) - ブログIDを出力する
 
- [getDescription](/ver4/関数リファレンス/getDescription) - ブログの説明文を取得する
 
- [getDescription](/ver4/関数リファレンス/getDescription) - ブログの説明文を取得する
 
- [getEyeCatch](/ver4/関数リファレンス/getEyeCatch) - アイキャッチ画像を取得する
 
- [getEyeCatch](/ver4/関数リファレンス/getEyeCatch) - アイキャッチ画像を取得する
行176: 行177:
 
- [getPostContent](/ver4/関数リファレンス/getPostContent) - 記事の本文を取得する
 
- [getPostContent](/ver4/関数リファレンス/getPostContent) - 記事の本文を取得する
 
- [getPostDate](/ver4/関数リファレンス/getPostDate) - 登録日を取得する
 
- [getPostDate](/ver4/関数リファレンス/getPostDate) - 登録日を取得する
 +
- [getPostDetail](/ver4/関数リファレンス/getPostDetail) - 記事の詳細を取得する
 
- [getPostImg](/ver4/関数リファレンス/getPostImg) - 記事中の画像を取得する
 
- [getPostImg](/ver4/関数リファレンス/getPostImg) - 記事中の画像を取得する
 
- [getPostLink](/ver4/関数リファレンス/getPostLink) - 記事へのリンクを取得する
 
- [getPostLink](/ver4/関数リファレンス/getPostLink) - 記事へのリンクを取得する
行195: 行197:
 
- [postContent](/ver4/関数リファレンス/postContent) - 記事の本文を表示する
 
- [postContent](/ver4/関数リファレンス/postContent) - 記事の本文を表示する
 
- [postDate](/ver4/関数リファレンス/postDate) - 記事の登録日を出力する
 
- [postDate](/ver4/関数リファレンス/postDate) - 記事の登録日を出力する
 +
- [postDetail](/ver4/関数リファレンス/postDetail) - 記事の詳細を表示する
 
- [postImg](/ver4/関数リファレンス/postImg) - 記事中の画像を出力する
 
- [postImg](/ver4/関数リファレンス/postImg) - 記事中の画像を出力する
 
- [postLink](/ver4/関数リファレンス/postLink) - 記事へのリンクを出力する
 
- [postLink](/ver4/関数リファレンス/postLink) - 記事へのリンクを出力する
 
- [postTitle](/ver4/関数リファレンス/postTitle) - 記事のタイトルを出力する
 
- [postTitle](/ver4/関数リファレンス/postTitle) - 記事のタイトルを出力する
 
- [prevLink](/ver4/関数リファレンス/prevLink) - 前の記事へのリンクを出力する
 
- [prevLink](/ver4/関数リファレンス/prevLink) - 前の記事へのリンクを出力する
 +
- [removeCtrlChars](/ver4/関数リファレンス/removeCtrlChars) - 文字列から制御文字を取り除く
 
- [setContent](/ver4/関数リファレンス/setContent) - ブログコンテンツデータをセットする
 
- [setContent](/ver4/関数リファレンス/setContent) - ブログコンテンツデータをセットする
 
- [tag](/ver4/関数リファレンス/tag) - タグを出力する
 
- [tag](/ver4/関数リファレンス/tag) - タグを出力する
 
- [title](/ver4/関数リファレンス/title) - ブログタイトルを出力する
 
- [title](/ver4/関数リファレンス/title) - ブログタイトルを出力する
 +
- [_getCategoryList](/ver4/関数リファレンス/_getCategoryList) - カテゴリーリストを取得する
  
  
行211: 行216:
 
- [descriptionExists](/ver4/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する
 
- [descriptionExists](/ver4/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する
 
- [getDescription](/ver4/関数リファレンス/getDescription) - メールの説明文を取得する
 
- [getDescription](/ver4/関数リファレンス/getDescription) - メールの説明文を取得する
 +
- [getForm](/ver4/関数リファレンス/getForm) - メールフォームを取得する
 
- [getFormTemplates](/ver4/関数リファレンス/getFormTemplates) - フォームテンプレートを取得
 
- [getFormTemplates](/ver4/関数リファレンス/getFormTemplates) - フォームテンプレートを取得
 
- [getLayoutTemplates](/ver4/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得
 
- [getLayoutTemplates](/ver4/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得
 
- [getMailTemplates](/ver4/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得
 
- [getMailTemplates](/ver4/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得
- <strike>[indexFields](/ver4/関数リファレンス/indexFields) - 管理画面のメールフィールド一覧ページへのリンクを出力する</strike>(非推奨)
+
- [getToken](/ver4/関数リファレンス/getToken) - ブラウザの戻るボタン対応コードを作成
 
- [link](/ver4/関数リファレンス/link) - メールフォームへのリンクを生成する
 
- [link](/ver4/関数リファレンス/link) - メールフォームへのリンクを生成する
 
- [setMailContent](/ver4/関数リファレンス/setMailContent) - メールコンテンツデータをセットする
 
- [setMailContent](/ver4/関数リファレンス/setMailContent) - メールコンテンツデータをセットする
 +
- [token](/ver4/関数リファレンス/token) - ブラウザの戻るボタン対応コードを出力
  
 
### Maildata($this->Maildata)
 
### Maildata($this->Maildata)
行236: 行243:
  
 
- [control](/ver4/関数リファレンス/control) - メールフィールドのデータよりコントロールを生成する
 
- [control](/ver4/関数リファレンス/control) - メールフィールドのデータよりコントロールを生成する
 +
- [create](/ver4/関数リファレンス/create) - ファイル添付の対応のためにデフォルト値を変更
  
  
行242: 行250:
 
$this->Feed->関数名 で使える関数は、フィードで利用できる関数です。
 
$this->Feed->関数名 で使える関数は、フィードで利用できる関数です。
  
- [cacheHeader](/ver4/関数リファレンス/cacheHeader) - フィードリストのキャッシュヘッダーを出力する
+
- <strike>[cacheHeader](/ver4/関数リファレンス/cacheHeader) - フィードリストのキャッシュヘッダーを出力する</strike>(非推奨)
 
- [getTemplates](/ver4/関数リファレンス/getTemplates) - レイアウトテンプレートを取得
 
- [getTemplates](/ver4/関数リファレンス/getTemplates) - レイアウトテンプレートを取得
- [saveCachetime](/ver4/関数リファレンス/saveCachetime) - フィードのキャッシュタイムをキャッシュファイルに保存
+
- <strike>[saveCachetime](/ver4/関数リファレンス/saveCachetime) - フィードのキャッシュタイムをキャッシュファイルに保存</strike>(非推奨)
  
 
### FeedBaser($this->BcBaserで利用可)
 
### FeedBaser($this->BcBaserで利用可)
行290: 行298:
 
- [jsonList](/ver4/関数リファレンス/jsonList) - JsonListを出力する
 
- [jsonList](/ver4/関数リファレンス/jsonList) - JsonListを出力する
 
- [prefTag](/ver4/関数リファレンス/prefTag) - 都道府県用のSELECTタグを表示する
 
- [prefTag](/ver4/関数リファレンス/prefTag) - 都道府県用のSELECTタグを表示する
 +
- [radio](/ver4/関数リファレンス/radio) - ラジオウィジェットのセットを作成する
 +
- [select](/ver4/関数リファレンス/select) - フォーマットされたSELECT要素を返す
 
- [selectText](/ver4/関数リファレンス/selectText) - 文字列保存用複数選択コントロール
 
- [selectText](/ver4/関数リファレンス/selectText) - 文字列保存用複数選択コントロール
 +
- [submit](/ver4/関数リファレンス/submit) - submitボタンを作成する
 
- [wyear](/ver4/関数リファレンス/wyear) - 和暦年を表示する
 
- [wyear](/ver4/関数リファレンス/wyear) - 和暦年を表示する
 +
- [_generateOptions](/ver4/関数リファレンス/_generateOptions) - SELECT要素の共通のオプションのリストを生成
 +
- [_getId](/ver4/関数リファレンス/_getId) - フォームのIDを取得する
 +
- [_selectOptions](/ver4/関数リファレンス/_selectOptions) - OPTION / OPTGROUP要素の配列を返す
  
  
行315: 行329:
 
- [load](/ver4/関数リファレンス/load) - Google マップ を読み込む
 
- [load](/ver4/関数リファレンス/load) - Google マップ を読み込む
 
- [loadLocation](/ver4/関数リファレンス/loadLocation) - 位置情報を読み込む
 
- [loadLocation](/ver4/関数リファレンス/loadLocation) - 位置情報を読み込む
 +
- [_getScript](/ver4/関数リファレンス/_getScript) - Google マップ読み込み用のjavascriptを生成する
  
  
行323: 行338:
 
## BcMobile($this->BcMobile)
 
## BcMobile($this->BcMobile)
 
- [afterLayout](/ver4/関数リファレンス/afterLayout) - 出力データをSJISに変換する
 
- [afterLayout](/ver4/関数リファレンス/afterLayout) - 出力データをSJISに変換する
 +
- [afterRender](/ver4/関数リファレンス/afterRender) - 別URLの場合、canonicalを出力
 
- [header](/ver4/関数リファレンス/header) - コンテンツタイプを出力
 
- [header](/ver4/関数リファレンス/header) - コンテンツタイプを出力
 +
- [_removeMobilePrefix](/ver4/関数リファレンス/_removeMobilePrefix) - リンクからモバイル用のプレフィックスを除外する
 +
- [_addMobilePrefix](/ver4/関数リファレンス/_addMobilePrefix) - リンクにモバイル用のプレフィックスを追加する
  
  
 
## BcSmartphone($this->BcSmartphone)
 
## BcSmartphone($this->BcSmartphone)
 
- [afterLayout](/ver4/関数リファレンス/afterLayout) - スマートフォン用プレフィックスを追加する
 
- [afterLayout](/ver4/関数リファレンス/afterLayout) - スマートフォン用プレフィックスを追加する
 +
- [afterRender](/ver4/関数リファレンス/afterRender) - 別URLの場合、canonicalを出力
 +
- [_removePrefix](/ver4/関数リファレンス/_removePrefix) - リンクからモバイル用のプレフィックスを除外する
 +
- [_addPrefix](/ver4/関数リファレンス/_addPrefix) - リンクにモバイル用のプレフィックスを追加する
  
  
行344: 行365:
 
- [booleanStatus](/ver4/関数リファレンス/booleanStatus) - boolean型用を無効・有効で出力
 
- [booleanStatus](/ver4/関数リファレンス/booleanStatus) - boolean型用を無効・有効で出力
 
- [booleanStatusList](/ver4/関数リファレンス/booleanStatusList) - boolean型用のリストを有効、無効で出力
 
- [booleanStatusList](/ver4/関数リファレンス/booleanStatusList) - boolean型用のリストを有効、無効で出力
- [dateTime](/ver4/関数リファレンス/dateTime) - form::dateTimeで取得したデータを文字列データに変換する
+
- [dateTime](/ver4/関数リファレンス/dateTime) - form::配列形式の日付データを文字列データに変換する
 
- [dateTimeWareki](/ver4/関数リファレンス/dateTimeWareki) - form::dateTimeで取得した和暦データを文字列データに変換する
 
- [dateTimeWareki](/ver4/関数リファレンス/dateTimeWareki) - form::dateTimeで取得した和暦データを文字列データに変換する
 
- [format](/ver4/関数リファレンス/format) - 文字をフォーマット形式で出力する
 
- [format](/ver4/関数リファレンス/format) - 文字をフォーマット形式で出力する
行353: 行374:
 
- [prefList](/ver4/関数リファレンス/prefList) - 都道府県のリストを出力
 
- [prefList](/ver4/関数リファレンス/prefList) - 都道府県のリストを出力
 
- [sex](/ver4/関数リファレンス/sex) - 性別を出力
 
- [sex](/ver4/関数リファレンス/sex) - 性別を出力
- [toArray](/ver4/関数リファレンス/toArray) - 区切り文字で区切られたテキストを配列に変換する
 
 
- [zipFormat](/ver4/関数リファレンス/zipFormat) - 郵便番号にハイフンをつけて出力
 
- [zipFormat](/ver4/関数リファレンス/zipFormat) - 郵便番号にハイフンをつけて出力
  
行373: 行393:
  
 
## BcUpload($this->BcUpload)
 
## BcUpload($this->BcUpload)
<del>- [file](/ver4/関数リファレンス/file) - ファイルインプットボックス出力</del>(非推奨)
+
- [fileLink](/ver4/関数リファレンス/fileLink) - ファイルへのリンクを取得する
- [fileLink](/ver4/関数リファレンス/fileLink) - ファイルへのリンクを取得する
+
- [uploadImage](/ver4/関数リファレンス/uploadImage) - アップロードした画像のタグをリンク付きで出力する
- [uploadImage](/ver4/関数リファレンス/uploadImage) - アップロードした画像のタグをリンク付きで出力する
+
- [getBasePath](/ver4/関数リファレンス/getBasePath) - アップロード先のベースパスを取得
 +
- [getBcUploadSetting](/ver4/関数リファレンス/getBcUploadSetting) - アップロードの設定を取得する
  
  
 
## BcXml($this->BcXml)
 
## BcXml($this->BcXml)
 
- [header](/ver4/関数リファレンス/header) - XML宣言を生成する
 
- [header](/ver4/関数リファレンス/header) - XML宣言を生成する
 +
 +
 +
## BcContents($this->BcContents)
 +
- [getContentFolderList](/ver4/関数リファレンス/getContentFolderList) - フォルダリストを取得する
 +
- [getCurrentRelatedSiteU](/ver4/関数リファレンス/getCurrentRelatedSiteU) - 現在のURLを元に指定したサブサイトのURLを取得する
 +
- [getJsonSettings](/ver4/関数リファレンス/getJsonSettings) - コンテンツ設定を Json 形式で取得する
 +
- [getParent](/ver4/関数リファレンス/getParent) - 親コンテンツを取得する
 +
- [getPureUrl](/ver4/関数リファレンス/getPureUrl) - プレフィックスなしのURLを取得する
 +
- [getRelatedSiteContents](/ver4/関数リファレンス/getRelatedSiteContents) - 関連サイトのコンテンツを取得
 +
- [getRelatedSiteLinks](/ver4/関数リファレンス/getRelatedSiteLinks) - 関連サイトのリンク情報を取得する
 +
- [getTree](/ver4/関数リファレンス/getTree) - コンテンツリストをツリー構造で取得する
 +
- [getUrl](/ver4/関数リファレンス/getUrl) - フルURLを取得する
 +
- [getUrlById](/ver4/関数リファレンス/getUrlById) - コンテンツIDよりフルURLを取得する
 +
- [isAllowPublish](/ver4/関数リファレンス/isAllowPublish) - データが公開状態にあるか確認する
 +
- [isSiteRelated](/ver4/関数リファレンス/isSiteRelated) - サイト連携データかどうか確認する
 +
- [setup](/ver4/関数リファレンス/setup) - セットアップ
 +
- [_getExistsTitles](/ver4/関数リファレンス/_getExistsTitles) - シングルコンテンツで既に登録済のタイトルを取得する
 +
- [_getIconUrl](/ver4/関数リファレンス/_getIconUrl) - アイコンのURLを取得する
  
 
[[Category:開発ガイド]]
 
[[Category:開発ガイド]]

2016年10月31日 (月) 17:44時点における版

baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。 コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 baserCMS API Document サイト には、baserCMSの関数がすべて網羅されています。

BcBaser($this->BcBaser)

$this->BcBaser->関数名 で使える関数は、どこでも共通で利用できる関数です。

  • addCrumb - パンくずリストの要素を追加する
  • afterRender
  • baseUrl - ベースとなるURLを出力する
  • cacheHeader - ブラウザにキャッシュさせる為のヘッダーを出力する
  • charset - メタタグを出力する
  • checkUpdate - アップデート処理が必要かチェックする
  • content - コンテンツ本体を出力する
  • contentsMenu - コンテンツメニューを出力する
  • contentsName - コンテンツを特定するIDを出力する
  • contentsNavi - コンテンツナビを出力する
  • contentsTitle - コンテンツのタイトルを出力する
  • copyYear - コピーライト用の年を出力する
  • crumbs - パンくずリストを出力する
  • crumbsList - パンくずリストを出力する
  • css - CSSの読み込みタグを出力する
  • docType - ドキュメントタイプを指定するタグを出力する
  • editLink - 編集画面へのリンクを出力する
  • element - エレメントテンプレートを出力する
  • existsEditLink - 編集画面へのリンクが存在するかチェックする
  • existsPublishLink - 公開ページへのリンクが存在するかチェックする
  • flash - セッションに保存したメッセージを出力する
  • footer - フッターテンプレートを出力する
  • func - ツールバーエレメントや CakePHP のデバッグ出力を表示
  • getBaseUrl - ベースとなるURLを取得する
  • getBlogs - Blogの基本情報を全て取得する
  • getContentCreatedDate - コンテンツ作成日を取得
  • getContentModifiedDate - コンテンツ更新日を取得
  • getContentsMenu - メニューを取得する
  • getContentsName - コンテンツを特定するIDを取得する
  • getContentsTitle - コンテンツタイトルを取得する
  • getCrumbs - パンくず用の配列を取得する
  • getCurrentContent - 現在のコンテンツ情報を取得する
  • getCurrentPrefix - 現在のサイトプレフィックスを取得する
  • getDescription - meta タグ用のページ説明文を取得する
  • getElement - エレメントテンプレートのレンダリング結果を取得する
  • getGlobalMenu - グローバルメニューを取得する
  • getGoogleMaps - Google Maps を取得する
  • getHere - 現在のページの純粋なURLを取得する
  • getImg - 画像タグを取得する
  • getKeywords - meta タグ用のキーワードを取得する
  • getLink - アンカータグを取得する
  • getParams - URLのパラメータ情報を返す
  • getRelatedSiteLinks - 関連サイトのリンク一覧を取得
  • getRoot - baserCMSが設置されているパスを出力する
  • getSitemap - サイトマップを取得する
  • getSiteName - WEBサイト名を取得する
  • getSitePrefix
  • getSiteSearchForm - サイト内検索フォームを取得
  • getSiteUrl - WEBサイトURLを出力する
  • getSubMenu - サブメニューを出力する
  • getThemeUrl - テーマのURLを取得する
  • getTitle - タイトルタグを取得する
  • getUpdateInfo - 更新情報を取得する
  • getUri - httpから始まるURLを取得する
  • getUrl - baserCMSの設置フォルダを考慮したURLを取得する
  • getUserName - ユーザー名を整形して表示する
  • getWidgetArea - ウィジェットエリアを取得する
  • globalMenu - グローバルメニューを出力する
  • googleAnalytics - Google Analytics のトラッキングコードを出力する
  • googleMaps - Google Maps を出力する
  • header - ヘッダーテンプレートを出力する
  • icon - アイコン(favicon)タグを出力する
  • img - 画像読み込みタグを出力する
  • includeCore - コアテンプレートを読み込む
  • isAdminUser - 現在のログインユーザーが管理者グループかどうかチェックする
  • isBlog - 現在のページがブログプラグインかどうかを判定する
  • isCategoryTop - 現在のページがページカテゴリのトップかどうかを判定する
  • isCurrentUrl - 指定したURLが現在のURLと同じかどうか判定する
  • isHome - 現在のページがトップページかどうかを判定する
  • isMail - 現在のページがメールプラグインかどうかを判定する
  • isPage - 現在のページが固定ページかどうかを判定する
  • isSSL - SSL通信かどうか判定する
  • js - javascriptの読み込みタグを出力する
  • link - アンカータグを出力する
  • listNum - 表示件数設定機能を出力する
  • logo - ロゴを出力する
  • mainImage - メインイメージを出力する
  • mark - 文字列を検索しマークとしてタグをつける
  • metaDescription - ページ説明文用のメタタグを出力する
  • metaKeywords - キーワード用のメタタグを出力する
  • page - ページをエレメントとして読み込む
  • pagination - ページネーションを出力する
  • publishLink - 公開ページへのリンクを出力する
  • relatedSiteLinks - 関連サイトのリンク一覧を取得
  • root - baserCMSが設置されているパスを出力する
  • rss - RSSフィードのリンクタグを出力する
  • scripts - コンテンツ内で設定した CSS や javascript をレイアウトテンプレートに出力し、ログイン中の場合、ツールバー用のCSSも出力する
  • set - レイアウトで利用する為の変数を設定する
  • setCategoryTitle - タイトルへのカテゴリタイトルの出力有無を設定する
  • setDescription - meta タグの説明文を設定する
  • setHomeTitle - トップページのタイトルをセットする
  • setKeywords - meta タグのキーワードを設定する
  • setPageEditLink - 編集画面へのリンクを設定する
  • setSubMenus - サブメニューを設定する(管理画面用)
  • setTitle - タイトルを設定する
  • siteSearchForm - サイト内検索フォームを出力
  • sitemap - サイトマップを出力する
  • siteName - WEBサイト名を出力する
  • siteUrl - WEBサイトURLを出力する
  • subMenu - サブメニューを出力する
  • swf - Flashを表示する
  • themeUrl - テーマのURLを出力する
  • title - タイトルタグを出力する
  • updateInfo - 更新情報を出力する
  • url - baserCMSの設置フォルダを考慮したURLを出力する
  • webClipIcon - スマートフォン用のウェブクリップアイコン用のタグを出力する
  • widgetArea - ウィジェットエリアを出力する
  • xmlHeader - XMLヘッダタグを出力する
  • __call - PluginBaserHelper 用マジックメソッド
  • _getThemeImage - ロゴを出力する
  • _initPluginBasers - PluginBaserHelper を初期化する

固定ページ($this->BcPage)

$this->BcPage->関数名 で使える関数は、固定ページで利用できる関数です。

  • allowPublish - 公開状態を取得する
  • content - 固定ページのコンテンツを出力する
  • getCategoryName - カテゴリ名を取得する
  • getNextLink - ページカテゴリ間の次の記事へのリンクを取得する
  • getPageList - ページリストを取得する
  • getPrevLink - ページカテゴリ間の前の記事へのリンクを取得する
  • getUrl - ページ機能用URLを取得する
  • nextLink - ページカテゴリ間の次の記事へのリンクを出力する
  • prevLink - ページカテゴリ間の前の記事へのリンクを出力する
  • treeList - No Description ※TODO: メソッドに説明載ってない><;
  • _getPageByNextOrPrev - 指定した固定ページデータの次、または、前のデータを取得する

BlogBaser($this->BcBaserで利用可)

ブログ($this->Blog)

$this->Blog->関数名 で使える関数は、ブログで利用できる関数です。

メールフォーム($this->Mail)

$this->Mail->関数名 で使える関数は、メールフォームで利用できる関数です。

  • description - メールの説明文を表示する
  • descriptionExists - メールの説明文が指定されているかどうかを判定する
  • getDescription - メールの説明文を取得する
  • getForm - メールフォームを取得する
  • getFormTemplates - フォームテンプレートを取得
  • getLayoutTemplates - レイアウトテンプレートを取得
  • getMailTemplates - レイアウトテンプレートを取得
  • getToken - ブラウザの戻るボタン対応コードを作成
  • link - メールフォームへのリンクを生成する
  • setMailContent - メールコンテンツデータをセットする
  • token - ブラウザの戻るボタン対応コードを出力

Maildata($this->Maildata)

$this->Maildata->関数名 で使える関数は、メールフォームで利用できる関数です。

  • control - メール表示用のデータを出力する

Mailfield($this->Mailfield)

$this->Mailfield->関数名 で使える関数は、メールフォームで利用できる関数です。

Mailform($this->Mailform)

$this->Mailform->関数名 で使える関数は、メールフォームで利用できる関数です。

  • control - メールフィールドのデータよりコントロールを生成する
  • create - ファイル添付の対応のためにデフォルト値を変更

フィード($this->Feed)

$this->Feed->関数名 で使える関数は、フィードで利用できる関数です。

  • cacheHeader - フィードリストのキャッシュヘッダーを出力する(非推奨)
  • getTemplates - レイアウトテンプレートを取得
  • saveCachetime - フィードのキャッシュタイムをキャッシュファイルに保存(非推奨)

FeedBaser($this->BcBaserで利用可)

  • feed - フィード出力

BcAdmin($this->BcAdmin)

  • isAdminGlobalmenuUsed - 管理システムグローバルメニューの利用可否確認
  • isSystemAdmin - ログインユーザーがシステム管理者かチェックする

BcArray($this->BcArray)

  • addText - 配列にテキストを追加する
  • first - 配列の最初の要素かどうか調べる
  • last - 配列の最後の要素かどうか調べる

BcCkeditor($this->BcCkeditor)

  • _build - CKEditor のスクリプトを構築する
  • editor - CKEditorのテキストエリアを出力する

BcCsv($this->BcCsv)

  • addModelData - データを追加する(単数)
  • addModelDatas - データをセットする(複数)
  • download - CSVファイルをダウンロードする
  • save - ファイルを保存する

BcForm($this->BcForm)

  • checkbox - CakeコアのFormHelperの拡張
  • ckeditor - CKEditorを出力する
  • create - フック用にCakeコアをラッピング
  • dateTime - CakeコアのFormHelperの拡張
  • dateTimePicker - 日付カレンダーと時間フィールド
  • datepicker - カレンダーコントロール付きのテキストフィールド
  • dispatchAfterForm - フォームの最後のフィールドの後に発動する前提としてイベントを発動する
  • editor - エディタを表示する
  • end - フック用にCakeコアをラッピング
  • file - ファイルインプットボックス出力
  • generateList - モデルよりリストを生成する
  • getControlSource - コントロールソースを取得する
  • hidden - Cakeコアをラッピング
  • input - Cakeコアをラッピング
  • jsonList - JsonListを出力する
  • prefTag - 都道府県用のSELECTタグを表示する
  • radio - ラジオウィジェットのセットを作成する
  • select - フォーマットされたSELECT要素を返す
  • selectText - 文字列保存用複数選択コントロール
  • submit - submitボタンを作成する
  • wyear - 和暦年を表示する
  • _generateOptions - SELECT要素の共通のオプションのリストを生成
  • _getId - フォームのIDを取得する
  • _selectOptions - OPTION / OPTGROUP要素の配列を返す

BcFreeze($this->BcFreeze)

  • checkbox - チェックボックスを表示する
  • dateTime - 日付タグを表示
  • datepicker - カレンダーコントロール付きのテキストフィールド
  • file - ファイルタグを出力
  • freeze - フォームを凍結させる
  • freezeControll - 凍結時用のコントロールを取得する
  • image - ファイルコントロール(画像)を表示する
  • jsonList - JsonListを出力する
  • radio - ラジオボタンを表示する
  • select - プルダウンメニューを表示
  • text - テキストボックスを表示する
  • textarea - テキストエリアを表示する
  • upload - アップロードした画像を表示する
  • wyear - 和暦年を表示する

BcGooglemaps($this->BcGooglemaps)

  • getLocation - 位置情報を取得する
  • load - Google マップ を読み込む
  • loadLocation - 位置情報を読み込む
  • _getScript - Google マップ読み込み用のjavascriptを生成する

BcHtml($this->BcHtml)

  • getStripCrumbs - タグにラッピングされていないパンくずデータを取得する

BcMobile($this->BcMobile)

  • afterLayout - 出力データをSJISに変換する
  • afterRender - 別URLの場合、canonicalを出力
  • header - コンテンツタイプを出力
  • _removeMobilePrefix - リンクからモバイル用のプレフィックスを除外する
  • _addMobilePrefix - リンクにモバイル用のプレフィックスを追加する

BcSmartphone($this->BcSmartphone)

  • afterLayout - スマートフォン用プレフィックスを追加する
  • afterRender - 別URLの場合、canonicalを出力
  • _removePrefix - リンクからモバイル用のプレフィックスを除外する
  • _addPrefix - リンクにモバイル用のプレフィックスを追加する

BcText($this->BcText)

  • age - 日付より年齢を取得する
  • arrayValue - 配列とキーを指定して値を取得する
  • arrayValues - 連想配列とキーのリストより値のリストを取得し文字列で返す
  • booleanAllow - boolean型用を可、不可で出力
  • booleanAllowList - boolean型用のリストを可、不可で出力
  • booleanDo - boolean型のデータを [〜する / 〜しない] 形式で出力する
  • booleanDoList - boolean型用のリストを[〜する/〜しない]形式で出力する
  • booleanExists - boolean型用を有無で出力
  • booleanExistsList - boolean型用のリストを「有」「無」で出力
  • booleanMark - boolean型を ○ または ― マークで出力
  • booleanMarkList - boolean型用のリストを ○ ― マークで出力
  • booleanStatus - boolean型用を無効・有効で出力
  • booleanStatusList - boolean型用のリストを有効、無効で出力
  • dateTime - form::配列形式の日付データを文字列データに変換する
  • dateTimeWareki - form::dateTimeで取得した和暦データを文字列データに変換する
  • format - 文字をフォーマット形式で出力する
  • listValue - モデルのコントロールソースより表示用データを取得する
  • moneyFormat - 通貨表示を行う
  • noValue - データをチェックして空の場合に指定した値を返す
  • pref - 番号を都道府県に変換して出力
  • prefList - 都道府県のリストを出力
  • sex - 性別を出力
  • zipFormat - 郵便番号にハイフンをつけて出力

BcTime($this->BcTime)

  • convertToSeirekiYear - 和暦の年を西暦に変換する。和暦のフォーマット例:s-48
  • convertToWareki - 和暦変換
  • convertToWarekiArray - 和暦変換(配列で返す)
  • convertToWarekiYear - 西暦を和暦の年に変換する
  • format - format 拡張
  • getJpWeek - 日本の曜日名を1文字 + $suffixの形式で取得する
  • jpWeek - 曜日情報を出力する
  • minutes - 文字列から時間(分)を取得
  • nengo - 年号を取得
  • pastDays - 指定した日数が経過しているか確認する。経過していない場合はtrueを返す
  • wareki - 和暦を取得(アルファベット)
  • wyear - 和暦の年を取得

BcUpload($this->BcUpload)

  • fileLink - ファイルへのリンクを取得する
  • uploadImage - アップロードした画像のタグをリンク付きで出力する
  • getBasePath - アップロード先のベースパスを取得
  • getBcUploadSetting - アップロードの設定を取得する

BcXml($this->BcXml)

  • header - XML宣言を生成する

BcContents($this->BcContents)