a-blog cms PHP API Reference

UserHelper extends BaseHelper
in package

Application

uses FieldTrait, EagerLoadingTrait, PaginationTrait

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: コンストラクタ
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を返す
getUserProfileData() : array<string|int, mixed>: ユーザープロフィールデータを取得する
setProperty() : void: プロパティの設定
autoConvertTypeTrait() : array<string|int, mixed>: 自動で型変換
buildBasicFieldGroupTrait() : array<string|int, mixed>: 基本カスタムフィールドグループを組み立て
buildBasicFieldTrait() : array<string|int, mixed>: 基本カスタムフィールドを組み立て
buildFieldTrait() : array<string|int, mixed>|null: フィールドを連想配列として組み立て
buildMultiFieldGroupTrait() : array<string|int, mixed>: 複数項目をもつカスタムフィールドグループを組み立て
buildMultiFieldTrait() : array<string|int, mixed>: 複数項目をもつカスタムフィールドを組み立て
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
extractGroupFieldKeysTrait() : array<string|int, mixed>: グループフィールドのキーを抜き出す
extractNonGroupFieldKeysTrait() : array<string|int, mixed>: グループフィールドのキーを除いてキーを取得
filterQuery() : void: 絞り込みクエリ組み立て
formatFieldKeysTrait() : array<string|int, mixed>: フィールドキー配列を整形
limitQuery() : void: limitクエリ組み立て
orderQuery() : void: orderクエリ組み立て
setCountQuery() : void: ユーザー数取得sqlの準備

$bids


        public
            array<string|int, int>
    $bids
     = []

$cids


        public
            array<string|int, int>
    $cids
     = []

$eids


        public
            array<string|int, int>
    $eids
     = []

$uids


        public
            array<string|int, int>
    $uids
     = []

$bid


        protected
            int
    $bid
     = null

$blogAxis


        protected
            string
    $blogAxis
     = 'self'

$categoryAxis


        protected
            string
    $categoryAxis
     = 'self'

$cid


        protected
            int|null
    $cid
     = null

$config


        protected
            mixed
    $config

$countQuery


        protected
            SQL_Select
    $countQuery

$eid


        protected
            int|null
    $eid
     = null

$end


        protected
            string|null
    $end
     = null

$Field


        protected
            Field_Search|null
    $Field
     = null

$keyword


        protected
            string|null
    $keyword
     = null

$order


        protected
            string
    $order
     = 'desc'

$page


        protected
            int
    $page
     = 1

$sortFields


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

$start


        protected
            string|null
    $start
     = null

$tags


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

$uid


        protected
            int|null
    $uid
     = null

__construct()

コンストラクタ


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

Parameters

$params : array<string|int, mixed>

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>

buildUserIndexQuery()

ユーザー情報を取得するSQLを生成する


    public
                    buildUserIndexQuery() : SQL_Select

Return values

SQL_Select

canAccessUser()

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


    public
                    canAccessUser(int $uid) : bool

Parameters

$uid : int

Return values

bool

getCountQuery()

ユーザー数取得用のSQLを返す


    public
                    getCountQuery() : SQL_Select

Return values

SQL_Select

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

autoConvertTypeTrait()

自動で型変換


    protected
                    autoConvertTypeTrait(array<string|int, mixed> $values) : array<string|int, mixed>

Parameters

$values : array<string|int, mixed>

Return values

array<string|int, mixed>

buildBasicFieldGroupTrait()

基本カスタムフィールドグループを組み立て


    protected
                    buildBasicFieldGroupTrait(array<string|int, mixed> $keys, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

$keys : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>

Return values

array<string|int, mixed>

buildBasicFieldTrait()

基本カスタムフィールドを組み立て


    protected
                    buildBasicFieldTrait(array<string|int, mixed> $keys, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

$keys : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>

Return values

array<string|int, mixed>

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

Return values

array<string|int, mixed>|null

buildMultiFieldGroupTrait()

複数項目をもつカスタムフィールドグループを組み立て


    protected
                    buildMultiFieldGroupTrait(array<string|int, mixed> $items, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

$items : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>

Return values

array<string|int, mixed>

buildMultiFieldTrait()

複数項目をもつカスタムフィールドを組み立て


    protected
                    buildMultiFieldTrait(array<string|int, mixed> $items, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

$items : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>

Return values

array<string|int, mixed>

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()

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>

extractGroupFieldKeysTrait()

グループフィールドのキーを抜き出す


    protected
                    extractGroupFieldKeysTrait(Field|Field_Validation $field, array<string|int, mixed> $fieldKeys) : array<string|int, mixed>

Parameters

$field : Field|Field_Validation
$fieldKeys : array<string|int, mixed>

Return values

array<string|int, mixed>

extractNonGroupFieldKeysTrait()

グループフィールドのキーを除いてキーを取得


    protected
                    extractNonGroupFieldKeysTrait(array<string|int, mixed> $fieldKeys, array<string|int, mixed> $groupKeys) : array<string|int, mixed>

Parameters

$fieldKeys : array<string|int, mixed>
$groupKeys : array<string|int, mixed>

Return values

array<string|int, mixed>

filterQuery()

絞り込みクエリ組み立て


    protected
                    filterQuery(SQL_Select $sql) : void

Parameters

$sql : SQL_Select

formatFieldKeysTrait()

フィールドキー配列を整形


    protected
                    formatFieldKeysTrait(array<string|int, mixed> $fieldKeys) : array<string|int, mixed>

Parameters

$fieldKeys : array<string|int, mixed>

Return values

array<string|int, mixed>

limitQuery()

limitクエリ組み立て


    protected
                    limitQuery(SQL_Select $sql) : void

Parameters

$sql : SQL_Select

orderQuery()

orderクエリ組み立て


    protected
                    orderQuery(SQL_Select $sql) : void

Parameters

$sql : SQL_Select

setCountQuery()

ユーザー数取得sqlの準備


    protected
                    setCountQuery(SQL_Select $sql) : void

Parameters

$sql : SQL_Select

UserHelper extends BaseHelper in package Application uses FieldTrait, EagerLoadingTrait, PaginationTrait

Table of Contents

Properties

Methods

Properties

$bids

$cids

$eids

$uids

$bid

$blogAxis

$categoryAxis

$cid

$config

$countQuery

$eid

$end

$Field

$keyword

$order

$page

$sortFields

$start

$tags

$uid

Methods

__construct()

Parameters

buildPagerTrait()

Parameters

Return values

buildPagination()

Parameters

Return values

buildPaginationTrait()

Parameters

Return values

buildUserEntry()

Parameters

Return values

buildUserIndex()

Parameters

Return values

buildUserIndexQuery()

Return values

canAccessUser()

Parameters

Return values

getCountQuery()

Return values

getUserProfileData()

Parameters

Return values

setProperty()

Parameters

autoConvertTypeTrait()

Parameters

Return values

buildBasicFieldGroupTrait()

Parameters

Return values

buildBasicFieldTrait()

Parameters

Return values

buildFieldTrait()

Parameters

Return values

buildMultiFieldGroupTrait()

Parameters

Return values

buildMultiFieldTrait()

Parameters

Return values

eagerLoadEntryTrait()

Parameters

Return values

eagerLoadFieldTrait()

Parameters

Return values

eagerLoadFullTextTrait()

UserHelper extends BaseHelper
in package

Application

uses FieldTrait, EagerLoadingTrait, PaginationTrait