Simon's MySQL

English

Jak spustit rozšíření

Nejdříve vložte soubor rozšíření pomocí příkazu include, require, include_once nebo require_once.
Pak vytvořte objekt rozšíření. Při chybějících parametrech se použijí výchozí z php.ini. Syntaxe:
new Smysql([string $host = NULL, string $user = NULL, string $password = NULL[, string $database = NULL]])
Nebo:
Smysql([string $host = NULL, string $user = NULL, string $password = NULL[, string $database = NULL[, &$object]]])
host
- Adresa serveru k připojení.
user
- Jméno uživatele.
password
- Heslo uživatele.
database
- Jméno databáze. K vytvoření databáze zadejte create[jméno nové databáze].
object
- Objekt, prázdný nebo nevytvořený. Je-li zmíněný, vloží se do něj objekt rozšíření a funkce nic nevrací.
Nebo:

              class mySmysql extends Smysql {
                protected $host = "Adresa serveru k připojení";
                protected $user = "Jméno uživatele";
                protected $password = "Heslo uživatele";
                protected $db = "Jméno databáze";
              };
              $object = new mySmysql();
            
Vrácená hodnota:
Object rozšíření.

Charset

Nastaví kódování. Syntaxe:
$object->charset(string $charset)
object
- Objekt rozšíření.
charset
- Kódování(např. utf8, latin1, latin2, utf8mb4, utf16, utf16le, cp1250, ascii. Komplentí seznam najdete na této stránce.).

Escape

Vymaže z proměnné nebezpečné znaky. Používá se pouze u funkce query. Syntaxe:
$object->escape(string $string)
object
- Objekt rozšíření.
string
- Původní text.
Vrácená hodnota: Vrátí text ošetřený od nebezpečných znaků.

Query

Provede SQL příkaz. Syntaxe:
$object->query(string $sqlCommand)
object
- Objekt rozšíření.
sqlCommand
- SQL příkaz.
Vrácená hodnota:
Vrátí číslo akce v případě úspěchu, v opačném případě false.

ChangeDB

Změní aktuální databázi. Syntaxe:
$object->changeDB(string $database)
Object
- Objekt rozšíření.
Database
- Jméno databáze. K vytvoření databáze zadejte create[jméno nové databáze].

DeleteDB

Vymaže databázi a připojí se k nové nebo uzavře spojení. Syntaxe:
$object->deleteDB(string $database[, string $close = false])
Object
- Objekt rozšíření.
Database
- Databáze k odstranění.
Close
- Při zadání true se zavře spojení s MySQL serverem. Při hodnotě false nelze vymazat aktuální databáze.
Vrácená hodnota: TRUE v případě úspěchu, v opačném případě FALSE.

CreateTable

Vytvoří tabulku. Syntaxe:
$object->createTable(string $table, array $names, array $types, array $lenghts[, string $primary = NULL[, array $uniques = array()[, array $others = array()]]])
Object
- Objekt rozšíření.
Table
- Název nové tabulky.
Names
- Pole názvů sloupců tabulky.
Types
- Pole typů tabulky (int pro číslo, varchar pro text, tinyint pro binární hodnotu...).
Lengths
- Pole maximálních délek sloupců tabulky, v případě typu INT může zůstat hodnota prázdná.
Primary
- Název sloupce, který bude mít klíč PRIMARY, může být jen jeden.
Uniques
- Pole názvů sloupců, které bude mít klíč UNIQUE (stejnou hodnotu tohoto ssloupce může mít jen jeden řádek).
Others
- Pole jiných vlastností tabulky, např. klíče nebo auto_increment(A_I).

RenameTable

Přejmenuje tabulku. Syntaxe:
$object->renameTable(string $table, string $newName)
Object
- Objekt rozšíření.
Table
- Současný název tabulky.
NewName
- Nový název tabulky.

DeleteTable

Vymaže tabulku. Syntaxe:
$object->deleteTable(string $table)
Object
- Objekt rozšíření.
Table
- Název tabulky k vymazání.

Fetch

Vrátí objekt z posledního výsledku databáze. Syntaxe:
$object->fetch([$result])
Object
- Objekt rozšíření.
Result
- Výsledek databáze, pokud není zadaný, použije se z posledního volání funkce select, selectWhere, selectJoin, exists, queryf nebo query.
Vrácená hodnota: Vrátí objekt s hodnotami aktuálního řádku tabulky.

FetchArray

