Documentation

imagelist extends filelist
in package
implements gsearchIndex

Image list object

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

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

Interfaces, Classes, Traits and Enums

gsearchIndex
FanPress CM Model global search indexer

Table of Contents

$basepath  : string
Dateilisten-Basispfad
$cache  : cache
System-Cache
$cacheModule  : string
Cache Modul
$cacheName  : string
Cache name
$config  : config
System-Config-Objekt
$data  : array<string|int, mixed>
Data array
$dbcon  : database
DB-Verbindung
$events  : events
Event-Liste
$exts  : array<string|int, mixed>
erlaute Dateierweiterungen
$language  : language
System-Sprachen-Objekt
$notifications  : notifications
Notifications
$pathprefix  : string
Dateilisten-Basispfad
$table  : string
Tabellen-Name
$finfo  : finfo
finfo instance
$indexUserId  : int
User id to use for file indexing
__construct()  : mixed
Konstruktor
__destruct()  : void
Konstruktor
createFilemanagerThumbs()  : bool
Creates file manager thumbnails
getCountQuery()  : selectParams
Get count query string
getDatabaseCountByCondition()  : array<string|int, mixed>
Fetch file index by condition
getDatabaseFileCount()  : int
Liefert Anzahl von Dateieinträgen in Datenbank zurück
getDatabaseList()  : array<string|int, mixed>
Gibt Dateiindex in Datenbank zurück
getDatabaseListByCondition()  : array<string|int, mixed>
Fetch file index by condition
getElementIcon()  : icon
Return link icon
getElementLink()  : string
Return link to element link
getFolderList()  : array<string|int, mixed>
Return list of files in file system
getPathprefix()  : string
Gibt Pfadprefix zurück
getSearchQuery()  : selectParams
Get query string
getUploadFolderSize()  : int
Gibt aktuelle Größe des upload-Ordners in byte zurück
prepareText()  : string
Prepare result text
removeBasePath()  : bool
Removes base path from give path
setPathprefix()  : mixed
Setzt Pfadprefix
updateFileIndex()  : bool
Updates file index
addToIndex()  : bool
Add single file to index
assignMultipleSearchParams()  : bool
Assigns search params object to value arrays
assignSearchParams()  : bool
Assigns search params from search object to where condition
getSearchQueryObj()  : selectParams
Returns selectParams object instance

Properties

$basepath

Dateilisten-Basispfad

protected string $basepath = ''

$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 = []
Tags
since
4.1

$exts

erlaute Dateierweiterungen

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

$pathprefix

Dateilisten-Basispfad

protected string $pathprefix = ''

$table

Tabellen-Name

protected string $table

$finfo

finfo instance

private finfo $finfo = null
Tags
since
4.5

$indexUserId

User id to use for file indexing

private int $indexUserId = 0
Tags
since
4.5

Methods

__construct()

Konstruktor

public __construct() : mixed
Return values
mixed

__destruct()

Konstruktor

public __destruct() : void
Return values
void

createFilemanagerThumbs()

Creates file manager thumbnails

public createFilemanagerThumbs([array<string|int, mixed>|null $folderFiles = null ][, bool|null $forceAll = null ]) : bool
Parameters
$folderFiles : array<string|int, mixed>|null = null
$forceAll : bool|null = null
Return values
bool

getDatabaseCountByCondition()

Fetch file index by condition

public getDatabaseCountByCondition(search $conditions) : array<string|int, mixed>
Parameters
$conditions : search
Return values
array<string|int, mixed>

getDatabaseFileCount()

Liefert Anzahl von Dateieinträgen in Datenbank zurück

public getDatabaseFileCount() : int
Tags
since
3.1
Return values
int

getDatabaseList()

Gibt Dateiindex in Datenbank zurück

public getDatabaseList([int $limit = false ][, int $offset = false ]) : array<string|int, mixed>
Parameters
$limit : int = false
$offset : int = false
Return values
array<string|int, mixed>

getDatabaseListByCondition()

Fetch file index by condition

public getDatabaseListByCondition(search $conditions) : array<string|int, mixed>
Parameters
$conditions : search
Return values
array<string|int, mixed>

getElementIcon()

Return link icon

public getElementIcon() : icon
Tags
since
5.1-dev
Return values
icon

Return link to element link

public getElementLink(mixed $filename) : string
Parameters
$filename : mixed
Tags
since
5.1-dev
Return values
string

getFolderList()

Return list of files in file system

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

getPathprefix()

Gibt Pfadprefix zurück

public getPathprefix() : string
Return values
string

getUploadFolderSize()

Gibt aktuelle Größe des upload-Ordners in byte zurück

public getUploadFolderSize() : int
Return values
int

prepareText()

Prepare result text

public prepareText(string $text) : string
Parameters
$text : string
Return values
string

removeBasePath()

Removes base path from give path

public removeBasePath(string &$path) : bool
Parameters
$path : string
Return values
bool

setPathprefix()

Setzt Pfadprefix

public setPathprefix(string $pathprefix) : mixed
Parameters
$pathprefix : string
Return values
mixed

updateFileIndex()

Updates file index

public updateFileIndex(int $userId) : bool
Parameters
$userId : int
Return values
bool

addToIndex()

Add single file to index

private addToIndex(string $file) : bool
Parameters
$file : string
Tags
since
4.5
Return values
bool

assignMultipleSearchParams()

Assigns search params object to value arrays

private assignMultipleSearchParams(search $conditions, array<string|int, mixed> &$where, array<string|int, mixed> &$valueParams, string $combination) : bool
Parameters
$conditions : search
$where : array<string|int, mixed>
$valueParams : array<string|int, mixed>
$combination : string
Return values
bool

assignSearchParams()

Assigns search params from search object to where condition

private assignSearchParams(search $conditions, array<string|int, mixed> &$where, array<string|int, mixed> &$valueParams, string $combination) : bool
Parameters
$conditions : search
$where : array<string|int, mixed>
$valueParams : array<string|int, mixed>
$combination : string
Tags
since
4.3
Return values
bool

Search results