Home modules.gotpike.org
Username: Password: [Create Account]
[Forgot Password?]

Pike Module Reference:

module version 0.3, prepared 2012-02-04

  MODULE PiJAX
Modules
Parse
Serialise
Serialize

Methods
parse()
serialise()
serialize()
supported()
Method serialise

string|object(Public.Parser.XML2.Node) PiJAX.serialise(mixed data, void|int as)

Description

Handy pointer to PiJAX.Serialise.serialise();

Parameter data

The data to be encoded.

See also

PiJAX.Serialise.serialise()
Method serialize

string PiJAX.serialize(mixed ... args)

Description

Handy pointer to PiJAX.Serialize.serialize();

Parameter data

The data to be encoded.

See also

PiJAX.Serialize.serialize()
Method parse

mixed PiJAX.parse(string|object(Public.Parser.XML2.Node) xml)

Description

Handy pointer to PiJAX.Parse.parse();

Parameter xml

The XML string to be parsed.

See also

PiJAX.Parse.parse()
Method supported

string|array PiJAX.supported(void|int xml)

Description

List the data types that can be (de)serialised by PiJAX. You can compare these against "%t".

Parameter xml

If PiJAX.XML is passed then the response is given as serialised XML - good for testing remotely.

See also

predef::sprintf()
  MODULE PiJAX.Parse
Methods
parse()
Method parse

mixed PiJAX.Parse.parse(string|object(Public.Parser.XML2.Node) xml)

Description

Parse some PiJAX XML back into a Pike data structure.

Parameter xml

An XML string containing the PiJAX XML.
  MODULE PiJAX.Serialise
Methods
mime_xml_namespace()
mime_xml_ns_prefix()
pike_xml_namespace()
pike_xml_ns_prefix()
serialise()
string_encoding()
xml_encoding()
xml_version()
Method xml_version

float PiJAX.Serialise.xml_version(void|float ver)

Description

Change the XML version number in the xml PI. Defaults to 1.0.

Parameter var

Version number. Really should only be 1.0.
Method xml_encoding

string PiJAX.Serialise.xml_encoding(void|string encoding)

Description

Change the XML encoding in the xml PI. Defaults to "ISO-8859-1".

Parameter encoding

The encoding.
Method pike_xml_namespace

string PiJAX.Serialise.pike_xml_namespace(void|string ns)

Description

Change the default Pike namespace - don't do this unless you know what you're doing. Defaults to "http://pike.ida.liu.se/".

Parameter ns

The URI of the new namespace.
Method pike_xml_ns_prefix

string PiJAX.Serialise.pike_xml_ns_prefix(void|string prefix)

Description

Change the default prefix for the Pike namespace - don't do this unless you know what you're doing. Defaults to "pike".

Parameter prefix

The URI of the new namespace.
Method mime_xml_namespace

string PiJAX.Serialise.mime_xml_namespace(void|string ns)

Description

Change the default MIME namespace - don't do this unless you know what you're doing. Defaults to "http://pike.ida.liu.se/generated/manual/modref/ex/predef_3A_3A/MIME.html".

Parameter ns

The URI of the new namespace.
Method mime_xml_ns_prefix

string PiJAX.Serialise.mime_xml_ns_prefix(void|string prefix)

Description

Change the default prefix for the MIME namespace - don't do this unless you know what you're doing. Defaults to "mime".

Parameter prefix

The URI of the new namespace.
Method string_encoding

string PiJAX.Serialise.string_encoding(void|string encoding)

Description

Change the default string encoding. Defaults to "cdata". Use this if you're trying to encode a binary string to XML and you're getting backtraces.

Parameter encoding

Either "base64", "uue" or "cdata".
Method serialise

string|object PiJAX.Serialise.serialise(mixed data, void|int as)

Description

Serialise the argument into XML.

Parameter data

The data to be encoded.

See also

PiJAX.supported()
  MODULE PiJAX.Serialize
Methods
serialize()
Inherit Serialise

  • .Serialise

    • Method serialize

    string PiJAX.Serialize.serialize(mixed data)

    Description

    Serialize the argument into XML.

    Parameter data

    The data to be encoded.

    See also

    PiJAX.supported()
    gotpike.org | Copyright © 2004 - 2011 | Pike is a trademark of Department of Computer and Information Science, Linköping University