Funkce v XML
Funkce umístěné ve jmenném prostoru XML.
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í:
- hodnota typu Stringpokud atribut existuje, pak hodnota atributu, 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í:
- hodnota typu Stringpř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í:
-
hodnota typu Elementprvní podřízený XML nod
-
hodnota typu nullnull, 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í:
- hodnota typu Booleantrue, 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í:
- hodnota typu Booleantrue, 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í:
-
hodnota typu Elementposlední podřízený XML nod
-
hodnota typu nullnull, 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í:
- hodnota typu Document, nullpř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í:
-
hodnota typu Elementnásledující XML nod
-
hodnota typu nullnull, 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í:
- hodnota typu Element[ Integer ]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í:
-
hodnota typu DocumentXML dokument při úspěšném rozparsování
-
hodnota typu nullnull 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í:
- hodnota typu Stringcesta 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í:
-
hodnota typu Elementpředcházející XML nod
-
hodnota typu nullnull, 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í:
- hodnota typu Element[ Integer ]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í:
- hodnota typu voidbez 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í:
- hodnota typu voidbez 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í:
- hodnota typu StringXML 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í:
-
hodnota typu ElementXML nod odpovídající výrazu XPath
-
hodnota typu nullnull, 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í:
- hodnota typu Stringpř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í:
- hodnota typu Stringobsah XML nodu
( umístěno v souboru /comex/scripts/comex.js )
Podřízené stránky
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.
Funkce create
Vytvoří nový XML dokument. Pokud je uveden jmenný prostor, bude tento jmenný prostor automaticky zaregistrován.