a-blog cms PHP API Reference

SitemapHelper 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
$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
コンストラクタ
getSitemap()  : array<string|int, array{loc: string, lastmod: string|null}>
サイトマップのアイテムを取得する
setProperty()  : void
プロパティの設定
formatLastModified()  : string
指定した日時をサイトマップのlastmod形式に変換する
getExceptBlogIds()  : array<string|int, int>
除外するブログIDを取得する
getLastModifiedEntry()  : string|null
指定したブログの最終更新日時(エントリー更新日)を取得する
getSitemapBlogs()  : array<string|int, mixed>
サイトマップに出力するブログを取得する
getSitemapCategories()  : array<string|int, mixed>
サイトマップに出力するカテゴリーを取得する
getSitemapEntries()  : array<string|int, mixed>
サイトマップに出力するカテゴリーを取得する

Properties

$categoryAxis

protected string $categoryAxis = 'self'

$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>

getSitemap()

サイトマップのアイテムを取得する

public getSitemap(bool $blogIndexing, string $blogOrder, Field_Search $blogFieldSearch, bool $categoryIndexing, string $categoryOrder, Field_Search $categoryFieldSearch, bool $entryIndexing, string $entryOrder, int $entryLimit, Field_Search $entryFieldSearch) : array<string|int, array{loc: string, lastmod: string|null}>
Parameters
$blogIndexing : bool
$blogOrder : string
$blogFieldSearch : Field_Search
$categoryIndexing : bool
$categoryOrder : string
$categoryFieldSearch : Field_Search
$entryIndexing : bool
$entryOrder : string
$entryLimit : int
$entryFieldSearch : Field_Search
Return values
array<string|int, array{loc: string, lastmod: string|null}>

setProperty()

プロパティの設定

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

formatLastModified()

指定した日時をサイトマップのlastmod形式に変換する

protected formatLastModified(string $datetime) : string
Parameters
$datetime : string
Return values
string

getExceptBlogIds()

除外するブログIDを取得する

protected getExceptBlogIds(int $targetBid) : array<string|int, int>
Parameters
$targetBid : int
Return values
array<string|int, int>

getLastModifiedEntry()

指定したブログの最終更新日時(エントリー更新日)を取得する

protected getLastModifiedEntry(int|null $bid, int|null $cid, bool $indexing) : string|null
Parameters
$bid : int|null
$cid : int|null
$indexing : bool
Return values
string|null

getSitemapBlogs()

サイトマップに出力するブログを取得する

protected getSitemapBlogs(array<string|int, int> $exceptBlog, bool $indexing, string $order, Field_Search $fieldSearch) : array<string|int, mixed>
Parameters
$exceptBlog : array<string|int, int>
$indexing : bool
$order : string
$fieldSearch : Field_Search
Return values
array<string|int, mixed>

getSitemapCategories()

サイトマップに出力するカテゴリーを取得する

protected getSitemapCategories(int $bid, bool $indexing, string $order, Field_Search $fieldSearch) : array<string|int, mixed>
Parameters
$bid : int
$indexing : bool
$order : string
$fieldSearch : Field_Search
Return values
array<string|int, mixed>

getSitemapEntries()

サイトマップに出力するカテゴリーを取得する

protected getSitemapEntries(int $bid, array<string|int, mixed> $cidAry, bool $indexing, string $order, int $limit, Field_Search $fieldSearch) : array<string|int, mixed>
Parameters
$bid : int
$cidAry : array<string|int, mixed>
$indexing : bool
$order : string
$limit : int
$fieldSearch : Field_Search
Return values
array<string|int, mixed>

        
On this page

Search results