Funkce add

Vloží nový XML nod nebo přesune existující XML nod na požadovanou pozici. Pokud je uveden jmenný prostor, bude tento jmenný prostor automaticky zaregistrován.

typ: function; celé jméno: COMEX.XML.add;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$dom

● hodnota typu Document

XML dokument

● hodnota typu Element

XML nod

$node

● hodnota typu String

název nového XML nodu

● hodnota typu Element

přesouvaný XML nod

$before

● hodnota typu Element (výchozí: null)

XML nod, před který má být XML nod vložen

null znamená na konec

$uri

● hodnota typu String (výchozí: undefined)

URI jmenného prostoru (nepovinný, pokud není uvedený prefix jmenného prostoru v názvu XML nodu nebo byl URI jmenného prostoru zaregistrován již dříve)

Vrací:

vložený XML nod

( umístěno v souboru /comex/scripts/comex.js )

Funkce attr

Vrátí hodnotu atributu a pokud je předána hodnota, nastaví jej na tuto hodnotu.

typ: function; celé jméno: COMEX.XML.attr;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Document

XML dokument (je brán rootový XML nod dokumentu)

● hodnota typu Element

XML nod

$attribute

● hodnota typu String

název atributu

$value

● hodnota typu String (výchozí: undefined)

hodnota atributu

● hodnota typu null (výchozí: undefined)

pokud je hodnota nastavena na null, je atribut odstraněn

Vrací:

pokud atribut existuje, pak hodnota atributu, jinak null

( umístěno v souboru /comex/scripts/comex.js )

Funkce create

Vytvoří nový XML dokument. Pokud je uveden jmenný prostor, bude tento jmenný prostor automaticky zaregistrován.

typ: function; celé jméno: COMEX.XML.create;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$root

● hodnota typu String

název rootového XML nodu (s prefixem, pokud má rootový XML nod patřit do jmenného prostoru, jinak bez prefixu)

$prefix

● hodnota typu String (výchozí: undefined)

prefix jmenného prostoru (musí být uvedený pouze pokud nemá rootový XML nod patřit do jmenného prostoru, ale jmenný prostor má být zaregistrován)

$uri

● hodnota typu String (výchozí: undefined)

URI jmenného prostoru (pokud není prefix uvedený v názvu rootového XML nodu ani v parametru $prefix)

Vrací:

při úspěšném vytvoření XML dokumentu, jinak null

( umístěno v souboru /comex/scripts/comex.js )

Funkce escape

Převede "nebezpečné" XML znaky na entity.

typ: function; celé jméno: COMEX.XML.escape;

Parametry:

$string

● hodnota typu String

převáděný řetězec

Vrací:

převedený řetězec

( umístěno v souboru /comex/scripts/comex.js )

Funkce first

Vrátí první podřízený XML nod.

typ: function; celé jméno: COMEX.XML.first;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Element

aktuální XML nod

Vrací:

první podřízený XML nod

null, pokud neexistuje

( umístěno v souboru /comex/scripts/comex.js )

Funkce isDoc

Ověří, zda je proměnná XML dokument.

typ: function; celé jméno: COMEX.XML.isDoc;

Parametry:

$var

● hodnota typu mixed

testovaná proměnná

Vrací:

true, pokud je proměnná XML dokument, jinak false

( umístěno v souboru /comex/scripts/comex.js )

Funkce isNode

Ověří, zda je proměnná XML nod.

typ: function; celé jméno: COMEX.XML.isNode;

Parametry:

$var

● hodnota typu mixed

testovaná proměnná

Vrací:

true, pokud je proměnná XML nod, jinak false

( umístěno v souboru /comex/scripts/comex.js )

Funkce last

Vrátí poslední podřízený XML nod.

typ: function; celé jméno: COMEX.XML.last;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Element

aktuální XML nod

Vrací:

poslední podřízený XML nod

null, pokud neexistuje

( umístěno v souboru /comex/scripts/comex.js )

Funkce load

Načte XML dokument.

typ: function; celé jméno: COMEX.XML.load;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$uri

● hodnota typu String

URI pro načtení XML dokumentu

$params

● hodnota typu mixed (výchozí: null)

parametry pro načtení XML dokumentu

$method

● hodnota typu String (výchozí: 'GET')

metoda pro načtení XML dokumentu

Vrací:

při úspěšném načtení XML dokumentu, jinak null

( umístěno v souboru /comex/scripts/comex.js )

Funkce next

Vrátí následující XML nod.

