cache
Klasa pozwala na zapisywanie do pamieci podręczniej danych oraz późniejsze ich wykorzystywanie, obsługiwane jest tutaj zarówno cachowanie w plikach statycznych jak i w tabeli bazy danych.Do obsługi cachu z plików statycznych mamy"
- fileRead($bucket,$key) - odczytuje dane
- fileWrite($bucket,$key,$data) - zapisuje dane
- fileIsCached($bucket,$key) - sprawdza czy dane zostały zapisane w cache
- fileClearByBucket($bucket) - czyści cache z danego kubełka
Do obsługi cachu bazodanowego mamy:
- read($name) - odczytuje dane
- write($name,$data,$bucket = 0) - zapisuje dane
- isCached($name,$expire = null) - sprawdza czy dane zostały zapisane w cache
- clearBucket($bucket) - czyści cały kubełek
- clearByName($name) - czyści daną zmienną
- clearAll() - czyści wszystkie zmienne
Zmienne jakie przyjmują funkcje to odpowiednio
- $bucket - kubełek, czyli grupa zkeszowanych zmiennych, dzięki niej możemy czyścić tylko wybrane fragmenty pamięci podręczniej
- $key oraz $name - klucz, czyli nazwa zmiennej po której później czytać będziemy cache
- $data - dane, mogą być zarówno w formie tablicy jak i stringa, system sam obrobi dane do porządanej formy
- $expire - czas po jakim zmienna wygasa w sekundach
Przykład wykorzystania
if (!cache::isCached('nazwaKlucza')) {
cache::write('nazwaKlucza','nasze dane','kubełek');
}
echo cache::read('nazwaKlucza');
compress
Klasa służy do kompresowania plików do formatu ZIP, pozwala też na ich dekompresjęGłówne metody jakie możemy wykorzystać to
- zip($source, $destination) - pakuje pliki
- unzip($source, $destination, $entries = '') - rozpakowywuje pliki
- getZipFile($fileName,$source) - zwraca spakowany plik w takiej formie że nastepuje pobieranie pliku przez użytkownika
- $source - plik lub folder źródłowy
- $destination - plik docelowy do jakiego mają zostać spakowane dane
- $fileName - nazwa pliku
Przykład wykorzystania
compress::getZipFile('nazwaMojegoPliku.zip','./sciezka_do_katalogu/')
config
Klasa służy do oczytu oraz dodawania zmiennych do configu WinduGłówne metody jakie możemy wykorzystać to
- get($name,$force = false) - pobiera zmienną z configu
- set($name,$value,$bucket=null,$type=null) - zapisuje zmienną
- $name - nazwa zmiennej w configu
- $value - wartość zmiennej
- $bucket - kubełek dla grupy zmiennych
- $type - typ zmiennej (numeric,bool,string)
Przykład wykorzystania
config::set('nazwaZmiennej',123,'cyfry','numeric');
echo config::get('nazwaZmiennej');
cookie
Główne metody jakie możemy wykorzystać to- get($name) - pobiera ciasteczko
- setCookie($name, $value = null, $expire = 3600,$subdirForce = null) - ustawianie ciasteczka
- removeCookie($name) - usuwanie ciasteczka
- $name - nazwa zmiennej
- $value - wartość zmiennej
- $expire - czas po jakim zmienna wygasa w sekundach
Przykład wykorzystania
cookie::set('nazwaZmiennej',123,'cyfry','numeric');
echo cookie::get('nazwaZmiennej');
csv
Główne metody jakie możemy wykorzystać to
- rowsToCsv(array &$fields,$delimiter = ';', $enclosure = '"', $encloseAll = false, $nullToMysqlNull = false ) - zwraca stringa w formie kodu pliku csv
- getCsvFile($fileName,array &$fields, $delimiter = ';', $enclosure = '"', $encloseAll = false, $nullToMysqlNull = false ) - zwraca plik w formacie csv z tablicy
- $fileName - nazwa pliku
- $fields - tablica z danymi
Przykład wykorzystania
csv::getCsvFile('nazwaPliku.csv',$arrayZDanymi);
generate
Główne metody jakie możemy wykorzystać to- sqlDatetime($timestemp = null) - zwraca datetime w formacie sql
- sqlDate($timestemp = null) - zwraca date w formacie sql
- showDatatime($datatime, $addDecorators = true, $onlyStringShow = false) - zwraca datatime z dekoratorami
- showDate($datatime) - zwraca date z dekoratorami
- ip() - zwraca IP wywołującego
- randomCode($length=8,$level=3) - zwraca losowy kod o określonych parametrach
- ekey($table,$colum = 'ekey',$length=12,$level=2) - zwraca unikalny losowy kod dla danej tabeli
- urlKey($baseString,$table,$colum = 'urlKey',$length=50) - zwraca unikalny element linku zgodny ze standardami
- replaceChars($data) - zamienia polskie znaki
- clean($data) - czyści string z niedozwolonych znaków
- cleanFileName($data) - przygotowywuje nazwe pliku
- clearHtml($data) - czyści html
- clearHtmlNl2Br($data) - czyści html i zamienia nowe linie na znaczniki br
- $timestemp - tak zwany timestemp w formie liczby
- $datatime - data w formie datatime mysql
- $data - dane w formie string
validator
Główne validatory jakie możemy wykorzystać to- email($value, $params = null, &$data)
- url($value, $params = null, &$data)
- stringLength($value,$params, &$data)
- numericLength($value,$params,&$data)
- numeric($value,$params,&$data)
- bool($value,$params,&$data)
- string($value,$params,&$data)
- unique($value,$params,&$data,$fieldName)
- exist($value,$params,&$data,$fieldName)
- same($value,$params,&$data)
- fileSize($value,$params,&$data,$fieldName)
- datatime($value,$params,&$data)
- fileType($value,$params,&$data,$fieldName)
- $value - wartość
- $params - parametry validatora w postaci tablicy
- $data - dane opcjonalne
- $fieldName - nazwa komórki w tabeli
