「関数リファレンス/BcBaser getLink」の版間の差分
提供: baserCMS公式ガイド
(ページの作成:「## 説明 アンカータグを取得します。 ## 使い方 <syntaxhighlight lang="php"> $this->BcBaser->getLink( $title , [$url] , [$options] , [$confirmMessage] );...」) |
|||
行8: | 行8: | ||
## パラメータ | ## パラメータ | ||
− | $title | + | (string)$title |
: アンカータグのラベル | : アンカータグのラベル | ||
- 初期値:- | - 初期値:- | ||
− | $url | + | (mixed)$url |
: リンク先のパス | : リンク先のパス | ||
: サイト内のページを指定するいは、BaserCMSの設置場所を起点としてスラッシュから始まる絶対パスを指定する。指定しない場合はカレント。 | : サイト内のページを指定するいは、BaserCMSの設置場所を起点としてスラッシュから始まる絶対パスを指定する。指定しない場合はカレント。 | ||
行19: | 行19: | ||
- 初期値:null | - 初期値:null | ||
− | $options | + | (array)$options |
: 要素を連想配列で指定する。 | : 要素を連想配列で指定する。 | ||
− | : | + | : `escape` : タイトルをエスケープするかどうか(初期値 : false) |
+ | : `prefix` : URLにプレフィックスをつけるかどうか(初期値 : false) | ||
+ | : `forceTitle` : 許可されていないURLの際にタイトルを強制的に出力するかどうか(初期値 : false) | ||
+ | : `ssl` : SSL用のURLをして出力するかどうか(初期値 : false) | ||
+ | : ※ その他のパラメータについては、HtmlHelper::image() を参照。 | ||
+ | |||
: 例)array('class'=>'hoge') | : 例)array('class'=>'hoge') | ||
: 呼び出し先のプレフィックスを指定するsubDirなどのオプションを設定することが出来ます。 | : 呼び出し先のプレフィックスを指定するsubDirなどのオプションを設定することが出来ます。 | ||
行27: | 行32: | ||
- 初期値:array() | - 初期値:array() | ||
− | $confirmMessage | + | (boolean) $confirmMessage |
− | : | + | : リンクをクリックした際に確認メッセージが表示され、はいをクリックした場合のみ遷移する。 |
- 初期値:false | - 初期値:false | ||
## 戻り値 | ## 戻り値 | ||
+ | (string) | ||
## 用例 | ## 用例 |
2014年11月18日 (火) 15:21時点における版
目次
説明
アンカータグを取得します。
使い方
$this->BcBaser->getLink( $title , [$url] , [$options] , [$confirmMessage] );
パラメータ
- (string)$title
-
アンカータグのラベル
- 初期値:-
- (mixed)$url
- リンク先のパス
-
サイト内のページを指定するいは、BaserCMSの設置場所を起点としてスラッシュから始まる絶対パスを指定する。指定しない場合はカレント。
- 初期値:null
- (array)$options
- 要素を連想配列で指定する。
escape
: タイトルをエスケープするかどうか(初期値 : false)prefix
: URLにプレフィックスをつけるかどうか(初期値 : false)forceTitle
: 許可されていないURLの際にタイトルを強制的に出力するかどうか(初期値 : false)ssl
: SSL用のURLをして出力するかどうか(初期値 : false)- ※ その他のパラメータについては、HtmlHelper::image() を参照。
- 例)array('class'=>'hoge')
-
呼び出し先のプレフィックスを指定するsubDirなどのオプションを設定することが出来ます。
- 初期値:array()
- (boolean) $confirmMessage
-
リンクをクリックした際に確認メッセージが表示され、はいをクリックした場合のみ遷移する。
- 初期値:false
戻り値
(string)
用例
基本
コード
<?php $this->BcBaser->getLink( $title , [$url] , [$options] , [$confirmMessage] ); ?>