「ver4/関数リファレンス」の版間の差分
提供: baserCMS公式ガイド
Katokaisya (トーク | 投稿記録) |
|||
(5人の利用者による、間の25版が非表示) | |||
行17: | 行17: | ||
- [content](/ver4/関数リファレンス/content) - コンテンツ本体を出力する | - [content](/ver4/関数リファレンス/content) - コンテンツ本体を出力する | ||
- [contentsMenu](/ver4/関数リファレンス/contentsMenu) - コンテンツメニューを出力する | - [contentsMenu](/ver4/関数リファレンス/contentsMenu) - コンテンツメニューを出力する | ||
− | - [contentsName](/ver4/関数リファレンス/contentsName) - | + | - [contentsName](/ver4/関数リファレンス/contentsName) - コンテンツを特定する文字列を出力する |
- [contentsNavi](/ver4/関数リファレンス/contentsNavi) - コンテンツナビを出力する | - [contentsNavi](/ver4/関数リファレンス/contentsNavi) - コンテンツナビを出力する | ||
- [contentsTitle](/ver4/関数リファレンス/contentsTitle) - コンテンツのタイトルを出力する | - [contentsTitle](/ver4/関数リファレンス/contentsTitle) - コンテンツのタイトルを出力する | ||
行33: | 行33: | ||
- [func](/ver4/関数リファレンス/func) - ツールバーエレメントや CakePHP のデバッグ出力を表示 | - [func](/ver4/関数リファレンス/func) - ツールバーエレメントや CakePHP のデバッグ出力を表示 | ||
- [getBaseUrl](/ver4/関数リファレンス/getBaseUrl) - ベースとなるURLを取得する | - [getBaseUrl](/ver4/関数リファレンス/getBaseUrl) - ベースとなるURLを取得する | ||
− | |||
- [getContentCreatedDate](/ver4/関数リファレンス/getContentCreatedDate) - コンテンツ作成日を取得 | - [getContentCreatedDate](/ver4/関数リファレンス/getContentCreatedDate) - コンテンツ作成日を取得 | ||
- [getContentModifiedDate](/ver4/関数リファレンス/getContentModifiedDate) - コンテンツ更新日を取得 | - [getContentModifiedDate](/ver4/関数リファレンス/getContentModifiedDate) - コンテンツ更新日を取得 | ||
− | - [getContentsMenu](/ver4/関数リファレンス/getContentsMenu) - | + | - [getContentsMenu](/ver4/関数リファレンス/getContentsMenu) - コンテンツメニューを取得する |
− | - [getContentsName](/ver4/関数リファレンス/getContentsName) - | + | - [getContentsName](/ver4/関数リファレンス/getContentsName) - コンテンツを特定する文字列を取得する |
- [getContentsTitle](/ver4/関数リファレンス/getContentsTitle) - コンテンツタイトルを取得する | - [getContentsTitle](/ver4/関数リファレンス/getContentsTitle) - コンテンツタイトルを取得する | ||
- [getCrumbs](/ver4/関数リファレンス/getCrumbs) - パンくず用の配列を取得する | - [getCrumbs](/ver4/関数リファレンス/getCrumbs) - パンくず用の配列を取得する | ||
行57: | 行56: | ||
- [[getSitePrefix]] | - [[getSitePrefix]] | ||
- [getSiteSearchForm](/ver4/関数リファレンス/getSiteSearchForm) - サイト内検索フォームを取得 | - [getSiteSearchForm](/ver4/関数リファレンス/getSiteSearchForm) - サイト内検索フォームを取得 | ||
− | - [getSiteUrl](/ver4/関数リファレンス/getSiteUrl) - | + | - [getSiteUrl](/ver4/関数リファレンス/getSiteUrl) - WEBサイトURLを取得する |
- [getSubMenu](/ver4/関数リファレンス/getSubMenu) - サブメニューを出力する | - [getSubMenu](/ver4/関数リファレンス/getSubMenu) - サブメニューを出力する | ||
- [getThemeUrl](/ver4/関数リファレンス/getThemeUrl) - テーマのURLを取得する | - [getThemeUrl](/ver4/関数リファレンス/getThemeUrl) - テーマのURLを取得する | ||
行122: | 行121: | ||
- [blogPosts](/ver4/関数リファレンス/blogPosts) - ブログ記事一覧出力 | - [blogPosts](/ver4/関数リファレンス/blogPosts) - ブログ記事一覧出力 | ||
+ | - [getBlogs](/ver4/関数リファレンス/getBlogs) - Blogの基本情報を全て取得する | ||
- [isBlogCategory](/ver4/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | - [isBlogCategory](/ver4/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | ||
- [isBlogDate](/ver4/関数リファレンス/isBlogDate) - 日別記事一覧ページ判定 | - [isBlogDate](/ver4/関数リファレンス/isBlogDate) - 日別記事一覧ページ判定 | ||
行141: | 行141: | ||
- [allowPublish](/ver4/関数リファレンス/blog/allowPublish) - 公開状態を取得する | - [allowPublish](/ver4/関数リファレンス/blog/allowPublish) - 公開状態を取得する | ||
- [author](/ver4/関数リファレンス/author) - 記事の投稿者を出力する | - [author](/ver4/関数リファレンス/author) - 記事の投稿者を出力する | ||
− | - [blogName](/ver4/関数リファレンス/blogName) - | + | - [blogName](/ver4/関数リファレンス/blogName) - ブログのコンテンツ名を出力する |
- [category](/ver4/関数リファレンス/category) - 記事が属するカテゴリ名を出力する | - [category](/ver4/関数リファレンス/category) - 記事が属するカテゴリ名を出力する | ||
- [currentBlogId](/ver4/関数リファレンス/currentBlogId) - ブログIDを出力する | - [currentBlogId](/ver4/関数リファレンス/currentBlogId) - ブログIDを出力する | ||
行148: | 行148: | ||
- [eyeCatch](/ver4/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する | - [eyeCatch](/ver4/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する | ||
- [getBlogArchiveType](/ver4/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する | - [getBlogArchiveType](/ver4/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する | ||
− | - [getBlogName](/ver4/関数リファレンス/getBlogName) - | + | - [getBlogName](/ver4/関数リファレンス/getBlogName) - ブログのコンテンツ名を取得する |
- [getCategory](/ver4/関数リファレンス/getCategory) - 記事が属するカテゴリ名の一覧を取得する | - [getCategory](/ver4/関数リファレンス/getCategory) - 記事が属するカテゴリ名の一覧を取得する | ||
− | - [getCategoryList](/ver4/関数リファレンス/getCategoryList) - | + | - [getCategories](/ver4/関数リファレンス/getCategories) - カテゴリの一覧を取得する |
+ | - [getCategoryList](/ver4/関数リファレンス/getCategoryList) - カテゴリの一覧をリストタグで取得する | ||
- [getCategoryUrl](/ver4/関数リファレンス/getCategoryUrl) - カテゴリ一覧へのURLを取得する | - [getCategoryUrl](/ver4/関数リファレンス/getCategoryUrl) - カテゴリ一覧へのURLを取得する | ||
- [getCurrentBlogId](/ver4/関数リファレンス/getCurrentBlogId) - ブログIDを出力する | - [getCurrentBlogId](/ver4/関数リファレンス/getCurrentBlogId) - ブログIDを出力する | ||
行247: | 行248: | ||
- [nextLink](/ver4/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを出力する | - [nextLink](/ver4/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを出力する | ||
- [prevLink](/ver4/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを出力する | - [prevLink](/ver4/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを出力する | ||
− | |||
行266: | 行266: | ||
### BcCsv($this->BcCsv) | ### BcCsv($this->BcCsv) | ||
− | - | + | - [addModelData](/ver4/関数リファレンス/BcCsv/addModelData) - データを追加する(単数) |
− | - | + | - [addModelDatas](/ver4/関数リファレンス/BcCsv/addModelDatas) - データをセットする(複数) |
− | - | + | - [download](/ver4/関数リファレンス/BcCsv/download) - CSVファイルをダウンロードする |
− | - | + | - [save](/ver4/関数リファレンス/BcCsv/save) - ファイルを保存する |
行279: | 行279: | ||
- [dateTimePicker](/ver4/関数リファレンス/BcForm/dateTimePicker) - 日付カレンダーと時間フィールド | - [dateTimePicker](/ver4/関数リファレンス/BcForm/dateTimePicker) - 日付カレンダーと時間フィールド | ||
- [datepicker](/ver4/関数リファレンス/BcForm/datepicker) - カレンダーコントロール付きのテキストフィールド | - [datepicker](/ver4/関数リファレンス/BcForm/datepicker) - カレンダーコントロール付きのテキストフィールド | ||
− | - | + | - [dispatchAfterForm](/ver4/関数リファレンス/BcForm/dispatchAfterForm) - フォームの最後のフィールドの後に発動する前提としてイベントを発動する |
- [editor](/ver4/関数リファレンス/BcForm/editor) - エディタを表示する | - [editor](/ver4/関数リファレンス/BcForm/editor) - エディタを表示する | ||
- [end](/ver4/関数リファレンス/BcForm/end) - フック用にCakeコアをラッピング | - [end](/ver4/関数リファレンス/BcForm/end) - フック用にCakeコアをラッピング | ||
- [file](/ver4/関数リファレンス/BcForm/file) - ファイルインプットボックス出力 | - [file](/ver4/関数リファレンス/BcForm/file) - ファイルインプットボックス出力 | ||
− | - | + | - [generateList](/ver4/関数リファレンス/BcForm/generateList) - モデルよりリストを生成する |
− | - | + | - [getControlSource](/ver4/関数リファレンス/BcForm/getControlSource) - コントロールソースを取得する |
- [hidden](/ver4/関数リファレンス/BcForm/hidden) - Cakeコアをラッピング | - [hidden](/ver4/関数リファレンス/BcForm/hidden) - Cakeコアをラッピング | ||
- [input](/ver4/関数リファレンス/BcForm/input) - Cakeコアをラッピング | - [input](/ver4/関数リファレンス/BcForm/input) - Cakeコアをラッピング | ||
行303: | 行303: | ||
- [freezeControll](/ver4/関数リファレンス/BcFreeze/freezeControll) - 凍結時用のコントロールを取得する | - [freezeControll](/ver4/関数リファレンス/BcFreeze/freezeControll) - 凍結時用のコントロールを取得する | ||
- [image](/ver4/関数リファレンス/BcFreeze/image) - ファイルコントロール(画像)を表示する | - [image](/ver4/関数リファレンス/BcFreeze/image) - ファイルコントロール(画像)を表示する | ||
− | - | + | - [jsonList](/ver4/関数リファレンス/BcFreeze/jsonList) - JsonListを出力する |
- [radio](/ver4/関数リファレンス/BcFreeze/radio) - ラジオボタンを表示する | - [radio](/ver4/関数リファレンス/BcFreeze/radio) - ラジオボタンを表示する | ||
- [select](/ver4/関数リファレンス/BcFreeze/select) - プルダウンメニューを表示 | - [select](/ver4/関数リファレンス/BcFreeze/select) - プルダウンメニューを表示 | ||
- [text](/ver4/関数リファレンス/BcFreeze/text) - テキストボックスを表示する | - [text](/ver4/関数リファレンス/BcFreeze/text) - テキストボックスを表示する | ||
- [textarea](/ver4/関数リファレンス/BcFreeze/textarea) - テキストエリアを表示する | - [textarea](/ver4/関数リファレンス/BcFreeze/textarea) - テキストエリアを表示する | ||
− | |||
- [wyear](/ver4/関数リファレンス/BcFreeze/wyear) - 和暦年を表示する | - [wyear](/ver4/関数リファレンス/BcFreeze/wyear) - 和暦年を表示する | ||
行338: | 行337: | ||
- [booleanDo](/ver4/関数リファレンス/BcText/booleanDo) - boolean型のデータを [〜する / 〜しない] 形式で出力する | - [booleanDo](/ver4/関数リファレンス/BcText/booleanDo) - boolean型のデータを [〜する / 〜しない] 形式で出力する | ||
- [booleanDoList](/ver4/関数リファレンス/BcText/booleanDoList) - boolean型用のリストを[〜する/〜しない]形式で出力する | - [booleanDoList](/ver4/関数リファレンス/BcText/booleanDoList) - boolean型用のリストを[〜する/〜しない]形式で出力する | ||
− | - | + | - [booleanExists](/ver4/関数リファレンス/BcText/booleanExists) - boolean型用を有無で出力 |
− | - | + | - [booleanExistsList](/ver4/関数リファレンス/BcText/booleanExistsList) - boolean型用のリストを「有」「無」で出力 |
− | - | + | - [booleanMark](/ver4/関数リファレンス/BcText/booleanMark) - boolean型を ○ または ― マークで出力 |
− | - | + | - [booleanMarkList](/ver4/関数リファレンス/BcText/booleanMarkList) - boolean型用のリストを ○ ― マークで出力 |
− | - | + | - [booleanStatus](/ver4/関数リファレンス/BcText/booleanStatus) - boolean型用を無効・有効で出力 |
− | - | + | - [booleanStatusList](/ver4/関数リファレンス/BcText/booleanStatusList) - boolean型用のリストを有効、無効で出力 |
− | - | + | - [dateTime](/ver4/関数リファレンス/BcText/dateTime) - form::配列形式の日付データを文字列データに変換する |
− | - | + | - [dateTimeWareki](/ver4/関数リファレンス/BcText/dateTimeWareki) - form::dateTimeで取得した和暦データを文字列データに変換する |
− | - | + | - [format](/ver4/関数リファレンス/BcText/format) - 文字をフォーマット形式で出力する |
− | - | + | - [listValue](/ver4/関数リファレンス/BcText/listValue) - モデルのコントロールソースより表示用データを取得する |
− | - | + | - [moneyFormat](/ver4/関数リファレンス/BcText/moneyFormat) - 通貨表示を行う |
− | - | + | - [noValue](/ver4/関数リファレンス/BcText/noValue) - データをチェックして空の場合に指定した値を返す |
− | - | + | - [pref](/ver4/関数リファレンス/BcText/pref) - 番号を都道府県に変換して出力 |
− | - | + | - [prefList](/ver4/関数リファレンス/BcText/prefList) - 都道府県のリストを出力 |
− | - | + | - [sex](/ver4/関数リファレンス/BcText/sex) - 性別を出力 |
− | - | + | - [zipFormat](/ver4/関数リファレンス/BcText/zipFormat) - 郵便番号にハイフンをつけて出力 |
### BcTime($this->BcTime) | ### BcTime($this->BcTime) | ||
− | - | + | - [convertToSeirekiYear](/ver4/関数リファレンス/BcTime/convertToSeirekiYear) - 和暦の年を西暦に変換する。和暦のフォーマット例:s-48 |
- [[convertToWareki]] - 和暦変換 | - [[convertToWareki]] - 和暦変換 | ||
− | - | + | - [convertToWarekiArray](/ver4/関数リファレンス/BcTime/convertToWarekiArray) - 和暦変換(配列で返す) |
- [[convertToWarekiYear]] - 西暦を和暦の年に変換する | - [[convertToWarekiYear]] - 西暦を和暦の年に変換する | ||
- [[format]] - format 拡張 | - [[format]] - format 拡張 | ||
行400: | 行399: | ||
- [isAllowPublish](/ver4/関数リファレンス/isAllowPublish) - データが公開状態にあるか確認する | - [isAllowPublish](/ver4/関数リファレンス/isAllowPublish) - データが公開状態にあるか確認する | ||
- [isSiteRelated](/ver4/関数リファレンス/isSiteRelated) - サイト連携データかどうか確認する | - [isSiteRelated](/ver4/関数リファレンス/isSiteRelated) - サイト連携データかどうか確認する | ||
+ | |||
+ | ### Paginator($this->Paginator) | ||
+ | - [Paginator](/ver4/関数リファレンス/Paginator) - ブログ記事一覧のページネーションを出力内容を細かく指定する | ||
[[Category:開発ガイド]] | [[Category:開発ガイド]] |
2020年10月20日 (火) 15:44時点における最新版
baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。 コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 baserCMS API Document サイト には、baserCMSの関数がすべて網羅されています。
このページの完成度を高めるためにご協力ください!
既にある関数ページに説明を書き込んだり、その関数に関する情報や使用例を記載してください。その際には[サンプルページ](/ver4/関数リファレンス/sample) の形式を参考にしてください。
関数が不足している場合や、不適切なカテゴリーにある場合は、適切なカテゴリーに移動してください。また、誤字脱字に気付かれた場合は訂正してください。
みなさん、宜しくお願いします。
既にある関数ページに説明を書き込んだり、その関数に関する情報や使用例を記載してください。その際には[サンプルページ](/ver4/関数リファレンス/sample) の形式を参考にしてください。
関数が不足している場合や、不適切なカテゴリーにある場合は、適切なカテゴリーに移動してください。また、誤字脱字に気付かれた場合は訂正してください。
みなさん、宜しくお願いします。
目次
- 1 BcBaser
- 2 ブログ
- 3 メールフォーム
- 4 フィード
- 5 その他
- 5.1 固定ページ($this->BcPage)
- 5.2 BcAdmin($this->BcAdmin)
- 5.3 BcArray($this->BcArray)
- 5.4 BcCkeditor($this->BcCkeditor)
- 5.5 BcCsv($this->BcCsv)
- 5.6 BcForm($this->BcForm)
- 5.7 BcFreeze($this->BcFreeze)
- 5.8 BcGooglemaps($this->BcGooglemaps)
- 5.9 BcHtml($this->BcHtml)
- 5.10 BcMobile($this->BcMobile)
- 5.11 BcSmartphone($this->BcSmartphone)
- 5.12 BcText($this->BcText)
- 5.13 BcTime($this->BcTime)
- 5.14 BcUpload($this->BcUpload)
- 5.15 BcWidgetArea($this->BcWidgetArea)
- 5.16 BcXml($this->BcXml)
- 5.17 BcContents($this->BcContents)
- 5.18 Paginator($this->Paginator)
BcBaser
BcBaser($this->BcBaser)
$this->BcBaser->関数名 で使える関数は、どこでも共通で利用できる関数です。
- addCrumb - パンくずリストの要素を追加する
- baseUrl - ベースとなるURLを出力する
- cacheHeader - ブラウザにキャッシュさせる為のヘッダーを出力する
- charset - メタタグを出力する
- checkUpdate - アップデート処理が必要かチェックする
- content - コンテンツ本体を出力する
- contentsMenu - コンテンツメニューを出力する
- contentsName - コンテンツを特定する文字列を出力する
- contentsNavi - コンテンツナビを出力する
- contentsTitle - コンテンツのタイトルを出力する
- copyYear - コピーライト用の年を出力する
- crumbs - パンくずリストを出力する
- crumbsList - パンくずリストを出力する
- css - CSSの読み込みタグを出力する
- docType - ドキュメントタイプを指定するタグを出力する
- editLink - 編集画面へのリンクを出力する
- element - エレメントテンプレートを出力する
- existsEditLink - 編集画面へのリンクが存在するかチェックする
- existsPublishLink - 公開ページへのリンクが存在するかチェックする
- flash - セッションに保存したメッセージを出力する
- footer - フッターテンプレートを出力する
- func - ツールバーエレメントや CakePHP のデバッグ出力を表示
- getBaseUrl - ベースとなるURLを取得する
- getContentCreatedDate - コンテンツ作成日を取得
- getContentModifiedDate - コンテンツ更新日を取得
- getContentsMenu - コンテンツメニューを取得する
- getContentsName - コンテンツを特定する文字列を取得する
- 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ヘッダタグを出力する
BlogBaser($this->BcBaserで利用可)
- blogPosts - ブログ記事一覧出力
- getBlogs - Blogの基本情報を全て取得する
- isBlogCategory - カテゴリー別記事一覧ページ判定
- isBlogDate - 日別記事一覧ページ判定
- isBlogHome - インデックスページ判定
- isBlogMonth - 月別記事一覧ページ判定
- isBlogSingle - 個別ページ判定
- isBlogTag - タグ別記事一覧ページ判定
- isBlogYear - 年別記事一覧ページ判定
FeedBaser($this->BcBaserで利用可)
- feed - フィード出力
ブログ
Blog($this->Blog)
$this->Blog->関数名 で使える関数は、ブログで利用できる関数です。
- allowPublish - 公開状態を取得する
- author - 記事の投稿者を出力する
- blogName - ブログのコンテンツ名を出力する
- category - 記事が属するカテゴリ名を出力する
- currentBlogId - ブログIDを出力する
- description - ブログの説明文を出力する
- descriptionExists - ブログの説明文が指定されているかどうかを判定する
- eyeCatch - アイキャッチ画像を出力する
- getBlogArchiveType - ブログのアーカイブタイプを取得する
- getBlogName - ブログのコンテンツ名を取得する
- getCategory - 記事が属するカテゴリ名の一覧を取得する
- getCategories - カテゴリの一覧を取得する
- getCategoryList - カテゴリの一覧をリストタグで取得する
- getCategoryUrl - カテゴリ一覧へのURLを取得する
- getCurrentBlogId - ブログIDを出力する
- getDescription - ブログの説明文を取得する
- getEyeCatch - アイキャッチ画像を取得する
- getHtmlById - 記事中のタグで指定したIDの内容を取得する
- getParentCategory - 親カテゴリを取得する
- getPostContent - 記事の本文を取得する
- getPostDate - 登録日を取得する
- getPostDetail - 記事の詳細を取得する
- getPostImg - 記事中の画像を取得する
- getPostLink - 記事へのリンクを取得する
- getPostLinkUrl - ブログ記事のURLを返す
- getPostTitle - 記事タイトルを取得する
- getRelatedPosts - 同じタグの関連投稿を取得する
- getTag - タグを取得する
- getTitle - タイトルを取得する
- isArchive - アーカイブページ判定
- isCategory - カテゴリー別記事一覧ページ判定
- isDate - 日別記事一覧ページ判定
- isHome - インデックスページ判定
- isMonth - 月別記事一覧ページ判定
- isSingle - 個別ページ判定
- isTag - タグ別記事一覧ページ判定
- isYear - 年別記事一覧ページ判定
- mailFormLink - メールフォームプラグインのフォームへのリンクを生成する
- nextLink - 次の記事へのリンクを出力する
- postContent - 記事の本文を表示する
- postDate - 記事の登録日を出力する
- postDetail - 記事の詳細を表示する
- postImg - 記事中の画像を出力する
- postLink - 記事へのリンクを出力する
- postTitle - 記事のタイトルを出力する
- prevLink - 前の記事へのリンクを出力する
- removeCtrlChars - 文字列から制御文字を取り除く
- setContent - ブログコンテンツデータをセットする
- tag - タグを出力する
- title - ブログタイトルを出力する
メールフォーム
Mail($this->Mail)
$this->Mail->関数名 で使える関数は、メールフォームで利用できる関数です。
- description - メールの説明文を表示する
- descriptionExists - メールの説明文が指定されているかどうかを判定する
- getDescription - メールの説明文を取得する
- getForm - メールフォームを取得する
- getToken - ブラウザの戻るボタン対応コードを作成
- link - メールフォームへのリンクを生成する
- setMailContent - メールコンテンツデータをセットする
- token - ブラウザの戻るボタン対応コードを出力
Maildata($this->Maildata)
$this->Maildata->関数名 で使える関数は、メールフォームで利用できる関数です。
- control - メール表示用のデータを出力する ※互換性維持用
- toDisplayString - メール表示用のデータを出力する
Mailfield($this->Mailfield)
$this->Mailfield->関数名 で使える関数は、メールフォームで利用できる関数です。
- getAttributes - htmlの属性を取得する
- getOptions - コントロールのソースを取得する
Mailform($this->Mailform)
$this->Mailform->関数名 で使える関数は、メールフォームで利用できる関数です。
フィード
Feed($this->Feed)
$this->Feed->関数名 で使える関数は、フィードで利用できる関数です。
- getTemplates - レイアウトテンプレートを取得
その他
固定ページ($this->BcPage)
$this->BcPage->関数名 で使える関数は、固定ページで利用できる関数です。
- allowPublish - 公開状態を取得する
- content - 固定ページのコンテンツを出力する
- getNextLink - ページカテゴリ間の次の記事へのリンクを取得する
- getPageList - ページリストを取得する
- getPrevLink - ページカテゴリ間の前の記事へのリンクを取得する
- getUrl - ページ機能用URLを取得する
- nextLink - ページカテゴリ間の次の記事へのリンクを出力する
- prevLink - ページカテゴリ間の前の記事へのリンクを出力する
BcAdmin($this->BcAdmin)
- isAdminGlobalmenuUsed - 管理システムグローバルメニューの利用可否確認
- isSystemAdmin - ログインユーザーがシステム管理者かチェックする
BcArray($this->BcArray)
BcCkeditor($this->BcCkeditor)
- 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 - 和暦年を表示する
BcFreeze($this->BcFreeze)
- checkbox - チェックボックスを表示する
- dateTime - 日付タグを表示
- datepicker - カレンダーコントロール付きのテキストフィールド
- file - ファイルタグを出力
- freeze - フォームを凍結させる
- freezeControll - 凍結時用のコントロールを取得する
- image - ファイルコントロール(画像)を表示する
- jsonList - JsonListを出力する
- radio - ラジオボタンを表示する
- select - プルダウンメニューを表示
- text - テキストボックスを表示する
- textarea - テキストエリアを表示する
- wyear - 和暦年を表示する
BcGooglemaps($this->BcGooglemaps)
- getLocation - 位置情報を取得する
- load - Google マップ を読み込む
- loadLocation - 位置情報を読み込む
BcHtml($this->BcHtml)
- getStripCrumbs - タグにラッピングされていないパンくずデータを取得する
BcMobile($this->BcMobile)
- afterLayout - 出力データをSJISに変換する
- header - コンテンツタイプを出力
BcSmartphone($this->BcSmartphone)
- afterLayout - スマートフォン用プレフィックスを追加する
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 - アップロードの設定を取得する
BcWidgetArea($this->BcWidgetArea)
- show - ウィジェットエリアを表示する
BcXml($this->BcXml)
- header - XML宣言を生成する
BcContents($this->BcContents)
- getContentFolderList - フォルダリストを取得する
- getCurrentRelatedSiteUrl - 現在のURLを元に指定したサブサイトのURLを取得する
- getJsonSettings - コンテンツ設定を Json 形式で取得する
- getParent - 親コンテンツを取得する
- getPureUrl - プレフィックスなしのURLを取得する
- getRelatedSiteContents - 関連サイトのコンテンツを取得
- getRelatedSiteLinks - 関連サイトのリンク情報を取得する
- getSiteRoot - サイトIDからコンテンツを取得する
- getSiteRootId - サイトIDからコンテンツIDを取得する
- getTree - コンテンツリストをツリー構造で取得する
- getUrl - フルURLを取得する
- getUrlById - コンテンツIDよりフルURLを取得する
- isActionAvailable - アクションが利用可能かどうか確認する
- isAllowPublish - データが公開状態にあるか確認する
- isSiteRelated - サイト連携データかどうか確認する
Paginator($this->Paginator)
- Paginator - ブログ記事一覧のページネーションを出力内容を細かく指定する