ここから本文です

baserCMS 3系関数リファレンス

ここではbaserCMSが提供するテンプレートで利用できる基本的な関数(命令)をご紹介します。

baserCMSはプログラム言語であるPHPで作られていいますので、関数は必ず<?php ?>で囲みます。
※スマートURLが有効でない場合でも、ルートディレクトリは「/app/webroot」ではなく「/」となります。

BcBaserHelper

BaserCMSでは、WEBプログラムのテンプレートをできるだけ簡単に利用できるようにする為、 テンプレートで利用する為の基本的な命令をBaserHelperにまとめています。
各命令は、出力系、取得系、設定系、判定系と4つのグループにわけられています。

BcBaserHelper 出力系命令

出力系の命令は、PHPにおける echo や print 等の出力命令を付与せずとも、関数を配置しただけでそのまま出力される命令を指します。

blogPosts
ブログ記事一覧出力
title
タイトルタグを出力する
metaDescription
ページ説明文用のメタタグを出力する
metaKeywords
キーワード用のメタタグを出力する
xmlHeader
XMLヘッダタグを出力する
icon
アイコン(favicon)タグを出力する
docType
ドキュメントタイプを指定するタグを出力する
css
CSSの読み込みタグを出力する
contentsTitle
コンテンツのタイトルを出力する
js
javascriptの読み込みタグを出力する
img
画像読み込みタグを出力する
link
アンカータグを出力する
scripts
コンテンツ内で設定したCSSやjavascriptをレイアウトテンプレートに出力
element
エレメント(部品)テンプレートを出力する
pagination
ページネーションを出力する
copyYear
コピーライト用の年を出力する
charset
charsetメタタグを出力する
flash
セッションメッセージを出力する
root
BaserCMSが設置されているパスを出力する
contentsName
コンテンツを特定するIDを出力する
sitemap
サイトマップを出力する
cacheHeader
ブラウザにキャッシュさせる為のヘッダーを出力する
footer
フッターテンプレートを出力する
header
ヘッダーテンプレートを出力する
rss
RSSフィードのリンクタグを出力する
crumbs
パンくずリストを出力する
page
ページをエレメントとして読み込む
url
ベースを考慮したURLを出力する
content
コンテンツを出力する
func
ツールバーやCakeのデバッグ出力を表示する
swf
Flashを表示する
widgetArea
ウィジェットエリアを出力する
feed
フィードを出力する

BcBaserHelper 取得系命令

取得系命令は、出力系命令のようにそのまま出力するのではなく、関数が生成したデータの中身を一旦取得して、加工してから出力したい場合などに利用します。
加工等を行ったデータを出力する場合は、PHPの echo や print 等の出力命令で明示的に出力する必要があります。

getPageList
ページ機能で作成したページの一覧データを取得する
getContentsName
コンテンツを特定するIDを取得する
getLink
アンカータグを取得する
getImg
画像タグを取得する
getElement
エレメント(部品)テンプレートを取得する
getUrl
相対パスから実際のパスを取得する
getRoot
BaserCMSが設置されているパスを取得する
getMenus
グローバルメニューを取得する
getDescription
ページ説明文を取得する
getKeywords
キーワードを取得する
getContentsTitle
コンテンツタイトルを取得する
getTitle
タイトルタグを取得する
getHere
現在のページの純粋なURLを取得する
getUri
httpから始まるURLを取得する
isBlogHome
ブログのトップページかを判定する

BaserHelper 設定系命令

設定系命令は、出力系命令や、取得系命令の生成するデータに影響を与える為の設定命令です。
主に、ページテンプレートなどのコンテンツ側から、レイアウトテンプレートが出力する内容を設定するのに利用します。

mark
文字列を検索しマークとしてタグをつける
addCrumb
パンくずリストの要素を追加する
setSubMenus
サブメニューを設定する
setCategoryTitle
タイトルへのカテゴリタイトルの出力有無を設定する
setDescription
説明文を設定する
setKeywords
キーワードを設定する
setTitle
タイトルを設定する
set
レイアウトで利用する為の変数を設定する

BcBaserHelper 判定系命令

判定系命令は、条件によって処理内容や表示内容を変更する場合に利用します。
PHPのif文等で利用します。

isSSL
SSL通信かどうか確認する
isHome
現在のページがトップページかどうかを判定する
isPage
現在のページが固定ページかどうかを判定する
isCategoryTop
現在のページがページカテゴリのトップかどうかを判定する
isAdminUser
現在のログインユーザーが管理者グループかどうかチェックする

BlogHelper

Blogプラグインで利用可能な関数の一覧です。 BaserHelperと同様、各関数は、出力系、取得系、設定系、判定系と4つのグループにわけられています。

BlogHelper 出力系命令

出力系の命令は、PHPにおける echo や print 等の出力命令を付与せずとも、関数を配置しただけでそのまま出力される命令を指します。

category
記事が属するカテゴリ名を出力する
postTitle
記事のタイトルを出力する
description
ブログの説明文を表示する
postImg
記事中の画像を出力する
tag
タグを出力する
postLink
記事へのリンクを出力する
nextLink
次の記事へのリンクを出力する
prevLink
前の記事へのリンクを出力する
author
記事の投稿者を出力する
postDate
記事の登録日を出力する
postContent
記事の内容を表示する
description
ブログの説明文を出力する
title
ブログタイトルを出力する

BlogHelper 取得系命令

取得系命令は、出力系命令のようにそのまま出力するのではなく、関数が生成したデータの中身を一旦取得して、加工してから出力したい場合などに利用します。
加工等を行ったデータを出力する場合は、PHPの echo や print 等の出力命令で明示的に出力する必要があります。

getParentCategory
親カテゴリを取得する
getPostImg
記事中の画像を取得する
allowPublish
公開状態を取得する
getTag
タグを取得する
getPostLink
記事へのリンクを取得する
getPostTitle
記事タイトルを取得する
getCategoryList
カテゴリーの一覧をリストタグで取得する
getCategoryUrl
カテゴリ一覧へのURLを取得する
getCategory
記事が属するカテゴリ名の一覧を取得する
getPostContent
記事の本文を取得する
getDescription
ブログの説明文を取得する
getHtmlById
記事中のタグで指定したIDの内容を取得する

BlogHelper 判定系命令

判定系命令は、条件によって処理内容や表示内容を変更する場合に利用します。
PHPのif文等で利用します。

descriptionExists
ブログの説明文が指定されているかどうかを判定する

MailHelper

Mailプラグインで利用可能な関数の一覧です。 BaserHelperと同様、各関数は、出力系、取得系、設定系、判定系と4つのグループにわけられています。
※ 現在は、出力系のみです。

MailHelper 出力系命令

出力系の命令は、PHPにおける echo や print 等の出力命令を付与せずとも、関数を配置しただけでそのまま出力される命令を指します。

indexFields
管理画面のメールフィールド一覧ページへのリンクを出力する
baserCMS最新版ダウンロード

ダウンロード数: ...

最新バーション: ...

メールマガジン•登録無料
baserCMSの最新情報を
毎週1回配信しています。

※ 登録にはGoogleアカウントが必要です。
  • baserマーケット
  • baserマガジン
  • それいけ!baserCMS

- P R -

ビーコミ - baserCMSの総合サービス