Gd
[ class tree: Gd ] [ index: Gd ] [ all elements ]

Class: VgtGd

Source Location: /moduly/VgtGd/VgtGd.php

Class Overview


Glowna klasa startowa modulu


Author(s):

  • VGT

Version:

  • 1.0.3

Constants

Methods



Class Details

[line 30]
Glowna klasa startowa modulu



Tags:

author:  VGT
version:  1.0.3


[ Top ]


Class Methods


static method colorConvertHtml [line 800]

static Array colorConvertHtml( String $sColor)

Metoda przyjmuje kolor okreslony za pomoca kodu HTML (np. "#FF0099"), przeprowadza konwersje i zwraca 3 elementowa tablice zawierajaca wartosci w zakresie 0-255 dla poszczegolnych skladowych RGB.

Aktualnie oznaczona jako deprecated. Funkcjonalnosc zastapiona przez klase VgtGdColor.




Tags:

deprecated:  
since:  1.0
access:  public


Parameters:

String   $sColor   Kod HTML koloru do konwersji.

[ Top ]

static method colorConvertInt [line 823]

static Array colorConvertInt( Integer $iColor)

Metoda przyjmuje liczbe reprezentujaca kolor, przeprowadza jej konwersje i zwraca 3 elementowa tablice zawierajaca wartosci w zakresie 0-255 dla poszczegolnych skladowych RGB.

Aktualnie oznaczona jako deprecated. Funkcjonalnosc zastapiona przez klase VgtGdColor.




Tags:

deprecated:  
since:  1.0
access:  public


Parameters:

Integer   $iColor   Liczba reprezentujaca kolor.

[ Top ]

constructor __construct [line 77]

VgtGd __construct( )

Konstruktor domyslny.



Tags:

since:  1.0
access:  public


[ Top ]

destructor __destruct [line 98]

void __destruct( )

Destruktor.



Tags:

since:  1.0
access:  public


[ Top ]

method cloneObject [line 312]

Object cloneObject( )

Tworzy kopie obiektu.



Tags:

return:  Kopia obiektu VgtGd.
since:  1.0
access:  public


[ Top ]

method create [line 212]

void create( Integer $iWidth, Integer $iHeight, [String $sType = null], [Mixed $mColor = null])

Stworzenie nowego obrazka.

Czwartym parametrem moze byc string definiujacy kolor HTML lub obiekt klasy VgtGdColor.




Tags:

since:  1.0
access:  public


Parameters:

Integer   $iWidth   Szerokosc obrazka w pikselach.
Integer   $iHeight   Wysokosc obrazka w pikselach.
String   $sType   Typ pliku [opcjonalny, domyslnie: jpg]
Mixed   $mColor   Kolor wypelnienia [opcjonalny, domyslnie: #FFFFFF]

[ Top ]

method cropMargins [line 553]

void cropMargins( [Integer $iTop = null], [Integer $iRight = null], [Integer $iDown = null], [Integer $iLeft = null])

Crop obrazka.

Wykonuje crop obrazka o okreslona ilosc rzedow pikseli z kazdej strony.




Tags:

since:  1.0


Parameters:

Integer   $iTop   Wielkosc gornego marginesu do obciecia. [opcjonalny, domyslnie: 0]
Integer   $iRight   Wielkosc prawego marginesu do obciecia. [opcjonalny, domyslnie: 0]
Integer   $iDown   Wielkosc dolnego marginesu do obciecia. [opcjonalny, domyslnie: 0]
Integer   $iLeft   Wielkosc lewego marginesu do obciecia. [opcjonalny, domyslnie: 0]

[ Top ]

method cropPoints [line 608]

void cropPoints( Integer $iX1, Integer $iY1, Integer $iX2, Integer $iY2)

Crop obrazka.

Wykonuje crop obrazka do obszaru wyznaczonego przez dwa punkty o podanych wspolrzednych.




Tags:

since:  1.0
access:  public


Parameters:

Integer   $iX1   Wspolrzedna X pierwszego punktu.
Integer   $iY1   Wspolrzedna Y pierwszego punktu.
Integer   $iX2   Wspolrzedna X drugiego punktu.
Integer   $iY2   Wspolrzedna Y drugiego punktu.

[ Top ]

method display [line 707]

void display( [Integer $iCompression = null])

Wyswietlenie obrazka.

UWAGA!

  • przed ta metoda nie nalezy wyswietlac jakichkolwiek informacji, gdyz konieczne jest wyslanie naglowkowych informujacych o type wyswietlanego obrazka.




Tags:

since:  1.0
access:  public


Parameters:

Integer   $iCompression   Parametr okreslajacy jakosc w przypadku wyswietlania pliku typu jpg. [opcjonalny, domyslnie: 85]

[ Top ]

method exportImage [line 353]

Resource exportImage( )

Zwraca uchwyt do zasobu.



Tags:

return:  Uchwyt do zasobu przechowujacego obrazek.
since:  1.0
access:  public


[ Top ]

method getClassPath [line 108]

String getClassPath( )

Metoda zwraca sciezke, w ktorej znajduje sie plik klasy.



Tags:

since:  1.0
access:  public


[ Top ]

method getEffectsFactory [line 164]

Object getEffectsFactory( )

Metoda zwraca referencje do fabryki efektow.



Tags:

return:  Obiekt fabryki efektow.
since:  1.0
access:  public


[ Top ]

method getHeight [line 130]

Integer getHeight( )

Metoda zwraca wysokosc aktualnie edytowanego obrazka.



Tags:

return:  Wysokosc obrazka.
since:  1.0
access:  public


[ Top ]

method getMemoryLimit [line 143]

Integer/String getMemoryLimit( [Boolean $bHumanOutput = false])

Metoda zwraca aktualnie ustawiony limit pamieci dla obiektu.



Tags:

return:  Limit pamieci, jaka obiekt moze wykorzystac podany w bajtach.
since:  1.0
access:  public


Parameters:

Boolean   $bHumanOutput   Okresla, czy zwracana wartosc ma byc przeliczona na kilo/mega/giga bajty [opcjonalny, domyslanie: false]

[ Top ]

method getMemoryUsage [line 154]

Integer/String getMemoryUsage( [Boolean $bHumanOutput = false])

Metoda zwraca aktualny stan zuzycia pamieci dla obiektu.



Tags:

return:  Szacowana ilosc aktualnie uzywanej pamieci.
since:  1.0
access:  public


Parameters:

Boolean   $bHumanOutput   Okresla, czy zwracana wartosc ma byc przeliczona na kilo/mega/giga bajty [opcjonalny, domyslanie: false]

[ Top ]

method getWidth [line 118]

Integer getWidth( )

Metoda zwraca szerokosc aktualnie edytowanego obrazka.



Tags:

return:  Szerokosc obrazka.
since:  1.0
access:  public


[ Top ]

method importImage [line 328]

void importImage( Resource $rImage, [String $sType = null])

Import zasobu typu gd do obiektu.



Tags:

since:  1.0
access:  public


Parameters:

Resource   $rImage   Zasob typu gd zawierajacy obrazek.
String   $sType   Typ obrazka. [opcjonalny, domyslnie: jpg]

[ Top ]

method open [line 242]

void open( String $sFile)

Otwarcie obrazka z lokalnego dysku, lub adresu URL.



Tags:

access:  public


Parameters:

String   $sFile   Sciezka do pliku na lokalnym dysku, lub adres URL.

[ Top ]

method openUrl [line 281]

void openUrl( String $sFile, [Integer $iTimeout = 10])

Otwarcie obrazka z adresu URL.



Tags:

since:  1.0
access:  public


Parameters:

String   $sFile   Adres URL do pliku.
Integer   $iTimeout   Maksymalny czas oczekiwania na odpowiedz serwera w sekundach. [opcjonalny, domyslnie: 10]

[ Top ]

method rotate [line 655]

void rotate( Integer $iCount)

Obrocenie obrazka.

Obraca obrazek zgodnie ze wskazowkami zegara o podana wielokrotnosc 90 stopni.




Tags:

since:  1.0
access:  public


Parameters:

Integer   $iCount   Przyjmuje wartosci od 1 do 3 i obraca obrazek o podana wielokrotnosc 90 stopni.

[ Top ]

method save [line 747]

void save( [String $sFile = null], [Integer $iCompression = null])

Zapisanie obrazka.

Sciezka, do ktorej ma byc zapisany plik jest opcjonalna tylko w przypadku wczesniejszego skorzystania z metody open(). W tej sytuacji obrazek bedzie zapisany do tego samego pliku, z ktorego zostal otwarty. W przypadku korzystania z metod create(), lub openUrl() sciezka jest obowiazkowa i jej niepodanie spowoduje wyrzucenie wyjatku.




Tags:

since:  1.0
access:  public


Parameters:

String   $sFile   Sciezka w ktorej ma byc zapisany plik. [opcjonalny]
Integer   $iCompression   Stopien kompresji w przypadku plikow typu jpg [opcjonalny, domyslnie: 85]

[ Top ]

method scale [line 503]

void scale( [Integer $iX = null], [Integer $iY = null], [Boolean $bAliasing = null])

Skalowanie obrazka.

W przypadku podania obydwu rozmiarow obrazek jest skalowany do danej rozdzielczosci niezaleznie od tego, czy spowoduje to zmiane proporcji.

W przyadpku podania tylko jednego z wymiarow drugi jest obliczany tak, aby zachowac proporcje obrazka.




Tags:

since:  1.0


Parameters:

Integer   $iX   Szerokosc obrazka po przeskalowaniu. [opcjonalny]
Integer   $iY   Wysokosc obrazka po przeskalowaniu. [opcjonalny]
Boolean   $bAliasing   Okresla, czy podczas skalowania stosowac antyaliasing. [opcjonalny, domyslanie: false]

[ Top ]

method setMemoryLimit [line 181]

void setMemoryLimit( String $sLimit)

Metoda pozwala ustawic limit pamieci dla obiektu.



Tags:

since:  1.0
access:  public


Parameters:

String   $sLimit   Wartosc limitu pamieci. Mozna przekazac dowolna liczbe bajtow, lub tekst w formacie, ktory akceptuje memory_limit w php.ini (np. "16M")

[ Top ]

method setType [line 192]

void setType( String $sType)

Pozwala zmienic typ edytowanego obrazka.



Tags:

since:  1.0
access:  public


Parameters:

String   $sType   Nazwa typu.

[ Top ]

method thumbnail [line 376]

void thumbnail( [Integer $iMaxX = null], [Integer $iMaxY = null], [Mixed $mColor = null])

Tworzenie miniatury obrazka.

Zarowno maksymalna wartosc X i Y jest parametrem opcjonalnym, jednak wymagane jest podanie przynajmniej jednego z nich. W takim wypadku drugi zostanie dobrany automatycznie, aby zachowac proporcje.

Jesli nie zostanie okreslony kolor wypelenia tla, obrazek moze miec inne rozmiary, niz przekazane w parametrach, jesli proporcje obrazka zrodlowego sa inne, niz proporcje tworzonej miniatury.

Trzecim parametrem moze byc string definiujacy kolor HTML lub obiekt klasy VgtGdColor.




Tags:

since:  1.0
access:  public


Parameters:

Integer   $iMaxX   Maksymalna szerokosc miniatury. [opcjonalny]
Integer   $iMaxY   Maksymalna wysokosc miniatury. [opcjonalny]
Mixed   $mColor   Kolor tla. [opcjonalny]

[ Top ]

method thumbnail2 [line 461]

void thumbnail2( Integer $iWidth, Integer $iHeight, [Float $fHorizontal = null], [Float $fVertical = null])

Tworzenie miniatury obrazka.

Miniatura zawsze bedzie miala podany rozmiar. Jesli obrazek jest zbyt maly, zostanie powiekszony. Jesli ma inne proporcje, elementy nie mieszczace sie w kadrze miniatury zostana przyciete.




Tags:

since:  1.0


Parameters:

Integer   $iWidth   Szerokosc utworzonej miniatury.
Integer   $iHeight   Wysokosc utworzonej miniatury.
Float   $fHorizontal   Umiejscowienie miniatury w poziomie wzgledem zrodlowego obrazka. Zakres od -1 (miniatura przy lewej krawedzi obrazka) do 1 (miniatura przy prawej krawedzi). [opcjonalny, domyslnie: 0]
Float   $fVertical   Umiejscowienie miniatury w pionie wzgledem zrodlowego obrazka. Zakres od -1 (miniatura przy dolnej krawedzi obrazka) do 1 (miniatura przy gornej krawedzi). [opcjonalny, domyslnie: 0]

[ Top ]

method useEffect [line 691]

void useEffect( Object $oEffect, [Integer $iX = null], [Integer $iY = null], [Integer $iWidth = null], [Integer $iHeight = null])

Naklada przekazany obiekt efektow na edytowany obrazek.



Tags:

since:  1.0
access:  public


Parameters:

Object   $oEffect   Obiekt efektu implementujacy interface VgtGdEffectInterface.
Integer   $iX   Wspolrzedna X punktu startowego obszaru. [opcjonalny, domyslnie: 0]
Integer   $iY   Wspolrzedna Y punktu startowego obszaru. [opcjonalny, domyslnie: 0]
Integer   $iWidth   Szerokosc obszaru. [opcjonalny, domyslnie: szerokosc obrazka]
Integer   $iHeight   Wysokosc obszaru. [opcjonalny, domyslnie: wysokosc obrazka]

[ Top ]


Class Constants

BPP =  32

[line 35]

Stala okreslajaca ilosc bitow na piksel wykorzystywana w obliczeniach zuzycia pamieci.


[ Top ]



Documentation generated on Fri, 02 Apr 2010 13:22:43 +0200 by phpDocumentor 1.4.3