Documentation

search extends searchWrapper
in package

Article search wrapper object

Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2017, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

since
3.5

Table of Contents

COMBINATION_AND  = 0
COMBINATION_OR  = 1
COMBINATION_STR_AND  = 'and'
COMBINATION_STR_OR  = 'or'
TYPE_COMBINED  = 2
TYPE_COMBINED_OR  = 3
TYPE_CONTENT  = 1
TYPE_TITLE  = 0
$approval  : bool
$archived  : bool
$category  : int
$changefrom  : int
$changeto  : int
$changeuser  : int
$combination  : string
$combinationApproval  : int
$combinationArchived  : int
$combinationCategoryid  : int
$combinationComments  : int
$combinationDatefrom  : int
$combinationDateto  : int
$combinationDeleted  : int
$combinationDraft  : int
$combinationPinned  : int
$combinationPostponed  : int
$combinationUserid  : int
$comment  : bool
$comments  : bool
$content  : string
$datefrom  : int
$dateto  : int
$deleted  : bool
$draft  : bool
$drafts  : bool
$ids  : int
$limit  : array<string|int, mixed>
$metaOnly  : bool
$modeActive  : bool
$modeArchive  : bool
$modeDeleted  : bool
$multipleQuery  : bool
$orderby  : array<string|int, mixed>
$pinned  : bool
$pinned_until  : int
$postponed  : bool
$relates_to  : int
$sources  : string
$title  : string
$user  : int
$cache  : cache
Cache object
$cacheModule  : string
Cache Modul
$cacheName  : string
Cache name
$config  : config
Config object
$data  : array<string|int, mixed>
Data array
$events  : events
Event list
$fieldOrder  : array<string|int, mixed>
Field order array
$filterParams  : array<string|int, mixed>
Search conditions array
$isMultiple  : bool
Multiple search flag
$language  : language
Sprachobjekt
$notifications  : notifications
Notifications
$permissions  : permissions
Permissions
$queryAssignResult  : queryAssignResult
Query assign result object
$session  : session
Session objekt
__construct()  : void
Konstruktor
assignApproval()  : void
Assign approval field
assignArchived()  : void
Assign archived field
assignCategory()  : void
Assign title field
assignChangefrom()  : void
Assign date from field
assignChangeto()  : void
Assign date to field
assignChangeuser()  : void
Assign changeuser id field
assignComments()  : void
Assign comments field
assignContent()  : void
Assign content field
assignDatefrom()  : void
Assign date from field
assignDateto()  : void
Assign date to field
assignDeleted()  : void
Assign spam field
assignDraft()  : void
Assign draft field
assignPinned()  : void
Assign pinned field
assignPinned_until()  : void
Assign pinned_until field
assignPostponed()  : void
Assign postponed field
assignRelates_to()  : void
Assign relates_to field
assignSources()  : void
Assign sources field
assignTitle()  : void
Assign title field
assignUser()  : void
Assign user id field
getCacheName()  : string
Cache-Name zurückgeben
getCondition()  : string
Returns condition for given value
getData()  : array<string|int, mixed>
Liefert Daten zurück, die über Eigenschaften erzeugt wurden
getDefaultOrder()  : string
Retrun deafult order field
getOrderFields()  : array<string|int, mixed>
Returns field whitelist for ordering
hasParams()  : bool
Funktion liefert Informationen zurpck, ob Suchparameter vorhanden
isMultiple()  : bool
Is multiple flag set
prepareApproval()  : void
Prepare approval value
prepareArchived()  : void
Prepare user id value
prepareCategory()  : void
Prepare title value
prepareChangefrom()  : void
Prepare date from value
prepareChangeto()  : void
Prepare date to value
prepareChangeuser()  : void
Prepare changeuser id value
prepareComments()  : void
Prepare comments value
prepareContent()  : void
Prepare title value
prepareDatefrom()  : void
Prepare date from value
prepareDateto()  : void
Prepare date to value
prepareDraft()  : void
Prepare draft value
prepareFilterParams()  : queryAssignResult
Parse and assigns UI filter params array to queries
prepareOrder()  : void
Prepare order string
preparePinned()  : void
Prepare pinned value
preparePinned_until()  : void
Prepare pinned_until value
preparePostponed()  : void
Prepare postponed value
prepareRelates_to()  : void
Prepare pinned_until value
prepareSources()  : void
Prepare sources value
prepareTitle()  : void
Prepare title value
prepareUser()  : void
Prepare user id value
prepareValues()  : void
Prepare values
setFilterParams()  : $this
Set filter params
setMultiple()  : $this
Sets multiple lag
getDB()  : database
Get database layer instance
assignCondition()  : void
Assigns filter params conditions
assignFieldAndValue()  : void
Assigns fields annd values from filter params

