ブログヘルパー

Add your application-wide methods in the class below, your helpers will inherit them.
package Blog.View.Helper

 Methods

コンストラクタ

__construct(\View $View, array $settings = array()) : void

Parameters

$View

\View

Viewオブジェクト

$settings

array

設定

Constructor.

__construct(\View $View, $settings = array()) : void
access public

Parameters

$View

$settings

afterLayout

afterLayout(\type $layoutFile) 

Parameters

$layoutFile

\type

公開状態を取得する

allowPublish(array $data) : boolean

Parameters

$data

array

ブログ記事

Returns

boolean公開状態

記事の投稿者を出力する

author(array $post) : void

Parameters

$post

array

ブログ記事

ブログアカウント名を出力する

blogName() : void

記事が属するカテゴリ名を出力する

category(array $post, array $options = array()) : void

Parameters

$post

array

記事データ

$options

array

オプション(初期値 : array())

  • link : リンクをつけるかどうか(初期値 : true) ※ その他のオプションは、linkオプションがtrueの場合に 生成されるa要素の属性設定となる。(HtmlHelper::link() を参照)

ブログIDを出力する

currentBlogId() : void

ブログの説明文を出力する

description() : void

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

descriptionExists() : boolean

Returns

boolean

イベントを発火

dispatchEvent(string $name, array $params = array(), $options = array()) : mixed

Parameters

$name

string

$params

array

$options

Returns

mixed

ブログ編集ページへのリンクを出力

editPost(int $blogContentId, int $blogPostId) : void
deprecated ツールバーに移行

Parameters

$blogContentId

int

ブログコンテンツID

$blogPostId

int

ブログ記事ID

アイキャッチ画像を出力する

eyeCatch(array $post, array $options = array()) : void

Parameters

$post

array

ブログ記事

$options

array

オプション(初期値 : array())

  • imgsize : 画像サイズ[thumb|small|medium|large](初期値 : thumb)
    • link : 大きいサイズの画像へのリンク有無(初期値 : true)
    • escape : タイトルについてエスケープする場合に true を指定(初期値 : false)
  • mobile : モバイルの画像を表示する場合に true を指定(初期値 : false)
  • alt : alt属性(初期値 : '')
  • width : 横幅(初期値 : '')
  • height : 高さ(初期値 : '')
  • noimage : 画像が存在しない場合に表示する画像(初期値 : '')
  • tmp : 一時保存データの場合に true を指定(初期値 : false)
  • class : タグの class を指定(初期値 : img-eye-catch)
  • force : 画像が存在しない場合でも強制的に出力する場合に true を指定する(初期値 : false) ※ その他のオプションについては、リンクをつける場合、HtmlHelper::link() を参照、つけない場合、Html::image() を参照

ブログのアーカイブタイプを取得する

getBlogArchiveType() : string

Returns

stringブログのアーカイブタイプ

ブログアカウント名を取得する

getBlogName() : string

Returns

string

ブログテンプレートを取得

getBlogTemplates() : array
コンボボックスのソースとして利用
todo 別のヘルパに移動

Returns

arrayブログテンプレート一覧

記事が属するカテゴリ名を取得する

getCategory(array $post, array $options = array()) : string

Parameters

$post

array

記事データ

$options

array

オプション(初期値 : array())

  • link : リンクをつけるかどうか(初期値 : true) ※ その他のオプションは、linkオプションがtrueの場合に 生成されるa要素の属性設定となる。(HtmlHelper::link() を参照)

Returns

stringカテゴリ名

カテゴリーの一覧をリストタグで取得する

getCategoryList(array $categories, int $depth = 3, boolean $count = false, array $options = array()) : string

Parameters

$categories

array

カテゴリ一覧データ

$depth

int

階層(初期値 : 3)

$count

boolean

件数を表示するかどうか(初期値 : false)

$options

array

オプション(初期値 : array())

  • link : リンクをつけるかどうか(初期値 : true) ※ その他のオプションは、linkオプションがtrueの場合に 生成されるa要素の属性設定となる。(HtmlHelper::link() を参照)

Returns

stringHTMLのカテゴリ一覧

カテゴリ一覧へのURLを取得する

getCategoryUrl($blogCategoryId, array $options = array()) : string
[注意] リンク関数でラップする前提の為、ベースURLは考慮されない

Parameters

$blogCategoryId

$options

array

オプション(初期値 : array()) named : URLの名前付きパラメーター

Returns

stringカテゴリ一覧へのURL

ブログIDを取得する

getCurrentBlogId() : integer

Returns

integer

ブログの説明文を取得する

getDescription() : string

Returns

string

アイキャッチ画像を取得する

getEyeCatch(array $post, array $options = array()) : string

