個人用ツール

「関数リファレンス」を編集中

提供: baserCMS公式ガイド

移動: 案内, 検索

警告: ログインしていません。

編集すると、IPアドレスがこのページの編集履歴に記録されます。
この編集を取り消せます。 下記の差分を確認して、本当に取り消していいか検証してください。よろしければ変更を保存して取り消しを完了してください。
最新版 編集中の文章
行1: 行1:
※ baserCMS ver.3系の関数リファレンスです。[ver.4系はこちら](/ver4/関数リファレンス)
+
## どこでも使えるBcBaser($this->BcBaser)
 
+
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を出力する
行64: 行53:
 
- [isPage](/関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する
 
- [isPage](/関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する
 
- [isSSL](/関数リファレンス/isSSL) - SSL通信かどうか判定する
 
- [isSSL](/関数リファレンス/isSSL) - SSL通信かどうか判定する
- <strike>[isTop](/関数リファレンス/isTop) - トップページかどうか判断する</strike>(非推奨)
+
- [isTop](/関数リファレンス/isTop) - トップページかどうか判断する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><;
 
- [js](/関数リファレンス/js) - javascriptの読み込みタグを出力する
 
- [js](/関数リファレンス/js) - javascriptの読み込みタグを出力する
 
- [link](/関数リファレンス/link) - アンカータグを出力する
 
- [link](/関数リファレンス/link) - アンカータグを出力する
行99: 行88:
  
 
## 固定ページ($this->BcPage)
 
## 固定ページ($this->BcPage)
 
$this->BcPage->関数名 で使える関数は、固定ページで利用できる関数です。
 
 
 
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する
 
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する
 
- [beforeRender](/関数リファレンス/beforeRender) - beforeRender
 
- [beforeRender](/関数リファレンス/beforeRender) - beforeRender
- [content](/関数リファレンス/BcPage/content) - 固定ページのコンテンツを出力する
+
- [content](/関数リファレンス/content) - 固定ページのコンテンツを出力する
 
- [contentsNaviAvailable](/関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック
 
- [contentsNaviAvailable](/関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック
 
- [getCategory](/関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する
 
- [getCategory](/関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する
 
- [getCategoryName](/関数リファレンス/getCategoryName) - カテゴリ名を取得する
 
- [getCategoryName](/関数リファレンス/getCategoryName) - カテゴリ名を取得する
- [getPageList](/関数リファレンス/BcPage/getPageList) - ページリストを取得する
+
- [getPageList](/関数リファレンス/getPageList) - ページリストを取得する
 
- [getParentCategory](/関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する
 
- [getParentCategory](/関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する
 
- [getTemplates](/関数リファレンス/getTemplates) - テンプレートを取得
 
- [getTemplates](/関数リファレンス/getTemplates) - テンプレートを取得
- [getUrl](/関数リファレンス/BcPage/getUrl) - ページ機能用URLを取得する
+
- [getUrl](/関数リファレンス/getUrl) - ページ機能用URLを取得する
 
- [nextLink](/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する
 
- [nextLink](/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する
 
- [prevLink](/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する
 
- [prevLink](/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する
行117: 行103:
  
 
### BlogBaser($this->BcBaserで利用可)
 
### BlogBaser($this->BcBaserで利用可)
 
 
- [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力
 
- [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力
 
- [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定
 
- [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定
行130: 行115:
  
 
## ブログ($this->Blog)
 
## ブログ($this->Blog)
 
$this->Blog->関数名 で使える関数は、ブログで利用できる関数です。
 
 
 
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する
 
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する
 
- [author](/関数リファレンス/author) - 記事の投稿者を出力する
 
- [author](/関数リファレンス/author) - 記事の投稿者を出力する
行138: 行120:
 
- [description](/関数リファレンス/description) - ブログの説明文を出力する
 
- [description](/関数リファレンス/description) - ブログの説明文を出力する
 
- [descriptionExists](/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する
 
- [descriptionExists](/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する
- <strike>[editPost](/関数リファレンス/editPost) - ブログ編集ページへのリンクを出力</strike>(非推奨)
+
- [editPost](/関数リファレンス/editPost) - ブログ編集ページへのリンクを出力(非推奨)※TODO: 打ち消し線付けたい誰かつけて><;
 
- [eyeCatch](/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する
 
- [eyeCatch](/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する
 
- [getBlogArchiveType](/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する
 
- [getBlogArchiveType](/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する
行181: 行163:
  
 
## メールフォーム($this->Mail)
 
## メールフォーム($this->Mail)
 
$this->Mail->関数名 で使える関数は、メールフォームで利用できる関数です。
 
 
 
- [description](/関数リファレンス/description) - メールの説明文を表示する
 
- [description](/関数リファレンス/description) - メールの説明文を表示する
 
- [descriptionExists](/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する
 
- [descriptionExists](/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する
行190: 行169:
 
- [getLayoutTemplates](/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得
 
- [getLayoutTemplates](/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得
 
- [getMailTemplates](/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得
 
- [getMailTemplates](/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得
- <strike>[indexFields](/関数リファレンス/indexFields) - 管理画面のメールフィールド一覧ページへのリンクを出力する</strike>(非推奨)
+
- [indexFields](/関数リファレンス/indexFields) - 管理画面のメールフィールド一覧ページへのリンクを出力する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><;
 
- [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) - レイアウトテンプレートを取得
行307: 行274:
  
 
## BcText($this->BcText)
 
## 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:開発ガイド]]
 

baserCMS公式ガイドへのすべての投稿は、他の利用者によって編集、変更、除去される場合があります。 あなたの投稿を、他人が遠慮なく編集するのを望まない場合は、ここには投稿しないでください。
また、投稿するのは、あなたが書いたものか、パブリック ドメインまたはそれに類するフリーな資料からの複製であることを約束してください (詳細は[[Basercms:著作権 ]]を参照)。 著作権保護されている作品を、許諾なしに投稿してはいけません!

Add Categories

開発ガイド

  

中止 | 編集の仕方 (新しいウィンドウで開きます)

このページで使用されているテンプレート: