「ver4/関数リファレンス/BcBaser getContentsName」の版間の差分
提供: baserCMS公式ガイド
細 (1版 : 関数リファレンス→ver4) |
|||
(2人の利用者による、間の7版が非表示) | |||
行2: | 行2: | ||
## 説明 | ## 説明 | ||
− | + | コンテンツを特定する文字列を取得する。<br> | |
+ | URLを元に、第一階層までの文字列をキャメルケースで取得します。<br /> | ||
− | + | 《例》<br /> | |
− | + | - トップページの場合 : Home<br /> | |
+ | - about ページの場合 : About<br> | ||
+ | - エラーページの場合 : Error | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
## 使い方 | ## 使い方 | ||
行20: | 行17: | ||
## パラメータ | ## パラメータ | ||
− | + | (bool) $detail | |
− | : true | + | : 詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで出力する |
− | : (例)http://xxx.xx/contact/index の場合、「ContactIndex」を取得 | + | :(例)http://xxx.xx/contact/index の場合、「ContactIndex」を取得 |
+ | : - 初期値:false | ||
− | + | (array) $options | |
+ | : オプション | ||
+ | : - 初期値:array() | ||
+ | :`home` : トップページの場合に出力する文字列(初期値: Home) | ||
+ | :`default` : ルート直下の下層ページの場合に出力する文字列(初期値: Default) | ||
+ | :`error` : エラーページの場合に出力する文字列(初期値: Error) | ||
+ | :`underscore` : キャメルケースではなくアンダースコア区切りで出力する(初期値: false | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
## 戻り値 | ## 戻り値 | ||
− | + | (string) | |
− | : | + | : コンテンツを特定する文字列 |
+ | |||
## 用例 | ## 用例 | ||
### 基本 | ### 基本 | ||
+ | コンテンツ名取得し、bodyのidにechoで出力する。 | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
− | <?php echo $this->BcBaser->getContentsName( | + | <body id="<?php echo $this->BcBaser->getContentsName() ?>"> |
</syntaxhighlight> | </syntaxhighlight> | ||
####出力 | ####出力 | ||
<syntaxhighlight lang="html5"> | <syntaxhighlight lang="html5"> | ||
− | + | <body id="Contact"> | |
</syntaxhighlight> | </syntaxhighlight> | ||
### 応用 | ### 応用 | ||
+ | コンテンツ名を一意となる文字列で取得し、echoでbodyのidに出力する。 | ||
####コード | ####コード | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
− | <body id="<?php echo $this->BcBaser->getContentsName(true) ?>"> | + | <body id="<?php echo $this->BcBaser->getContentsName(true, array('underscore' => true)) ?>"> |
</syntaxhighlight> | </syntaxhighlight> | ||
行60: | 行60: | ||
<body id="ContactIndex"> | <body id="ContactIndex"> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
##類似の関数 | ##類似の関数 | ||
− | + | - [contentsName](/ver4/関数リファレンス/contentsName) - コンテンツを特定する文字列を出力する | |
− | + | ||
− | [ | + |
2018年12月13日 (木) 00:38時点における最新版
[このコンテンツは内容調整中です]
説明
コンテンツを特定する文字列を取得する。
URLを元に、第一階層までの文字列をキャメルケースで取得します。
《例》
- トップページの場合 : Home
- about ページの場合 : About
- エラーページの場合 : Error
使い方
<?php $this->BcBaser->getContentsName( [$detail] , [$option] ); ?>
パラメータ
- (bool) $detail
- 詳細モード true にした場合は、ページごとに一意となる文字列をキャメルケースで出力する
- (例)http://xxx.xx/contact/index の場合、「ContactIndex」を取得
home
: トップページの場合に出力する文字列(初期値: Home)default
: ルート直下の下層ページの場合に出力する文字列(初期値: Default)error
: エラーページの場合に出力する文字列(初期値: Error)underscore
: キャメルケースではなくアンダースコア区切りで出力する(初期値: false
戻り値
- (string)
- コンテンツを特定する文字列
用例
基本
コンテンツ名取得し、bodyのidにechoで出力する。
コード
<body id="<?php echo $this->BcBaser->getContentsName() ?>">
出力
<body id="Contact">
応用
コンテンツ名を一意となる文字列で取得し、echoでbodyのidに出力する。
コード
<body id="<?php echo $this->BcBaser->getContentsName(true, array('underscore' => true)) ?>">
出力
<body id="ContactIndex">
類似の関数
- contentsName - コンテンツを特定する文字列を出力する