テーマで利用する関数は、BcBaserHelper というヘルパを利用します。
ヘルパの利用方法は次のとおりです。
// 画像の出力
$this->BcBaser->img('/img/baser.power.gif', ['width' => 200]);
ここでは、BcBaserHelperのリファレンスをご紹介しますが、
その他にも、様々なヘルパや、クラスメソッドがあります。
詳しく知るには、baserCMS クラスリファレンス をご覧ください。
BcBaserHelper::img(string $path, array $options = []): void
imgタグを出力します。
$this->BcBaser->img('/img/baser.power.gif', ['width' => 200]);
BcBaserHelper::getImg(string $path, array $options = []): string
imgタグを取得します。
$img = $this->BcBaser->getImg('/img/baser.power.gif', ['width' => 200]);
BcBaserHelper::css(string|array $path, bool $inline = true, array $options = []): void
CSSの読み込みタグを出力します。
$inlineがtrueの場合は呼び出した箇所、falseの場合はヘッダー内の $this->BcBaser->scripts() が記載された箇所にタグを表示します。
そのため、 $inlineがfalseの場合は $this->BcBaser->scripts() が実行される前に BcBaserHelper::cssを実行する必要があります。
$this->BcBaser->css([
'style',
'jquery-ui/jquery-ui-1.11.4',
'colorbox/colorbox-1.6.1',
'editor'
])
BcBaserHelper::js(string|array $path, bool $inline = true, array $options = []): void
scriptタグを出力します。
$inlineがtrueの場合は呼び出した箇所、falseの場合はヘッダー内の $this->BcBaser->scripts() が記載された箇所にタグを表示します。
そのため、 $inlineがfalseの場合は $this->BcBaser->scripts() が実行される前に BcBaserHelper::jsを実行する必要があります。
$this->BcBaser->js([
'admin/users/index.bundle',
'https://code.jquery.com/jquery-3.6.0.min.js',
], true, [
'defer',
]);
BcBaserHelper::scripts(): void
$this->BcBaser->cssや$this->BcBaser->jsでインライン出力を無効にした場合、$this->BcBaser->scripts()を記載した箇所にまとめて出力されます。
また、ツールバー用のCSSの呼び出しも行います。
エレメントとは表示用のHTML等を細分化したパーツの事で、共通する部分などを切り分けておくことで保守性を高めます。
BcBaserHelper::element(string $name, array $data = [], array $options = []): void
$nameに呼び出したいエレメント名、$dataにエレメントに渡したいデータを記載します。
以下の例では、elementフォルダ内のmenu.phpを呼び出しています。
// 呼び出し元
$this->BcBaser->element('menu', ['menus' => ['a', 'b', 'c']]);
// 呼び出し先
<ul>
<?php foreach ($menus as $menu): ?>
<li>
<?php echo h($menu) ?>
</li>
<?php endforeach ?>
</ul>
/*
<ul>
<li>a</li>
<li>b</li>
<li>c</li>
</ul>
*/
BcBaserHelper::getElement(string $name, array $data = [], array $options = []): string
$this->BcBaser->elementではエレメントの取得・出力を行いますが、$this->BcBaser->getElementではエレメントの取得までを行います。
$head = $this->BcBaser->element('head');
BcBaserHelper::header(array $data = [], array $options = []): void
headerエレメントを出力します。
BcBaserHelper::footer(array $data = [], array $options = []): void
footerエレメントを出力します。
BcBaserHelper::globalMenu(int $level = 1, array $options = []): void
グローバルメニューを出力します。
$levelには最上位の階層から何階層までのコンテンツを出力するか指定します。
出力されるタグを調整したい場合は、 element/global_menu.php を変更します。
BcBaserHelper::getGlobalMenu(int $level = 1, array $options = []): string
グローバルメニューを取得します。
BcBaserHelper::link(string $title, mixed $url = null, array $htmlAttributes = [], mixed $confirmMessage = false): void
アンカータグを出力します。
$confirmMessageが設定されている場合は、リンクをクリックした際に確認メッセージが表示され、はいをクリックした場合のみリンクが開きます。
$this->BcBaser->link('top', '/', ['target' => '_blank'], 'ページを開きますか?');
// <a href="/" target="_blank" data-confirm-message="ページを開きますか?" onclick="if (confirm(this.dataset.confirmMessage)) { return true; } return false;">top</a>
BcBaserHelper::getLink(string $title, mixed $url = null, array $options = [], mixed $confirmMessage = false): string
アンカータグを取得します。
BcBaserHelper::url(string $url = null, bool $full = false, bool $sessionId = true): void
baserCMSの設置フォルダを考慮したURLを出力します。
$fullがtrueの場合は絶対URLになります。
$this->BcBaser->url('/test', true);
// baserが https://example.com/baser/ に設置されている場合、 「https://example.com/baser/test」を出力
BcBaserHelper::getUrl(string $url = null, bool $full = false, bool $sessionId = true): string
baserCMSの設置フォルダを考慮したURLを取得します。
BcBaserHelper::siteUrl(bool $ssl = false): void
システム基本設定のWebサイトURLを出力します。
BcBaserHelper::getSiteUrl(bool $ssl = false): string
システム基本設定のWebサイトURLを取得します。
BcBaserHelper::baseUrl(): void
baserCMSが設置されているパスを出力します。
// basercmsというフォルダに設置している場合
<img src="<?php echo $this->BcBaser->baseUrl() ?>img/test.png" />
// <img src="/basercms/img/test.png" />
BcBaserHelper::baseUrl(): string
baserCMSが設置されているパスを取得します。
BcBaserHelper::themeUrl(): string
現在のテーマのURLを出力します。
BcBaserHelper::getThemeUrl(): string
現在のテーマのURLを取得します。
BcBaserHelper::getParams(): void
パラメータ情報を取得します。
print_r($this->BcBaser->getParams());
/*
Array
(
[plugin] => BaserCore
[controller] => Pages
[action] => view
[pass] => Array
(
[0] => index
)
[named] => Array
(
)
[entityId] => 1
[_matchedRoute] => /*
[Content] =>
[Site] =>
[?] => Array
(
[query] => sample
)
[_ext] =>
)
*/
BcBaserHelper::getUrlParams(): void
URL情報を取得します。
print_r($this->BcBaser->getUrlParams());
/*
Array
(
[url] => https://localhost/baser5/?query=sample
[here] => /baser5/
[path] => /
[webroot] => /baser5/
[base] => /baser5
[query] => Array
(
[query] => sample
)
)
*/
BcBaserHelper::isHome(): bool
現在のページがトップページかどうかを判定します。
if ($this->BcBaser->isHome()) {
// トップページ用の処理
}
BcBaserHelper::isPage(): bool
現在のページが固定ページかどうかを判定します。
BcBaserHelper::isSSL(): bool
サイトへのアクセス時にSSLが使用されているか判定します。
BcBaserHelper::isAdminUser(array| User $user = null): bool
指定したユーザーが管理者グループに属しているか判定を行います。
$userを指定しない場合はログイン中のユーザーを対象にします。
BcBaserHelper::isDebug(): bool
デバッグモードか判定します。
BcBaserHelper::isPluginLoaded(string $plugin): bool
指定したプラグインがロードされているか判定します。
if ($this->BcBaser->isPluginLoaded('BcBlog')) {
echo 'ブログプラグインが有効';
}
BcBaserHelper::isContentFolder(): bool
現在のページがコンテンツフォルダかどうか判定します。
BcBaserHelper::setTitle(string $title, mixed $categoryTitleOn = null): void
ページのタイトルを設定します。
$categoryTitleOn がfalseの場合はタイトルに階層情報を含みません。
$this->BcBaser->setTitle('ページタイトル', true);
// <title>ページタイトル｜プレスリリース｜NEWS｜My Site</title>
$this->BcBaser->setTitle('ページタイトル', false);
// <title>ページタイトル｜My Site</title>
BcBaserHelper::title(string $separator = '｜', bool $categoryTitleOn = null): void
タイトルタグを出力します。
$this->BcBaser->title(' - ')
// <title>ブログ機能について説明します - プレスリリース - NEWS - My Site</title>
BcBaserHelper::getTitle(string $separator = '｜', array $options = []): string
タイトルタグを取得します。
BcBaserHelper::setKeywords(string $keywords): void
metaタグ用のキーワードを設定します。
$this->BcBaser->setKeywords('キーワードA,キーワードB');
BcBaserHelper::metaKeywords(): void
metaタグ用のキーワードタグを出力します。
BcBaserHelper::getKeywords(): string
metaタグ用のキーワードを取得します。
BcBaserHelper::setDescription(string $description): void
metaタグ用の説明文を設定します。
BcBaserHelper::metaDescription(): void
metaタグ用の説明文を出力します。
BcBaserHelper::getDescription(): string
metaタグ用の説明文を取得します。
BcBaserHelper::crumbsList(array $data = [], array $options = []): void
パンくずリストを出力します。
パンくずリストとは現在表示しているページがトップページからどの階層にあるのかを示すものです。
この関数を利用するとトップページから表示ページまでの階層までを表示し、各階層の名称にはリンクが設置されます。
出力されるタグを調整したい場合は、 element/crumbs.php を変更します。
BcBaserHelper::crumbs(string $separator, string|bool $startText, bool $onSchema): void
パンくずリストを出力します。
主にcrumbs.php内で使用されています。
事前に出力したい内容をBcBaserHelper::addCrumbで追加しておく必要があります。
BcBaserHelper::addCrumb(string $name, mixed $link = null, mixed $options = []): void
パンくずリストの要素を追加します。
BcBaserHelper::getCrumbs(mixed $categoryTitleOn = null): array
パンくずリストを配列形式で取得します。
BcBaserHelper::content(): void
コンテンツを出力します。
固定ページの場合はtemplates/Pages/default.php、ブログの場合はtemplates/plugin/BcBlog/Blog/default/single.phpなど、それぞれのコンテンツに合わせた内容が出力されます。
どのファイルが読み込まれるかは、テーマの構造をご覧ください。
BcBaserHelper::contentsTitle(): void
コンテンツのタイトルを出力します。
BcBaserHelper::getContentsTitle(): string
コンテンツのタイトルを取得します。
BcBaserHelper::contentsName(bool $detail = false, array $options = []): void
URLを元に、第一階層までの文字列をキャメルケースで出力します。
$detailがtrueの場合はページごとに一意となる文字列を出力します。
$options
home : トップページの場合に出力する文字列（初期値 : Home）default : ルート直下の下層ページの場合に出力する文字列（初期値 : Default）error : エラーページの場合に出力する文字列（初期値 : Error）underscore : キャメルケースではなく、アンダースコア区切りで出力する（初期値 : false）// URL: /
BcBaserHelper::contentsName();
// Home
BcBaserHelper::contentsName(true, ['home' => 'Top']);
// Top
// URL: /test/sample/
BcBaserHelper::contentsName();
// Test
BcBaserHelper::contentsName(true, ['underscore' => true]);
// test_sample_index
BcBaserHelper::getContentsName(bool $detail = false, array $options = []): string
URLを元に、第一階層までの文字列をキャメルケースで取得します。
BcBaserHelper::contentsMenu(mixed $id = null, int $level = null, string $currentId = null, array $options = [])
コンテンツメニューを出力します。
出力されるタグを調整したい場合は、 element/contents_menu.php を変更します。
$id: コンテンツIDを指定しない場合はルートからのメニューを表示
ID指定できるのはフォルダのみ
コンテンツIDは、編集画面 > その他情報 > コンテンツID から確認可能
$level: 何階層まで表示するか指定
$currentId: 現在のページのコンテンツIDを指定 currentクラスの表示に使用
BcBaserHelper::getContentsMenu(mixed $id = null, int $level = null, string $currentId = null, array $options = []): string
コンテンツメニューを取得します。
BcBaserHelper::getCurrentContent(): mixed|null
現在のコンテンツ情報を取得します。
BcBaserHelper::getContentCreatedDate(string $format = 'Y/m/d H:i'): null|string
コンテンツが作成された日時を取得します。
コンテンツ作成日時は、 編集画面 > オプション > 作成者 > [作成日]から設定します。
$formatはPHPのDateTimeInterface::format()が受け入れるフォーマットを指定します。
BcBaserHelper::getContentModifiedDate(string $format = 'Y/m/d H:i'): null|string
コンテンツが更新された日時を取得します。
コンテンツ更新日時は、 編集画面 > オプション > 作成者 > [更新日]から設定します。
BcBaserHelper::updateInfo(): void
コンテンツの作成日時と更新日時が記載されたエレメントを出力します。
表示を調整したい場合は element/update_info.php を変更します。
BcBaserHelper::getUpdateInfo(): string
コンテンツの作成日時と更新日時が記載されたエレメントを取得します。
BcBaserHelper::pagination(string $name = 'default', array $data = [], array $options = []): void
ページネーションを出力します。
$nameで指定したエレメントを出力します。
出力されるタグを調整したい場合は、 element/paginations 配下を変更します。
細かくカスタマイズしたい場合はCakePHPのドキュメントもご覧ください。
BcBaserHelper::siteName(): void
サイト名を出力します。
BcBaserHelper::getSiteName(): string
サイト名を取得します。
BcBaserHelper::getUserName(User $user): string
指定したユーザーの姓と名を結合して取得します。
ニックネームがある場合にはニックネームを優先します。
BcBaserHelper::flash(string $key = 'flash'): void
セッションに保存したメッセージを出力します。
例: フォームのエラーメッセージ等
BcBaserHelper::set(string $key, mixed $value): void
変数を設定します。設定した変数は後で読み込まれるビューファイルで使用できます。
BcBaserHelper::func(): void
ツールバーの出力を行います。
BcBaserHelper::getCurrentSite(): Site
現在表示しているページのサイトエンティティを取得します。
BcBaserHelper::getCurrentContent(): Content
現在表示しているページのコンテンツエンティティを取得します。