a-blog cms PHP API Reference

GeoListHelper extends UserHelper
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
$get  : Field
$keyword  : string|null
$lat  : float|null
$lng  : float|null
$order  : string
$page  : int
$sortFields  : array<string|int, mixed>
$start  : string|null
$tags  : array<string|int, string>
$uid  : int|null

Methods

__construct()  : mixed
コンストラクタ
buildGeoListQuery()  : SQL_Select
sqlの組み立て
buildPagerTrait()  : array<string|int, mixed>
ページャーの組み立て
buildPagination()  : null|array<string|int, mixed>
ページネーションを組み立て
buildPaginationTrait()  : array<string|int, mixed>
ページネーションの組み立て
buildUserEntry()  : array<string|int, mixed>
ユーザーのエントリーを取得する
buildUserIndex()  : array<string|int, mixed>
ユーザーインデックスを組み立てる
buildUserIndexQuery()  : SQL_Select
ユーザー情報を取得するSQLを生成する
canAccessUser()  : bool
ユーザーへのアクセス権限を確認する
getCountQuery()  : SQL_Select
ユーザー数取得用のSQLを返す
getLat()  : float|null
基準点となる位置情報(違度)を取得
getLng()  : float|null
基準点となる位置情報(経度)を取得
getUserProfileData()  : array<string|int, mixed>
ユーザープロフィールデータを取得する
setProperty()  : void
プロパティの設定
setReferencePoint()  : void
基準点となる位置情報を取得
buildFieldTrait()  : array<string|int, mixed>|null
フィールドを連想配列として組み立て
eagerLoadEntryTrait()  : array<int, array<string, mixed>>
エントリーのEagerLoading
eagerLoadFieldTrait()  : Field>)
eagerLoadFullTextTrait()  : array<int<1, max>, UnitCollection>
フルテキストのEagerLoading
eagerLoadMainImageFieldTrait()  : array<int, array<string|int, mixed>>
指定したエントリーカスタムフィールドのメインイメージをEagerLoadする
eagerLoadMainImageTrait()  : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})
メインイメージのEagerLoading
eagerLoadRelatedEntryTrait()  : array<string|int, mixed>
関連記事のEagerLoading
eagerLoadSubCategoriesTrait()  : array<string|int, array<int, array<string, mixed>>>
サブカテゴリーのEagerLoading
eagerLoadTagTrait()  : array<string|int, mixed>
タグのEagerLoading
filterQuery()  : void
絞り込みクエリ組み立て
limitQuery()  : void
limitクエリ組み立て
orderQuery()  : void
orderクエリ組み立て
resolveTemplateUrlsTrait()  : array<string|int, mixed>
toStructured の出力に対し、path フィールドの URL 解決と html フィールドの 絶対化(テンプレート出力固有)を適用する。
setCountQuery()  : void
ユーザー数取得sqlの準備
resolveTemplateUrlsInGroupRowTrait()  : array<string|int, mixed>
グループ内の 1 行に含まれるマルチ項目(連想配列構造)に対して URL 解決を適用。
resolveTemplateUrlsInMultiEntryTrait()  : array<string|int, mixed>
マルチ項目フィールドエントリ('value'/'array' を持つ)に対して URL 解決を適用。

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>
Tags
inheritDoc

buildPagerTrait()

ページャーの組み立て

public buildPagerTrait(int $page[, bool $nextPage = true ]) : array<string|int, mixed>
Parameters
$page : int
$nextPage : bool = true
Return values
array<string|int, mixed>

buildPagination()

ページネーションを組み立て

public buildPagination(SQL_Select $countQuery) : null|array<string|int, mixed>
Parameters
$countQuery : SQL_Select
Return values
null|array<string|int, mixed>

buildPaginationTrait()

ページネーションの組み立て

public buildPaginationTrait(int $page, int $total, int $limit, int $maxPages[, array<string|int, mixed> $context = [] ]) : array<string|int, mixed>
Parameters
$page : int
$total : int
$limit : int
$maxPages : int
$context : array<string|int, mixed> = []
Return values
array<string|int, mixed>

buildUserEntry()

ユーザーのエントリーを取得する

public buildUserEntry(int $uid) : array<string|int, mixed>
Parameters
$uid : int
Return values
array<string|int, mixed>

buildUserIndex()

ユーザーインデックスを組み立てる

public buildUserIndex(array<string|int, mixed> $users) : array<string|int, mixed>
Parameters
$users : array<string|int, mixed>
Return values
array<string|int, mixed>

canAccessUser()

ユーザーへのアクセス権限を確認する

public canAccessUser(int $uid) : bool
Parameters
$uid : int
Return values
bool

getLat()

基準点となる位置情報(違度)を取得

public getLat() : float|null
Return values
float|null

getLng()

基準点となる位置情報(経度)を取得

public getLng() : float|null
Return values
float|null

getUserProfileData()

ユーザープロフィールデータを取得する

public getUserProfileData(array<string|int, mixed> $users) : array<string|int, mixed>
Parameters
$users : array<string|int, mixed>
Return values
array<string|int, mixed>