Vrátí pole s hodnotami aktuálního řádku tabulky. Syntaxe:
$object->fetchArray([$result])
Object
- Objekt rozšíření.
Result
- Výsledek databáze, pokud není zadaný, použije se z posledního volání funkce select, selectWhere, selectJoin, exists, queryf nebo query.
Vrácená hodnota: Vrátí pole s hodnotami aktuálního řádku tabulky.

FetchAll

Vrátí údaje o všech řádcích tabulky. Syntaxe:
$object->fetchAll([$result])
Object
- Objekt rozšíření.
Result
- Výsledek databáze, pokud není zadaný, použije se z posledního volání funkce select, selectWhere, selectJoin, exists, queryf nebo query.
Vrácená hodnota: Vrátí pole s objekty s hodnotami z takového řádku tabulky, jehož číslo je rovno klíči pole.

Queryf

Ošetří parametry a provede příkaz. Syntaxe:
$object->queryf(string $prepare, array $array)
Object
- Objekt rozšíření.
Prepare
- Dotaz se zástupnými znaky %0, %1, %2 atd.
Array
- Pole s proměnnými, které se ošetří a vloží se do příkazu místo zástupných znaků.

Select

Vrátí a uloží do paměti kód příkazu SELECT, tento příkaz zjistí data uložená v tabulce. Syntaxe:
$object->select(string $table[, string $order = NULL[string $orderType = "ASC", [, array $cols = array("*")]]])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Order
- Název sloupce, podle kterého řadí funkce fetch(), fetchArray() nebo fetchAll(). Při zápisu NULL se řadí podle času přidání.
OrderType
- ASC nebo DESC, jakým směrem řadit podle abecedy. ASC vzestupně nebo DESC sestupně.
Cols
- Seznam sloupců s hodnotami, které funkce fetch(), fetchArray() nebo fetchAll() vrátí. Při zápisu array("*") vrátí všechny sloupce.

SelectWhere

Vrátí a uloží do paměti kód příkazu SELECT, tento příkaz zjistí data uložená v tabulce. Syntaxe:
$object->selectWhere(string $table, mixed $array[, bool $all = true[, string $order = NULL[, string $orderType = "ASC"[, array $cols = array("*")]]]])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Array
- Řetězec SQL podmínky nebo pole, kde klíč je název sloupce a hodnota je jeho hodnota, když všechno popř. alespoň jedno platí, řádek se vybere.
All
- Pokud je zadáno TRUE, řádek se vybere, pouze pokud platí všechny podmínky, jinak stačí pouze jedna
Order
- Název sloupce, podle kterého řadí funkce fetch(), fetchArray() nebo fetchAll(). Při zápisu NULL se řadí podle času přidání.
OrderType
- ASC nebo DESC, jakým směrem řadit podle abecedy. ASC vzestupně nebo DESC sestupně.
Cols
- Seznam sloupců s hodnotami, které funkce fetch(), fetchArray() nebo fetchAll() vrátí. Při zápisu array("*") vrátí všechny sloupce.

SelectJoin

Spojí dvě tabulky a provede dotaz. Syntaxe:
$object->selectJoin(string $table, string $join, mixed $array[, bool $all = true[, int $joinType = 0[, string $order = NULL[, string $orderType = "ASC"[, array $cols = array("*")]]]]])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Join
- Připojená tabulka
Array
- Řetězec SQL podmínky nebo pole, kde klíč je název sloupce a hodnota je jeho hodnota, když všechno popř. alespoň jedno platí, řádek se vybere.
All
- Pokud je zadáno TRUE, řádek se vybere, pouze pokud platí všechny podmínky, jinak stačí pouze jedna
JoinType
- Chování, pokud jeden řádek nenašel shodu. Při zadání 0, což znamená INNER, se tento řádek nevybere. Při zadání 1, což znamená LEFT, vybere existující část řádku v původní tabulce, a chybějící část nahradí NULL. Při zadání 2, což znamená RIGHT, vybere existující část řádku v připojené tabulce, a chybějící část nahradí NULL. Při zadání 3, což znamená FULL, každou část řádku a zbytek nahradí NULL.
Order
- Název sloupce, podle kterého řadí funkce fetch(), fetchArray() nebo fetchAll(). Při zápisu NULL se řadí podle času přidání.
OrderType
- ASC nebo DESC, jakým směrem řadit podle abecedy. ASC vzestupně nebo DESC sestupně.
Cols
- Seznam sloupců s hodnotami, které funkce fetch(), fetchArray() nebo fetchAll() vrátí. Při zápisu array("*") vrátí všechny sloupce.

Exists