Constants

COMBINATION_STR_AND

public mixed COMBINATION_STR_AND = 'and'

TYPE_COMBINED

public mixed TYPE_COMBINED = 2

TYPE_COMBINED_OR

public mixed TYPE_COMBINED_OR = 3

TYPE_CONTENT

public mixed TYPE_CONTENT = 1

TYPE_TITLE

public mixed TYPE_TITLE = 0

Properties

$approval

public bool $approval

nur freizugebende Artikel

$archived

public bool $archived

nur archivierte Artikel

$category

public int $category

via Kategorie

$changefrom

public int $changefrom

bis Datum X.Y.Z

$changeto

public int $changeto

bis Datum X.Y.Z

$changeuser

public int $changeuser

via change user

$combination

public string $combination

logische Verknüpfung AND/OR

$combinationApproval

public int $combinationApproval

AND/OR for approval

$combinationArchived

public int $combinationArchived

AND/OR for archived

$combinationCategoryid

public int $combinationCategoryid

AND/OR for categoryid

$combinationComments

public int $combinationComments

AND/OR for comments

$combinationDatefrom

public int $combinationDatefrom

AND/OR for datefrom

$combinationDateto

public int $combinationDateto

AND/OR for dateto

$combinationDeleted

public int $combinationDeleted

AND/OR for deleted

$combinationDraft

public int $combinationDraft

AND/OR for draft

$combinationPinned

public int $combinationPinned

AND/OR for pinned

$combinationPostponed

public int $combinationPostponed

AND/OR for postponed

$combinationUserid

public int $combinationUserid

AND/OR for userid

$comment

public bool $comment

Kommentare sind aktiv

$comments

public bool $comments

Kommentare sind aktiv

$content

public string $content

via content-Inhalt

$datefrom

public int $datefrom

seit Datum X.Y.Z

$dateto

public int $dateto

bis Datum X.Y.Z

$deleted

public bool $deleted

nur gelöschte Artikel

$draft

public bool $draft

nur Entwürfe

$drafts

public bool $drafts

nur Entwürfe

$limit

public array<string|int, mixed> $limit

Abfrage einschränken

$metaOnly

public bool $metaOnly

Artikel-Text nicht abrufen

$modeActive

public bool $modeActive

flag for archive articles

$modeArchive

public bool $modeArchive

flag for archive articles

$modeDeleted

public bool $modeDeleted

flag for deleted articles

$multipleQuery

public bool $multipleQuery

Multiple select queries

$orderby

public array<string|int, mixed> $orderby

Array von Sortierungen in SQL-Syntax

$pinned

public bool $pinned

nur gepinnte Artikel

$pinned_until

public int $pinned_until

pinned until to date

$postponed

public bool $postponed

nur geplante Artikel

$relates_to

public int $relates_to

related to article

$sources

public string $sources

sources

$title

public string $title

via Title-Inhalt

$user

public int $user

via Benutzer

$cacheModule

Cache Modul

protected string $cacheModule = ''
Tags
since
3.4

$cacheName

Cache name

protected string $cacheName = false

$data

Data array

protected array<string|int, mixed> $data

$fieldOrder

Field order array

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

$filterParams

Search conditions array

protected array<string|int, mixed> $filterParams
Tags
since
5.3.0-dev

$isMultiple

Multiple search flag

protected bool $isMultiple = false
Tags
since
4.3

Methods

__construct()

Konstruktor

public __construct() : void
Return values
void

assignApproval()

Assign approval field

public assignApproval() : void
Return values
void

assignArchived()

Assign archived field

public assignArchived() : void
Return values
void

assignCategory()

Assign title field

public assignCategory() : void
Return values
void

assignChangefrom()

Assign date from field

public assignChangefrom() : void
Return values
void

assignChangeto()

Assign date to field

public assignChangeto() : void
Return values
void

assignChangeuser()

Assign changeuser id field

public assignChangeuser() : void
Return values
void

assignComments()

Assign comments field

public assignComments() : void
Return values
void

assignContent()

Assign content field

public assignContent() : void
Return values
void

assignDatefrom()

Assign date from field

public assignDatefrom() : void
Return values
void

assignDateto()

Assign date to field

public assignDateto() : void
Return values
void

assignDeleted()

Assign spam field

public assignDeleted() : void
Return values
void

assignDraft()

Assign draft field

public assignDraft() : void
Return values
void

assignPinned()

Assign pinned field

public assignPinned() : void
Return values
void

assignPinned_until()

Assign pinned_until field

public assignPinned_until() : void
Return values
void

assignPostponed()

Assign postponed field

public assignPostponed() : void
Return values
void

assignRelates_to()

Assign relates_to field

public assignRelates_to() : void
Return values
void

assignSources()

Assign sources field

public assignSources() : void
Return values
void

assignTitle()

Assign title field

public assignTitle() : void
Return values
void

assignUser()

Assign user id field

public assignUser() : void
Return values
void

getCacheName()

Cache-Name zurückgeben

public getCacheName([string $addName = '' ]) : string
Parameters
$addName : string = ''
Return values
string

getCondition()

Returns condition for given value

public getCondition(string $condition, string $query) : string
Parameters
$condition : string
$query : string
Return values
string

getData()

Liefert Daten zurück, die über Eigenschaften erzeugt wurden

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDefaultOrder()

Retrun deafult order field

public getDefaultOrder() : string
Return values
string

getOrderFields()

Returns field whitelist for ordering

public getOrderFields() : array<string|int, mixed>
Tags
since
5.3.0-dev
Return values
array<string|int, mixed>

hasParams()

Funktion liefert Informationen zurpck, ob Suchparameter vorhanden

public hasParams() : bool
Return values
bool

isMultiple()

Is multiple flag set

public isMultiple() : bool
Tags
since
4.2
Return values
bool

prepareApproval()

Prepare approval value

public prepareApproval() : void
Return values
void

prepareArchived()

Prepare user id value

public prepareArchived() : void
Return values
void

prepareCategory()

Prepare title value

public prepareCategory() : void
Return values
void

prepareChangefrom()

Prepare date from value

public prepareChangefrom() : void
Return values
void

prepareChangeto()

Prepare date to value

public prepareChangeto() : void
Return values
void

prepareChangeuser()

Prepare changeuser id value

public prepareChangeuser() : void
Return values
void

prepareComments()

Prepare comments value

public prepareComments() : void
Return values
void

prepareContent()

Prepare title value

public prepareContent() : void
Return values
void

prepareDatefrom()

Prepare date from value

public prepareDatefrom() : void
Return values
void

prepareDateto()

Prepare date to value

public prepareDateto() : void
Return values
void

prepareDraft()

Prepare draft value

public prepareDraft() : void
Return values
void

prepareOrder()

Prepare order string

public prepareOrder(string $field, string $order) : void
Parameters
$field : string
$order : string
Tags
since
5.3.0-dev
Return values
void

preparePinned()

Prepare pinned value

public preparePinned() : void
Return values
void

preparePinned_until()

Prepare pinned_until value

public preparePinned_until() : void
Return values
void

preparePostponed()

Prepare postponed value

public preparePostponed() : void
Return values
void

prepareRelates_to()

Prepare pinned_until value

public prepareRelates_to() : void
Return values
void

prepareSources()

Prepare sources value

public prepareSources() : void
Return values
void

prepareTitle()

Prepare title value

public prepareTitle() : void
Return values
void

prepareUser()

Prepare user id value

public prepareUser() : void
Return values
void

prepareValues()

Prepare values

public prepareValues(array<string|int, mixed> &$filter) : void
Parameters
$filter : array<string|int, mixed>
Tags
since
5.3.0-dev
Return values
void

setFilterParams()

Set filter params

public setFilterParams(array<string|int, mixed> $filterParams) : $this
Parameters
$filterParams : array<string|int, mixed>
Tags
since
5.3.0-dev
Return values
$this

setMultiple()

Sets multiple lag

public setMultiple([bool $isMultiple = true ]) : $this
Parameters
$isMultiple : bool = true
Tags
since
4.3
Return values
$this

assignFieldAndValue()

Assigns fields annd values from filter params

private assignFieldAndValue(filterParam $obj) : void
Parameters
$obj : filterParam
Return values
void

Search results