typ: function; celé jméno: COMEX.XML.next;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Element

aktuální XML nod

Vrací:

následující XML nod

null, pokud neexistuje

( umístěno v souboru /comex/scripts/comex.js )

Funkce nodes

Vrátí dceřinné XML nody.

typ: function; celé jméno: COMEX.XML.nodes;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Document

XML dokument (je brát rootový XML nod dokumentu)

● hodnota typu Element

aktuální XML nod

Vrací:

pole dceřinných XML nodů

( umístěno v souboru /comex/scripts/comex.js )

Funkce parse

Rozparsuje XML data a vytvoří XML dokument.

typ: function; celé jméno: COMEX.XML.parse;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$xml

● hodnota typu String

XML data

Vrací:

XML dokument při úspěšném rozparsování

null při chybě

( umístěno v souboru /comex/scripts/comex.js )

Funkce path

Vrátí cestu ke XML nodu.

typ: function; celé jméno: COMEX.XML.path;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Element

XML nod

Vrací:

cesta ke XML nodu

( umístěno v souboru /comex/scripts/comex.js )

Funkce prev

Vrátí předcházející XML nod.

typ: function; celé jméno: COMEX.XML.prev;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Element

aktuální XML nod

Vrací:

předcházející XML nod

null, pokud neexistuje

( umístěno v souboru /comex/scripts/comex.js )

Funkce query

Najde a vrátí všechny XML nody odpovídající výrazu XPath. Pokud výraz XPath hledá i přes jmenné prostory, je třeba použít před touto metodou ještě metodu COMEX.XML.regNS pro registraci každého jmenného prostoru, pokud tak již nebylo učiněno dříve.

typ: function; celé jméno: COMEX.XML.query;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$dom

● hodnota typu Document

XML dokument

● hodnota typu Element

XML nod

$xpath

● hodnota typu String

výraz XPath

Vrací:

pole XML nodů odpovídajících výrazu XPath

( umístěno v souboru /comex/scripts/comex.js )

Funkce regNS

Zaregistruje prefix a URI jmenného prostoru.

typ: function; celé jméno: COMEX.XML.regNS;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$prefix

● hodnota typu String

prefix jmenného prostoru

$uri

● hodnota typu String

URI jmenného prostoru

Vrací:

bez návratové hodnoty

( umístěno v souboru /comex/scripts/comex.js )

Funkce rem

Odstraní XML nod.

typ: function; celé jméno: COMEX.XML.rem;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Element

odstraňovaný XML nod

Vrací:

bez návratové hodnoty

( umístěno v souboru /comex/scripts/comex.js )

Funkce serialize

Zaserializuje XML data do řetězce.

typ: function; celé jméno: COMEX.XML.serialize;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$dom

● hodnota typu Document

XML dokument

● hodnota typu Element

XML nod

$definition

● hodnota typu Boolean (výchozí: true)

true, pokud má být přidána definice XML, jinak false

Vrací:

XML data

( umístěno v souboru /comex/scripts/comex.js )

Funkce squery

Najde a vrátí 1. výskyt XML nodu odpovídajícího výrazu XPath. Pokud výraz XPath hledá i přes jmenné prostory, je třeba použít před touto metodou ještě metodu COMEX.XML.regNS pro registraci každého jmenného prostoru, pokud tak již nebylo učiněno dříve.

typ: function; celé jméno: COMEX.XML.squery;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$dom

● hodnota typu Document

XML dokument

● hodnota typu Element

XML nod

$xpath

● hodnota typu String

výraz XPath

Vrací:

XML nod odpovídající výrazu XPath

null, pokud neexistuje

( umístěno v souboru /comex/scripts/comex.js )

Funkce unescape

Převede entity na "nebezpečné" XML znaky.

typ: function; celé jméno: COMEX.XML.unescape;

Parametry:

$string

● hodnota typu String

převáděný řetězec

Vrací:

převedený řetězec

( umístěno v souboru /comex/scripts/comex.js )

Funkce val

Vrátí obsah XML nodu a pokud je předána hodnota, nastaví obsah na tuto hodnotu.

typ: function; celé jméno: COMEX.XML.val;

Možné výjimky:

COMEX.Exceptions.GeneralException

Parametry:

$node

● hodnota typu Document

XML dokument (je vrácen obsah rootového XML nodu)

● hodnota typu Element

XML nod

$value

● hodnota typu String (výchozí: undefined)

obsah XML nodu

Vrací:

obsah XML nodu

( umístěno v souboru /comex/scripts/comex.js )