Parameters

$post

array

ブログ記事

$options

array

オプション(初期値 : array())

  • imgsize : 画像サイズ[thumb|small|medium|large](初期値 : thumb)
    • link : 大きいサイズの画像へのリンク有無(初期値 : true)
    • escape : タイトルについてエスケープする場合に true を指定(初期値 : false)
  • mobile : モバイルの画像を表示する場合に true を指定(初期値 : false)
  • alt : alt属性(初期値 : '')
  • width : 横幅(初期値 : '')
  • height : 高さ(初期値 : '')
  • noimage : 画像が存在しない場合に表示する画像(初期値 : '')
  • tmp : 一時保存データの場合に true を指定(初期値 : false)
  • class : タグの class を指定(初期値 : img-eye-catch)
  • force : 画像が存在しない場合でも強制的に出力する場合に true を指定する(初期値 : false)
  • output : 出力形式 tag, url のを指定できる(初期値 : '') ※ その他のオプションについては、リンクをつける場合、HtmlHelper::link() を参照、つけない場合、Html::image() を参照

Returns

stringアイキャッチ画像のHTML

記事中のタグで指定したIDの内容を取得する

getHtmlById(array $post, string $id) : string

Parameters

$post

array

ブログ記事

$id

string

取得したいデータが属しているタグのID属性

Returns

string指定したIDの内容

レイアウトテンプレートを取得

getLayoutTemplates() : array
コンボボックスのソースとして利用
todo 別のヘルパに移動

Returns

arrayレイアウトテンプレート一覧

親カテゴリを取得する

getParentCategory(array $post) : array

Parameters

$post

array

ブログ記事

Returns

array$parentCategory 親カテゴリ

記事の本文を取得する

getPostContent(array $post, boolean $moreText = true, \mixied $moreLink = false, mixed $cut = false) : string

Parameters

$post

array

ブログ記事データ

$moreText

boolean

詳細データを表示するかどうか(初期値 : true)

$moreLink

\mixied

詳細ページへのリンクを表示するかどうか。true に指定した場合、 「≫ 続きを読む」という文字列がリンクとして表示される。(初期値 : false) また、文字列を指定するとその文字列がリンクとなる

$cut

mixed

文字をカットするかどうかを真偽値で指定。カットする場合、文字数を数値で入力(初期値 : false)

Returns

string記事本文

登録日

getPostDate(array $post, string $format = 'Y/m/d') : string

Parameters

$post

array

ブログ記事

$format

string

日付フォーマット(初期値 : Y/m/d)

Returns

string登録日

記事の詳細を取得する

getPostDetail(array $post, array $options = array()) : string

Parameters

$post

array

ブログ記事データ

$options

array

オプション(初期値 : array())

  • cut : 文字をカットするかどうかを真偽値で指定。カットする場合、文字数を数値で入力(初期値 : false)

Returns

string記事本文

記事中の画像を取得する

getPostImg(array $post, array $options = array()) : void

Parameters

$post

array

ブログ記事

$options

array

オプション(初期値 : array())

  • num : 何枚目の画像か順番を指定(初期値 : 1)
  • link : 詳細ページへのリンクをつけるかどうか(初期値 : true)
  • alt : ALT属性(初期値 : ブログ記事のタイトル)

ブログ記事のURLを取得する

getPostLinkUrl(array $post) : string

Parameters

$post

array

ブログ記事データ

Returns

stringブログ記事のURL

記事タイトルを取得する

getPostTitle(array $post, boolean $link = true) : string

Parameters

$post

array

ブログ記事データ

$link

boolean

詳細ページへのリンクをつける場合には、true を指定する(初期値 : true)

Returns

string記事タイトル

同じタグの関連投稿を取得する

getRelatedPosts(array $post, array $options = array()) : array

Parameters

$post

array

ブログ記事

$options

array

オプション(初期値 : array())

  • recursive : 関連データを取得する場合の階層(初期値 : -1)
  • limit : 件数(初期値 : 5)
  • order : 並び順指定(初期値 : BlogPost.posts_date DESC)

Returns

array

タグを取得する

getTag(array $post, string $separator = ' , ') : void
複数所属する場合は複数取得する

Parameters

$post

array

記事データ

$separator

string

区切り文字(初期値 : , )

タイトルを取得する

getTitle() : string

Returns

string

アーカイブページ判定

isArchive() : boolean

Returns

boolean現在のページがアーカイブページの場合は true を返す

カテゴリー別記事一覧ページ判定

isCategory() : boolean

Returns

boolean現在のページがカテゴリー別記事一覧ページの場合は true を返す

日別記事一覧ページ判定

isDate() : boolean

Returns

boolean現在のページが日別記事一覧ページの場合は true を返す

