Metody v Doc

Metody umístěné ve jmenném prostoru Doc.


Metoda add

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

typ: method; celé jméno: COMEX.XML.Doc.add;


Parametry:

$node

● hodnota typu String

název nového XML nodu

● hodnota typu Element

přesouvaný XML nod

● hodnota typu COMEX.XML.Node

přesouvaný XML nod (obálka)

$before

● hodnota typu COMEX.XML.Node (výchozí: null)

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

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

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í:

nový XML nod, pokud byl vložen nebo přesunut

null při chybě

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


Metoda create

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

typ: method; celé jméno: COMEX.XML.Doc.create;


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 (nepovinný, pokud není prefix uvedený v názvu rootového XML nodu ani v parametru $prefix)


Vrací:

true, při úspěšném vytvoření, jinak false

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


Metoda load

Načte XML dokument z URL.

typ: method; celé jméno: COMEX.XML.Doc.load;


Parametry:

$url

● hodnota typu String

URL 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í:

true, při úspěšném načtení, jinak false

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


Metoda parse

Rozparsuje XML data a vytvoří XML dokument.

typ: method; celé jméno: COMEX.XML.Doc.parse;


Parametry:

$xml

● hodnota typu String

XML data


Vrací:

true, při úspěšném rozparsování, jinak false

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


Metoda 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 $document.regNS pro registraci každého jmenného prostoru, pokud tak již nebylo učiněno dříve.

typ: method; celé jméno: COMEX.XML.Doc.query;


Parametry:

$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 )


Metoda regNS

Zaregistruje prefix a URI jmenného prostoru.

typ: method; celé jméno: COMEX.XML.Doc.regNS;


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 )


Metoda serialize

Vrátí serializovaná XML data dokumentu.

typ: method; celé jméno: COMEX.XML.Doc.serialize;


Parametry:

$definition

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

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


Vrací:

XML data

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


Metoda 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 $document.regNS pro registraci každého jmenného prostoru, pokud tak již nebylo učiněno dříve.

typ: method; celé jméno: COMEX.XML.Doc.squery;


Parametry:

$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 )


Metoda toString

Vrátí textovou reprezentaci XML dokumentu (XML data).

typ: method; celé jméno: COMEX.XML.Doc.toString;


Vrací:

textová reprezentace

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


Vlastnosti v DocMetody v Doc