「関数リファレンス」の版間の差分
提供: baserCMS公式ガイド
(5人の利用者による、間の21版が非表示) | |||
行1: | 行1: | ||
− | ## | + | ※ baserCMS ver.3系の関数リファレンスです。[ver.4系はこちら](/ver4/関数リファレンス) |
+ | |||
+ | baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。 | ||
+ | <!-- また、主にプラグインの開発に用いるイベントに関する関数もあります。 -->コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 [baserCMS API Document サイト](http://api.basercms.net/) には、baserCMSの関数がすべて網羅されています。 | ||
+ | |||
+ | {{info|このページの完成度を高めるためにご協力ください!<br> | ||
+ | 既にある関数ページに説明を書き込んだり、その関数に関する情報や使用例を記載してください。その際には\[サンプルページ](/関数リファレンス/sample) の形式を参考にしてください。<br>関数が不足している場合や、不適切なカテゴリーにある場合は、適切なカテゴリーに移動してください。また、誤字脱字に気付かれた場合は訂正してください。<br>みなさん、宜しくお願いします。}} | ||
+ | |||
+ | ## BcBaser($this->BcBaser) | ||
+ | |||
+ | $this->BcBaser->関数名 で使える関数は、どこでも共通で利用できる関数です。 | ||
+ | |||
- [addCrumb](/関数リファレンス/addCrumb) - パンくずリストの要素を追加する | - [addCrumb](/関数リファレンス/addCrumb) - パンくずリストの要素を追加する | ||
- [baseUrl](/関数リファレンス/baseUrl) - ベースとなるURLを出力する | - [baseUrl](/関数リファレンス/baseUrl) - ベースとなるURLを出力する | ||
行53: | 行64: | ||
- [isPage](/関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する | - [isPage](/関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する | ||
- [isSSL](/関数リファレンス/isSSL) - SSL通信かどうか判定する | - [isSSL](/関数リファレンス/isSSL) - SSL通信かどうか判定する | ||
− | - [isTop](/関数リファレンス/isTop) - | + | - <strike>[isTop](/関数リファレンス/isTop) - トップページかどうか判断する</strike>(非推奨) |
- [js](/関数リファレンス/js) - javascriptの読み込みタグを出力する | - [js](/関数リファレンス/js) - javascriptの読み込みタグを出力する | ||
- [link](/関数リファレンス/link) - アンカータグを出力する | - [link](/関数リファレンス/link) - アンカータグを出力する | ||
行88: | 行99: | ||
## 固定ページ($this->BcPage) | ## 固定ページ($this->BcPage) | ||
+ | |||
+ | $this->BcPage->関数名 で使える関数は、固定ページで利用できる関数です。 | ||
+ | |||
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | - [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | ||
- [beforeRender](/関数リファレンス/beforeRender) - beforeRender | - [beforeRender](/関数リファレンス/beforeRender) - beforeRender | ||
− | - [content](/関数リファレンス/content) - 固定ページのコンテンツを出力する | + | - [content](/関数リファレンス/BcPage/content) - 固定ページのコンテンツを出力する |
- [contentsNaviAvailable](/関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック | - [contentsNaviAvailable](/関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック | ||
- [getCategory](/関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する | - [getCategory](/関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する | ||
- [getCategoryName](/関数リファレンス/getCategoryName) - カテゴリ名を取得する | - [getCategoryName](/関数リファレンス/getCategoryName) - カテゴリ名を取得する | ||
− | - [getPageList](/関数リファレンス/getPageList) - ページリストを取得する | + | - [getPageList](/関数リファレンス/BcPage/getPageList) - ページリストを取得する |
- [getParentCategory](/関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する | - [getParentCategory](/関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する | ||
- [getTemplates](/関数リファレンス/getTemplates) - テンプレートを取得 | - [getTemplates](/関数リファレンス/getTemplates) - テンプレートを取得 | ||
− | - [getUrl](/関数リファレンス/getUrl) - ページ機能用URLを取得する | + | - [getUrl](/関数リファレンス/BcPage/getUrl) - ページ機能用URLを取得する |
- [nextLink](/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する | - [nextLink](/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する | ||
- [prevLink](/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する | - [prevLink](/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する | ||
行103: | 行117: | ||
### BlogBaser($this->BcBaserで利用可) | ### BlogBaser($this->BcBaserで利用可) | ||
+ | |||
- [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力 | - [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力 | ||
- [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | - [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | ||
行115: | 行130: | ||
## ブログ($this->Blog) | ## ブログ($this->Blog) | ||
+ | |||
+ | $this->Blog->関数名 で使える関数は、ブログで利用できる関数です。 | ||
+ | |||
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | - [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | ||
- [author](/関数リファレンス/author) - 記事の投稿者を出力する | - [author](/関数リファレンス/author) - 記事の投稿者を出力する | ||
行120: | 行138: | ||
- [description](/関数リファレンス/description) - ブログの説明文を出力する | - [description](/関数リファレンス/description) - ブログの説明文を出力する | ||
- [descriptionExists](/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する | - [descriptionExists](/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する | ||
− | - [editPost](/関数リファレンス/editPost) - | + | - <strike>[editPost](/関数リファレンス/editPost) - ブログ編集ページへのリンクを出力</strike>(非推奨) |
- [eyeCatch](/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する | - [eyeCatch](/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する | ||
- [getBlogArchiveType](/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する | - [getBlogArchiveType](/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する | ||
行163: | 行181: | ||
## メールフォーム($this->Mail) | ## メールフォーム($this->Mail) | ||
+ | |||
+ | $this->Mail->関数名 で使える関数は、メールフォームで利用できる関数です。 | ||
+ | |||
- [description](/関数リファレンス/description) - メールの説明文を表示する | - [description](/関数リファレンス/description) - メールの説明文を表示する | ||
- [descriptionExists](/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する | - [descriptionExists](/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する | ||
行169: | 行190: | ||
- [getLayoutTemplates](/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得 | - [getLayoutTemplates](/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得 | ||
- [getMailTemplates](/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得 | - [getMailTemplates](/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得 | ||
− | - [indexFields](/関数リファレンス/indexFields) - | + | - <strike>[indexFields](/関数リファレンス/indexFields) - 管理画面のメールフィールド一覧ページへのリンクを出力する</strike>(非推奨) |
- [link](/関数リファレンス/link) - メールフォームへのリンクを生成する | - [link](/関数リファレンス/link) - メールフォームへのリンクを生成する | ||
- [setMailContent](/関数リファレンス/setMailContent) - メールコンテンツデータをセットする | - [setMailContent](/関数リファレンス/setMailContent) - メールコンテンツデータをセットする | ||
### Maildata($this->Maildata) | ### Maildata($this->Maildata) | ||
+ | |||
+ | $this->Maildata->関数名 で使える関数は、メールフォームで利用できる関数です。 | ||
+ | |||
- [control](/関数リファレンス/control) - メール表示用のデータを出力する | - [control](/関数リファレンス/control) - メール表示用のデータを出力する | ||
### Mailfield($this->Mailfield) | ### Mailfield($this->Mailfield) | ||
+ | |||
+ | $this->Mailfield->関数名 で使える関数は、メールフォームで利用できる関数です。 | ||
+ | |||
- [getAttributes](/関数リファレンス/getAttributes) - htmlの属性を取得する | - [getAttributes](/関数リファレンス/getAttributes) - htmlの属性を取得する | ||
- [getOptions](/関数リファレンス/getOptions) - コントロールのソースを取得する | - [getOptions](/関数リファレンス/getOptions) - コントロールのソースを取得する | ||
### Mailform($this->Mailform) | ### Mailform($this->Mailform) | ||
+ | |||
+ | $this->Mailform->関数名 で使える関数は、メールフォームで利用できる関数です。 | ||
+ | |||
- [control](/関数リファレンス/control) - メールフィールドのデータよりコントロールを生成する | - [control](/関数リファレンス/control) - メールフィールドのデータよりコントロールを生成する | ||
## フィード($this->Feed) | ## フィード($this->Feed) | ||
+ | |||
+ | $this->Feed->関数名 で使える関数は、フィードで利用できる関数です。 | ||
+ | |||
- [cacheHeader](/関数リファレンス/cacheHeader) - フィードリストのキャッシュヘッダーを出力する | - [cacheHeader](/関数リファレンス/cacheHeader) - フィードリストのキャッシュヘッダーを出力する | ||
- [getTemplates](/関数リファレンス/getTemplates) - レイアウトテンプレートを取得 | - [getTemplates](/関数リファレンス/getTemplates) - レイアウトテンプレートを取得 | ||
行231: | 行264: | ||
- [hidden](/関数リファレンス/hidden) - Cakeコアをラッピング | - [hidden](/関数リファレンス/hidden) - Cakeコアをラッピング | ||
- [input](/関数リファレンス/input) - Cakeコアをラッピング | - [input](/関数リファレンス/input) - Cakeコアをラッピング | ||
− | - [jsonList](/関数リファレンス/jsonList) - | + | - [jsonList](/関数リファレンス/jsonList) - JsonListを出力する |
- [prefTag](/関数リファレンス/prefTag) - 都道府県用のSELECTタグを表示する | - [prefTag](/関数リファレンス/prefTag) - 都道府県用のSELECTタグを表示する | ||
- [selectText](/関数リファレンス/selectText) - 文字列保存用複数選択コントロール | - [selectText](/関数リファレンス/selectText) - 文字列保存用複数選択コントロール | ||
− | - [wyear](/関数リファレンス/wyear) - | + | - [wyear](/関数リファレンス/wyear) - 和暦年を表示する |
+ | |||
+ | |||
+ | ## BcFreeze($this->BcFreeze) | ||
+ | - [checkbox](/関数リファレンス/checkbox) - チェックボックスを表示する | ||
+ | - [dateTime](/関数リファレンス/dateTime) - 日付タグを表示 | ||
+ | - [datepicker](/関数リファレンス/datepicker) - カレンダーコントロール付きのテキストフィールド | ||
+ | - [file](/関数リファレンス/file) - ファイルタグを出力 | ||
+ | - [freeze](/関数リファレンス/freeze) - フォームを凍結させる | ||
+ | - [freezeControll](/関数リファレンス/freezeControll) - 凍結時用のコントロールを取得する | ||
+ | - [image](/関数リファレンス/image) - ファイルコントロール(画像)を表示する | ||
+ | - [jsonList](/関数リファレンス/jsonList) - JsonListを出力する | ||
+ | - [radio](/関数リファレンス/radio) - ラジオボタンを表示する | ||
+ | - [select](/関数リファレンス/select) - プルダウンメニューを表示 | ||
+ | - [text](/関数リファレンス/text) - テキストボックスを表示する | ||
+ | - [textarea](/関数リファレンス/textarea) - テキストエリアを表示する | ||
+ | - [upload](/関数リファレンス/upload) - アップロードした画像を表示する | ||
+ | - [wyear](/関数リファレンス/wyear) - 和暦年を表示する | ||
+ | |||
+ | |||
+ | ## BcGooglemaps($this->BcGooglemaps) | ||
+ | - [getLocation](/関数リファレンス/getLocation) - 位置情報を取得する | ||
+ | - [load](/関数リファレンス/load) - Google マップ を読み込む | ||
+ | - [loadLocation](/関数リファレンス/loadLocation) - 位置情報を読み込む | ||
+ | |||
+ | |||
+ | ## BcHtml($this->BcHtml) | ||
+ | - [getStripCrumbs](/関数リファレンス/getStripCrumbs) - タグにラッピングされていないパンくずデータを取得する | ||
+ | |||
+ | |||
+ | ## BcMobile($this->BcMobile) | ||
+ | - [afterLayout](/関数リファレンス/afterLayout) - 出力データをSJISに変換する | ||
+ | - [header](/関数リファレンス/header) - コンテンツタイプを出力 | ||
+ | |||
+ | |||
+ | ## BcSmartphone($this->BcSmartphone) | ||
+ | - [afterLayout](/関数リファレンス/afterLayout) - スマートフォン用プレフィックスを追加する | ||
+ | |||
+ | |||
+ | ## BcText($this->BcText) | ||
+ | - [age](/関数リファレンス/age) - 日付より年齢を取得する | ||
+ | - [arrayValue](/関数リファレンス/arrayValue) - 配列とキーを指定して値を取得する | ||
+ | - [arrayValues](/関数リファレンス/arrayValues) - 連想配列とキーのリストより値のリストを取得し文字列で返す | ||
+ | - [booleanAllow](/関数リファレンス/booleanAllow) - boolean型用を可、不可で出力 | ||
+ | - [booleanAllowList](/関数リファレンス/booleanAllowList) - boolean型用のリストを可、不可で出力 | ||
+ | - [booleanDo](/関数リファレンス/booleanDo) - boolean型のデータを [〜する / 〜しない] 形式で出力する | ||
+ | - [booleanDoList](/関数リファレンス/booleanDoList) - boolean型用のリストを[〜する/〜しない]形式で出力する | ||
+ | - [booleanExists](/関数リファレンス/booleanExists) - boolean型用を有無で出力 | ||
+ | - [booleanExistsList](/関数リファレンス/booleanExistsList) - boolean型用のリストを「有」「無」で出力 | ||
+ | - [booleanMark](/関数リファレンス/booleanMark) - boolean型を ○ または ― マークで出力 | ||
+ | - [booleanMarkList](/関数リファレンス/booleanMarkList) - boolean型用のリストを ○ ― マークで出力 | ||
+ | - [booleanStatus](/関数リファレンス/booleanStatus) - boolean型用を無効・有効で出力 | ||
+ | - [booleanStatusList](/関数リファレンス/booleanStatusList) - boolean型用のリストを有効、無効で出力 | ||
+ | - [dateTime](/関数リファレンス/dateTime) - form::dateTimeで取得したデータを文字列データに変換する | ||
+ | - [dateTimeWareki](/関数リファレンス/dateTimeWareki) - form::dateTimeで取得した和暦データを文字列データに変換する | ||
+ | - [format](/関数リファレンス/format) - 文字をフォーマット形式で出力する | ||
+ | - [listValue](/関数リファレンス/listValue) - モデルのコントロールソースより表示用データを取得する | ||
+ | - [moneyFormat](/関数リファレンス/moneyFormat) - 通貨表示を行う | ||
+ | - [noValue](/関数リファレンス/noValue) - データをチェックして空の場合に指定した値を返す | ||
+ | - [pref](/関数リファレンス/pref) - 番号を都道府県に変換して出力 | ||
+ | - [prefList](/関数リファレンス/prefList) - 都道府県のリストを出力 | ||
+ | - [sex](/関数リファレンス/sex) - 性別を出力 | ||
+ | - [toArray](/関数リファレンス/toArray) - 区切り文字で区切られたテキストを配列に変換する | ||
+ | - [zipFormat](/関数リファレンス/zipFormat) - 郵便番号にハイフンをつけて出力 | ||
+ | |||
+ | |||
+ | ## BcTime($this->BcTime) | ||
+ | - [convertToSeirekiYear](/関数リファレンス/convertToSeirekiYear) - 和暦の年を西暦に変換する。和暦のフォーマット例:s-48 | ||
+ | - [convertToWareki](/関数リファレンス/convertToWareki) - 和暦変換 | ||
+ | - [convertToWarekiArray](/関数リファレンス/convertToWarekiArray) - 和暦変換(配列で返す) | ||
+ | - [convertToWarekiYear](/関数リファレンス/convertToWarekiYear) - 西暦を和暦の年に変換する | ||
+ | - [format](/関数リファレンス/format) - format 拡張 | ||
+ | - [getJpWeek](/関数リファレンス/getJpWeek) - 日本の曜日名を1文字 + $suffixの形式で取得する | ||
+ | - [jpWeek](/関数リファレンス/jpWeek) - 曜日情報を出力する | ||
+ | - [minutes](/関数リファレンス/minutes) - 文字列から時間(分)を取得 | ||
+ | - [nengo](/関数リファレンス/nengo) - 年号を取得 | ||
+ | - [pastDays](/関数リファレンス/pastDays) - 指定した日数が経過しているか確認する。経過していない場合はtrueを返す | ||
+ | - [wareki](/関数リファレンス/wareki) - 和暦を取得(アルファベット) | ||
+ | - [wyear](/関数リファレンス/wyear) - 和暦の年を取得 | ||
+ | |||
+ | |||
+ | ## BcUpload($this->BcUpload) | ||
+ | <del>- [file](/関数リファレンス/file) - ファイルインプットボックス出力</del>(非推奨) | ||
+ | - [fileLink](/関数リファレンス/fileLink) - ファイルへのリンクを取得する | ||
+ | - [uploadImage](/関数リファレンス/uploadImage) - アップロードした画像のタグをリンク付きで出力する | ||
+ | |||
+ | |||
+ | ## BcXml($this->BcXml) | ||
+ | - [header](/関数リファレンス/header) - XML宣言を生成する | ||
+ | |||
+ | [[Category:開発ガイド]] |
2016年9月29日 (木) 16:42時点における最新版
※ baserCMS ver.3系の関数リファレンスです。ver.4系はこちら
baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。 コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 baserCMS API Document サイト には、baserCMSの関数がすべて網羅されています。
このページの完成度を高めるためにご協力ください!
既にある関数ページに説明を書き込んだり、その関数に関する情報や使用例を記載してください。その際には[サンプルページ](/関数リファレンス/sample) の形式を参考にしてください。
関数が不足している場合や、不適切なカテゴリーにある場合は、適切なカテゴリーに移動してください。また、誤字脱字に気付かれた場合は訂正してください。
みなさん、宜しくお願いします。
既にある関数ページに説明を書き込んだり、その関数に関する情報や使用例を記載してください。その際には[サンプルページ](/関数リファレンス/sample) の形式を参考にしてください。
関数が不足している場合や、不適切なカテゴリーにある場合は、適切なカテゴリーに移動してください。また、誤字脱字に気付かれた場合は訂正してください。
みなさん、宜しくお願いします。
目次
- 1 BcBaser($this->BcBaser)
- 2 固定ページ($this->BcPage)
- 3 ブログ($this->Blog)
- 4 メールフォーム($this->Mail)
- 5 フィード($this->Feed)
- 6 BcAdmin($this->BcAdmin)
- 7 BcArray($this->BcArray)
- 8 BcCkeditor($this->BcCkeditor)
- 9 BcCsv($this->BcCsv)
- 10 BcForm($this->BcForm)
- 11 BcFreeze($this->BcFreeze)
- 12 BcGooglemaps($this->BcGooglemaps)
- 13 BcHtml($this->BcHtml)
- 14 BcMobile($this->BcMobile)
- 15 BcSmartphone($this->BcSmartphone)
- 16 BcText($this->BcText)
- 17 BcTime($this->BcTime)
- 18 BcUpload($this->BcUpload)
- 19 BcXml($this->BcXml)
BcBaser($this->BcBaser)
$this->BcBaser->関数名 で使える関数は、どこでも共通で利用できる関数です。
- addCrumb - パンくずリストの要素を追加する
- baseUrl - ベースとなるURLを出力する
- cacheHeader - ブラウザにキャッシュさせる為のヘッダーを出力する
- changePrefixToAlias - URLをリンクとして利用可能なURLに変換する
- charset - メタタグを出力する
- checkUpdate - アップデート処理が必要かチェックする
- content - コンテンツ本体を出力する
- contentsName - コンテンツを特定するIDを出力する
- contentsNavi - コンテンツナビを出力する
- contentsTitle - コンテンツのタイトルを出力する
- copyYear - コピーライト用の年を出力する
- crumbs - パンくずリストを出力する
- crumbsList - パンくずリストを出力する
- css - CSSの読み込みタグを出力する
- docType - ドキュメントタイプを指定するタグを出力する
- editLink - 編集画面へのリンクを出力する
- element - エレメントテンプレートを出力する
- existsEditLink - 編集画面へのリンクが存在するかチェックする
- existsPublishLink - 公開ページへのリンクが存在するかチェックする
- flash - セッションに保存したメッセージを出力する
- footer - フッターテンプレートを出力する
- func - ツールバーエレメントや CakePHP のデバッグ出力を表示
- getBaseUrl - ベースとなるURLを取得する
- getContentsName - コンテンツを特定するIDを取得する
- getContentsTitle - コンテンツタイトルを取得する
- getCrumbs - パンくず用の配列を取得する
- getDescription - meta タグ用のページ説明文を取得する
- getElement - エレメントテンプレートのレンダリング結果を取得する
- getHere - 現在のページの純粋なURLを取得する
- getImg - 画像タグを取得する
- getKeywords - meta タグ用のキーワードを取得する
- getLink - アンカータグを取得する
- getMenus - メニューのデータを取得する
- getPageList - ページ機能で作成したページの一覧データを取得する
- getRoot - baserCMSが設置されているパスを取得する
- getThemeUrl - テーマのURLを取得する
- getTitle - タイトルタグを取得する
- getUri - httpから始まるURLを取得する
- getUrl - baserCMSの設置フォルダを考慮したURLを取得する
- getUserName - ユーザー名を整形して表示する
- globalMenu - グローバルメニューを出力する
- googleAnalytics - Google Analytics のトラッキングコードを出力する
- googleMaps - Google Maps を出力する
- header - ヘッダーテンプレートを出力する
- icon - アイコン(favicon)タグを出力する
- img - 画像読み込みタグを出力する
- includeCore - コアテンプレートを読み込む
- isAdminUser - 現在のログインユーザーが管理者グループかどうかチェックする
- isCategoryTop - 現在のページがページカテゴリのトップかどうかを判定する
- isCurrentUrl - 指定したURLが現在のURLと同じかどうか判定する
- isHome - 現在のページがトップページかどうかを判定する
- isPage - 現在のページが固定ページかどうかを判定する
- isSSL - SSL通信かどうか判定する
isTop - トップページかどうか判断する(非推奨)- js - javascriptの読み込みタグを出力する
- link - アンカータグを出力する
- listNum - 表示件数設定機能を出力する
- logo - ロゴを出力する
- mainImage - メインイメージを出力する
- mark - 文字列を検索しマークとしてタグをつける
- metaDescription - ページ説明文用のメタタグを出力する
- metaKeywords - キーワード用のメタタグを出力する
- page - ページをエレメントとして読み込む
- pagination - ページネーションを出力する
- publishLink - 公開ページへのリンクを出力する
- root - baserCMSが設置されているパスを出力する
- rss - RSSフィードのリンクタグを出力する
- scripts - コンテンツ内で設定した CSS や javascript をレイアウトテンプレートに出力し、ログイン中の場合、ツールバー用のCSSも出力する
- set - レイアウトで利用する為の変数を設定する
- setCategoryTitle - タイトルへのカテゴリタイトルの出力有無を設定する
- setDescription - meta タグの説明文を設定する
- setKeywords - meta タグのキーワードを設定する
- setPageEditLink - 編集画面へのリンクを設定する
- setSubMenus - サブメニューを設定する(管理画面用)
- setTitle - タイトルを設定する
- siteSearchForm - サイト内検索フォームを出力
- sitemap - サイトマップを出力する
- subMenu - サブメニューを出力する
- swf - Flashを表示する
- themeUrl - テーマのURLを出力する
- title - タイトルタグを出力する
- updateMessage - アップデート用のメッセージを出力する
- url - baserCMSの設置フォルダを考慮したURLを出力する
- widgetArea - ウィジェットエリアを出力する
- xmlHeader - XMLヘッダタグを出力する
固定ページ($this->BcPage)
$this->BcPage->関数名 で使える関数は、固定ページで利用できる関数です。
- allowPublish - 公開状態を取得する
- beforeRender - beforeRender
- content - 固定ページのコンテンツを出力する
- contentsNaviAvailable - コンテンツナビ有効チェック
- getCategory - 現在のページが所属するカテゴリデータを取得する
- getCategoryName - カテゴリ名を取得する
- getPageList - ページリストを取得する
- getParentCategory - 現在のページが所属する親のカテゴリを取得する
- getTemplates - テンプレートを取得
- getUrl - ページ機能用URLを取得する
- nextLink - ページカテゴリ間の次の記事へのリンクを取得する
- prevLink - ページカテゴリ間の前の記事へのリンクを取得する
- treeList - No Description ※TODO: メソッドに説明載ってない><;
BlogBaser($this->BcBaserで利用可)
- blogPosts - ブログ記事一覧出力
- isBlogCategory - カテゴリー別記事一覧ページ判定
- isBlogDate - 日別記事一覧ページ判定
- isBlogHome - インデックスページ判定
- isBlogMonth - 月別記事一覧ページ判定
- isBlogSingle - 個別ページ判定
- isBlogTag - タグ別記事一覧ページ判定
- isBlogYear - 年別記事一覧ページ判定
ブログ($this->Blog)
$this->Blog->関数名 で使える関数は、ブログで利用できる関数です。
- allowPublish - 公開状態を取得する
- author - 記事の投稿者を出力する
- category - 記事が属するカテゴリ名を出力する
- description - ブログの説明文を出力する
- descriptionExists - ブログの説明文が指定されているかどうかを判定する
editPost - ブログ編集ページへのリンクを出力(非推奨)- eyeCatch - アイキャッチ画像を出力する
- getBlogArchiveType - ブログのアーカイブタイプを取得する
- getBlogTemplates - ブログテンプレートを取得
- getCategory - 記事が属するカテゴリ名の一覧を取得する
- getCategoryList - カテゴリーの一覧をリストタグで取得する
- getCategoryUrl - カテゴリ一覧へのURLを取得する
- getDescription - ブログの説明文を取得する
- getEyeCatch - アイキャッチ画像を取得する
- getHtmlById - 記事中のタグで指定したIDの内容を取得する
- getLayoutTemplates - レイアウトテンプレートを取得
- getParentCategory - 親カテゴリを取得する
- getPostContent - 記事の本文を取得する
- getPostDate - 登録日を取得する
- getPostImg - 記事中の画像を取得する
- getPostLink - 記事へのリンクを取得する
- getPostLinkUrl - ブログ記事のURLを返す
- getPostTitle - 記事タイトルを取得する
- getRelatedPosts - 同じタグの関連投稿を取得する
- getTag - タグを取得する
- getTitle - タイトルを取得する
- isArchive - アーカイブページ判定
- isCategory - カテゴリー別記事一覧ページ判定
- isDate - 日別記事一覧ページ判定
- isHome - インデックスページ判定
- isMonth - 月別記事一覧ページ判定
- isSingle - 個別ページ判定
- isTag - タグ別記事一覧ページ判定
- isYear - 年別記事一覧ページ判定
- mailFormLink - メールフォームプラグインのフォームへのリンクを生成する
- nextLink - 次の記事へのリンクを出力する
- postContent - 記事の本文を表示する
- postDate - 記事の登録日を出力する
- postImg - 記事中の画像を出力する
- postLink - 記事へのリンクを出力する
- postTitle - 記事のタイトルを出力する
- prevLink - 前の記事へのリンクを出力する
- setContent - ブログコンテンツデータをセットする
- tag - タグを出力する
- title - ブログタイトルを出力する
メールフォーム($this->Mail)
$this->Mail->関数名 で使える関数は、メールフォームで利用できる関数です。
- description - メールの説明文を表示する
- descriptionExists - メールの説明文が指定されているかどうかを判定する
- getDescription - メールの説明文を取得する
- getFormTemplates - フォームテンプレートを取得
- getLayoutTemplates - レイアウトテンプレートを取得
- getMailTemplates - レイアウトテンプレートを取得
indexFields - 管理画面のメールフィールド一覧ページへのリンクを出力する(非推奨)- link - メールフォームへのリンクを生成する
- setMailContent - メールコンテンツデータをセットする
Maildata($this->Maildata)
$this->Maildata->関数名 で使える関数は、メールフォームで利用できる関数です。
- control - メール表示用のデータを出力する
Mailfield($this->Mailfield)
$this->Mailfield->関数名 で使える関数は、メールフォームで利用できる関数です。
- getAttributes - htmlの属性を取得する
- getOptions - コントロールのソースを取得する
Mailform($this->Mailform)
$this->Mailform->関数名 で使える関数は、メールフォームで利用できる関数です。
- control - メールフィールドのデータよりコントロールを生成する
フィード($this->Feed)
$this->Feed->関数名 で使える関数は、フィードで利用できる関数です。
- cacheHeader - フィードリストのキャッシュヘッダーを出力する
- getTemplates - レイアウトテンプレートを取得
- saveCachetime - フィードのキャッシュタイムをキャッシュファイルに保存
FeedBaser($this->BcBaserで利用可)
- feed - フィード出力
BcAdmin($this->BcAdmin)
- isAdminGlobalmenuUsed - 管理システムグローバルメニューの利用可否確認
- isSystemAdmin - ログインユーザーがシステム管理者かチェックする
BcArray($this->BcArray)
BcCkeditor($this->BcCkeditor)
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タグを表示する
- selectText - 文字列保存用複数選択コントロール
- wyear - 和暦年を表示する
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 - 位置情報を読み込む
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::dateTimeで取得したデータを文字列データに変換する
- dateTimeWareki - form::dateTimeで取得した和暦データを文字列データに変換する
- format - 文字をフォーマット形式で出力する
- listValue - モデルのコントロールソースより表示用データを取得する
- moneyFormat - 通貨表示を行う
- noValue - データをチェックして空の場合に指定した値を返す
- pref - 番号を都道府県に変換して出力
- prefList - 都道府県のリストを出力
- sex - 性別を出力
- toArray - 区切り文字で区切られたテキストを配列に変換する
- 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)
- file - ファイルインプットボックス出力(非推奨)
- fileLink - ファイルへのリンクを取得する - uploadImage - アップロードした画像のタグをリンク付きで出力する
BcXml($this->BcXml)
- header - XML宣言を生成する