「関数リファレンス」を編集中
提供: baserCMS公式ガイド
警告: ログインしていません。
編集すると、IPアドレスがこのページの編集履歴に記録されます。この編集を取り消せます。
下記の差分を確認して、本当に取り消していいか検証してください。よろしければ変更を保存して取り消しを完了してください。
最新版 | 編集中の文章 | ||
行1: | 行1: | ||
− | |||
− | |||
baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。 | baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。 | ||
<!-- また、主にプラグインの開発に用いるイベントに関する関数もあります。 -->コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 [baserCMS API Document サイト](http://api.basercms.net/) には、baserCMSの関数がすべて網羅されています。 | <!-- また、主にプラグインの開発に用いるイベントに関する関数もあります。 -->コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 [baserCMS API Document サイト](http://api.basercms.net/) には、baserCMSの関数がすべて網羅されています。 | ||
− | + | ``` | |
− | + | このページの完成度を高めるためにご協力ください! | |
+ | 既にある関数ページに説明を書き込んだり、その関数に関する情報や使用例を記載してください。その際には、[サンプルページ](/関数リファレンス/sample) の形式を参考にしてください。 | ||
+ | 関数が不足している場合や、不適切なカテゴリーにある場合は、適切なカテゴリーに移動してください。また、誤字脱字に気付かれた場合は訂正してください。 | ||
+ | みなさん、宜しくお願いします。 | ||
+ | ``` | ||
+ | |||
## BcBaser($this->BcBaser) | ## BcBaser($this->BcBaser) | ||
− | |||
− | |||
− | |||
- [addCrumb](/関数リファレンス/addCrumb) - パンくずリストの要素を追加する | - [addCrumb](/関数リファレンス/addCrumb) - パンくずリストの要素を追加する | ||
- [baseUrl](/関数リファレンス/baseUrl) - ベースとなるURLを出力する | - [baseUrl](/関数リファレンス/baseUrl) - ベースとなるURLを出力する | ||
行64: | 行64: | ||
- [isPage](/関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する | - [isPage](/関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する | ||
- [isSSL](/関数リファレンス/isSSL) - SSL通信かどうか判定する | - [isSSL](/関数リファレンス/isSSL) - SSL通信かどうか判定する | ||
− | - | + | - [isTop](/関数リファレンス/isTop) - トップページかどうか判断する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><; |
- [js](/関数リファレンス/js) - javascriptの読み込みタグを出力する | - [js](/関数リファレンス/js) - javascriptの読み込みタグを出力する | ||
- [link](/関数リファレンス/link) - アンカータグを出力する | - [link](/関数リファレンス/link) - アンカータグを出力する | ||
行99: | 行99: | ||
## 固定ページ($this->BcPage) | ## 固定ページ($this->BcPage) | ||
− | |||
− | |||
− | |||
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | - [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | ||
- [beforeRender](/関数リファレンス/beforeRender) - beforeRender | - [beforeRender](/関数リファレンス/beforeRender) - beforeRender | ||
− | - [content](/関数リファレンス | + | - [content](/関数リファレンス/content) - 固定ページのコンテンツを出力する |
- [contentsNaviAvailable](/関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック | - [contentsNaviAvailable](/関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック | ||
- [getCategory](/関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する | - [getCategory](/関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する | ||
- [getCategoryName](/関数リファレンス/getCategoryName) - カテゴリ名を取得する | - [getCategoryName](/関数リファレンス/getCategoryName) - カテゴリ名を取得する | ||
− | - [getPageList](/関数リファレンス | + | - [getPageList](/関数リファレンス/getPageList) - ページリストを取得する |
- [getParentCategory](/関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する | - [getParentCategory](/関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する | ||
- [getTemplates](/関数リファレンス/getTemplates) - テンプレートを取得 | - [getTemplates](/関数リファレンス/getTemplates) - テンプレートを取得 | ||
− | - [getUrl](/関数リファレンス | + | - [getUrl](/関数リファレンス/getUrl) - ページ機能用URLを取得する |
- [nextLink](/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する | - [nextLink](/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する | ||
- [prevLink](/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する | - [prevLink](/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する | ||
行117: | 行114: | ||
### BlogBaser($this->BcBaserで利用可) | ### BlogBaser($this->BcBaserで利用可) | ||
− | |||
- [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力 | - [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力 | ||
- [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | - [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | ||
行130: | 行126: | ||
## ブログ($this->Blog) | ## ブログ($this->Blog) | ||
− | |||
− | |||
− | |||
- [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | - [allowPublish](/関数リファレンス/allowPublish) - 公開状態を取得する | ||
- [author](/関数リファレンス/author) - 記事の投稿者を出力する | - [author](/関数リファレンス/author) - 記事の投稿者を出力する | ||
行138: | 行131: | ||
- [description](/関数リファレンス/description) - ブログの説明文を出力する | - [description](/関数リファレンス/description) - ブログの説明文を出力する | ||
- [descriptionExists](/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する | - [descriptionExists](/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する | ||
− | - | + | - [editPost](/関数リファレンス/editPost) - ブログ編集ページへのリンクを出力(非推奨)※TODO: 打ち消し線付けたい誰かつけて><; |
- [eyeCatch](/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する | - [eyeCatch](/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する | ||
- [getBlogArchiveType](/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する | - [getBlogArchiveType](/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する | ||
行181: | 行174: | ||
## メールフォーム($this->Mail) | ## メールフォーム($this->Mail) | ||
− | |||
− | |||
− | |||
- [description](/関数リファレンス/description) - メールの説明文を表示する | - [description](/関数リファレンス/description) - メールの説明文を表示する | ||
- [descriptionExists](/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する | - [descriptionExists](/関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する | ||
行190: | 行180: | ||
- [getLayoutTemplates](/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得 | - [getLayoutTemplates](/関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得 | ||
- [getMailTemplates](/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得 | - [getMailTemplates](/関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得 | ||
− | - | + | - [indexFields](/関数リファレンス/indexFields) - 管理画面のメールフィールド一覧ページへのリンクを出力する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><; |
- [link](/関数リファレンス/link) - メールフォームへのリンクを生成する | - [link](/関数リファレンス/link) - メールフォームへのリンクを生成する | ||
- [setMailContent](/関数リファレンス/setMailContent) - メールコンテンツデータをセットする | - [setMailContent](/関数リファレンス/setMailContent) - メールコンテンツデータをセットする | ||
### Maildata($this->Maildata) | ### Maildata($this->Maildata) | ||
− | |||
− | |||
− | |||
- [control](/関数リファレンス/control) - メール表示用のデータを出力する | - [control](/関数リファレンス/control) - メール表示用のデータを出力する | ||
### Mailfield($this->Mailfield) | ### Mailfield($this->Mailfield) | ||
− | |||
− | |||
− | |||
- [getAttributes](/関数リファレンス/getAttributes) - htmlの属性を取得する | - [getAttributes](/関数リファレンス/getAttributes) - htmlの属性を取得する | ||
- [getOptions](/関数リファレンス/getOptions) - コントロールのソースを取得する | - [getOptions](/関数リファレンス/getOptions) - コントロールのソースを取得する | ||
### Mailform($this->Mailform) | ### Mailform($this->Mailform) | ||
− | |||
− | |||
− | |||
- [control](/関数リファレンス/control) - メールフィールドのデータよりコントロールを生成する | - [control](/関数リファレンス/control) - メールフィールドのデータよりコントロールを生成する | ||
## フィード($this->Feed) | ## フィード($this->Feed) | ||
− | |||
− | |||
− | |||
- [cacheHeader](/関数リファレンス/cacheHeader) - フィードリストのキャッシュヘッダーを出力する | - [cacheHeader](/関数リファレンス/cacheHeader) - フィードリストのキャッシュヘッダーを出力する | ||
- [getTemplates](/関数リファレンス/getTemplates) - レイアウトテンプレートを取得 | - [getTemplates](/関数リファレンス/getTemplates) - レイアウトテンプレートを取得 | ||
行349: | 行327: | ||
## BcUpload($this->BcUpload) | ## BcUpload($this->BcUpload) | ||
− | + | - [file](/関数リファレンス/file) - ファイルインプットボックス出力(非推奨)※TODO: 打ち消し線付けたい誰かつけて><; | |
− | + | - [fileLink](/関数リファレンス/fileLink) - ファイルへのリンクを取得する | |
− | + | - [uploadImage](/関数リファレンス/uploadImage) - アップロードした画像のタグをリンク付きで出力する | |
## BcXml($this->BcXml) | ## BcXml($this->BcXml) | ||
- [header](/関数リファレンス/header) - XML宣言を生成する | - [header](/関数リファレンス/header) - XML宣言を生成する | ||
− | |||
− |