「関数リファレンス」を編集中
提供: baserCMS公式ガイド
警告: ログインしていません。
編集すると、IPアドレスがこのページの編集履歴に記録されます。この編集を取り消せます。
下記の差分を確認して、本当に取り消していいか検証してください。よろしければ変更を保存して取り消しを完了してください。
最新版 | 編集中の文章 | ||
行1: | 行1: | ||
− | + | ## どこでも使えるBcBaser($this->BcBaser) | |
− | + | - [addCrumb](関数リファレンス/addCrumb) - パンくずリストの要素を追加する | |
− | + | - [baseUrl](関数リファレンス/baseUrl) - ベースとなるURLを出力する | |
− | + | - [cacheHeader](関数リファレンス/cacheHeader) - ブラウザにキャッシュさせる為のヘッダーを出力する | |
− | + | - [changePrefixToAlias](関数リファレンス/changePrefixToAlias) - URLをリンクとして利用可能なURLに変換する | |
− | + | - [charset](関数リファレンス/charset) - メタタグを出力する | |
− | + | - [checkUpdate](関数リファレンス/checkUpdate) - アップデート処理が必要かチェックする | |
− | + | - [content](関数リファレンス/content) - コンテンツ本体を出力する | |
− | ## | + | - [contentsName](関数リファレンス/contentsName) - コンテンツを特定するIDを出力する |
− | + | - [contentsNavi](関数リファレンス/contentsNavi) - コンテンツナビを出力する | |
− | + | - [contentsTitle](関数リファレンス/contentsTitle) - コンテンツのタイトルを出力する | |
− | + | - [copyYear](関数リファレンス/copyYear) - コピーライト用の年を出力する | |
− | - [addCrumb]( | + | - [crumbs](関数リファレンス/crumbs) - パンくずリストを出力する |
− | - [baseUrl]( | + | - [crumbsList](関数リファレンス/crumbsList) - パンくずリストを出力する |
− | - [cacheHeader]( | + | - [css](関数リファレンス/css) - CSSの読み込みタグを出力する |
− | - [changePrefixToAlias]( | + | - [docType](関数リファレンス/docType) - ドキュメントタイプを指定するタグを出力する |
− | - [charset]( | + | - [editLink](関数リファレンス/editLink) - 編集画面へのリンクを出力する |
− | - [checkUpdate]( | + | - [element](関数リファレンス/element) - エレメントテンプレートを出力する |
− | - [content]( | + | - [existsEditLink](関数リファレンス/existsEditLink) - 編集画面へのリンクが存在するかチェックする |
− | - [contentsName]( | + | - [existsPublishLink](関数リファレンス/existsPublishLink) - 公開ページへのリンクが存在するかチェックする |
− | - [contentsNavi]( | + | - [flash](関数リファレンス/flash) - セッションに保存したメッセージを出力する |
− | - [contentsTitle]( | + | - [footer](関数リファレンス/footer) - フッターテンプレートを出力する |
− | - [copyYear]( | + | - [func](関数リファレンス/func) - ツールバーエレメントや CakePHP のデバッグ出力を表示 |
− | - [crumbs]( | + | - [getBaseUrl](関数リファレンス/getBaseUrl) - ベースとなるURLを取得する |
− | - [crumbsList]( | + | - [getContentsName](関数リファレンス/getContentsName) - コンテンツを特定するIDを取得する |
− | - [css]( | + | - [getContentsTitle](関数リファレンス/getContentsTitle) - コンテンツタイトルを取得する |
− | - [docType]( | + | - [getCrumbs](関数リファレンス/getCrumbs) - パンくず用の配列を取得する |
− | - [editLink]( | + | - [getDescription](関数リファレンス/getDescription) - meta タグ用のページ説明文を取得する |
− | - [element]( | + | - [getElement](関数リファレンス/getElement) - エレメントテンプレートのレンダリング結果を取得する |
− | - [existsEditLink]( | + | - [getHere](関数リファレンス/getHere) - 現在のページの純粋なURLを取得する |
− | - [existsPublishLink]( | + | - [getImg](関数リファレンス/getImg) - 画像タグを取得する |
− | - [flash]( | + | - [getKeywords](関数リファレンス/getKeywords) - meta タグ用のキーワードを取得する |
− | - [footer]( | + | - [getLink](関数リファレンス/getLink) - アンカータグを取得する |
− | - [func]( | + | - [getMenus](関数リファレンス/getMenus) - メニューのデータを取得する |
− | - [getBaseUrl]( | + | - [getPageList](関数リファレンス/getPageList) - ページ機能で作成したページの一覧データを取得する |
− | - [getContentsName]( | + | - [getRoot](関数リファレンス/getRoot) - baserCMSが設置されているパスを取得する |
− | - [getContentsTitle]( | + | - [getThemeUrl](関数リファレンス/getThemeUrl) - テーマのURLを取得する |
− | - [getCrumbs]( | + | - [getTitle](関数リファレンス/getTitle) - タイトルタグを取得する |
− | - [getDescription]( | + | - [getUri](関数リファレンス/getUri) - httpから始まるURLを取得する |
− | - [getElement]( | + | - [getUrl](関数リファレンス/getUrl) - baserCMSの設置フォルダを考慮したURLを取得する |
− | - [getHere]( | + | - [getUserName](関数リファレンス/getUserName) - ユーザー名を整形して表示する |
− | - [getImg]( | + | - [globalMenu](関数リファレンス/globalMenu) - グローバルメニューを出力する |
− | - [getKeywords]( | + | - [googleAnalytics](関数リファレンス/googleAnalytics) - Google Analytics のトラッキングコードを出力する |
− | - [getLink]( | + | - [googleMaps](関数リファレンス/googleMaps) - Google Maps を出力する |
− | - [getMenus]( | + | - [header](関数リファレンス/header) - ヘッダーテンプレートを出力する |
− | - [getPageList]( | + | - [icon](関数リファレンス/icon) - アイコン(favicon)タグを出力する |
− | - [getRoot]( | + | - [img](関数リファレンス/img) - 画像読み込みタグを出力する |
− | - [getThemeUrl]( | + | - [includeCore](関数リファレンス/includeCore) - コアテンプレートを読み込む |
− | - [getTitle]( | + | - [isAdminUser](関数リファレンス/isAdminUser) - 現在のログインユーザーが管理者グループかどうかチェックする |
− | - [getUri]( | + | - [isCategoryTop](関数リファレンス/isCategoryTop) - 現在のページがページカテゴリのトップかどうかを判定する |
− | - [getUrl]( | + | - [isCurrentUrl](関数リファレンス/isCurrentUrl) - 指定したURLが現在のURLと同じかどうか判定する |
− | - [getUserName]( | + | - [isHome](関数リファレンス/isHome) - 現在のページがトップページかどうかを判定する |
− | - [globalMenu]( | + | - [isPage](関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する |
− | - [googleAnalytics]( | + | - [isSSL](関数リファレンス/isSSL) - SSL通信かどうか判定する |
− | - [googleMaps]( | + | - [isTop](関数リファレンス/isTop) - トップページかどうか判断する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><; |
− | - [header]( | + | - [js](関数リファレンス/js) - javascriptの読み込みタグを出力する |
− | - [icon]( | + | - [link](関数リファレンス/link) - アンカータグを出力する |
− | - [img]( | + | - [listNum](関数リファレンス/listNum) - 表示件数設定機能を出力する |
− | - [includeCore]( | + | - [logo](関数リファレンス/logo) - ロゴを出力する |
− | - [isAdminUser]( | + | - [mainImage](関数リファレンス/mainImage) - メインイメージを出力する |
− | - [isCategoryTop]( | + | - [mark](関数リファレンス/mark) - 文字列を検索しマークとしてタグをつける |
− | - [isCurrentUrl]( | + | - [metaDescription](関数リファレンス/metaDescription) - ページ説明文用のメタタグを出力する |
− | - [isHome]( | + | - [metaKeywords](関数リファレンス/metaKeywords) - キーワード用のメタタグを出力する |
− | - [isPage]( | + | - [page](関数リファレンス/page) - ページをエレメントとして読み込む |
− | - [isSSL]( | + | - [pagination](関数リファレンス/pagination) - ページネーションを出力する |
− | - | + | - [publishLink](関数リファレンス/publishLink) - 公開ページへのリンクを出力する |
− | - [js]( | + | - [root](関数リファレンス/root) - baserCMSが設置されているパスを出力する |
− | - [link]( | + | - [rss](関数リファレンス/rss) - RSSフィードのリンクタグを出力する |
− | - [listNum]( | + | - [scripts](関数リファレンス/scripts) - コンテンツ内で設定した CSS や javascript をレイアウトテンプレートに出力し、ログイン中の場合、ツールバー用のCSSも出力する |
− | - [logo]( | + | - [set](関数リファレンス/set) - レイアウトで利用する為の変数を設定する |
− | - [mainImage]( | + | - [setCategoryTitle](関数リファレンス/setCategoryTitle) - タイトルへのカテゴリタイトルの出力有無を設定する |
− | - [mark]( | + | - [setDescription](関数リファレンス/setDescription) - meta タグの説明文を設定する |
− | - [metaDescription]( | + | - [setKeywords](関数リファレンス/setKeywords) - meta タグのキーワードを設定する |
− | - [metaKeywords]( | + | - [setPageEditLink](関数リファレンス/setPageEditLink) - 編集画面へのリンクを設定する |
− | - [page]( | + | - [setSubMenus](関数リファレンス/setSubMenus) - サブメニューを設定する(管理画面用) |
− | - [pagination]( | + | - [setTitle](関数リファレンス/setTitle) - タイトルを設定する |
− | - [publishLink]( | + | - [siteSearchForm](関数リファレンス/siteSearchForm) - サイト内検索フォームを出力 |
− | - [root]( | + | - [sitemap](関数リファレンス/sitemap) - サイトマップを出力する |
− | - [rss]( | + | - [subMenu](関数リファレンス/subMenu) - サブメニューを出力する |
− | - [scripts]( | + | - [swf](関数リファレンス/swf) - Flashを表示する |
− | - [set]( | + | - [themeUrl](関数リファレンス/themeUrl) - テーマのURLを出力する |
− | - [setCategoryTitle]( | + | - [title](関数リファレンス/title) - タイトルタグを出力する |
− | - [setDescription]( | + | - [updateMessage](関数リファレンス/updateMessage) - アップデート用のメッセージを出力する |
− | - [setKeywords]( | + | - [url](関数リファレンス/url) - baserCMSの設置フォルダを考慮したURLを出力する |
− | - [setPageEditLink]( | + | - [widgetArea](関数リファレンス/widgetArea) - ウィジェットエリアを出力する |
− | - [setSubMenus]( | + | - [xmlHeader](関数リファレンス/xmlHeader) - XMLヘッダタグを出力する |
− | - [setTitle]( | + | |
− | - [siteSearchForm]( | + | |
− | - [sitemap]( | + | |
− | - [subMenu]( | + | |
− | - [swf]( | + | |
− | - [themeUrl]( | + | |
− | - [title]( | + | |
− | - [updateMessage]( | + | |
− | - [url]( | + | |
− | - [widgetArea]( | + | |
− | - [xmlHeader]( | + | |
## 固定ページ($this->BcPage) | ## 固定ページ($this->BcPage) | ||
− | + | - [allowPublish](関数リファレンス/allowPublish) - 公開状態を取得する | |
− | + | - [beforeRender](関数リファレンス/beforeRender) - beforeRender | |
− | + | - [content](関数リファレンス/content) - 固定ページのコンテンツを出力する | |
− | - [allowPublish]( | + | - [contentsNaviAvailable](関数リファレンス/contentsNaviAvailable) - コンテンツナビ有効チェック |
− | - [beforeRender]( | + | - [getCategory](関数リファレンス/getCategory) - 現在のページが所属するカテゴリデータを取得する |
− | - [content]( | + | - [getCategoryName](関数リファレンス/getCategoryName) - カテゴリ名を取得する |
− | - [contentsNaviAvailable]( | + | - [getPageList](関数リファレンス/getPageList) - ページリストを取得する |
− | - [getCategory]( | + | - [getParentCategory](関数リファレンス/getParentCategory) - 現在のページが所属する親のカテゴリを取得する |
− | - [getCategoryName]( | + | - [getTemplates](関数リファレンス/getTemplates) - テンプレートを取得 |
− | - [getPageList]( | + | - [getUrl](関数リファレンス/getUrl) - ページ機能用URLを取得する |
− | - [getParentCategory]( | + | - [nextLink](関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを取得する |
− | - [getTemplates]( | + | - [prevLink](関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを取得する |
− | - [getUrl]( | + | - [treeList](関数リファレンス/treeList) - No Description ※TODO: メソッドに説明載ってない><; |
− | - [nextLink]( | + | |
− | - [prevLink]( | + | |
− | - [treeList]( | + | |
### BlogBaser($this->BcBaserで利用可) | ### BlogBaser($this->BcBaserで利用可) | ||
− | |||
- [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力 | - [blogPosts](/関数リファレンス/blogPosts) - ブログ記事一覧出力 | ||
- [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | - [isBlogCategory](/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定 | ||
行130: | 行115: | ||
## ブログ($this->Blog) | ## ブログ($this->Blog) | ||
− | + | - [allowPublish](関数リファレンス/allowPublish) - 公開状態を取得する | |
− | + | - [author](関数リファレンス/author) - 記事の投稿者を出力する | |
− | + | - [category](関数リファレンス/category) - 記事が属するカテゴリ名を出力する | |
− | - [allowPublish]( | + | - [description](関数リファレンス/description) - ブログの説明文を出力する |
− | - [author]( | + | - [descriptionExists](関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する |
− | - [category]( | + | - [editPost](関数リファレンス/editPost) - ブログ編集ページへのリンクを出力(非推奨)※TODO: 打ち消し線付けたい誰かつけて><; |
− | - [description]( | + | - [eyeCatch](関数リファレンス/eyeCatch) - アイキャッチ画像を出力する |
− | - [descriptionExists]( | + | - [getBlogArchiveType](関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する |
− | - | + | - [getBlogTemplates](関数リファレンス/getBlogTemplates) - ブログテンプレートを取得 |
− | - [eyeCatch]( | + | - [getCategory](関数リファレンス/getCategory) - 記事が属するカテゴリ名の一覧を取得する |
− | - [getBlogArchiveType]( | + | - [getCategoryList](関数リファレンス/getCategoryList) - カテゴリーの一覧をリストタグで取得する |
− | - [getBlogTemplates]( | + | - [getCategoryUrl](関数リファレンス/getCategoryUrl) - カテゴリ一覧へのURLを取得する |
− | - [getCategory]( | + | - [getDescription](関数リファレンス/getDescription) - ブログの説明文を取得する |
− | - [getCategoryList]( | + | - [getEyeCatch](関数リファレンス/getEyeCatch) - アイキャッチ画像を取得する |
− | - [getCategoryUrl]( | + | - [getHtmlById](関数リファレンス/getHtmlById) - 記事中のタグで指定したIDの内容を取得する |
− | - [getDescription]( | + | - [getLayoutTemplates](関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得 |
− | - [getEyeCatch]( | + | - [getParentCategory](関数リファレンス/getParentCategory) - 親カテゴリを取得する |
− | - [getHtmlById]( | + | - [getPostContent](関数リファレンス/getPostContent) - 記事の本文を取得する |
− | - [getLayoutTemplates]( | + | - [getPostDate](関数リファレンス/getPostDate) - 登録日を取得する |
− | - [getParentCategory]( | + | - [getPostImg](関数リファレンス/getPostImg) - 記事中の画像を取得する |
− | - [getPostContent]( | + | - [getPostLink](関数リファレンス/getPostLink) - 記事へのリンクを取得する |
− | - [getPostDate]( | + | - [getPostLinkUrl](関数リファレンス/getPostLinkUrl) - ブログ記事のURLを返す |
− | - [getPostImg]( | + | - [getPostTitle](関数リファレンス/getPostTitle) - 記事タイトルを取得する |
− | - [getPostLink]( | + | - [getRelatedPosts](関数リファレンス/getRelatedPosts) - 同じタグの関連投稿を取得する |
− | - [getPostLinkUrl]( | + | - [getTag](関数リファレンス/getTag) - タグを取得する |
− | - [getPostTitle]( | + | - [getTitle](関数リファレンス/getTitle) - タイトルを取得する |
− | - [getRelatedPosts]( | + | - [isArchive](関数リファレンス/isArchive) - アーカイブページ判定 |
− | - [getTag]( | + | - [isCategory](関数リファレンス/isCategory) - カテゴリー別記事一覧ページ判定 |
− | - [getTitle]( | + | - [isDate](関数リファレンス/isDate) - 日別記事一覧ページ判定 |
− | - [isArchive]( | + | - [isHome](関数リファレンス/isHome) - インデックスページ判定 |
− | - [isCategory]( | + | - [isMonth](関数リファレンス/isMonth) - 月別記事一覧ページ判定 |
− | - [isDate]( | + | - [isSingle](関数リファレンス/isSingle) - 個別ページ判定 |
− | - [isHome]( | + | - [isTag](関数リファレンス/isTag) - タグ別記事一覧ページ判定 |
− | - [isMonth]( | + | - [isYear](関数リファレンス/isYear) - 年別記事一覧ページ判定 |
− | - [isSingle]( | + | - [mailFormLink](関数リファレンス/mailFormLink) - メールフォームプラグインのフォームへのリンクを生成する |
− | - [isTag]( | + | - [nextLink](関数リファレンス/nextLink) - 次の記事へのリンクを出力する |
− | - [isYear]( | + | - [postContent](関数リファレンス/postContent) - 記事の本文を表示する |
− | - [mailFormLink]( | + | - [postDate](関数リファレンス/postDate) - 記事の登録日を出力する |
− | - [nextLink]( | + | - [postImg](関数リファレンス/postImg) - 記事中の画像を出力する |
− | - [postContent]( | + | - [postLink](関数リファレンス/postLink) - 記事へのリンクを出力する |
− | - [postDate]( | + | - [postTitle](関数リファレンス/postTitle) - 記事のタイトルを出力する |
− | - [postImg]( | + | - [prevLink](関数リファレンス/prevLink) - 前の記事へのリンクを出力する |
− | - [postLink]( | + | - [setContent](関数リファレンス/setContent) - ブログコンテンツデータをセットする |
− | - [postTitle]( | + | - [tag](関数リファレンス/tag) - タグを出力する |
− | - [prevLink]( | + | - [title](関数リファレンス/title) - ブログタイトルを出力する |
− | - [setContent]( | + | |
− | - [tag]( | + | |
− | - [title]( | + | |
## メールフォーム($this->Mail) | ## メールフォーム($this->Mail) | ||
− | + | - [description](関数リファレンス/description) - メールの説明文を表示する | |
− | + | - [descriptionExists](関数リファレンス/descriptionExists) - メールの説明文が指定されているかどうかを判定する | |
− | + | - [getDescription](関数リファレンス/getDescription) - メールの説明文を取得する | |
− | - [description]( | + | - [getFormTemplates](関数リファレンス/getFormTemplates) - フォームテンプレートを取得 |
− | - [descriptionExists]( | + | - [getLayoutTemplates](関数リファレンス/getLayoutTemplates) - レイアウトテンプレートを取得 |
− | - [getDescription]( | + | - [getMailTemplates](関数リファレンス/getMailTemplates) - レイアウトテンプレートを取得 |
− | - [getFormTemplates]( | + | - [indexFields](関数リファレンス/indexFields) - 管理画面のメールフィールド一覧ページへのリンクを出力する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><; |
− | - [getLayoutTemplates]( | + | - [link](関数リファレンス/link) - メールフォームへのリンクを生成する |
− | - [getMailTemplates]( | + | - [setMailContent](関数リファレンス/setMailContent) - メールコンテンツデータをセットする |
− | - | + | |
− | - [link]( | + | |
− | - [setMailContent]( | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
## フィード($this->Feed) | ## フィード($this->Feed) | ||
− | + | - [cacheHeader](関数リファレンス/cacheHeader) - フィードリストのキャッシュヘッダーを出力する | |
− | + | - [getTemplates](関数リファレンス/getTemplates) - レイアウトテンプレートを取得 | |
− | + | - [saveCachetime](関数リファレンス/saveCachetime) - フィードのキャッシュタイムをキャッシュファイルに保存 | |
− | - [cacheHeader]( | + | |
− | - [getTemplates]( | + | |
− | - [saveCachetime]( | + | |
### FeedBaser($this->BcBaserで利用可) | ### FeedBaser($this->BcBaserで利用可) | ||
- [feed](/関数リファレンス/feed) - フィード出力 | - [feed](/関数リファレンス/feed) - フィード出力 | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |