Documentation

search extends searchWrapper
in package

Comment search wrapper object

Tags
author

Stefan Seehafer aka imagine fanpress@nobody-knows.org

copyright

(c) 2017-2025, 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_ALL  = 0
TYPE_ALLOR  = 3
TYPE_NAMEMAILWEB  = 2
TYPE_NAMEMAILWEB_OR  = 4
TYPE_TEXT  = 1
$approved  : bool
$articleid  : int
$combination  : string
$combinationApproved  : int
$combinationArticleid  : int
$combinationDatefrom  : int
$combinationDateto  : int
$combinationDeleted  : int
$combinationPrivate  : int
$combinationSpam  : int
$datefrom  : int
$dateto  : int
$deleted  : bool
$email  : string
$ipaddress  : string
$limit  : array<string|int, mixed>
$metaOnly  : bool
$modeDeleted  : bool
$name  : string
$orderby  : array<string|int, mixed>
$private  : bool
$searchtype  : bool
$spam  : bool
$text  : string
$unapproved  : bool
$website  : string
$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
assignApproved()  : void
Assign spam field
assignArticleid()  : void
Assign spam field
assignDatefrom()  : void
Assign date from field
assignDateto()  : void
Assign date to field
assignDeleted()  : void
Assign spam field
assignEmail()  : void
Assign e-mail field
assignIpaddress()  : void
Assign spam field
assignName()  : void
Assign name field
assignPrivate()  : void
Assign spam field
assignSpam()  : void
Assign spam field
assignText()  : void
Assign text field
assignWebsite()  : void
Assign website 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
prepareApproved()  : void
Prepare approved value
prepareArticleid()  : void
Prepare articleid value
prepareDatefrom()  : void
Prepare date from value
prepareDateto()  : void
Prepare date to value
prepareEmail()  : void
Prepare email value
prepareFilterParams()  : queryAssignResult
Parse and assigns UI filter params array to queries
prepareIpaddress()  : void
Prepare ipaddress value
prepareName()  : void
Prepare name value
prepareOrder()  : void
Prepare order string
preparePrivate()  : void
Prepare private value
prepareSpam()  : void
Prepare spam value
prepareText()  : void
Prepare website value
prepareValues()  : void
Prepare values
prepareWebsite()  : void
Prepare website value
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_ALL

public mixed TYPE_ALL = 0

TYPE_ALLOR

public mixed TYPE_ALLOR = 3

TYPE_NAMEMAILWEB

public mixed TYPE_NAMEMAILWEB = 2

TYPE_NAMEMAILWEB_OR

public mixed TYPE_NAMEMAILWEB_OR = 4

TYPE_TEXT

public mixed TYPE_TEXT = 1

Properties

$approved

public bool $approved

nur als Freigegeben markierte Kommentare

$articleid

public int $articleid

Artikel-ID

$combination

public string $combination

logische Verknüpfung AND/OR

$combinationApproved

public int $combinationApproved

AND/OR for approved

$combinationArticleid

public int $combinationArticleid

AND/OR for articleid

$combinationDatefrom

public int $combinationDatefrom

AND/OR for datefrom

$combinationDateto

public int $combinationDateto

AND/OR for dateto

$combinationDeleted

public int $combinationDeleted

AND/OR for deleted

$combinationPrivate

public int $combinationPrivate

AND/OR for private

$combinationSpam

public int $combinationSpam

AND/OR for spam

$datefrom

public int $datefrom

seit Datum X.Y.Z

$dateto

public int $dateto

bis Datum X.Y.Z

$deleted

public bool $deleted

nur als nicht Freigegeben markierte Kommentare

$email

public string $email

via e-mail

$ipaddress

public string $ipaddress

IP-Adresse

$limit

public array<string|int, mixed> $limit

Abfrage einschränken

$metaOnly

public bool $metaOnly

Kommentar-Text nicht abrufen

$modeDeleted

public bool $modeDeleted

flag for deleted articles

$name

public string $name

via name

$orderby

public array<string|int, mixed> $orderby

Array von Sortierungen in SQL-Syntax

$private

public bool $private

nur als Privat markierte Kommentare

$searchtype

public bool $searchtype

Suchtyp

$spam

public bool $spam

nur als Spam markierte Kommentare

$text

public string $text

via comment text

$unapproved

public bool $unapproved

nur als nicht Freigegeben markierte Kommentare

$website

public string $website

via website

$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

assignApproved()

Assign spam field

public assignApproved() : void
Return values
void

assignArticleid()

Assign spam field

public assignArticleid() : 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

assignEmail()

Assign e-mail field

public assignEmail() : void
Return values
void

assignIpaddress()

Assign spam field

public assignIpaddress() : void
Return values
void

assignName()

Assign name field

public assignName() : void
Return values
void

assignPrivate()

Assign spam field

public assignPrivate() : void
Return values
void

assignSpam()

Assign spam field

public assignSpam() : void
Return values
void

assignText()

Assign text field

public assignText() : void
Return values
void

assignWebsite()

Assign website field

public assignWebsite() : 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
Tags
since
5.3.0-dev
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

prepareApproved()

Prepare approved value

public prepareApproved() : void
Return values
void

prepareArticleid()

Prepare articleid value

public prepareArticleid() : 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

prepareEmail()

Prepare email value

public prepareEmail() : void
Return values
void

prepareIpaddress()

Prepare ipaddress value

public prepareIpaddress() : void
Return values
void

prepareName()

Prepare name value

public prepareName() : 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

preparePrivate()

Prepare private value

public preparePrivate() : void
Return values
void

prepareSpam()

Prepare spam value

public prepareSpam() : void
Return values
void

prepareText()

Prepare website value

public prepareText() : 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

prepareWebsite()

Prepare website value

public prepareWebsite() : void
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