|
|
行1: |
行1: |
− | baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。
| + | [このコンテンツは内容調整中です] |
− | <!-- また、主にプラグインの開発に用いるイベントに関する関数もあります。 -->コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 [baserCMS API Document サイト](http://api.basercms.net/) には、baserCMSの関数がすべて網羅されています。
| + | |
| | | |
− | {{info|このページの完成度を高めるためにご協力ください!<br>
| + | ## 説明 |
− | 既にある関数ページに説明を書き込んだり、その関数に関する情報や使用例を記載してください。その際には\[サンプルページ](/ver4/関数リファレンス/sample) の形式を参考にしてください。<br>関数が不足している場合や、不適切なカテゴリーにある場合は、適切なカテゴリーに移動してください。また、誤字脱字に気付かれた場合は訂正してください。<br>みなさん、宜しくお願いします。}}
| + | 関連サイトのリンク情報を取得する |
| | | |
− | ## BcBaser
| + | フロントエンド専用メソッド |
− | ### BcBaser($this->BcBaser) | + | ## 使い方 |
| + | <syntaxhighlight lang="php"> |
| + | $this->BcContents->getRelatedSiteLinks( [$id] , [$options] ) |
| + | </syntaxhighlight> |
| | | |
− | $this->BcBaser->関数名 で使える関数は、どこでも共通で利用できる関数です。 | + | ## パラメータ |
| + | (int)$id |
| + | : コンテンツID = Null |
| | | |
− | - [addCrumb](/ver4/関数リファレンス/addCrumb) - パンくずリストの要素を追加する
| + | (array)$options |
− | - [baseUrl](/ver4/関数リファレンス/baseUrl) - ベースとなるURLを出力する
| + | : |
− | - [cacheHeader](/ver4/関数リファレンス/cacheHeader) - ブラウザにキャッシュさせる為のヘッダーを出力する
| + | |
− | - [charset](/ver4/関数リファレンス/charset) - メタタグを出力する
| + | |
− | - [checkUpdate](/ver4/関数リファレンス/checkUpdate) - アップデート処理が必要かチェックする
| + | |
− | - [content](/ver4/関数リファレンス/content) - コンテンツ本体を出力する
| + | |
− | - [contentsMenu](/ver4/関数リファレンス/contentsMenu) - コンテンツメニューを出力する
| + | |
− | - [contentsName](/ver4/関数リファレンス/contentsName) - コンテンツを特定するIDを出力する
| + | |
− | - [contentsNavi](/ver4/関数リファレンス/contentsNavi) - コンテンツナビを出力する
| + | |
− | - [contentsTitle](/ver4/関数リファレンス/contentsTitle) - コンテンツのタイトルを出力する
| + | |
− | - [copyYear](/ver4/関数リファレンス/copyYear) - コピーライト用の年を出力する
| + | |
− | - [crumbs](/ver4/関数リファレンス/crumbs) - パンくずリストを出力する
| + | |
− | - [crumbsList](/ver4/関数リファレンス/crumbsList) - パンくずリストを出力する
| + | |
− | - [css](/ver4/関数リファレンス/css) - CSSの読み込みタグを出力する
| + | |
− | - [docType](/ver4/関数リファレンス/docType) - ドキュメントタイプを指定するタグを出力する
| + | |
− | - [editLink](/ver4/関数リファレンス/editLink) - 編集画面へのリンクを出力する
| + | |
− | - [element](/ver4/関数リファレンス/element) - エレメントテンプレートを出力する
| + | |
− | - [existsEditLink](/ver4/関数リファレンス/existsEditLink) - 編集画面へのリンクが存在するかチェックする
| + | |
− | - [existsPublishLink](/ver4/関数リファレンス/existsPublishLink) - 公開ページへのリンクが存在するかチェックする
| + | |
− | - [flash](/ver4/関数リファレンス/flash) - セッションに保存したメッセージを出力する
| + | |
− | - [footer](/ver4/関数リファレンス/footer) - フッターテンプレートを出力する
| + | |
− | - [func](/ver4/関数リファレンス/func) - ツールバーエレメントや CakePHP のデバッグ出力を表示
| + | |
− | - [getBaseUrl](/ver4/関数リファレンス/getBaseUrl) - ベースとなるURLを取得する
| + | |
− | - [getBlogs](/ver4/関数リファレンス/getBlogs) - Blogの基本情報を全て取得する
| + | |
− | - [getContentCreatedDate](/ver4/関数リファレンス/getContentCreatedDate) - コンテンツ作成日を取得
| + | |
− | - [getContentModifiedDate](/ver4/関数リファレンス/getContentModifiedDate) - コンテンツ更新日を取得
| + | |
− | - [getContentsMenu](/ver4/関数リファレンス/getContentsMenu) - メニューを取得する
| + | |
− | - [getContentsName](/ver4/関数リファレンス/getContentsName) - コンテンツを特定するIDを取得する
| + | |
− | - [getContentsTitle](/ver4/関数リファレンス/getContentsTitle) - コンテンツタイトルを取得する
| + | |
− | - [getCrumbs](/ver4/関数リファレンス/getCrumbs) - パンくず用の配列を取得する
| + | |
− | - [getCurrentContent](/ver4/関数リファレンス/getCurrentContent) - 現在のコンテンツ情報を取得する
| + | |
− | - [getCurrentPrefix](/ver4/関数リファレンス/getCurrentPrefix) - 現在のサイトプレフィックスを取得する
| + | |
− | - [getDescription](/ver4/関数リファレンス/getDescription) - meta タグ用のページ説明文を取得する
| + | |
− | - [getElement](/ver4/関数リファレンス/getElement) - エレメントテンプレートのレンダリング結果を取得する
| + | |
− | - [getGlobalMenu](/ver4/関数リファレンス/getGlobalMenu) - グローバルメニューを取得する
| + | |
− | - [getGoogleMaps](/ver4/関数リファレンス/getGoogleMaps) - Google Maps を取得する
| + | |
− | - [getHere](/ver4/関数リファレンス/getHere) - 現在のページの純粋なURLを取得する
| + | |
− | - [getImg](/ver4/関数リファレンス/getImg) - 画像タグを取得する
| + | |
− | - [getKeywords](/ver4/関数リファレンス/getKeywords) - meta タグ用のキーワードを取得する
| + | |
− | - [getLink](/ver4/関数リファレンス/getLink) - アンカータグを取得する
| + | |
− | - [getParams](/ver4/関数リファレンス/getParams) - URLのパラメータ情報を返す
| + | |
− | - [getRelatedSiteLinks](/ver4/関数リファレンス/getRelatedSiteLinks) - 関連サイトのリンク一覧を取得
| + | |
− | - [getRoot](/ver4/関数リファレンス/getRoot) - baserCMSが設置されているパスを出力する
| + | |
− | - [getSitemap](/ver4/関数リファレンス/getSitemap) - サイトマップを取得する
| + | |
− | - [getSiteName](/ver4/関数リファレンス/getSiteName) - WEBサイト名を取得する
| + | |
− | - [[getSitePrefix]]
| + | |
− | - [getSiteSearchForm](/ver4/関数リファレンス/getSiteSearchForm) - サイト内検索フォームを取得
| + | |
− | - [getSiteUrl](/ver4/関数リファレンス/getSiteUrl) - WEBサイトURLを出力する
| + | |
− | - [getSubMenu](/ver4/関数リファレンス/getSubMenu) - サブメニューを出力する
| + | |
− | - [getThemeUrl](/ver4/関数リファレンス/getThemeUrl) - テーマのURLを取得する
| + | |
− | - [getTitle](/ver4/関数リファレンス/getTitle) - タイトルタグを取得する
| + | |
− | - [getUpdateInfo](/ver4/関数リファレンス/getUpdateInfo) - 更新情報を取得する
| + | |
− | - [getUri](/ver4/関数リファレンス/getUri) - httpから始まるURLを取得する
| + | |
− | - [getUrl](/ver4/関数リファレンス/BcBaser/getUrl) - baserCMSの設置フォルダを考慮したURLを取得する
| + | |
− | - [getUserName](/ver4/関数リファレンス/getUserName) - ユーザー名を整形して表示する
| + | |
− | - [getWidgetArea](/ver4/関数リファレンス/getWidgetArea) - ウィジェットエリアを取得する
| + | |
− | - [globalMenu](/ver4/関数リファレンス/globalMenu) - グローバルメニューを出力する
| + | |
− | - [googleAnalytics](/ver4/関数リファレンス/googleAnalytics) - Google Analytics のトラッキングコードを出力する
| + | |
− | - [googleMaps](/ver4/関数リファレンス/googleMaps) - Google Maps を出力する
| + | |
− | - [header](/ver4/関数リファレンス/header) - ヘッダーテンプレートを出力する
| + | |
− | - [icon](/ver4/関数リファレンス/icon) - アイコン(favicon)タグを出力する
| + | |
− | - [img](/ver4/関数リファレンス/img) - 画像読み込みタグを出力する
| + | |
− | - [includeCore](/ver4/関数リファレンス/includeCore) - コアテンプレートを読み込む
| + | |
− | - [isAdminUser](/ver4/関数リファレンス/isAdminUser) - 現在のログインユーザーが管理者グループかどうかチェックする
| + | |
− | - [isBlog](/ver4/関数リファレンス/isBlog) - 現在のページがブログプラグインかどうかを判定する
| + | |
− | - [isCategoryTop](/ver4/関数リファレンス/isCategoryTop) - 現在のページがページカテゴリのトップかどうかを判定する
| + | |
− | - [isCurrentUrl](/ver4/関数リファレンス/isCurrentUrl) - 指定したURLが現在のURLと同じかどうか判定する
| + | |
− | - [isHome](/ver4/関数リファレンス/isHome) - 現在のページがトップページかどうかを判定する
| + | |
− | - [isMail](/ver4/関数リファレンス/isMail) - 現在のページがメールプラグインかどうかを判定する
| + | |
− | - [isPage](/ver4/関数リファレンス/isPage) - 現在のページが固定ページかどうかを判定する
| + | |
− | - [isSSL](/ver4/関数リファレンス/isSSL) - SSL通信かどうか判定する
| + | |
− | - [js](/ver4/関数リファレンス/js) - javascriptの読み込みタグを出力する
| + | |
− | - [link](/ver4/関数リファレンス/link) - アンカータグを出力する
| + | |
− | - [listNum](/ver4/関数リファレンス/listNum) - 表示件数設定機能を出力する
| + | |
− | - [logo](/ver4/関数リファレンス/logo) - ロゴを出力する
| + | |
− | - [mainImage](/ver4/関数リファレンス/mainImage) - メインイメージを出力する
| + | |
− | - [mark](/ver4/関数リファレンス/mark) - 文字列を検索しマークとしてタグをつける
| + | |
− | - [metaDescription](/ver4/関数リファレンス/metaDescription) - ページ説明文用のメタタグを出力する
| + | |
− | - [metaKeywords](/ver4/関数リファレンス/metaKeywords) - キーワード用のメタタグを出力する
| + | |
− | - [page](/ver4/関数リファレンス/page) - ページをエレメントとして読み込む
| + | |
− | - [pagination](/ver4/関数リファレンス/pagination) - ページネーションを出力する
| + | |
− | - [publishLink](/ver4/関数リファレンス/publishLink) - 公開ページへのリンクを出力する
| + | |
− | - [relatedSiteLinks](/ver4/関数リファレンス/relatedSiteLinks) - 関連サイトのリンク一覧を取得
| + | |
− | - [root](/ver4/関数リファレンス/root) - baserCMSが設置されているパスを出力する
| + | |
− | - [rss](/ver4/関数リファレンス/rss) - RSSフィードのリンクタグを出力する
| + | |
− | - [scripts](/ver4/関数リファレンス/scripts) - コンテンツ内で設定した CSS や javascript をレイアウトテンプレートに出力し、ログイン中の場合、ツールバー用のCSSも出力する
| + | |
− | - [set](/ver4/関数リファレンス/set) - レイアウトで利用する為の変数を設定する
| + | |
− | - [setCategoryTitle](/ver4/関数リファレンス/setCategoryTitle) - タイトルへのカテゴリタイトルの出力有無を設定する
| + | |
− | - [setDescription](/ver4/関数リファレンス/setDescription) - meta タグの説明文を設定する
| + | |
− | - [setHomeTitle](/ver4/関数リファレンス/setHomeTitle) - トップページのタイトルをセットする
| + | |
− | - [setKeywords](/ver4/関数リファレンス/setKeywords) - meta タグのキーワードを設定する
| + | |
− | - [setPageEditLink](/ver4/関数リファレンス/setPageEditLink) - 編集画面へのリンクを設定する
| + | |
− | - [setSubMenus](/ver4/関数リファレンス/setSubMenus) - サブメニューを設定する(管理画面用)
| + | |
− | - [setTitle](/ver4/関数リファレンス/setTitle) - タイトルを設定する
| + | |
− | - [siteSearchForm](/ver4/関数リファレンス/siteSearchForm) - サイト内検索フォームを出力
| + | |
− | - [sitemap](/ver4/関数リファレンス/sitemap) - サイトマップを出力する
| + | |
− | - [siteName](/ver4/関数リファレンス/siteName) - WEBサイト名を出力する
| + | |
− | - [siteUrl](/ver4/関数リファレンス/siteUrl) - WEBサイトURLを出力する
| + | |
− | - [subMenu](/ver4/関数リファレンス/subMenu) - サブメニューを出力する
| + | |
− | - [swf](/ver4/関数リファレンス/swf) - Flashを表示する
| + | |
− | - [themeUrl](/ver4/関数リファレンス/themeUrl) - テーマのURLを出力する
| + | |
− | - [title](/ver4/関数リファレンス/title) - タイトルタグを出力する
| + | |
− | - [updateInfo](/ver4/関数リファレンス/updateInfo) - 更新情報を出力する
| + | |
− | - [url](/ver4/関数リファレンス/url) - baserCMSの設置フォルダを考慮したURLを出力する
| + | |
− | - [webClipIcon](/ver4/関数リファレンス/webClipIcon) - スマートフォン用のウェブクリップアイコン用のタグを出力する
| + | |
− | - [widgetArea](/ver4/関数リファレンス/widgetArea) - ウィジェットエリアを出力する
| + | |
− | - [xmlHeader](/ver4/関数リファレンス/xmlHeader) - XMLヘッダタグを出力する
| + | |
| | | |
| | | |
− | ### BlogBaser($this->BcBaserで利用可) | + | ## 戻り値 |
| | | |
− | - [blogPosts](/ver4/関数リファレンス/blogPosts) - ブログ記事一覧出力
| + | (array) |
− | - [isBlogCategory](/ver4/関数リファレンス/isBlogCategory) - カテゴリー別記事一覧ページ判定
| + | : prefix , name , url |
− | - [isBlogDate](/ver4/関数リファレンス/isBlogDate) - 日別記事一覧ページ判定
| + | |
− | - [isBlogHome](/ver4/関数リファレンス/isBlogHome) - インデックスページ判定
| + | |
− | - [isBlogMonth](/ver4/関数リファレンス/isBlogMonth) - 月別記事一覧ページ判定
| + | |
− | - [isBlogSingle](/ver4/関数リファレンス/isBlogSingle) - 個別ページ判定
| + | |
− | - [isBlogTag](/ver4/関数リファレンス/isBlogTag) - タグ別記事一覧ページ判定
| + | |
− | - [isBlogYear](/ver4/関数リファレンス/isBlogYear) - 年別記事一覧ページ判定
| + | |
| | | |
− | ### FeedBaser($this->BcBaserで利用可)
| |
− | - [feed](/ver4/関数リファレンス/feed) - フィード出力
| |
| | | |
| + | ## 用例 |
| + | ### 基本 |
| + | ####コード |
| + | <syntaxhighlight lang="php"> |
| | | |
− | ## ブログ
| + | </syntaxhighlight> |
− | ### Blog($this->Blog)
| + | |
| | | |
− | $this->Blog->関数名 で使える関数は、ブログで利用できる関数です。
| + | ####出力 |
| + | <syntaxhighlight lang="html5"> |
| | | |
− | - [allowPublish](/ver4/関数リファレンス/blog/allowPublish) - 公開状態を取得する
| + | </syntaxhighlight> |
− | - [author](/ver4/関数リファレンス/author) - 記事の投稿者を出力する
| + | |
− | - [blogName](/ver4/関数リファレンス/blogName) - ブログアカウント名を出力する
| + | |
− | - [category](/ver4/関数リファレンス/category) - 記事が属するカテゴリ名を出力する
| + | |
− | - [currentBlogId](/ver4/関数リファレンス/currentBlogId) - ブログIDを出力する
| + | |
− | - [description](/ver4/関数リファレンス/description) - ブログの説明文を出力する
| + | |
− | - [descriptionExists](/ver4/関数リファレンス/descriptionExists) - ブログの説明文が指定されているかどうかを判定する
| + | |
− | - [eyeCatch](/ver4/関数リファレンス/eyeCatch) - アイキャッチ画像を出力する
| + | |
− | - [getBlogArchiveType](/ver4/関数リファレンス/getBlogArchiveType) - ブログのアーカイブタイプを取得する
| + | |
− | - [getBlogName](/ver4/関数リファレンス/getBlogName) - ブログアカウント名を取得する
| + | |
− | - [getCategory](/ver4/関数リファレンス/getCategory) - 記事が属するカテゴリ名の一覧を取得する
| + | |
− | - [getCategoryList](/ver4/関数リファレンス/getCategoryList) - カテゴリーの一覧をリストタグで取得する
| + | |
− | - [getCategoryUrl](/ver4/関数リファレンス/getCategoryUrl) - カテゴリ一覧へのURLを取得する
| + | |
− | - [getCurrentBlogId](/ver4/関数リファレンス/getCurrentBlogId) - ブログIDを出力する
| + | |
− | - [getDescription](/ver4/関数リファレンス/Blog/getDescription) - ブログの説明文を取得する
| + | |
− | - [getEyeCatch](/ver4/関数リファレンス/getEyeCatch) - アイキャッチ画像を取得する
| + | |
− | - [getHtmlById](/ver4/関数リファレンス/getHtmlById) - 記事中のタグで指定したIDの内容を取得する
| + | |
− | - [getParentCategory](/ver4/関数リファレンス/Blog/getParentCategory) - 親カテゴリを取得する
| + | |
− | - [getPostContent](/ver4/関数リファレンス/getPostContent) - 記事の本文を取得する
| + | |
− | - [getPostDate](/ver4/関数リファレンス/getPostDate) - 登録日を取得する
| + | |
− | - [getPostDetail](/ver4/関数リファレンス/getPostDetail) - 記事の詳細を取得する
| + | |
− | - [getPostImg](/ver4/関数リファレンス/getPostImg) - 記事中の画像を取得する
| + | |
− | - [getPostLink](/ver4/関数リファレンス/getPostLink) - 記事へのリンクを取得する
| + | |
− | - [getPostLinkUrl](/ver4/関数リファレンス/getPostLinkUrl) - ブログ記事のURLを返す
| + | |
− | - [getPostTitle](/ver4/関数リファレンス/getPostTitle) - 記事タイトルを取得する
| + | |
− | - [getRelatedPosts](/ver4/関数リファレンス/getRelatedPosts) - 同じタグの関連投稿を取得する
| + | |
− | - [getTag](/ver4/関数リファレンス/getTag) - タグを取得する
| + | |
− | - [getTitle](/ver4/関数リファレンス/blog/getTitle) - タイトルを取得する
| + | |
− | - [isArchive](/ver4/関数リファレンス/blog/isArchive) - アーカイブページ判定
| + | |
− | - [isCategory](/ver4/関数リファレンス/blog/isCategory) - カテゴリー別記事一覧ページ判定
| + | |
− | - [isDate](/ver4/関数リファレンス/blog/isDate) - 日別記事一覧ページ判定
| + | |
− | - [isHome](/ver4/関数リファレンス/blog/isHome) - インデックスページ判定
| + | |
− | - [isMonth](/ver4/関数リファレンス/blog/isMonth) - 月別記事一覧ページ判定
| + | |
− | - [isSingle](/ver4/関数リファレンス/blog/isSingle) - 個別ページ判定
| + | |
− | - [isTag](/ver4/関数リファレンス/blog/isTag) - タグ別記事一覧ページ判定
| + | |
− | - [isYear](/ver4/関数リファレンス/blog/isYear) - 年別記事一覧ページ判定
| + | |
− | - [mailFormLink](/ver4/関数リファレンス/mailFormLink) - メールフォームプラグインのフォームへのリンクを生成する
| + | |
− | - [nextLink](/ver4/関数リファレンス/blog/nextLink) - 次の記事へのリンクを出力する
| + | |
− | - [postContent](/ver4/関数リファレンス/postContent) - 記事の本文を表示する
| + | |
− | - [postDate](/ver4/関数リファレンス/postDate) - 記事の登録日を出力する
| + | |
− | - [postDetail](/ver4/関数リファレンス/postDetail) - 記事の詳細を表示する
| + | |
− | - [postImg](/ver4/関数リファレンス/postImg) - 記事中の画像を出力する
| + | |
− | - [postLink](/ver4/関数リファレンス/postLink) - 記事へのリンクを出力する
| + | |
− | - [postTitle](/ver4/関数リファレンス/postTitle) - 記事のタイトルを出力する
| + | |
− | - [prevLink](/ver4/関数リファレンス/blog/prevLink) - 前の記事へのリンクを出力する
| + | |
− | - [removeCtrlChars](/ver4/関数リファレンス/removeCtrlChars) - 文字列から制御文字を取り除く
| + | |
− | - [setContent](/ver4/関数リファレンス/setContent) - ブログコンテンツデータをセットする
| + | |
− | - [tag](/ver4/関数リファレンス/tag) - タグを出力する
| + | |
− | - [title](/ver4/関数リファレンス/blog/title) - ブログタイトルを出力する
| + | |
| | | |
| + | ### 応用 |
| + | ####コード |
| + | <syntaxhighlight lang="php"> |
| | | |
− | ## メールフォーム
| + | </syntaxhighlight> |
− | ### Mail($this->Mail)
| + | |
| | | |
− | $this->Mail->関数名 で使える関数は、メールフォームで利用できる関数です。
| + | ####出力 |
| + | <syntaxhighlight lang="html5"> |
| | | |
− | - [description](/ver4/関数リファレンス/Mail/description) - メールの説明文を表示する
| + | </syntaxhighlight> |
− | - [descriptionExists](/ver4/関数リファレンス/Mail/descriptionExists) - メールの説明文が指定されているかどうかを判定する
| + | |
− | - [getDescription](/ver4/関数リファレンス/Mail/getDescription) - メールの説明文を取得する
| + | |
− | - [getForm](/ver4/関数リファレンス/Mail/getForm) - メールフォームを取得する
| + | |
− | - [getToken](/ver4/関数リファレンス/Mail/getToken) - ブラウザの戻るボタン対応コードを作成
| + | |
− | - [link](/ver4/関数リファレンス/Mail/link) - メールフォームへのリンクを生成する
| + | |
− | - [setMailContent](/ver4/関数リファレンス/Mail/setMailContent) - メールコンテンツデータをセットする
| + | |
− | - [token](/ver4/関数リファレンス/Mail/token) - ブラウザの戻るボタン対応コードを出力
| + | |
| | | |
− | ### Maildata($this->Maildata) | + | ## 注 |
| | | |
− | $this->Maildata->関数名 で使える関数は、メールフォームで利用できる関数です。
| + | ## 変更履歴 |
| | | |
− | - [control](/ver4/関数リファレンス/control) - メール表示用のデータを出力する ※互換性維持用
| + | ## ソースファイル |
− | - [toDisplayString](/ver4/関数リファレンス/toDisplayString) - メール表示用のデータを出力する
| + | |
| | | |
− | ### Mailfield($this->Mailfield) | + | ## 関連資料 |
| | | |
− | $this->Mailfield->関数名 で使える関数は、メールフォームで利用できる関数です。
| + | ##類似の関数 |
| | | |
− | - [getAttributes](/ver4/関数リファレンス/getAttributes) - htmlの属性を取得する
| |
− | - [getOptions](/ver4/関数リファレンス/getOptions) - コントロールのソースを取得する
| |
| | | |
− | ### Mailform($this->Mailform)
| + | [[Category:関数リファレンスver4]] |
− | | + | |
− | $this->Mailform->関数名 で使える関数は、メールフォームで利用できる関数です。
| + | |
− | | + | |
− | - [control](/ver4/関数リファレンス/Mailform/control) - メールフィールドのデータよりコントロールを生成する
| + | |
− | - [create](/ver4/関数リファレンス/Mailform/create) - ファイル添付の対応のためにデフォルト値を変更
| + | |
− | | + | |
− | | + | |
− | ## フィード
| + | |
− | ### Feed($this->Feed)
| + | |
− | | + | |
− | $this->Feed->関数名 で使える関数は、フィードで利用できる関数です。
| + | |
− | | + | |
− | - [getTemplates](/ver4/関数リファレンス/Feed/getTemplates) - レイアウトテンプレートを取得
| + | |
− | | + | |
− | | + | |
− | ## その他
| + | |
− | ### 固定ページ($this->BcPage)
| + | |
− | | + | |
− | $this->BcPage->関数名 で使える関数は、固定ページで利用できる関数です。
| + | |
− | | + | |
− | - [allowPublish](/ver4/関数リファレンス/allowPublish) - 公開状態を取得する
| + | |
− | - [content](/ver4/関数リファレンス/BcPage/content) - 固定ページのコンテンツを出力する
| + | |
− | - [getNextLink](/ver4/関数リファレンス/getNextLink) - ページカテゴリ間の次の記事へのリンクを取得する
| + | |
− | - [getPageList](/ver4/関数リファレンス/BcPage/getPageList) - ページリストを取得する
| + | |
− | - [getPrevLink](/ver4/関数リファレンス/getPrevLink) - ページカテゴリ間の前の記事へのリンクを取得する
| + | |
− | - [getUrl](/ver4/関数リファレンス/BcPage/getUrl) - ページ機能用URLを取得する
| + | |
− | - [nextLink](/ver4/関数リファレンス/nextLink) - ページカテゴリ間の次の記事へのリンクを出力する
| + | |
− | - [prevLink](/ver4/関数リファレンス/prevLink) - ページカテゴリ間の前の記事へのリンクを出力する
| + | |
− | - [[treeList]] - No Description
| + | |
− | | + | |
− | | + | |
− | ### BcAdmin($this->BcAdmin)
| + | |
− | - [isAdminGlobalmenuUsed](/ver4/関数リファレンス/isAdminGlobalmenuUsed) - 管理システムグローバルメニューの利用可否確認
| + | |
− | - [isSystemAdmin](/ver4/関数リファレンス/isSystemAdmin) - ログインユーザーがシステム管理者かチェックする
| + | |
− | | + | |
− | | + | |
− | ### BcArray($this->BcArray)
| + | |
− | - [addText](/ver4/関数リファレンス/addText) - 配列にテキストを追加する
| + | |
− | - [first](/ver4/関数リファレンス/first) - 配列の最初の要素かどうか調べる
| + | |
− | - [last](/ver4/関数リファレンス/last) - 配列の最後の要素かどうか調べる
| + | |
− | | + | |
− | | + | |
− | ### 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]] - テキストエリアを表示する
| + | |
− | - [[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::配列形式の日付データを文字列データに変換する
| + | |
− | - [[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]] - アップロードの設定を取得する
| + | |
− | | + | |
− | | + | |
− | ### BcXml($this->BcXml)
| + | |
− | - [[header](/ver4/関数リファレンス/BcXml/header) - XML宣言を生成する
| + | |
− | | + | |
− | | + | |
− | ### BcContents($this->BcContents)
| + | |
− | - [[getContentFolderList]] - フォルダリストを取得する
| + | |
− | - [getCurrentRelatedSiteUrl](/ver4/関数リファレンス/getCurrentRelatedSiteUrl) - 現在のURLを元に指定したサブサイトのURLを取得する
| + | |
− | - [[getJsonSettings]] - コンテンツ設定を Json 形式で取得する
| + | |
− | - [[getParent]] - 親コンテンツを取得する
| + | |
− | - [[getPureUrl]] - プレフィックスなしのURLを取得する
| + | |
− | - [getRelatedSiteContents](/ver4/関数リファレンス/getRelatedSiteContents) - 関連サイトのコンテンツを取得
| + | |
− | - [getRelatedSiteLinks](/ver4/関数リファレンス/BcContents/getRelatedSiteLinks) - 関連サイトのリンク情報を取得する
| + | |
− | - [getTree](/ver4/関数リファレンス/getTree) - コンテンツリストをツリー構造で取得する
| + | |
− | - [[getUrl]] - フルURLを取得する
| + | |
− | - [[getUrlById]] - コンテンツIDよりフルURLを取得する
| + | |
− | - [isActionAvailable](/ver4/関数リファレンス/isActionAvailable) - アクションが利用可能かどうか確認する
| + | |
− | - [[isAllowPublish]] - データが公開状態にあるか確認する
| + | |
− | - [isSiteRelated](/ver4/関数リファレンス/isSiteRelated) - サイト連携データかどうか確認する
| + | |
− | - [[setup]] - セットアップ
| + | |
− | | + | |
− | [[Category:開発ガイド]] | + | |