setProperty()

プロパティの設定

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

setReferencePoint()

基準点となる位置情報を取得

public setReferencePoint() : void

buildFieldTrait()

フィールドを連想配列として組み立て

protected buildFieldTrait(Field|Field_Validation $field[, string|null $scp = null ]) : array<string|int, mixed>|null
Parameters
$field : Field|Field_Validation
$scp : string|null = null

子フィールドとして再帰したときの名前(takeover キーの prefix に使う)

Return values
array<string|int, mixed>|null

フィールドが空の場合は null

eagerLoadEntryTrait()

エントリーのEagerLoading

protected eagerLoadEntryTrait(array<string|int, int> $ids) : array<int, array<string, mixed>>
Parameters
$ids : array<string|int, int>
Return values
array<int, array<string, mixed>>

eagerLoadFieldTrait()

protected eagerLoadFieldTrait(array<string|int, int>|array<string|int, string> $ids, "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id" $type[, int|null $rvid = null ]) : Field>)
Parameters
$ids : array<string|int, int>|array<string|int, string>
$type : "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id"
$rvid : int|null = null
Return values
Field>)

eagerLoadFullTextTrait()

フルテキストのEagerLoading

protected eagerLoadFullTextTrait(array<string|int, int> $entryIds) : array<int<1, max>, UnitCollection>
Parameters
$entryIds : array<string|int, int>
Return values
array<int<1, max>, UnitCollection>

eagerLoadMainImageFieldTrait()

指定したエントリーカスタムフィールドのメインイメージをEagerLoadする

protected eagerLoadMainImageFieldTrait(array<string|int, mixed> $entryIds, string $fieldName[, int|null $rvid = null ]) : array<int, array<string|int, mixed>>
Parameters
$entryIds : array<string|int, mixed>
$fieldName : string
$rvid : int|null = null
Return values
array<int, array<string|int, mixed>>

eagerLoadMainImageTrait()

メインイメージのEagerLoading

protected eagerLoadMainImageTrait(mixed $entries[, mixed $target = 'unit' ][, mixed $fieldName = '' ][, int|null $rvid = null ]) : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})
Parameters
$entries : mixed
$target : mixed = 'unit'

'unit'|'field'

$fieldName : mixed = ''

?string

$rvid : int|null = null
Return values
, media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})

eagerLoadRelatedEntryTrait()

関連記事のEagerLoading

protected eagerLoadRelatedEntryTrait(array<string|int, int> $eidArray) : array<string|int, mixed>
Parameters
$eidArray : array<string|int, int>
Return values
array<string|int, mixed>

eagerLoadSubCategoriesTrait()

サブカテゴリーのEagerLoading

protected eagerLoadSubCategoriesTrait(array<string|int, int> $eidArray[, null|int $rvid = null ]) : array<string|int, array<int, array<string, mixed>>>
Parameters
$eidArray : array<string|int, int>
$rvid : null|int = null
Return values
array<string|int, array<int, array<string, mixed>>>

eagerLoadTagTrait()

タグのEagerLoading

protected eagerLoadTagTrait(array<string|int, int> $eidArray[, int|null $rvid = null ]) : array<string|int, mixed>
Parameters
$eidArray : array<string|int, int>
$rvid : int|null = null
Return values
array<string|int, mixed>

resolveTemplateUrlsTrait()

toStructured の出力に対し、path フィールドの URL 解決と html フィールドの 絶対化(テンプレート出力固有)を適用する。

protected resolveTemplateUrlsTrait(array<string|int, mixed> $data, Field|Field_Validation $field) : array<string|int, mixed>
  • マルチ項目フィールド (['value' => {...}, 'array' => [...]]) の中の path / html
  • グループ内マルチ項目(連番キーの行配列の中の各 baseName)の path / html

単一値フィールドや、グループ内単一値フィールドには URL 解決を適用しない(旧挙動)。

Parameters
$data : array<string|int, mixed>
$field : Field|Field_Validation
Return values
array<string|int, mixed>

resolveTemplateUrlsInGroupRowTrait()

グループ内の 1 行に含まれるマルチ項目(連想配列構造)に対して URL 解決を適用。

private resolveTemplateUrlsInGroupRowTrait(array<string|int, mixed> $row, Field|Field_Validation $field) : array<string|int, mixed>

グループ内単一値は ['value' => x] の形なのでスキップ。 グループ内マルチ項目は ['alt' => x, 'path' => y, ...] の形。

Parameters
$row : array<string|int, mixed>
$field : Field|Field_Validation
Return values
array<string|int, mixed>

resolveTemplateUrlsInMultiEntryTrait()

マルチ項目フィールドエントリ('value'/'array' を持つ)に対して URL 解決を適用。

private resolveTemplateUrlsInMultiEntryTrait(array<string|int, mixed> $entry, string $baseName, Field|Field_Validation $field) : array<string|int, mixed>
Parameters
$entry : array<string|int, mixed>
$baseName : string
$field : Field|Field_Validation
Return values
array<string|int, mixed>

        
On this page

Search results