Documentation

ImageList
in package

Třída reprezentuje seznam obrázku. Umí je uložit do souboru i načíst ze souboru.

Table of Contents

Properties

$filename  : string
$images  : array<string|int, mixed>

Methods

__construct()  : mixed
Konstruktor, pokud je druhý parametr true, nahrají se obrázky okamžitě při vzniku objektu.
add()  : Image
Přidá nový obrázek do pole obrázků.
deleteImage()  : bool
Smaže obrázek na pozici $id ze seznamu obrázků. Pokud je druhý parametr true, okamžitě výsledek uloží.
getFileName()  : string
Vrací název datového souboru.
getImages()  : array<string|int, mixed>
Vrací pole obrázků typu Image
load()  : array<string|int, mixed>
Nahraje obrázky ze souboru.
save()  : void
Uloží obrázky do souboru.
setFileName()  : string
Nastaví název a cestu souboru, do a ze kterého se mají ukládat/načítat data.

Properties

$filename

protected string $filename

Název souboru, do a ze kterého se seznam bude ukládat/načítat.

$images

protected array<string|int, mixed> $images = array()

Pole obrázků typu Image

Methods

__construct()

Konstruktor, pokud je druhý parametr true, nahrají se obrázky okamžitě při vzniku objektu.

public __construct(string $filename[, bool $load = false ]) : mixed
Parameters
$filename : string

Název souboru, kde jsou data.

$load : bool = false

Zda nahrát okamžitě data. Dedault je false, tedy ne.

add()

Přidá nový obrázek do pole obrázků.

public add(Image $image[, bool $saveImmediately = true ]) : Image
Parameters
$image : Image

Nový obrázek, který se přidá na konec pole obrázků

$saveImmediately : bool = true

Pokud je true, výsledek se okamžitě uloží.

Return values
Image

Vrací obrázek, který byl zadán jako parametr.

deleteImage()

Smaže obrázek na pozici $id ze seznamu obrázků. Pokud je druhý parametr true, okamžitě výsledek uloží.

public deleteImage(int $id[, mixed $saveImmediately = true ]) : bool

Pokud $id neexistuje, nestane se nic.

Parameters
$id : int

Id pozice obrázku.

$saveImmediately : mixed = true

Pokud je true, bude výsledek okamžitě uložen.

Return values
bool

Pokud došlo ke smazání, vrací true, jinak false.

getFileName()

Vrací název datového souboru.

public getFileName() : string
Return values
string

getImages()

Vrací pole obrázků typu Image

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

load()

Nahraje obrázky ze souboru.

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

Vrací pole obrázků typu Image

save()

Uloží obrázky do souboru.

public save() : void

setFileName()

Nastaví název a cestu souboru, do a ze kterého se mají ukládat/načítat data.

public setFileName(string $file) : string
Parameters
$file : string

Název souboru.

Return values
string

        
On this page

Search results