インデックスページ判定

isHome() : boolean

Returns

boolean現在のページがインデックスページの場合は true を返す

月別記事一覧ページ判定

isMonth() : boolean

Returns

boolean現在のページが月別記事一覧ページの場合は true を返す

個別ページ判定

isSingle() : boolean

Returns

boolean現在のページが個別ページの場合は true を返す

タグ別記事一覧ページ判定

isTag() : boolean

Returns

boolean現在のページがタグ別記事一覧ページの場合は true を返す

年別記事一覧ページ判定

isYear() : boolean

Returns

boolean現在のページが年別記事一覧ページの場合は true を返す

記事の本文を表示する

postContent(array $post, boolean $moreText = true, \mixied $moreLink = false, mixed $cut = false) : void

Parameters

$post

array

ブログ記事データ

$moreText

boolean

詳細データを表示するかどうか(初期値 : true)

$moreLink

\mixied

詳細ページへのリンクを表示するかどうか。true に指定した場合、 「≫ 続きを読む」という文字列がリンクとして表示される。(初期値 : false) また、文字列を指定するとその文字列がリンクとなる

$cut

mixed

文字をカットするかどうかを真偽値で指定。カットする場合、文字数を数値で入力(初期値 : false)

記事の詳細を表示する

postDetail(array $post, array $options = array()) : void

Parameters

$post

array

ブログ記事データ

$options

array

オプション(初期値 : array())getPostDetailを参照

記事中の画像を出力する

postImg(array $post, array $options = array()) : void

Parameters

$post

array

ブログ記事

$options

array

オプション(初期値 : array())

  • num : 何枚目の画像か順番を指定(初期値 : 1)
  • link : 詳細ページへのリンクをつけるかどうか(初期値 : true)
  • alt : ALT属性(初期値 : ブログ記事のタイトル)

記事のタイトルを出力する

postTitle(array $post, boolean $link = true) : void

Parameters

$post

array

ブログ記事データ

$link

boolean

詳細ページへのリンクをつける場合には、true を指定する(初期値 : true)

文字列から制御文字を取り除く

removeCtrlChars($string) 

Parameters

$string

ブログコンテンツデータをセットする

setContent(int $blogContentId = null) : void
アイキャッチを利用する場合に必ず設定が必要

Parameters

$blogContentId

int

ブログコンテンツID

タグを出力する

tag(array $post, string $separator = ' , ') : void
複数所属する場合は複数出力する

Parameters

$post

array

記事データ

$separator

string

区切り文字(初期値 : , )

ブログタイトルを出力する

title() : void

Finds URL for specified action.

url(mixed $url = null, boolean $full = false, $sessionId = true) : string
Returns an URL pointing to a combination of controller and action. Param $url can be: + Empty - the method will find adress to actuall controller/action. + '/' - the method will find base URL of application. + A combination of controller/action - the method will find url for it.

Parameters

$url

mixed

Cake-relative URL, like "/products/edit/92" or "/presidents/elect/4"

                   or an array specifying any of the following: 'controller', 'action',
                   and/or 'plugin', in addition to named arguments (keyed array elements),
                   and standard URL arguments (indexed array elements)

$full

boolean

If true, the full base URL will be prepended to the result

$sessionId

Returns

stringFull translated URL with base path.

Checks if a file exists when theme is used, if no file is found default location is returned

webroot(string $file) : string
PENDING Core Hack

Parameters

$file

string

Returns

string$webPath web path to file.

カテゴリーリストを取得する

_getCategoryList(array $categories, int $depth = 3, int $current = 1, boolean $count = false, array $options = array()) : string

Parameters

$categories

array

カテゴリ一覧データ

$depth

int

階層(初期値 : 3)

$current

int

現在の階層(初期値 : 1)

$count

boolean

件数を表示するかどうか(初期値 : false)

$options

array

オプション(初期値 : array())

  • link : リンクをつけるかどうか(初期値 : true) ※ その他のオプションは、linkオプションがtrueの場合に 生成されるa要素の属性設定となる。(HtmlHelper::link() を参照)

Returns

stringHTMLのカテゴリ一覧

 Properties

 

BcBaserヘルパ

$BcBaser : \BcBaserHelper

Default

magic
property BcBaserヘルパ
 

BcTimeヘルパ

$BcTime : \BcTimeHelper

Default

magic
property BcTimeヘルパ
 

BcUploadヘルパ

$BcUpload : \BcUploadHelper

Default

magic
property BcUploadヘルパ
 

ブログカテゴリモデル

$BlogCategory : \BlogCategory

Default

null
 

ヘルパー

$helpers : array

Default

array('Html', 'BcTime', 'BcBaser', 'BcUpload')