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
TYPE_COMBINED  = 2
TYPE_COMBINED_OR  = 3
TYPE_CONTENT  = 1
TYPE_TITLE  = 0
$approval  : bool
$archived  : bool
$category  : 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
$multipleQuery  : bool
$orderby  : array<string|int, mixed>
$pinned  : bool
$postponed  : bool
$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
$isMultiple  : bool
Multiple search flag
$language  : language
Sprachobjekt
$notifications  : notifications
Notifications
$permissions  : permissions
Permissions
$session  : session
Session objekt
__construct()  : void
Konstruktor
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
hasParams()  : bool
Funktion liefert Informationen zurpck, ob Suchparameter vorhanden
isMultiple()  : bool
Is multiple flag set
setMultiple()  : $this
Sets multiple lag

Constants

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

$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

$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

$postponed

public bool $postponed

nur geplante Artikel

$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

$isMultiple

Multiple search flag

protected bool $isMultiple = false
Tags
since
4.3

Methods

__construct()

Konstruktor

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

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 —

setMultiple()

Sets multiple lag

public setMultiple(bool $isMultiple) : $this
Parameters
$isMultiple : bool
Tags
since
4.3
Return values
$this —

Search results