個人用ツール

ver4/関数リファレンス

提供: baserCMS公式ガイド

移動: 案内, 検索

baserCMSには、便利な関数がたくさん定義されています。baser関数と呼ばれる一部の関数は、特に baserCMS テーマ用に定義されているものになります。 コアの baserCMS 関数の多くはプラグインやテーマ開発に役立ちます。ここでは、主にビュー側で利用するHelperのほとんどのコア関数を一覧にしています。ここにある情報に加え、 baserCMS API Document サイト には、baserCMSの関数がすべて網羅されています。

BcBaser

BcBaser($this->BcBaser)

$this->BcBaser->関数名 で使える関数は、どこでも共通で利用できる関数です。

  • addCrumb - パンくずリストの要素を追加する
  • baseUrl - ベースとなるURLを出力する
  • cacheHeader - ブラウザにキャッシュさせる為のヘッダーを出力する
  • charset - メタタグを出力する
  • checkUpdate - アップデート処理が必要かチェックする
  • content - コンテンツ本体を出力する
  • contentsMenu - コンテンツメニューを出力する
  • contentsName - コンテンツを特定するIDを出力する
  • contentsNavi - コンテンツナビを出力する
  • contentsTitle - コンテンツのタイトルを出力する
  • copyYear - コピーライト用の年を出力する
  • crumbs - パンくずリストを出力する
  • crumbsList - パンくずリストを出力する
  • css - CSSの読み込みタグを出力する
  • docType - ドキュメントタイプを指定するタグを出力する
  • editLink - 編集画面へのリンクを出力する
  • element - エレメントテンプレートを出力する
  • existsEditLink - 編集画面へのリンクが存在するかチェックする
  • existsPublishLink - 公開ページへのリンクが存在するかチェックする
  • flash - セッションに保存したメッセージを出力する
  • footer - フッターテンプレートを出力する
  • func - ツールバーエレメントや CakePHP のデバッグ出力を表示
  • getBaseUrl - ベースとなるURLを取得する
  • getBlogs - Blogの基本情報を全て取得する
  • getContentCreatedDate - コンテンツ作成日を取得
  • getContentModifiedDate - コンテンツ更新日を取得
  • getContentsMenu - メニューを取得する
  • getContentsName - コンテンツを特定するIDを取得する
  • getContentsTitle - コンテンツタイトルを取得する
  • getCrumbs - パンくず用の配列を取得する
  • getCurrentContent - 現在のコンテンツ情報を取得する
  • getCurrentPrefix - 現在のサイトプレフィックスを取得する
  • getDescription - meta タグ用のページ説明文を取得する
  • getElement - エレメントテンプレートのレンダリング結果を取得する
  • getGlobalMenu - グローバルメニューを取得する
  • getGoogleMaps - Google Maps を取得する
  • getHere - 現在のページの純粋なURLを取得する
  • getImg - 画像タグを取得する
  • getKeywords - meta タグ用のキーワードを取得する
  • getLink - アンカータグを取得する
  • getParams - URLのパラメータ情報を返す
  • getRelatedSiteLinks - 関連サイトのリンク一覧を取得
  • getRoot - baserCMSが設置されているパスを出力する
  • getSitemap - サイトマップを取得する
  • getSiteName - WEBサイト名を取得する
  • getSitePrefix
  • getSiteSearchForm - サイト内検索フォームを取得
  • getSiteUrl - WEBサイトURLを出力する
  • getSubMenu - サブメニューを出力する
  • getThemeUrl - テーマのURLを取得する
  • getTitle - タイトルタグを取得する
  • getUpdateInfo - 更新情報を取得する
  • getUri - httpから始まるURLを取得する
  • getUrl - baserCMSの設置フォルダを考慮したURLを取得する
  • getUserName - ユーザー名を整形して表示する
  • getWidgetArea - ウィジェットエリアを取得する
  • globalMenu - グローバルメニューを出力する
  • googleAnalytics - Google Analytics のトラッキングコードを出力する
  • googleMaps - Google Maps を出力する
  • header - ヘッダーテンプレートを出力する
  • icon - アイコン(favicon)タグを出力する
  • img - 画像読み込みタグを出力する
  • includeCore - コアテンプレートを読み込む
  • isAdminUser - 現在のログインユーザーが管理者グループかどうかチェックする
  • isBlog - 現在のページがブログプラグインかどうかを判定する
  • isCategoryTop - 現在のページがページカテゴリのトップかどうかを判定する
  • isCurrentUrl - 指定したURLが現在のURLと同じかどうか判定する
  • isHome - 現在のページがトップページかどうかを判定する
  • isMail - 現在のページがメールプラグインかどうかを判定する
  • isPage - 現在のページが固定ページかどうかを判定する
  • isSSL - SSL通信かどうか判定する
  • js - javascriptの読み込みタグを出力する
  • link - アンカータグを出力する
  • listNum - 表示件数設定機能を出力する
  • logo - ロゴを出力する
  • mainImage - メインイメージを出力する
  • mark - 文字列を検索しマークとしてタグをつける
  • metaDescription - ページ説明文用のメタタグを出力する
  • metaKeywords - キーワード用のメタタグを出力する
  • page - ページをエレメントとして読み込む
  • pagination - ページネーションを出力する
  • publishLink - 公開ページへのリンクを出力する
  • relatedSiteLinks - 関連サイトのリンク一覧を取得
  • root - baserCMSが設置されているパスを出力する
  • rss - RSSフィードのリンクタグを出力する
  • scripts - コンテンツ内で設定した CSS や javascript をレイアウトテンプレートに出力し、ログイン中の場合、ツールバー用のCSSも出力する
  • set - レイアウトで利用する為の変数を設定する
  • setCategoryTitle - タイトルへのカテゴリタイトルの出力有無を設定する
  • setDescription - meta タグの説明文を設定する
  • setHomeTitle - トップページのタイトルをセットする
  • setKeywords - meta タグのキーワードを設定する
  • setPageEditLink - 編集画面へのリンクを設定する
  • setSubMenus - サブメニューを設定する(管理画面用)
  • setTitle - タイトルを設定する
  • siteSearchForm - サイト内検索フォームを出力
  • sitemap - サイトマップを出力する
  • siteName - WEBサイト名を出力する
  • siteUrl - WEBサイトURLを出力する
  • subMenu - サブメニューを出力する
  • swf - Flashを表示する
  • themeUrl - テーマのURLを出力する
  • title - タイトルタグを出力する
  • updateInfo - 更新情報を出力する
  • url - baserCMSの設置フォルダを考慮したURLを出力する
  • webClipIcon - スマートフォン用のウェブクリップアイコン用のタグを出力する
  • widgetArea - ウィジェットエリアを出力する
  • xmlHeader - XMLヘッダタグを出力する

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

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

  • feed - フィード出力

