個人用ツール

「関数リファレンス」の版間の差分

提供: baserCMS公式ガイド

移動: 案内, 検索
行199: 行199:
  
 
## BcArray($this->BcArray)
 
## BcArray($this->BcArray)
 +
- [addText](/関数リファレンス/addText) - 配列にテキストを追加する
 +
- [first](/関数リファレンス/first) - 配列の最初の要素かどうか調べる
 +
- [last](/関数リファレンス/last) - 配列の最後の要素かどうか調べる
 +
 +
 +
## BcCkeditor($this->BcCkeditor)
 +
- [_build](/関数リファレンス/_build) - CKEditor のスクリプトを構築する
 +
- [editor](/関数リファレンス/editor) - CKEditorのテキストエリアを出力する
 +
 +
 +
## BcCsv($this->BcCsv)
 +
- [addModelData](/関数リファレンス/addModelData) - データを追加する(単数)
 +
- [addModelDatas](/関数リファレンス/addModelDatas) - データをセットする(複数)
 +
- [download](/関数リファレンス/download) - CSVファイルをダウンロードする
 +
- [save](/関数リファレンス/save) - ファイルを保存する
 +
 +
 +
## BcForm($this->BcForm)
 +
- [checkbox](/関数リファレンス/checkbox) - CakeコアのFormHelperの拡張
 +
- [ckeditor](/関数リファレンス/ckeditor) - CKEditorを出力する
 +
- [create](/関数リファレンス/create) - フック用にCakeコアをラッピング
 +
- [dateTime](/関数リファレンス/dateTime) - CakeコアのFormHelperの拡張
 +
- [dateTimePicker](/関数リファレンス/dateTimePicker) - 日付カレンダーと時間フィールド
 +
- [datepicker](/関数リファレンス/datepicker) - カレンダーコントロール付きのテキストフィールド
 +
- [dispatchAfterForm](/関数リファレンス/dispatchAfterForm) - フォームの最後のフィールドの後に発動する前提としてイベントを発動する
 +
- [editor](/関数リファレンス/editor) - エディタを表示する
 +
- [end](/関数リファレンス/end) - フック用にCakeコアをラッピング
 +
- [file](/関数リファレンス/file) - ファイルインプットボックス出力
 +
- [generateList](/関数リファレンス/generateList) - モデルよりリストを生成する
 +
- [getControlSource](/関数リファレンス/getControlSource) - コントロールソースを取得する
 +
- [hidden](/関数リファレンス/hidden) - Cakeコアをラッピング
 +
- [input](/関数リファレンス/input) - Cakeコアをラッピング
 +
- [jsonList](/関数リファレンス/jsonList) - JsonListを出力
 +
- [prefTag](/関数リファレンス/prefTag) - 都道府県用のSELECTタグを表示する
 +
- [selectText](/関数リファレンス/selectText) - 文字列保存用複数選択コントロール
 +
- [wyear](/関数リファレンス/wyear) - 和暦年

2014年11月2日 (日) 00:25時点における版

どこでも使える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 - トップページかどうか判断する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><;
  • 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)

  • allowPublish - 公開状態を取得する
  • beforeRender - beforeRender
  • content - 固定ページのコンテンツを出力する
  • contentsNaviAvailable - コンテンツナビ有効チェック
  • getCategory - 現在のページが所属するカテゴリデータを取得する
  • getCategoryName - カテゴリ名を取得する
  • getPageList - ページリストを取得する
  • getParentCategory - 現在のページが所属する親のカテゴリを取得する
  • getTemplates - テンプレートを取得
  • getUrl - ページ機能用URLを取得する
  • nextLink - ページカテゴリ間の次の記事へのリンクを取得する
  • prevLink - ページカテゴリ間の前の記事へのリンクを取得する
  • treeList - No Description ※TODO: メソッドに説明載ってない><;

BlogBaser($this->BcBaserで利用可)

ブログ($this->Blog)

  • allowPublish - 公開状態を取得する
  • author - 記事の投稿者を出力する
  • category - 記事が属するカテゴリ名を出力する
  • description - ブログの説明文を出力する
  • descriptionExists - ブログの説明文が指定されているかどうかを判定する
  • editPost - ブログ編集ページへのリンクを出力(非推奨)※TODO: 打ち消し線付けたい誰かつけて><;
  • 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)

  • description - メールの説明文を表示する
  • descriptionExists - メールの説明文が指定されているかどうかを判定する
  • getDescription - メールの説明文を取得する
  • getFormTemplates - フォームテンプレートを取得
  • getLayoutTemplates - レイアウトテンプレートを取得
  • getMailTemplates - レイアウトテンプレートを取得
  • indexFields - 管理画面のメールフィールド一覧ページへのリンクを出力する(非推奨)※TODO: 打ち消し線付けたい誰かつけて><;
  • link - メールフォームへのリンクを生成する
  • setMailContent - メールコンテンツデータをセットする

Maildata($this->Maildata)

  • control - メール表示用のデータを出力する

Mailfield($this->Mailfield)

Mailform($this->Mailform)

  • control - メールフィールドのデータよりコントロールを生成する

フィード($this->Feed)

  • cacheHeader - フィードリストのキャッシュヘッダーを出力する
  • getTemplates - レイアウトテンプレートを取得
  • saveCachetime - フィードのキャッシュタイムをキャッシュファイルに保存

FeedBaser($this->BcBaserで利用可)

  • feed - フィード出力

BcAdmin($this->BcAdmin)

  • isAdminGlobalmenuUsed - 管理システムグローバルメニューの利用可否確認
  • isSystemAdmin - ログインユーザーがシステム管理者かチェックする

BcArray($this->BcArray)

  • addText - 配列にテキストを追加する
  • first - 配列の最初の要素かどうか調べる
  • last - 配列の最後の要素かどうか調べる

BcCkeditor($this->BcCkeditor)

  • _build - CKEditor のスクリプトを構築する
  • 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タグを表示する
  • selectText - 文字列保存用複数選択コントロール
  • wyear - 和暦年