Documentation

Image
in package

class Image Popisuje obrázek jako takový.

Umí z nového obrázku vyrobit jeho miniaturu. Pamatuje si také uložení miniatury a původního obrázku. Pro potřeby uložení vygeneruje unikátní název (id) pro každý obrázek, proto při ukládání nedojde ke kolizi. Obrázek umí i smazat, tj. jeho originál i miniaturu.

Table of Contents

Properties

$bits  : int
$description  : string
$mime  : string
$name  : string
$orig_x  : int
$orig_y  : int
$original_directory  : string
$th_x  : int
$th_y  : int
$thumbnail_directory  : string
$type  : int
$unique_id  : string

Methods

__construct()  : mixed
destroy()  : void
Smaže soubory obrázku v lokacích original i náhledu.
generateImages()  : void
Přiřadí k instaci skutečný obrázek z cesty source, uloží ho i jeho náhled.
getDescription()  : string
Vrací popisek obrázku.
getName()  : string
getOriginalFullPath()  : string
Vrací cestu k originálnímu souboru.
getOrigX()  : int
Vrací šířku původního obrázku.
getOrigY()  : int
Vrací výšku původního obrázku
getThumbnailFullPath()  : string
Vrací cestu k náhledu včetně jména souboru náhledu.
getUniqueName()  : string
Vrací název souboru, pod kterým je uložen v original a náhledovém adresáři.
createOriginal()  : void
Jednoduše zkopíruje obrázek do nového cíle, tj. do adresáře original. Název bude unikátní s použitím unikátního identifikátoru.
createThumbnail()  : void
Vyrobí náhled obrázku. Zde se používá knihovna GD k vyrobení nového obrázku a přenesení do něj zmenšeného originálu.
generateUniqueId()  : mixed
getFunctionNameByImageType()  : string|false
Vrací název podle typu souboru.

Properties

$bits

protected int $bits

Detekovaná hloubka barev obrázku.

$description

protected string $description

Popis obrázku.

$mime

protected string $mime

Detekovaný mime type.

$name

protected string $name

Jméno souboru.

$orig_x

protected int $orig_x

Šířka originálního obrázku v px.

$orig_y

protected int $orig_y

Výška originálního obrkázku v px.

$original_directory

protected string $original_directory

Cesta pro uložení originálu.

$th_x

protected int $th_x

Šířka náhledu v px.

$th_y

protected int $th_y

Výška náhledu v px.

$thumbnail_directory

protected string $thumbnail_directory

Cesta pro uložení náhledu.

$type

protected int $type

Typ podle https://www.php.net/manual/en/image.constants.php#constant.imagetype-gif PHP dokumentace

$unique_id

protected string $unique_id = ""

Unikátní id vygenerované při vzniku objektu.

Methods

__construct()

public __construct(string $name, string $description[, int $th_max_x = 100 ][, int $th_max_y = 100 ], string $origDir, string $thmbDir) : mixed
Parameters
$name : string

Název souboru

$description : string

Popis obrázku

$th_max_x : int = 100

Max šířka náhledu

$th_max_y : int = 100

Max výška náhledu

$origDir : string

Adresář, kam se má uložit originál

$thmbDir : string

Adresář, kam se má uložit náhled

destroy()

Smaže soubory obrázku v lokacích original i náhledu.

public destroy() : void

generateImages()

Přiřadí k instaci skutečný obrázek z cesty source, uloží ho i jeho náhled.

public generateImages(string $source) : void
Parameters
$source : string

Soubor zdrojového obrázku.

Tags
throws
FileException

Výjimka v případě, ze se nepodařilo soubor otevřít.

throws
ImageException

Výjimka v případě, že soubor není obrázek.

getDescription()

Vrací popisek obrázku.

public getDescription() : string
Return values
string

Popisek obrázku.

getName()

public getName() : string
Return values
string

getOriginalFullPath()

Vrací cestu k originálnímu souboru.

public getOriginalFullPath() : string
Return values
string

Cestak originálu

getOrigX()

Vrací šířku původního obrázku.

public getOrigX() : int
Return values
int

Šířka původního obrázku.

getOrigY()

Vrací výšku původního obrázku

public getOrigY() : int
Return values
int

Výška původního obrázku.

getThumbnailFullPath()

Vrací cestu k náhledu včetně jména souboru náhledu.

public getThumbnailFullPath() : string
Return values
string

Cesta k náhledu.

getUniqueName()

Vrací název souboru, pod kterým je uložen v original a náhledovém adresáři.

public getUniqueName() : string
Return values
string

createOriginal()

Jednoduše zkopíruje obrázek do nového cíle, tj. do adresáře original. Název bude unikátní s použitím unikátního identifikátoru.

protected createOriginal(string $path) : void
Parameters
$path : string

Location of the original image.

createThumbnail()

Vyrobí náhled obrázku. Zde se používá knihovna GD k vyrobení nového obrázku a přenesení do něj zmenšeného originálu.

protected createThumbnail(string $path, int $max_x, int $max_y) : void
Parameters
$path : string

Zdrojový obrázek.

$max_x : int

Max. šířka náhledu.

$max_y : int

Max. výška náhledu.

Tags
throws
ImageException

Vyhodí výjimku v případě, že obrázek je neznámého typu.

generateUniqueId()

private generateUniqueId() : mixed

getFunctionNameByImageType()

Vrací název podle typu souboru.

private getFunctionNameByImageType(string $fnPrefix) : string|false
Parameters
$fnPrefix : string

Prefix, ktery je následně spojen s názvem typu obrázku.

Return values
string|false

False se vrací tehdy, kdy se to nepovedlo.


        
On this page

Search results