ブログ

Blog($this->Blog)

$this->Blog->関数名 で使える関数は、ブログで利用できる関数です。

  • allowPublish - 公開状態を取得する
  • author - 記事の投稿者を出力する
  • blogName - ブログアカウント名を出力する
  • category - 記事が属するカテゴリ名を出力する
  • currentBlogId - ブログIDを出力する
  • description - ブログの説明文を出力する
  • descriptionExists - ブログの説明文が指定されているかどうかを判定する
  • eyeCatch - アイキャッチ画像を出力する
  • getBlogArchiveType - ブログのアーカイブタイプを取得する
  • getBlogName - ブログアカウント名を取得する
  • getCategory - 記事が属するカテゴリ名の一覧を取得する
  • getCategoryList - カテゴリーの一覧をリストタグで取得する
  • getCategoryUrl - カテゴリ一覧へのURLを取得する
  • getCurrentBlogId - ブログIDを出力する
  • getDescription - ブログの説明文を取得する
  • getEyeCatch - アイキャッチ画像を取得する
  • getHtmlById - 記事中のタグで指定したIDの内容を取得する
  • getParentCategory - 親カテゴリを取得する
  • getPostContent - 記事の本文を取得する
  • getPostDate - 登録日を取得する
  • getPostDetail - 記事の詳細を取得する
  • getPostImg - 記事中の画像を取得する
  • getPostLink - 記事へのリンクを取得する
  • getPostLinkUrl - ブログ記事のURLを返す
  • getPostTitle - 記事タイトルを取得する
  • getRelatedPosts - 同じタグの関連投稿を取得する
  • getTag - タグを取得する
  • getTitle - タイトルを取得する
  • isArchive - アーカイブページ判定
  • isCategory - カテゴリー別記事一覧ページ判定
  • isDate - 日別記事一覧ページ判定
  • isHome - インデックスページ判定
  • isMonth - 月別記事一覧ページ判定
  • isSingle - 個別ページ判定
  • isTag - タグ別記事一覧ページ判定
  • isYear - 年別記事一覧ページ判定
  • mailFormLink - メールフォームプラグインのフォームへのリンクを生成する
  • nextLink - 次の記事へのリンクを出力する
  • postContent - 記事の本文を表示する
  • postDate - 記事の登録日を出力する
  • postDetail - 記事の詳細を表示する
  • postImg - 記事中の画像を出力する
  • postLink - 記事へのリンクを出力する
  • postTitle - 記事のタイトルを出力する
  • prevLink - 前の記事へのリンクを出力する
  • removeCtrlChars - 文字列から制御文字を取り除く
  • setContent - ブログコンテンツデータをセットする
  • tag - タグを出力する
  • title - ブログタイトルを出力する

