a-blog cms PHP API Reference

OgpHelper extends BaseHelper
in package

Table of Contents

Properties

$bids  : array<string|int, int>
$cids  : array<string|int, int>
$eids  : array<string|int, int>
$uids  : array<string|int, int>
$bid  : int
$blogAxis  : string
$categoryAxis  : string
$cid  : int|null
$config  : mixed
$countQuery  : SQL_Select
$eid  : int|null
$end  : string|null
$Field  : Field_Search|null
$glue  : string
連結文字列
$keyword  : string|null
$order  : string
$page  : int
$sortFields  : array<string|int, mixed>
$start  : string|null
$tags  : array<string|int, string>
$uid  : int|null

Methods

__construct()  : mixed
コンストラクタ
getDescription()  : bool|string
og:description を取得 優先度: EntryField -> EntrySummary -> CategoryField -> BlogField
getImage()  : false|array{type: "image"|"media", width: int, height: int, path: string}
og:image を取得 優先度: EntryField -> EntryMainImage -> CategoryField -> BlogField
getKeywords()  : bool|string
keywords を取得 優先度: EntryField -> CategoryField -> BlogField
getTitle()  : string
og:title を取得します
getType()  : string
タイプを取得
setGlue()  : void
連結文字列を設定
setProperty()  : void
プロパティの設定
get404Title()  : bool|string
getAdminTitle()  : bool|string
getBlogDescription()  : bool|string
getBlogImage()  : false|array{type: "image"|"media", width: int, height: int, path: string}
getBlogKeywords()  : bool|string
getBlogTitle()  : bool|string
getCategoryDescription()  : bool|string
getCategoryImage()  : false|array{type: "image"|"media", width: int, height: int, path: string}
getCategoryKeywords()  : bool|string
getCategoryTitle()  : bool|string
getDateTitle()  : bool|false|string
getEntryDescription()  : bool|string
getEntryImage()  : false|array{type: "image"|"media", width: int, height: int, path: string}
getEntryKeywords()  : bool|string
getEntryTitle()  : bool|string
getKeywordTitle()  : bool|null|string
getPageTitle()  : bool|string
getRootBlogTitle()  : bool|string
getSize()  : mixed
getTagTitle()  : bool|string

Properties

$categoryAxis

protected string $categoryAxis = 'self'

$glue

連結文字列

protected string $glue = ' | '

$sortFields

protected array<string|int, mixed> $sortFields = []

$tags

protected array<string|int, string> $tags = []

Methods

__construct()

コンストラクタ

public __construct(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

getDescription()

og:description を取得 優先度: EntryField -> EntrySummary -> CategoryField -> BlogField

public getDescription() : bool|string
Return values
bool|string

getImage()

og:image を取得 優先度: EntryField -> EntryMainImage -> CategoryField -> BlogField

public getImage() : false|array{type: "image"|"media", width: int, height: int, path: string}
Return values
false|array{type: "image"|"media", width: int, height: int, path: string}

getKeywords()

keywords を取得 優先度: EntryField -> CategoryField -> BlogField

public getKeywords() : bool|string
Return values
bool|string

getTitle()

og:title を取得します

public getTitle() : string
Return values
string

getType()

タイプを取得

public getType() : string
Return values
string

setGlue()

連結文字列を設定

public setGlue(string $glue) : void
Parameters
$glue : string

setProperty()

プロパティの設定

public setProperty(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

get404Title()

protected get404Title() : bool|string
Return values
bool|string

getAdminTitle()

protected getAdminTitle() : bool|string
Return values
bool|string

getBlogDescription()

protected getBlogDescription([int $bid = BID ]) : bool|string
Parameters
$bid : int = BID
Return values
bool|string

getBlogImage()

protected getBlogImage([int $bid = BID ]) : false|array{type: "image"|"media", width: int, height: int, path: string}
Parameters
$bid : int = BID
Return values
false|array{type: "image"|"media", width: int, height: int, path: string}

getBlogKeywords()

protected getBlogKeywords([int $bid = BID ]) : bool|string
Parameters
$bid : int = BID
Return values
bool|string

getBlogTitle()

protected getBlogTitle([int|null $bid = BID ]) : bool|string
Parameters
$bid : int|null = BID
Return values
bool|string

getCategoryDescription()

protected getCategoryDescription() : bool|string
Return values
bool|string

getCategoryImage()

protected getCategoryImage() : false|array{type: "image"|"media", width: int, height: int, path: string}
Return values
false|array{type: "image"|"media", width: int, height: int, path: string}

getCategoryKeywords()

protected getCategoryKeywords() : bool|string
Return values
bool|string

getCategoryTitle()

protected getCategoryTitle() : bool|string
Return values
bool|string

getDateTitle()

protected getDateTitle() : bool|false|string
Return values
bool|false|string

getEntryDescription()

protected getEntryDescription([bool $hide = false ]) : bool|string
Parameters
$hide : bool = false
Return values
bool|string

getEntryImage()

protected getEntryImage() : false|array{type: "image"|"media", width: int, height: int, path: string}
Return values
false|array{type: "image"|"media", width: int, height: int, path: string}

getEntryKeywords()

protected getEntryKeywords() : bool|string
Return values
bool|string

getEntryTitle()

protected getEntryTitle() : bool|string
Return values
bool|string

getKeywordTitle()

protected getKeywordTitle() : bool|null|string
Return values
bool|null|string

getPageTitle()

protected getPageTitle() : bool|string
Return values
bool|string

getRootBlogTitle()

protected getRootBlogTitle() : bool|string
Return values
bool|string

getSize()

protected getSize(mixed $str[, mixed $type = 'width' ]) : mixed
Parameters
$str : mixed
$type : mixed = 'width'

getTagTitle()

protected getTagTitle() : bool|string
Return values
bool|string

        
On this page

Search results