個人用ツール

「ver4/関数リファレンス/BcBaser contentsName」の版間の差分

提供: baserCMS公式ガイド

移動: 案内, 検索
行18: 行18:
 
## パラメータ
 
## パラメータ
 
(bool) $detail
 
(bool) $detail
: true にした場合は、ページごとに一意となる文字列をキャメルケースで出力する
+
: 詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで出力する
 
: - 初期値:false
 
: - 初期値:false
  
行24: 行24:
 
: オプション
 
: オプション
 
: - 初期値:array()
 
: - 初期値:array()
:`home`: トップページの場合に出力する文字列(初期値: Home)
+
:`home` : トップページの場合に出力する文字列(初期値: Home)
:- 'default' ルート直下の下層ページの場合に出力する文字列(初期値: Default)
+
:`default` : ルート直下の下層ページの場合に出力する文字列(初期値: Default)
:- 'error' エラーページの場合に出力する文字列(初期値: Error)
+
:`error` : エラーページの場合に出力する文字列(初期値: Error)
:- 'underscore' キャメルケースではなくアンダースコア区切りで出力する(初期値: false)
+
:`underscore` : キャメルケースではなくアンダースコア区切りで出力する(初期値: false)
 
: ※ オプションの詳細については、BcBaserHelper::getContentsName() を参照
 
: ※ オプションの詳細については、BcBaserHelper::getContentsName() を参照
 
## 戻り値
 
## 戻り値

2018年10月23日 (火) 21:40時点における版

[このコンテンツは内容調整中です]

説明

コンテンツを特定する文字列を出力する。

URLを元に、第一階層までの文字列をキャメルケースで出力する。

《例》
- トップページの場合 : Home
- about ページの場合 : About

使い方

<?php $this->BcBaser->contentsName( [$detail], [$options] ); ?>

パラメータ

(bool) $detail
詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで出力する
- 初期値:false
(array) $options
オプション
- 初期値:array()
home : トップページの場合に出力する文字列(初期値: Home)
default : ルート直下の下層ページの場合に出力する文字列(初期値: Default)
error : エラーページの場合に出力する文字列(初期値: Error)
underscore : キャメルケースではなくアンダースコア区切りで出力する(初期値: false)
※ オプションの詳細については、BcBaserHelper::getContentsName() を参照

戻り値

(string)
コンテンツと特定するID

用例

基本

bodyのidにコンテンツ名を指定する。

コード

<body id="<?php $this->BcBaser->contentsName() ?>">

出力

<body id="Contact">

応用

bodyのidに一意となる文字列をアンダースコア区切りで出力する。

コード

<body id="<?php $this->BcBaser->contentsName( true, array('underscore' => true)) ?>">

出力

<body id="contact_index">

変更履歴

ソースファイル

関連資料

類似の関数