メールフォーム

Mail($this->Mail)

$this->Mail->関数名 で使える関数は、メールフォームで利用できる関数です。

  • description - メールの説明文を表示する
  • descriptionExists - メールの説明文が指定されているかどうかを判定する
  • getDescription - メールの説明文を取得する
  • getForm - メールフォームを取得する
  • getToken - ブラウザの戻るボタン対応コードを作成
  • link - メールフォームへのリンクを生成する
  • setMailContent - メールコンテンツデータをセットする
  • token - ブラウザの戻るボタン対応コードを出力

Maildata($this->Maildata)

$this->Maildata->関数名 で使える関数は、メールフォームで利用できる関数です。

  • control - メール表示用のデータを出力する ※互換性維持用
  • toDisplayString - メール表示用のデータを出力する

Mailfield($this->Mailfield)

$this->Mailfield->関数名 で使える関数は、メールフォームで利用できる関数です。

Mailform($this->Mailform)

$this->Mailform->関数名 で使える関数は、メールフォームで利用できる関数です。

  • control - メールフィールドのデータよりコントロールを生成する
  • create - ファイル添付の対応のためにデフォルト値を変更

フィード

Feed($this->Feed)

$this->Feed->関数名 で使える関数は、フィードで利用できる関数です。

その他

固定ページ($this->BcPage)

$this->BcPage->関数名 で使える関数は、固定ページで利用できる関数です。

  • allowPublish - 公開状態を取得する
  • content - 固定ページのコンテンツを出力する
  • getNextLink - ページカテゴリ間の次の記事へのリンクを取得する
  • getPageList - ページリストを取得する
  • getPrevLink - ページカテゴリ間の前の記事へのリンクを取得する
  • getUrl - ページ機能用URLを取得する
  • nextLink - ページカテゴリ間の次の記事へのリンクを出力する
  • prevLink - ページカテゴリ間の前の記事へのリンクを出力する
  • treeList - No Description

BcAdmin($this->BcAdmin)

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

BcArray($this->BcArray)

  • addText - 配列にテキストを追加する
  • first - 配列の最初の要素かどうか調べる
  • 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)

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 - アップロードの設定を取得する

BcWidgetArea($this->BcWidgetArea)

  • show - ウィジェットエリアを表示する

BcXml($this->BcXml)

  • header - XML宣言を生成する

BcContents($this->BcContents)