Testuje jestli existuje takový řádek. Syntaxe:
$object->exists(string $table, mixed $array, bool $all)
Object
- Objekt rozšíření.
Table
- Název tabulky.
Array
- Řetězec SQL podmínky nebo pole, kde klíč je název sloupce a hodnota je jeho hodnota, když všechno popř. alespoň jedno platí, vrátí TRUE.
All
- Pokud je zadáno TRUE, vrací TRUE, pouze pokud platí všechny podmínky, jinak stačí pouze jedna
Vrácená hodnota: Vrací TRUE nebo FALSE, podle toho, jestli takový řádek existuje.

Read

Univerzální verze čtení z tabulky. Syntaxe:
$object->read(string $table[, mixed $array[, bool $all = true]])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Array
- Řetězec SQL podmínky nebo pole, kde klíč je název sloupce a hodnota je jeho hodnota, když všechno popř. alespoň jedno platí, řádek se vybere. Pokud není zadáno, vyberou se všechny řádky z dané tabulky.
All
- Pokud je zadáno TRUE, řádek se vybere, pouze pokud platí všechny podmínky, jinak stačí pouze jedna
Vrácená hodnota: Pokud se žádný řádek nevybere, vrací FALSE, pokud se vybere jeden, vrací objekt z tohoto řádku jako funkce fetch a pokud je jich víc, vrací pole s objekty ze všech vybraných řádků (jako fetchAll).

Insert

Vloží data nového řádku do tabulky. Syntaxe:
$object->insert(string $table, array $values[, array $cols = array()[, bool $retId = false]])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Values
- Pole s hodnotami sloupců popořadě.
Cols
- Pole s prvky které se mají vložit, můžou se přeházet. Při zápisu array() se vyberou všechny, v pořadí z definování tabulky.
RetId
- Pokud je zadáno TRUE, funkce vrací hodnotu sloupce s auto_increment.
Vrácená hodnota: Pokud je parametr retId TRUE, funkce vrací hodnotu sloupce s auto_increment.

Update

Změní jeden řádek tabulky. Syntaxe:
$object->update(string $table, array $arr, array $values[, bool $all = true])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Arr
- Řetězec SQL podmínky nebo pole, kde klíč je název sloupce a hodnota je jeho hodnota, když všechno popř. alespoň jedno platí, řádek se změní.
Values
- Asocuativní pole, kde klíč je název sloupce a hodnota nová hodnota tohoto sloupce.
All
- Pokud je zadáno TRUE, řádek se změní, pouze pokud platí všechny podmínky, jinak stačí pouze jedna

Add

Přidá nový sloupec v tabulce. Syntaxe:
$object->add(string $table, string $name, string $type, int $lenth, bool $null, string $where, string $key[, string $data = NULL])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Name
- Název nového sloupce.
Type
- Datový typ nového sloupce, například varchar pro text nebo int či bigint pro číslo.
Null
- Logická hodnota, jestli hodnota sloupce může být prázná.
Where
- Before nebo after, podle toho kam má být vložen nový sloupec.
Key
- Existující sloupec před popř. po který má být nový vložen.
Data
- Další parametry v jazyku SQL o novém sloupci.

Change

Změní sloupec v tabulce. Synataxe:
$object->change(string $table, string $name, string $newName, string $type, int $lenth, bool $null[, string $data = NULL])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Name
- Název sloupce.
NewName
- Nový název sloupce.
Type
- Datový typ sloupce, například varchar pro text nebo int či bigint pro číslo.
Null
- Logická hodnota, jestli hodnota sloupce může být prázná.
Data
- Další parametry v jazyku SQL o sloupci.

Drop

Vymaže sloupec v tabulce. Synatexe:
$object->drop(string $table, string $name)
Object
- Objekt rozšíření.
Table
- Název tabulky.
Name
- Název sloupce, který má být odstraněn.

Delete

Vymaže řádek/řádky. Syntaxe:
$object->delete(string $table, mixed $array[, bool $all = true])
Object
- Objekt rozšíření.
Table
- Název tabulky.
Array
- Řetězec SQL podmínky nebo pole, kde klíč je název sloupce a hodnota je jeho hodnota, když všechno popř. alespoň jedno platí, řádek se vymaže.
All
- Pokud je zadáno TRUE, řádek se vymaže, pouze pokud platí všechny podmínky, jinak stačí pouze jedna

Truncate

Vymaže všechny řádky tabulky. Syntaxe:
$object->truncate(string $table)
Object
- Objekt rozšíření.
Table
- Název tabulky