From: Michael Wallner Date: Wed, 19 Jan 2022 20:22:27 +0000 (+0100) Subject: docs: attempt to fix gh-pages X-Git-Tag: v0.1.0~19 X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=f27d5e87d6a39a1d4dae84a46fdbfd162b33eade;p=awesomized%2Fext-ion docs: attempt to fix gh-pages --- diff --git a/.gitignore b/.gitignore index fa3ee0a..b0405b5 100644 --- a/.gitignore +++ b/.gitignore @@ -21,7 +21,7 @@ include install-sh libtool ltmain.sh -Makefile +/Makefile Makefile.fragments Makefile.global Makefile.objects @@ -46,4 +46,5 @@ tmp-php.ini *.gcno .idea docs/vendor +docs/src docs/composer.* diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..ddbea7b --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,27 @@ +PHP ?= php +COMPOSER ?= composer +TAG := $(shell (git describe --tags --exact-match --match=v[1-9]* || echo v0.0) | cut -d. -f-2 2>/dev/null) + +.PHONY: all +all: latest + +.PHONY: clean +clean: + -rm -rf latest src vendor composer.* + +vendor/%: + $(COMPOSER) require m6w6/mdref:dev-master + +src: ../ion.stub.php | vendor/bin/stub2ref + mkdir -p $@ && cd $@ && $(PHP) ../$| ion ../$^ + touch $@ + +$(TAG): src | vendor/bin/ref2html + mkdir -p $@ + $(PHP) $| $@ $^ + touch $@ + +latest: $(TAG) + -unlink latest 2>/dev/null + ln -s "$(TAG)/" latest + touch $@ diff --git a/docs/html/.htaccess b/docs/html/.htaccess deleted file mode 100644 index aa71b43..0000000 --- a/docs/html/.htaccess +++ /dev/null @@ -1,11 +0,0 @@ -Options -Indexes +MultiViews +FollowSymLinks -DirectorySlash Off - -RewriteEngine On -RewriteCond %{REQUEST_FILENAME} -d -RewriteRule ^(.+)$ $1.html [L] - - - ForceType text/x-php - SetHandler default-handler - diff --git a/docs/html/.nojekyll b/docs/html/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/docs/html/AUTHORS b/docs/html/AUTHORS deleted file mode 100644 index 67bbd91..0000000 --- a/docs/html/AUTHORS +++ /dev/null @@ -1 +0,0 @@ -Michael Wallner diff --git a/docs/html/LICENSE b/docs/html/LICENSE deleted file mode 100644 index 816ff40..0000000 --- a/docs/html/LICENSE +++ /dev/null @@ -1,23 +0,0 @@ -Copyright (c) 2013, Michael Wallner . -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - diff --git a/docs/html/VERSION b/docs/html/VERSION deleted file mode 100644 index cd5ac03..0000000 --- a/docs/html/VERSION +++ /dev/null @@ -1 +0,0 @@ -2.0 diff --git a/docs/html/favicon.ico b/docs/html/favicon.ico deleted file mode 100644 index d28351c..0000000 Binary files a/docs/html/favicon.ico and /dev/null differ diff --git a/docs/html/index.css b/docs/html/index.css deleted file mode 100644 index c0204cd..0000000 --- a/docs/html/index.css +++ /dev/null @@ -1,317 +0,0 @@ -html { - font-size: 18px; -} -html, body{ - height: 100%; - min-height: 100%; -} -body, code { - font-family: Inconsolata, 'Inconsolata Awesome', 'Andale Mono', Monaco, 'Courier New', Courier, monospace; -} -body { - line-height: 1.5; - font-size: 1.1em; - margin: 0; - padding: 0; - color: #3f3f3f; -} - -div.page { - margin: auto; -/* max-width: 1200px; -*/ min-height: 100%; - padding-bottom: 5em; - box-shadow: 0 0 20px 10px rgba(0, 0, 0, 0.5); -} - -div.page>* { - margin-left: 1em; -} -div.page>footer { - margin-left: 0; -} -div.page>ul, div.page>div>ul { - margin-left: 2em; -} - -.sidebar { - float: right; - background: #f0f0f0; - border-bottom-left-radius: 10px; - padding: 0; - width: auto; - min-width: 200px; - padding-right: 1em; - padding-bottom: 1em; - margin-bottom: 1em; -} -.sidebar>ul { -} -.sidebar ul { - margin-left: 1em; - margin-top: .5em; - margin-bottom: 0; - padding: 0; - list-style-type: none; -} - -.sidebar .edit { - display: block; - position: relative; - top: 2em; - right: 0; - -webkit-transform: rotate(45deg); - transform: rotate(45deg); - text-decoration: none; - font-weight: bold; - text-shadow: 0 0 5px red; - float: right; -} - -.sidebar .edit a { - color: white !important; -} -code { - border-radius: 2px; - padding: 0px 2px 2px 2px; - background: #f0f0f0; - color: #606060; - box-shadow: 0 0 1px #999; -} - -code code { - display: inline; - padding: 0; - background: transparent; - border: none; - box-shadow: none; -} - -pre>code { - display: inline-block; - padding: 1em; - min-width: 50%; - line-height: 1.2; -} - -pre>code, pre>code code { - background: #333; - color: #eee; -} - -p, pre, table, dl { - margin: 1em 2em; - margin-left: 2em !important; -} - -pre>code, table, dl { - margin-bottom: 2em !important; -} - -li>p { - margin: 1em 0; -} - -blockquote { - border-top: 1px solid #800000; - border-bottom: 1px solid #800000; - background: #ffe4e1; - margin: 2em 0 !important; -} - -ul { - margin-top: 1em; - margin-bottom: 2em; -} -ol { - list-style-type: none; -} -ol ul { - margin-top: 0; - margin-bottom: 0; -} -ol li { - margin-bottom: 0; -} -ol>li { - font-weight: bold; - margin-bottom: .5em; -} -ol>li>* { - font-weight: normal; -} -li { - margin-bottom: .5em; -} -a, h1 code>a { - color: #2f4f4f; -} -a:hover { - text-decoration: none; -} -a[href^="http:"]:after, a[href^="https:"]:after { - content: " ⬈"; -} - -a.permalink { - position: relative; - top: 0; - right: 0; - color: #999999; - opacity: 0.25; -} - -.var { - color: #800000; -} -.constant { - color: #2e8b57; -} - -h1, li h3, th, footer { - background: #708090; - color: #f5f5dc; -} - -h1, footer { - margin: 0; -/* max-width: 1200px; -*/ padding: 1em; -} - -h1 { - line-height: 1.5; - margin-left: 0 !important; - padding-left: 2em; -} -h1 code { - font-weight: normal; - font-size: .9em; - line-height: 1.33; -} -h1 a.permalink { - left: -.8em; - margin-right: -.6em; -} - -li h3 { - border-radius: 4px; - display: inline-block; - width: auto; - padding: .2em; - margin: .5em 0 0 0; -} - -div.page>h3, div.page>div>h3 { - margin-left: 1.25em; -} -div.page>h4, div.page>div>h4 { - margin-left: 1.5em; -} -div.page>h5, div.page>div>h5 { - margin-left: 1.75em; -} -div.page>h6, div.page>div>h6 { - margin-left: 2em; -} - -h1 .constant, pre>code .consant, li h3 .constant { - color: #98fb98; -} - -h1 .var, pre>code .var, li h3 .var { - color: #f4a460; -} -h1 { - font-size: 125%; -} -h2 { - font-size: 120%; -} -h3 { - font-size: 110%; -} -h4 { - font-size: 100%; -} -footer a, h1 a, pre>code a, li h3 a { - color: #b0e0e6; -} -li h3 { -} -li h3 a { - text-decoration: none; -} -li h3 a:hover { - text-decoration: underline; -} - -#disqus_thread { - margin-top: 8em; - margin-right: 2em; -} -#disqus_activator { - margin: auto; - width: 80%; - padding: 1em; - background-color: slategrey; - color: white; - font-size: 1em; - font-weight: bold; - border: 0; - border-radius: 2px; - box-shadow: 0 0 4px #999; -} - -footer { - font-size: smaller; - text-align: center; - clear: both; - position: fixed; - bottom: 0; - width: 100%; - padding: 0; - transition: margin-bottom 2s ease 0.1s; -} -footer.hidden { - margin-bottom: -10em; - transition: margin-bottom 2s ease 0.1s; -} - -footer ul { - margin: 0; - padding: 1em 0; -} - -footer li { - list-style-type: none; - display: inline-block; - margin: 0 1em; -} - -footer a { - text-decoration: none; -} - -footer a:hover { - text-decoration: underline; -} - -table { - border-collapse: collapse; -} -th, td { - padding: .4em; - border-bottom: 1px solid rgba(112, 128, 144, 0.1); -} -dt { - font-weight: bold; - margin-top: 1em; -} -dd { - line-height: 1.33; - margin-left: 1em; -} -h1, footer, table, .sidebar, pre>code, li h3 { - box-shadow: 0 0 4px #708090; -} diff --git a/docs/html/index.html b/docs/html/index.html deleted file mode 100644 index 4ab5df2..0000000 --- a/docs/html/index.html +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - mdref - - - - - - - - - - - -
- -
- - - -
- -

mdref

- - -

- pecl/ion

-

PHP extension wrapping amzn/ion-c. -See the Amazon ION specification.

-
- -
- - - - - - -
- - diff --git a/docs/html/index.js b/docs/html/index.js deleted file mode 100644 index 5124ffe..0000000 --- a/docs/html/index.js +++ /dev/null @@ -1,250 +0,0 @@ -"use strict"; - -$(function() { - var mdref = { - log: function log() { - console.log.apply(console, arguments); - }, - is_constant: function is_constant(s) { - s = s.replace(/v\d+(_\d+)?$/, ""); - if (s.length < 2) { - return false; - } - return s.toUpperCase(s) === s; - }, - is_variable: function is_variable(s) { - return s.substring(0,1) === "$"; - }, - type: function type(s, nn) { - var i, j, t; - // mdref.log("type", s); - // nothing - if (!s.match(/[a-zA-Z]/)) { - return; - } - - switch (s) { - // types - case "void": - case "bool": - case "int": - case "float": - case "string": - case "resource": - case "array": - case "object": - case "callable": - case "mixed": - // Zend/SPL - case "stdClass": - case "Exception": - case "ErrorException": - case "RuntimeException": - case "UnexpectedValueException": - case "DomainException": - case "InvalidArgumentException": - case "BadMethodCallException": - case "Closure": - case "Generator": - case "Countable": - case "Serializable": - case "Traversable": - case "Iterator": - case "IteratorAggregate": - case "RecursiveIterator": - case "ArrayAccess": - case "ArrayObject": - case "ArrayIterator": - case "RecursiveArrayIterator": - case "SeekableIterator": - case "SplObserver": - case "SplSubject": - case "SplObjectStorage": - case "JsonSerializable": - return ""; - - // keywords - case "is": - if (nn !== "H1") { - return; - } - case "extends": - case "implements": - if (nn === "H1") { - return "
 "; - } - case "class": - case "enum": - case "interface": - case "namespace": - case "public": - case "protected": - case "private": - case "static": - case "final": - case "abstract": - case "self": - case "parent": - // phrases - case "Optional": - case "optional": - return ""; - } - - // class members - if (-1 !== (i = s.indexOf("::"))) { - t = s.substring(i+2); - if (!mdref.is_constant(t) && !mdref.is_variable(t)) { - // methods - return ""; - } - } - if (-1 !== (j = s.lastIndexOf("\\")) && s.substr(j+1,1) !== "n") { - t = s.substring(j+1); - if (!mdref.is_constant(t) || s.match(/\\/g).length <= 1) { - return ""; - } - return ""; - } - - switch (s.toLowerCase()) { - // variables - default: - if (!mdref.is_variable(s)) { - break; - } - // special constants - case "null": - case "true": - case "false": - return ""; - } - - // constants - if (mdref.is_constant(s)) { - return ""; - } - }, - wrap: function wrap(n, nn) { - var $n = $(n) - var a = []; - - $n.text().split(/([^a-zA-Z0-9_\\\$:]+)/).forEach(function(v) { - var t; - - if ((t = mdref.type(v.replace(/:$/, ""), nn))) { - a.push($(t).text(v)); - } else if (a.length && a[a.length-1].nodeName === "#text") { - /* if we already have a text node and the next is also gonna be a text - * node, then join them, becuase chrome v30+ or something eats whitespace - * for breakfast, lunch and dinner! - */ - a[a.length-1].textContent += v; - } else { - a.push(document.createTextNode(v)); - } - }); - $n.replaceWith(a); - }, - walk: function walk(i, e) { - // mdref.log("walk", i, e); - - switch (e.nodeName) { - case "H1": - case "H2": - case "H3": - case "H4": - case "H5": - case "H6": - if (e.id.length) { - var href = document.location.pathname; - var perm = $("#"); - if (e.nodeName === "H1") { - perm.prependTo(e); - } else { - perm.attr("href", function(i, href) { - return href + e.id; - }); - perm.appendTo(e); - } - } - break; - } - - $.each($.makeArray(e.childNodes), function(i, n) { - switch (n.nodeName) { - case "A": - case "BR": - case "HR": - case "EM": - case "CODE": - case "SPAN": - break; - case "#text": - mdref.wrap(n, e.nodeName); - break; - default: - mdref.walk(-1, n); - break; - } - }); - }, - blink: function blink(c) { - var $c = $(c); - - $c.fadeOut("fast").queue(function(next) { - this.style.color = "red"; - next(); - }).fadeIn("fast").fadeOut("slow").queue(function(next) { - this.style.color = ""; - next(); - }).fadeIn("slow"); - }, - hashchange: function hashchange() { - if (location.hash.length > 1) { - var e; - if ((e = document.getElementById(location.hash.substring(1)))) { - mdref.blink(e); - } else { - var hash = location.hash.substring(1); - var name = mdref.is_variable(hash) ? ".var" : ".constant"; - var scrolled = false; - - $(name).each(hash.substring(hash.length-1) === "_" ? function(i, c) { - if (c.textContent.substring(0, hash.length) === hash) { - if (!scrolled) { - $(window).scrollTop($(c).offset().top - 100); - scrolled = true; - } - mdref.blink(c); - } - } : function(i, c) { - if (c.textContent === hash) { - $(window).scrollTop($(c).offset().top - 100); - mdref.blink(c); - return false; - } - }); - } - } - } - }; - - $("h1,h2,h3,h4,h5,h6,p,li,code,td").each(mdref.walk); - $(window).on("hashchange", mdref.hashchange); - mdref.hashchange(); - - $("#disqus_activator").on("click", function() { - var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; - dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js'; - (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); - }); - $.ajax("https://disqus.com/api/3.0/threads/details.json?thread:ident="+(disqus_identifier||"index")+"&forum=mdref&api_key=VmhVG4z5jjtY8SCaMstOjfUuwniMv43Xy9FCU9YfEzhsrl95dNz1epykXSJn8jt9"). then(function(json) { - if (json && json.response) { - $("#disqus_activator span").text(json.response.posts); - } - }); - setTimeout(function() { - $("footer").addClass("hidden"); - }, 1000); -}); diff --git a/docs/html/ion.html b/docs/html/ion.html deleted file mode 100644 index 658a805..0000000 --- a/docs/html/ion.html +++ /dev/null @@ -1,424 +0,0 @@ - - - - - - ion - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

pecl/ion

-

About:

-

PHP extension wrapping amzn/ion-c. -See the Amazon ION specification.

-

License:

-

BSD-2-Clause; -see spdx.org.

-

Installation:

-

PECL and PHARext is WIP.

-

Dependencies:

-

Required:

-
    -
  • PHP-8.1 -
      -
    • ext/date (standard)
      • -
    • ext/spl (standard)
      • -
    -
    • -
-

Optional:

- -

Trinity:

-
phpize
-./configure
-make # -j$(nproc)
-sudo make install # INSTALL=install
-
-

Try with Docker:

-
docker build -t php-ion
-docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\Table\PHP());'
-
-

Editor Stub:

-

See ion.stub.php.

-

Known Issues:

-

Due to private internal state of ion-c's readers and writers, -instances of the following PHP classes cannot be cloned:

-
    -
  • ion\Reader\Reader
    • -
  • ion\Writer\Writer
    • -
  • ion\Serializer\PHP
    • -
  • ion\Unserializer\PHP
    • -
- - - -

Functions:

-
    - -
  • -

    serialize

    -

    Serialize a PHP value as ION data.

    - -

    string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL])

    -
    • - -
  • -

    unserialize

    -

    Unserialize ION data (stream) as PHP value(s).

    - -

    mixed ion\unserialize(string|resource $data, [?ion\Unserializer $unserializer = NULL])

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Catalog

    -

    The Catalog holds a collection of ion\Symbol\Table instances queried from ion\Reader and ion\Writer instances.

    - -

    class ion\Catalog implements Countable

    -
    • - -
  • -

    Decimal

    -

    An arbitrary precision fixed point decimal.

    - -

    class ion\Decimal implements Stringable

    -
    • - -
  • -

    Exception

    -

    Base exception for the ION extension.

    - -

    class ion\Exception extends Exception implements Stringable, Throwable

    -
    • - -
  • -

    LOB

    -

    A large object.

    - -

    class ion\LOB

    -
    • - -
  • -

    Reader

    -

    ION reader API.

    - -

    interface ion\Reader implements Iterator, RecursiveIterator, Traversable

    -
    • - -
  • -

    Serializer

    -

    Serializer interface, used to customize ion\serialize()'s behavior.

    - -

    interface ion\Serializer

    -
    • - -
  • -

    Symbol

    - -

    class ion\Symbol implements Stringable

    -
    • - -
  • -

    Timestamp

    -

    An ION Timestamp.

    - -

    class ion\Timestamp extends DateTime implements DateTimeInterface, Stringable

    -
    • - -
  • -

    Type

    -

    ION data type.

    - -

    enum ion\Type implements BackedEnum, UnitEnum

    -
    • - -
  • -

    Unserializer

    -

    Unserializer interface, used to customize ion\unserialize()'s behavior.

    - -

    interface ion\Unserializer

    -
    • - -
  • -

    Writer

    -

    ION writer API.

    - -

    interface ion\Writer

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Catalog.html b/docs/html/ion/Catalog.html deleted file mode 100644 index 7c334e8..0000000 --- a/docs/html/ion/Catalog.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - Catalog - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Catalog implements Countable

-

The Catalog holds a collection of ion\Symbol\Table instances queried from ion\Reader and ion\Writer instances.

-

See also the ION spec's symbol guide chapter on catalog..

-

Constants:

-

None.

-

Properties:

-
    -
  • private array $symbolTables = array ( -)
    -Internal cache.
    • -
- - - -

Functions:

-
    - -
  • -

    Catalog::__construct

    -

    Create a new Catalog.

    - -

    void ion\Catalog::__construct()

    -
    • - -
  • -

    Catalog::add

    -

    Add a shared symbol table to the catalog.

    - -

    void ion\Catalog::add(ion\Symbol\Table $table)

    -
    • - -
  • -

    Catalog::find

    -

    Find a shared symbol table within the catalog.

    - -

    ?ion\Symbol\Table ion\Catalog::find(string $name, [int $version = 0])

    -
    • - -
  • -

    Catalog::findBest

    -

    Find a "best match" for a shared symbol table within the catalog.

    - -

    ?ion\Symbol\Table ion\Catalog::findBest(string $name, [int $version = 0])

    -
    • - -
  • -

    Catalog::remove

    -

    Remove a shared symbol table from the catalog.

    - -

    bool ion\Catalog::remove(ion\Symbol\Table|string $table)

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Catalog/__construct.html b/docs/html/ion/Catalog/__construct.html deleted file mode 100644 index 5313440..0000000 --- a/docs/html/ion/Catalog/__construct.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - Catalog::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Catalog::__construct()

-

Create a new Catalog.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Catalog/add.html b/docs/html/ion/Catalog/add.html deleted file mode 100644 index 9fb5872..0000000 --- a/docs/html/ion/Catalog/add.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Catalog::add - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Catalog::add(ion\Symbol\Table $table)

-

Add a shared symbol table to the catalog.

-

Params:

-
    -
  • ion\Symbol\Table $table
    -The new table to add.
    • -
-

Returns:

-
    -
  • void,
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Catalog/find.html b/docs/html/ion/Catalog/find.html deleted file mode 100644 index 651d912..0000000 --- a/docs/html/ion/Catalog/find.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Catalog::find - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

?ion\Symbol\Table ion\Catalog::find(string $name, [int $version = 0])

-

Find a shared symbol table within the catalog.

-

Params:

-
    -
  • string $name
    -The name of the symbol table.
    • -
  • Optional int $version = 0
    -The version the symbol table should match.
    • -
-

Returns:

-
    -
  • \Symbol\Table|null, The symbol table found, if any.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Catalog/findBest.html b/docs/html/ion/Catalog/findBest.html deleted file mode 100644 index 54ad399..0000000 --- a/docs/html/ion/Catalog/findBest.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Catalog::findBest - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

?ion\Symbol\Table ion\Catalog::findBest(string $name, [int $version = 0])

-

Find a "best match" for a shared symbol table within the catalog.

-

Params:

-
    -
  • string $name
    -The name of the symbol table,
    • -
  • Optional int $version = 0
    -The minimum version of the symbol table.
    • -
-

Returns:

-
    -
  • \Symbol\Table|null, The symbol table found, if any.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Catalog/remove.html b/docs/html/ion/Catalog/remove.html deleted file mode 100644 index 9bb62ff..0000000 --- a/docs/html/ion/Catalog/remove.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Catalog::remove - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Catalog::remove(ion\Symbol\Table|string $table)

-

Remove a shared symbol table from the catalog.

-

Params:

-
    -
  • ion\Symbol\Table|string $table
    -The symbol table to renmove.
    • -
-

Returns:

-
    -
  • bool, Success.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal.html b/docs/html/ion/Decimal.html deleted file mode 100644 index 4cec146..0000000 --- a/docs/html/ion/Decimal.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - Decimal - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Decimal implements Stringable

-

An arbitrary precision fixed point decimal.

-

See also \ion\Decimal\Context, and the ION spec's decimal docs.

-

Constants:

-

None.

-

Properties:

-
    -
  • public string|int $number
    -The decimal number.
    • -
  • public ?ion\Decimal\Context $context
    -The decimal context.
    • -
- - - -

Functions:

-
    - -
  • -

    Decimal::__construct

    -

    Create a new fixed point decimal.

    - -

    void ion\Decimal::__construct(string|int $number, [?ion\Decimal\Context $context = NULL])

    -
    • - -
  • -

    Decimal::equals

    -

    Check two decimals for equality.

    - -

    bool ion\Decimal::equals(ion\Decimal $decimal)

    -
    • - -
  • -

    Decimal::isInt

    -

    Check whether the decimal is actually a big integer.

    - -

    bool ion\Decimal::isInt()

    -
    • - -
  • -

    Decimal::toInt

    -

    Get the integer represention of the decimal.

    - -

    int ion\Decimal::toInt()

    -
    • - -
  • -

    Decimal::toString

    -

    Get the string representation of the decimal.

    - -

    string ion\Decimal::toString()

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Context

    -

    An ion\Decimal's context.

    - -

    class ion\Decimal\Context

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/Context.html b/docs/html/ion/Decimal/Context.html deleted file mode 100644 index bb059be..0000000 --- a/docs/html/ion/Decimal/Context.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - Context - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Decimal\Context

-

An ion\Decimal's context.

-

Constants:

-

None.

-

Properties:

-
    -
  • public int $digits
    -Maximum digits.
    • -
  • public int $eMax
    -Maximum exponent.
    • -
  • public int $eMin
    -Minimum exponent.
    • -
  • public ion\Decimal\Context\Rounding|int $round
    -Rounding mode.
    • -
  • public bool $clamp
    -Whether to clamp.
    • -
- - - -

Functions:

-
    - -
  • -

    Context::__construct

    -

    Create a new decimal context.

    - -

    void ion\Decimal\Context::__construct(int $digits, int $eMax, int $eMin, ion\Decimal\Context\Rounding|int $round, bool $clamp)

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Dec128

    -

    Create a context suitable for 128bit decimals.

    - -

    static ion\Decimal\Context ion\Decimal\Context::Dec128()

    -
    • - -
  • -

    Dec32

    -

    Create a context suitable for 32bit decimals.

    - -

    static ion\Decimal\Context ion\Decimal\Context::Dec32()

    -
    • - -
  • -

    Dec64

    -

    Create a context suitable for 64bit decimals.

    - -

    static ion\Decimal\Context ion\Decimal\Context::Dec64()

    -
    • - -
  • -

    DecMax

    -

    Create a context with maximum settings.

    - -

    static ion\Decimal\Context ion\Decimal\Context::DecMax([ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven])

    -
    • - -
  • -

    Rounding

    -

    Rounding mode.

    - -

    enum ion\Decimal\Context\Rounding implements BackedEnum, UnitEnum

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/Context/Dec128.html b/docs/html/ion/Decimal/Context/Dec128.html deleted file mode 100644 index 2f390c6..0000000 --- a/docs/html/ion/Decimal/Context/Dec128.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Dec128 - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

static ion\Decimal\Context ion\Decimal\Context::Dec128()

-

Create a context suitable for 128bit decimals.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/Context/Dec32.html b/docs/html/ion/Decimal/Context/Dec32.html deleted file mode 100644 index bfcf16b..0000000 --- a/docs/html/ion/Decimal/Context/Dec32.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Dec32 - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

static ion\Decimal\Context ion\Decimal\Context::Dec32()

-

Create a context suitable for 32bit decimals.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/Context/Dec64.html b/docs/html/ion/Decimal/Context/Dec64.html deleted file mode 100644 index 36cce0d..0000000 --- a/docs/html/ion/Decimal/Context/Dec64.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Dec64 - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

static ion\Decimal\Context ion\Decimal\Context::Dec64()

-

Create a context suitable for 64bit decimals.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/Context/DecMax.html b/docs/html/ion/Decimal/Context/DecMax.html deleted file mode 100644 index e23cf8f..0000000 --- a/docs/html/ion/Decimal/Context/DecMax.html +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - DecMax - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

static ion\Decimal\Context ion\Decimal\Context::DecMax([ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven])

-

Create a context with maximum settings.

-

Params:

-
    -
  • Optional ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven
    -Rounding mode.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/Context/Rounding.html b/docs/html/ion/Decimal/Context/Rounding.html deleted file mode 100644 index 16c903a..0000000 --- a/docs/html/ion/Decimal/Context/Rounding.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Rounding - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

enum ion\Decimal\Context\Rounding implements BackedEnum, UnitEnum

-

Rounding mode.

-

Constants:

-
    -
  • -Ceiling = 0 -
    • -
  • -Up = 1 -
    • -
  • -HalfUp = 2 -
    • -
  • -HalfEven = 3 -
    • -
  • -HalfDown = 4 -
    • -
  • -Down = 5 -
    • -
  • -Floor = 6 -
    • -
  • -Down05Up = 7 -
    • -
-

Properties:

-
    -
  • public string $name
    -Rounding mode.
    • -
  • public int $value
    -Rounding mode.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/Context/__construct.html b/docs/html/ion/Decimal/Context/__construct.html deleted file mode 100644 index 9a71e37..0000000 --- a/docs/html/ion/Decimal/Context/__construct.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Context::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Decimal\Context::__construct(int $digits, int $eMax, int $eMin, ion\Decimal\Context\Rounding|int $round, bool $clamp)

-

Create a new decimal context.

-

Params:

-
    -
  • int $digits
    -Maximum digits.
    • -
  • int $eMax
    -Maximum exponent.
    • -
  • int $eMin
    -Minimum exponent.
    • -
  • ion\Decimal\Context\Rounding|int $round
    -Rounding mode.
    • -
  • bool $clamp
    -Whether to clamp.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/__construct.html b/docs/html/ion/Decimal/__construct.html deleted file mode 100644 index e870037..0000000 --- a/docs/html/ion/Decimal/__construct.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - Decimal::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Decimal::__construct(string|int $number, [?ion\Decimal\Context $context = NULL])

-

Create a new fixed point decimal.

-

Params:

-
    -
  • string|int $number
    -The decimal number.
    • -
  • Optional ?ion\Decimal\Context $context = NULL
    -The decimal context.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/equals.html b/docs/html/ion/Decimal/equals.html deleted file mode 100644 index 90c7569..0000000 --- a/docs/html/ion/Decimal/equals.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Decimal::equals - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Decimal::equals(ion\Decimal $decimal)

-

Check two decimals for equality.

-

Params:

-
    -
  • ion\Decimal $decimal
    -The decimal to compare to.
    • -
-

Returns:

-
    -
  • bool, Whether both decimals equal.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/isInt.html b/docs/html/ion/Decimal/isInt.html deleted file mode 100644 index 4fd1e89..0000000 --- a/docs/html/ion/Decimal/isInt.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Decimal::isInt - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Decimal::isInt()

-

Check whether the decimal is actually a big integer.

-

Params:

-

None.

-

Returns:

-
    -
  • bool, Whether the decimal is actually an integer.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/toInt.html b/docs/html/ion/Decimal/toInt.html deleted file mode 100644 index 74a71fc..0000000 --- a/docs/html/ion/Decimal/toInt.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Decimal::toInt - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Decimal::toInt()

-

Get the integer represention of the decimal.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Decimal/toString.html b/docs/html/ion/Decimal/toString.html deleted file mode 100644 index 53cac70..0000000 --- a/docs/html/ion/Decimal/toString.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - Decimal::toString - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Decimal::toString()

-

Get the string representation of the decimal.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Exception.html b/docs/html/ion/Exception.html deleted file mode 100644 index a940a87..0000000 --- a/docs/html/ion/Exception.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Exception - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Exception extends Exception implements Stringable, Throwable

-

Base exception for the ION extension.

-

Constants:

-

None.

-

Properties:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/LOB.html b/docs/html/ion/LOB.html deleted file mode 100644 index db8cca9..0000000 --- a/docs/html/ion/LOB.html +++ /dev/null @@ -1,136 +0,0 @@ - - - - - - LOB - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\LOB

-

A large object.

-

See also \ion\Type, the ION spec's BLob definition, and the ION sepc's CLob definition.

-

Constants:

-

None.

-

Properties:

-
    -
  • public string $value
    -The value of the large object.
    • -
  • public ion\Type $type
    -The type (CLob/BLob).
    • -
- - - -

Functions:

-
    - -
  • -

    LOB::__construct

    -

    Create an ION large object.

    - -

    void ion\LOB::__construct(string $value, [ion\Type $type = ion\Type::CLob])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/LOB/__construct.html b/docs/html/ion/LOB/__construct.html deleted file mode 100644 index d63b348..0000000 --- a/docs/html/ion/LOB/__construct.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - LOB::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\LOB::__construct(string $value, [ion\Type $type = ion\Type::CLob])

-

Create an ION large object.

-

Params:

-
    -
  • string $value
    -The value of the large object.
    • -
  • Optional ion\Type $type = ion\Type::CLob
    -The type (CLob/BLob).
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader.html b/docs/html/ion/Reader.html deleted file mode 100644 index 6451871..0000000 --- a/docs/html/ion/Reader.html +++ /dev/null @@ -1,493 +0,0 @@ - - - - - - Reader - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Reader implements Iterator, RecursiveIterator, Traversable

-

ION reader API.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

- - - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Buffer

    -

    ION string buffer reader API.

    - -

    interface ion\Reader\Buffer implements Iterator, RecursiveIterator, Traversable, ion\Reader

    -
    • - -
  • -

    Options

    -

    Reader options.

    - -

    class ion\Reader\Options

    -
    • - -
  • -

    Reader

    -

    Base implementation of ION readers.

    - -

    abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader

    -
    • - -
  • -

    Stream

    -

    ION stream reader API.

    - -

    interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Buffer.html b/docs/html/ion/Reader/Buffer.html deleted file mode 100644 index 8eb93fc..0000000 --- a/docs/html/ion/Reader/Buffer.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - Buffer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Reader\Buffer implements Iterator, RecursiveIterator, Traversable, ion\Reader

-

ION string buffer reader API.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Buffer::getBuffer

    -

    Get the buffer read from.

    - -

    string ion\Reader\Buffer::getBuffer()

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Reader

    -

    ION string buffer reader.

    - -

    class ion\Reader\Buffer\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Buffer

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Buffer/Reader.html b/docs/html/ion/Reader/Buffer/Reader.html deleted file mode 100644 index a1efec1..0000000 --- a/docs/html/ion/Reader/Buffer/Reader.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Reader - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Reader\Buffer\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Buffer

-

ION string buffer reader.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Reader::__construct

    -

    Create a new string buffer reader.

    - -

    void ion\Reader\Buffer\Reader::__construct(string $buffer, [?ion\Reader\Options $options = NULL])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Buffer/Reader/__construct.html b/docs/html/ion/Reader/Buffer/Reader/__construct.html deleted file mode 100644 index 8b1e7d5..0000000 --- a/docs/html/ion/Reader/Buffer/Reader/__construct.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Reader::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Reader\Buffer\Reader::__construct(string $buffer, [?ion\Reader\Options $options = NULL])

-

Create a new string buffer reader.

-

Params:

-
    -
  • string $buffer
    -The buffer to read from.
    • -
  • Optional ?ion\Reader\Options $options = NULL
    -Reader options.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Buffer/getBuffer.html b/docs/html/ion/Reader/Buffer/getBuffer.html deleted file mode 100644 index f3f89f2..0000000 --- a/docs/html/ion/Reader/Buffer/getBuffer.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Buffer::getBuffer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Reader\Buffer::getBuffer()

-

Get the buffer read from.

-

Params:

-

None.

-

Returns:

-
    -
  • string, The buffer read from.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Options.html b/docs/html/ion/Reader/Options.html deleted file mode 100644 index 467f6cb..0000000 --- a/docs/html/ion/Reader/Options.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - Options - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Reader\Options

-

Reader options.

-

Constants:

-

None.

-

Properties:

-
    -
  • public ?ion\Catalog $catalog
    -ION catalog to use for symbol lookup.
    • -
  • public ?ion\Decimal\Context $decimalContext
    -Decimal context to use.
    • -
  • public ?Closure $onContextChange
    -Callback as function(\ion\Reader):void called upon local symbol table context change.
    • -
  • public bool $returnSystemValues
    -Whether to return otherwise hidden system values.
    • -
  • public int $maxContainerDepth
    -The maximum depth of nested containers.
    • -
  • public int $maxAnnotations
    -The maximum number of annotations allowed on a single value.
    • -
  • public int $annotationBufferSize
    -The maximum number of bytes of all annotations on a single value.
    • -
  • public int $tempBufferSize
    -The maximum number of bytes of a symbol/value/chunk.
    • -
  • public bool $skipCharacterValidation
    -Whether to skip UTF-8 validation.
    • -
- - - -

Functions:

-
    - -
  • -

    Options::__construct

    - -

    void ion\Reader\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [?Closure $onContextChange = NULL, [bool $returnSystemValues = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $annotationBufferSize = 16384, [int $tempBufferSize = 16384, [bool $skipCharacterValidation = false]]]]]]]]])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Options/__construct.html b/docs/html/ion/Reader/Options/__construct.html deleted file mode 100644 index 056e165..0000000 --- a/docs/html/ion/Reader/Options/__construct.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Options::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Reader\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [?Closure $onContextChange = NULL, [bool $returnSystemValues = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $annotationBufferSize = 16384, [int $tempBufferSize = 16384, [bool $skipCharacterValidation = false]]]]]]]]])

-

Params:

-
    -
  • Optional ?ion\Catalog $catalog = NULL
    -ION catalog to use for symbol lookup.
    • -
  • Optional ?ion\Decimal\Context $decimalContext = NULL
    -Decimal context to use.
    • -
  • Optional ?Closure $onContextChange = NULL
    -Callback as function(\ion\Reader):void called upon local symbol table context change.
    • -
  • Optional bool $returnSystemValues = false
    -Whether to return otherwise hidden system values.
    • -
  • Optional int $maxContainerDepth = 10
    -The maximum depth of nested containers.
    • -
  • Optional int $maxAnnotations = 10
    -The maximum number of annotations allowed on a single value.
    • -
  • Optional int $annotationBufferSize = 16384
    -The maximum number of bytes of all annotations on a single value.
    • -
  • Optional int $tempBufferSize = 16384
    -The maximum number of bytes of a symbol/value/chunk.
    • -
  • Optional bool $skipCharacterValidation = false
    -Whether to skip UTF-8 validation.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Reader.html b/docs/html/ion/Reader/Reader.html deleted file mode 100644 index da785dc..0000000 --- a/docs/html/ion/Reader/Reader.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Reader - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader

-

Base implementation of ION readers.

-

Constants:

-

None.

-

Properties:

-
    -
  • public ?ion\Reader\Options $options
    -Reader options.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Stream.html b/docs/html/ion/Reader/Stream.html deleted file mode 100644 index a04ea7f..0000000 --- a/docs/html/ion/Reader/Stream.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - Stream - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader

-

ION stream reader API.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Stream::getStream

    -

    Get the stream read from.

    - -

    void ion\Reader\Stream::getStream()

    -
    • - -
  • -

    Stream::resetStream

    -

    Reset the stream read from.

    - -

    void ion\Reader\Stream::resetStream(resource $stream)

    -
    • - -
  • -

    Stream::resetStreamWithLength

    -

    Reset the stream read from, limiting length to read.

    - -

    void ion\Reader\Stream::resetStreamWithLength(resource $stream, int $length)

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Reader

    -

    ION stream reader.

    - -

    class ion\Reader\Stream\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Stream

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Stream/Reader.html b/docs/html/ion/Reader/Stream/Reader.html deleted file mode 100644 index d411ad4..0000000 --- a/docs/html/ion/Reader/Stream/Reader.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Reader - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Reader\Stream\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Stream

-

ION stream reader.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Reader::__construct

    -

    Create a new stream reader.

    - -

    void ion\Reader\Stream\Reader::__construct(resource $stream, [?ion\Reader\Options $options = NULL])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Stream/Reader/__construct.html b/docs/html/ion/Reader/Stream/Reader/__construct.html deleted file mode 100644 index c7e694e..0000000 --- a/docs/html/ion/Reader/Stream/Reader/__construct.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Reader::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Reader\Stream\Reader::__construct(resource $stream, [?ion\Reader\Options $options = NULL])

-

Create a new stream reader.

-

Params:

-
    -
  • resource $stream
    -The stream to read from.
    • -
  • Optional ?ion\Reader\Options $options = NULL
    -Reader options.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Stream/getStream.html b/docs/html/ion/Reader/Stream/getStream.html deleted file mode 100644 index 592c67a..0000000 --- a/docs/html/ion/Reader/Stream/getStream.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Stream::getStream - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Reader\Stream::getStream()

-

Get the stream read from.

-

Params:

-

None.

-

Returns:

-
    -
  • resource, The stream read from.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Stream/resetStream.html b/docs/html/ion/Reader/Stream/resetStream.html deleted file mode 100644 index 5f3c4be..0000000 --- a/docs/html/ion/Reader/Stream/resetStream.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Stream::resetStream - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Reader\Stream::resetStream(resource $stream)

-

Reset the stream read from.

-

Params:

-
    -
  • resource $stream
    -The new stream to from.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/Stream/resetStreamWithLength.html b/docs/html/ion/Reader/Stream/resetStreamWithLength.html deleted file mode 100644 index 6a2d440..0000000 --- a/docs/html/ion/Reader/Stream/resetStreamWithLength.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Stream::resetStreamWithLength - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Reader\Stream::resetStreamWithLength(resource $stream, int $length)

-

Reset the stream read from, limiting length to read.

-

Params:

-
    -
  • resource $stream
    -The stream to read from.
    • -
  • int $length
    -The maximum length to read from $stream.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/countAnnotations.html b/docs/html/ion/Reader/countAnnotations.html deleted file mode 100644 index 677a675..0000000 --- a/docs/html/ion/Reader/countAnnotations.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::countAnnotations - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Reader::countAnnotations()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getAnnotation.html b/docs/html/ion/Reader/getAnnotation.html deleted file mode 100644 index 4b1f8c7..0000000 --- a/docs/html/ion/Reader/getAnnotation.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - Reader::getAnnotation - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Reader::getAnnotation(int $index)

-

Params:

-
    -
  • int $index
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getAnnotationSymbol.html b/docs/html/ion/Reader/getAnnotationSymbol.html deleted file mode 100644 index 16f9d3c..0000000 --- a/docs/html/ion/Reader/getAnnotationSymbol.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - Reader::getAnnotationSymbol - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Symbol ion\Reader::getAnnotationSymbol(int $index)

-

Params:

-
    -
  • int $index
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getAnnotationSymbols.html b/docs/html/ion/Reader/getAnnotationSymbols.html deleted file mode 100644 index b074cc6..0000000 --- a/docs/html/ion/Reader/getAnnotationSymbols.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getAnnotationSymbols - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

array ion\Reader::getAnnotationSymbols()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getAnnotations.html b/docs/html/ion/Reader/getAnnotations.html deleted file mode 100644 index bf02c2b..0000000 --- a/docs/html/ion/Reader/getAnnotations.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getAnnotations - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

array ion\Reader::getAnnotations()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getDepth.html b/docs/html/ion/Reader/getDepth.html deleted file mode 100644 index 3cb3057..0000000 --- a/docs/html/ion/Reader/getDepth.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getDepth - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Reader::getDepth()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getFieldName.html b/docs/html/ion/Reader/getFieldName.html deleted file mode 100644 index 0d1ab30..0000000 --- a/docs/html/ion/Reader/getFieldName.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getFieldName - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Reader::getFieldName()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getFieldNameSymbol.html b/docs/html/ion/Reader/getFieldNameSymbol.html deleted file mode 100644 index fc88526..0000000 --- a/docs/html/ion/Reader/getFieldNameSymbol.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getFieldNameSymbol - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Symbol ion\Reader::getFieldNameSymbol()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getPosition.html b/docs/html/ion/Reader/getPosition.html deleted file mode 100644 index 90620ad..0000000 --- a/docs/html/ion/Reader/getPosition.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getPosition - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Reader::getPosition()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getType.html b/docs/html/ion/Reader/getType.html deleted file mode 100644 index cf6c3bc..0000000 --- a/docs/html/ion/Reader/getType.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getType - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Type ion\Reader::getType()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getValueLength.html b/docs/html/ion/Reader/getValueLength.html deleted file mode 100644 index 87ad9a5..0000000 --- a/docs/html/ion/Reader/getValueLength.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getValueLength - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Reader::getValueLength()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/getValueOffset.html b/docs/html/ion/Reader/getValueOffset.html deleted file mode 100644 index 40ea04b..0000000 --- a/docs/html/ion/Reader/getValueOffset.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::getValueOffset - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Reader::getValueOffset()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/hasAnnotation.html b/docs/html/ion/Reader/hasAnnotation.html deleted file mode 100644 index c62c923..0000000 --- a/docs/html/ion/Reader/hasAnnotation.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - Reader::hasAnnotation - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Reader::hasAnnotation(string $annotation)

-

Params:

-
    -
  • string $annotation
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/hasAnnotations.html b/docs/html/ion/Reader/hasAnnotations.html deleted file mode 100644 index b943aa5..0000000 --- a/docs/html/ion/Reader/hasAnnotations.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::hasAnnotations - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Reader::hasAnnotations()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/isInStruct.html b/docs/html/ion/Reader/isInStruct.html deleted file mode 100644 index bf55eae..0000000 --- a/docs/html/ion/Reader/isInStruct.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::isInStruct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Reader::isInStruct()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/isNull.html b/docs/html/ion/Reader/isNull.html deleted file mode 100644 index e3191c0..0000000 --- a/docs/html/ion/Reader/isNull.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::isNull - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Reader::isNull()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readBool.html b/docs/html/ion/Reader/readBool.html deleted file mode 100644 index 722c20e..0000000 --- a/docs/html/ion/Reader/readBool.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readBool - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Reader::readBool()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readDecimal.html b/docs/html/ion/Reader/readDecimal.html deleted file mode 100644 index bde9c02..0000000 --- a/docs/html/ion/Reader/readDecimal.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readDecimal - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Decimal ion\Reader::readDecimal()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readFloat.html b/docs/html/ion/Reader/readFloat.html deleted file mode 100644 index cb3c7c7..0000000 --- a/docs/html/ion/Reader/readFloat.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readFloat - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

float ion\Reader::readFloat()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readInt.html b/docs/html/ion/Reader/readInt.html deleted file mode 100644 index 9927f00..0000000 --- a/docs/html/ion/Reader/readInt.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readInt - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string|int ion\Reader::readInt()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readLob.html b/docs/html/ion/Reader/readLob.html deleted file mode 100644 index 7cbd465..0000000 --- a/docs/html/ion/Reader/readLob.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readLob - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Reader::readLob()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readLobPart.html b/docs/html/ion/Reader/readLobPart.html deleted file mode 100644 index 7e1fb35..0000000 --- a/docs/html/ion/Reader/readLobPart.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Reader::readLobPart - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Reader::readLobPart( &$string, [int $length = 4096])

-

Params:

-
    -
  • -

    Reference &$string

    -
    • -
  • -

    Optional int $length = 4096

    -
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readNull.html b/docs/html/ion/Reader/readNull.html deleted file mode 100644 index 05b2df3..0000000 --- a/docs/html/ion/Reader/readNull.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readNull - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Type ion\Reader::readNull()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readString.html b/docs/html/ion/Reader/readString.html deleted file mode 100644 index a49dc33..0000000 --- a/docs/html/ion/Reader/readString.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readString - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Reader::readString()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readStringPart.html b/docs/html/ion/Reader/readStringPart.html deleted file mode 100644 index da5d5e0..0000000 --- a/docs/html/ion/Reader/readStringPart.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - Reader::readStringPart - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Reader::readStringPart( &$string, [int $length = 4096])

-

Params:

-
    -
  • -

    Reference &$string

    -
    • -
  • -

    Optional int $length = 4096

    -
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readSymbol.html b/docs/html/ion/Reader/readSymbol.html deleted file mode 100644 index 9716f1d..0000000 --- a/docs/html/ion/Reader/readSymbol.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readSymbol - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Symbol ion\Reader::readSymbol()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/readTimestamp.html b/docs/html/ion/Reader/readTimestamp.html deleted file mode 100644 index bdd93ae..0000000 --- a/docs/html/ion/Reader/readTimestamp.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Reader::readTimestamp - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Timestamp ion\Reader::readTimestamp()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Reader/seek.html b/docs/html/ion/Reader/seek.html deleted file mode 100644 index e32da8c..0000000 --- a/docs/html/ion/Reader/seek.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - Reader::seek - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Reader::seek(int $offset, [int $length = -1])

-

Params:

-
    -
  • int $offset
    • -
  • Optional int $length = -1
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Serializer.html b/docs/html/ion/Serializer.html deleted file mode 100644 index b37cbd9..0000000 --- a/docs/html/ion/Serializer.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - Serializer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Serializer

-

Serializer interface, used to customize ion\serialize()'s behavior.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

- - - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    PHP

    -

    Specialization of the serializer for PHP.

    - -

    class ion\Serializer\PHP implements ion\Serializer

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Serializer/PHP.html b/docs/html/ion/Serializer/PHP.html deleted file mode 100644 index 6417f09..0000000 --- a/docs/html/ion/Serializer/PHP.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - PHP - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Serializer\PHP implements ion\Serializer

-

Specialization of the serializer for PHP.

-

Constants:

-

None.

-

Properties:

-
    -
  • public ?ion\Writer\Options $writerOptions
    -Writer options.
    • -
  • public bool $multiSequence
    -Whether to write the top level array as multiple ION sequences.
    • -
  • public bool $callMagicSerialize
    -Whether to call magic __serialize() methods on objects to serialize.
    • -
  • public ?string $callCustomSerialize
    -Whether and which custom serialize method to call on objects to serialize.
    • -
- - - -

Functions:

-
    - -
  • -

    PHP::__construct

    -

    Create a new PHP ION serializer.

    - -

    void ion\Serializer\PHP::__construct([?ion\Writer\Options $writerOptions = NULL, [bool $multiSequence = false, [bool $callMagicSerialize = true, [?string $callCustomSerialize = NULL]]]])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Serializer/PHP/__construct.html b/docs/html/ion/Serializer/PHP/__construct.html deleted file mode 100644 index ac85ab2..0000000 --- a/docs/html/ion/Serializer/PHP/__construct.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - PHP::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Serializer\PHP::__construct([?ion\Writer\Options $writerOptions = NULL, [bool $multiSequence = false, [bool $callMagicSerialize = true, [?string $callCustomSerialize = NULL]]]])

-

Create a new PHP ION serializer.

-

Params:

-
    -
  • Optional ?ion\Writer\Options $writerOptions = NULL
    -Writer options.
    • -
  • Optional bool $multiSequence = false
    -Whether to write the top level array as multiple ION sequences.
    • -
  • Optional bool $callMagicSerialize = true
    -Whether to call magic __serialize() methods on objects to serialize.
    • -
  • Optional ?string $callCustomSerialize = NULL
    -Whether and which custom serialize method to call on objects to serialize.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Serializer/serialize.html b/docs/html/ion/Serializer/serialize.html deleted file mode 100644 index c48d81d..0000000 --- a/docs/html/ion/Serializer/serialize.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Serializer::serialize - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Serializer::serialize(mixed $data)

-

Params:

-
    -
  • mixed $data
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol.html b/docs/html/ion/Symbol.html deleted file mode 100644 index 6126ed1..0000000 --- a/docs/html/ion/Symbol.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - Symbol - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Symbol implements Stringable

-

See also ION spec's symbol definition, and ION spec's symbol guide.

-

Constants:

-

None.

-

Properties:

-
    -
  • public ?string $value
    -The symbol's text representation.
    • -
  • public int $sid
    -The symbols ID, referencing its location within a shared symbol table.
    • -
  • public ?ion\Symbol\ImportLocation $importLocation
    -The import location referencing a shared symbol table.
    • -
- - - -

Functions:

-
    - -
  • -

    Symbol::__construct

    -

    Create an ION symbol.

    - -

    void ion\Symbol::__construct([?string $value = NULL, [int $sid = -1, [?ion\Symbol\ImportLocation $importLocation = NULL]]])

    -
    • - -
  • -

    Symbol::equals

    -

    Compare two symbols for equality.

    - -

    bool ion\Symbol::equals(ion\Symbol $symbol)

    -
    • - -
  • -

    Symbol::toString

    - -

    string ion\Symbol::toString()

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Enum

    -

    Base interface of built-in shared symbol tables.

    - -

    interface ion\Symbol\Enum

    -
    • - -
  • -

    ImportLocation

    -

    The import location (referring to a shared table= of a symbol.

    - -

    class ion\Symbol\ImportLocation

    -
    • - -
  • -

    Table

    -

    Base interface of an ION symbol table.

    - -

    interface ion\Symbol\Table

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Enum.html b/docs/html/ion/Symbol/Enum.html deleted file mode 100644 index e8c5091..0000000 --- a/docs/html/ion/Symbol/Enum.html +++ /dev/null @@ -1,145 +0,0 @@ - - - - - - Enum - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Symbol\Enum

-

Base interface of built-in shared symbol tables.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

- - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Enum/toSID.html b/docs/html/ion/Symbol/Enum/toSID.html deleted file mode 100644 index ee3b8c1..0000000 --- a/docs/html/ion/Symbol/Enum/toSID.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Enum::toSID - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Symbol\Enum::toSID()

-

Params:

-

None.

-

Returns:

-
    -
  • int, The symbol id.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Enum/toString.html b/docs/html/ion/Symbol/Enum/toString.html deleted file mode 100644 index 6c1b152..0000000 --- a/docs/html/ion/Symbol/Enum/toString.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Enum::toString - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Symbol\Enum::toString()

-

Params:

-

None.

-

Returns:

-
    -
  • string, The symbol's textual representation.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Enum/toSymbol.html b/docs/html/ion/Symbol/Enum/toSymbol.html deleted file mode 100644 index 2c6207a..0000000 --- a/docs/html/ion/Symbol/Enum/toSymbol.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Enum::toSymbol - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

ion\Symbol ion\Symbol\Enum::toSymbol()

-

Params:

-

None.

-

Returns:

-
    -
  • \ion\Symbol, Instance of the symbol.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/ImportLocation.html b/docs/html/ion/Symbol/ImportLocation.html deleted file mode 100644 index 2e83a8d..0000000 --- a/docs/html/ion/Symbol/ImportLocation.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - ImportLocation - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Symbol\ImportLocation

-

The import location (referring to a shared table= of a symbol.

-

Constants:

-

None.

-

Properties:

-
    -
  • public string $name
    -The name of the shared symbol table.
    • -
  • public int $location
    -The location (sid) of the symbol within the table.
    • -
- - - -

Functions:

-
    - -
  • -

    ImportLocation::__construct

    -

    Create a new import location.

    - -

    void ion\Symbol\ImportLocation::__construct(string $name, int $location)

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/ImportLocation/__construct.html b/docs/html/ion/Symbol/ImportLocation/__construct.html deleted file mode 100644 index 28dd4ce..0000000 --- a/docs/html/ion/Symbol/ImportLocation/__construct.html +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - ImportLocation::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Symbol\ImportLocation::__construct(string $name, int $location)

-

Create a new import location.

-

Params:

-
    -
  • string $name
    -The name of the shared symbol table.
    • -
  • int $location
    -The location (sid) of the symbol within the table.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table.html b/docs/html/ion/Symbol/Table.html deleted file mode 100644 index d7b01ab..0000000 --- a/docs/html/ion/Symbol/Table.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - - - Table - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Symbol\Table

-

Base interface of an ION symbol table.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Table::add

    -

    Add a symbol to the table.

    - -

    int ion\Symbol\Table::add(ion\Symbol|string $symbol)

    -
    • - -
  • -

    Table::find

    -

    Find a symbol within the symbol table, including imports.

    - -

    ?ion\Symbol ion\Symbol\Table::find(string|int $id)

    -
    • - -
  • -

    Table::findLocal

    -

    Find a symbol within only this symbol table, ignoring imports.

    - -

    ?ion\Symbol ion\Symbol\Table::findLocal(string|int $id)

    -
    • - -
  • -

    Table::getMaxId

    -

    Get the maximum symbol ID within the symbol table.

    - -

    int ion\Symbol\Table::getMaxId()

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Local

    -

    A local symbol table.

    - -

    class ion\Symbol\Table\Local implements ion\Symbol\Table

    -
    • - -
  • -

    PHP

    -

    The built-in PHP symbols.

    - -

    enum ion\Symbol\Table\PHP implements BackedEnum, UnitEnum, ion\Symbol\Enum

    -
    • - -
  • -

    Shared

    -

    A shared symbol table.

    - -

    class ion\Symbol\Table\Shared implements ion\Symbol\Table

    -
    • - -
  • -

    System

    -

    The built-in ION system symbols.

    - -

    enum ion\Symbol\Table\System implements BackedEnum, UnitEnum, ion\Symbol\Enum

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/Local.html b/docs/html/ion/Symbol/Table/Local.html deleted file mode 100644 index 1ddb8ac..0000000 --- a/docs/html/ion/Symbol/Table/Local.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - Local - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Symbol\Table\Local implements ion\Symbol\Table

-

A local symbol table.

-

See also the ION spec's symbol guide, and the ION doc's cookbook.

-

Constants:

-

None.

-

Properties:

-
    -
  • private array $imports = array ( -)
    -Internal cache.
    • -
  • private array $symbols = array ( -)
    -Internal cache.
    • -
- - - -

Functions:

-
    - -
  • -

    Local::__construct

    -

    Create a local symbol table.

    - -

    void ion\Symbol\Table\Local::__construct()

    -
    • - -
  • -

    Local::import

    -

    Import a symbol table.

    - -

    void ion\Symbol\Table\Local::import(ion\Symbol\Table $table)

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/Local/__construct.html b/docs/html/ion/Symbol/Table/Local/__construct.html deleted file mode 100644 index a44ad64..0000000 --- a/docs/html/ion/Symbol/Table/Local/__construct.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Local::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Symbol\Table\Local::__construct()

-

Create a local symbol table.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/Local/import.html b/docs/html/ion/Symbol/Table/Local/import.html deleted file mode 100644 index 6e8edaf..0000000 --- a/docs/html/ion/Symbol/Table/Local/import.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - Local::import - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Symbol\Table\Local::import(ion\Symbol\Table $table)

-

Import a symbol table.

-

Params:

-
    -
  • ion\Symbol\Table $table
    -The symbol table to import.
    • -
-

Returns:

-
    -
  • void,
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/PHP.html b/docs/html/ion/Symbol/Table/PHP.html deleted file mode 100644 index 6b42b6b..0000000 --- a/docs/html/ion/Symbol/Table/PHP.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - PHP - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

enum ion\Symbol\Table\PHP implements BackedEnum, UnitEnum, ion\Symbol\Enum

-

The built-in PHP symbols.

-

Constants:

-
    -
  • -PHP = 'PHP' -
    • -
  • -Reference = 'R' -
    • -
  • -Backref = 'r' -
    • -
  • -Property = 'p' -
    • -
  • -Object = 'o' -
    • -
  • -ClassObject = 'c' -
    • -
  • -MagicObject = 'O' -
    • -
  • -CustomObject = 'C' -
    • -
  • -Enum = 'E' -
    • -
  • -Serializable = 'S' -
    • -
-

Properties:

-
    -
  • public string $name
    -The built-in PHP symbols.
    • -
  • public string $value
    -The built-in PHP symbols.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/Shared.html b/docs/html/ion/Symbol/Table/Shared.html deleted file mode 100644 index 38f37ed..0000000 --- a/docs/html/ion/Symbol/Table/Shared.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - Shared - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Symbol\Table\Shared implements ion\Symbol\Table

-

A shared symbol table.

-

See also the ION spec's symbol guide, and the ION doc's cookbook.

-

Constants:

-

None.

-

Properties:

-
    -
  • public string $name
    -The name of the shared symbol table.
    • -
  • public int $version
    -The version of the shared symbol table.
    • -
  • private array $symbols = array ( -)
    -Internal cache.
    • -
- - - -

Functions:

-
    - -
  • -

    Shared::__construct

    -

    Create a shared symbol table.

    - -

    void ion\Symbol\Table\Shared::__construct(string $name, [int $version = 1, [?array $symbols = NULL]])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/Shared/__construct.html b/docs/html/ion/Symbol/Table/Shared/__construct.html deleted file mode 100644 index 21b7d78..0000000 --- a/docs/html/ion/Symbol/Table/Shared/__construct.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - Shared::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Symbol\Table\Shared::__construct(string $name, [int $version = 1, [?array $symbols = NULL]])

-

Create a shared symbol table.

-

Params:

-
    -
  • string $name
    -The name of the shared symbol table.
    • -
  • Optional int $version = 1
    -The version of the shared symbol table.
    • -
  • Optional ?array $symbols = NULL
    -Internal cache.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/System.html b/docs/html/ion/Symbol/Table/System.html deleted file mode 100644 index 534a281..0000000 --- a/docs/html/ion/Symbol/Table/System.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - System - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

enum ion\Symbol\Table\System implements BackedEnum, UnitEnum, ion\Symbol\Enum

-

The built-in ION system symbols.

-

Constants:

-
    -
  • -Ion = '$ion' -
    • -
  • -Ivm_1_0 = '$ion_1_0' -
    • -
  • -IonSymbolTable = '$ion_symbol_table' -
    • -
  • -Name = 'name' -
    • -
  • -Version = 'version' -
    • -
  • -Imports = 'imports' -
    • -
  • -Symbols = 'symbols' -
    • -
  • -MaxId = 'max_id' -
    • -
  • -SharedSymbolTable = '$ion_shared_symbol_table' -
    • -
-

Properties:

-
    -
  • public string $name
    -The built-in ION system symbols.
    • -
  • public string $value
    -The built-in ION system symbols.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/add.html b/docs/html/ion/Symbol/Table/add.html deleted file mode 100644 index e79e62f..0000000 --- a/docs/html/ion/Symbol/Table/add.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Table::add - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Symbol\Table::add(ion\Symbol|string $symbol)

-

Add a symbol to the table.

-

Params:

-
    -
  • ion\Symbol|string $symbol
    -The symbol (value) to add.
    • -
-

Returns:

-
    -
  • int, The symbol ID.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/find.html b/docs/html/ion/Symbol/Table/find.html deleted file mode 100644 index 0a194fc..0000000 --- a/docs/html/ion/Symbol/Table/find.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Table::find - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

?ion\Symbol ion\Symbol\Table::find(string|int $id)

-

Find a symbol within the symbol table, including imports.

-

Params:

-
    -
  • string|int $id
    -The ID or text of the symbol to find.
    • -
-

Returns:

-
    -
  • \ion\Symbol|null, The symbol found, if any.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/findLocal.html b/docs/html/ion/Symbol/Table/findLocal.html deleted file mode 100644 index 8d82cd6..0000000 --- a/docs/html/ion/Symbol/Table/findLocal.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - Table::findLocal - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

?ion\Symbol ion\Symbol\Table::findLocal(string|int $id)

-

Find a symbol within only this symbol table, ignoring imports.

-

Params:

-
    -
  • string|int $id
    -The ID or text of the symbol to find.
    • -
-

Returns:

-
    -
  • \ion\Symbol|null, The symbol found, if any.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/Table/getMaxId.html b/docs/html/ion/Symbol/Table/getMaxId.html deleted file mode 100644 index 1cf67a1..0000000 --- a/docs/html/ion/Symbol/Table/getMaxId.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - Table::getMaxId - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Symbol\Table::getMaxId()

-

Get the maximum symbol ID within the symbol table.

-

Params:

-

None.

-

Returns:

-
    -
  • int, The maximum symbol ID.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/__construct.html b/docs/html/ion/Symbol/__construct.html deleted file mode 100644 index b14dcc9..0000000 --- a/docs/html/ion/Symbol/__construct.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - Symbol::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Symbol::__construct([?string $value = NULL, [int $sid = -1, [?ion\Symbol\ImportLocation $importLocation = NULL]]])

-

Create an ION symbol.

-

Params:

-
    -
  • Optional ?string $value = NULL
    -The symbol's text representation.
    • -
  • Optional int $sid = -1
    -The symbols ID, referencing its location within a shared symbol table.
    • -
  • Optional ?ion\Symbol\ImportLocation $importLocation = NULL
    -The import location referencing a shared symbol table.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/equals.html b/docs/html/ion/Symbol/equals.html deleted file mode 100644 index 8514f5b..0000000 --- a/docs/html/ion/Symbol/equals.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - Symbol::equals - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

bool ion\Symbol::equals(ion\Symbol $symbol)

-

Compare two symbols for equality.

-

Two symbols are considered equal, if either:

-
    -
  • both are the same object or NULL
    • -
  • both values are NULL (unknown text), and both $importLocations match
    • -
  • both values match, regardless of $sid and $importLocation
    • -
-

Params:

-
    -
  • ion\Symbol $symbol
    • -
-

Returns:

-
    -
  • bool, whether the two Symbols equal
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Symbol/toString.html b/docs/html/ion/Symbol/toString.html deleted file mode 100644 index ad456b2..0000000 --- a/docs/html/ion/Symbol/toString.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - Symbol::toString - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Symbol::toString()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Timestamp.html b/docs/html/ion/Timestamp.html deleted file mode 100644 index f413166..0000000 --- a/docs/html/ion/Timestamp.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - Timestamp - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Timestamp extends DateTime implements DateTimeInterface, Stringable

-

An ION Timestamp.

-

See also the ION sepc's timestamp definintion, and PHP's date documentation.

-

Constants:

-

None.

-

Properties:

-
    -
  • public int $precision
    -The timestamp's precision. See ion\Timestamp\Precision.
    • -
  • public string $format
    -The timestamp's format. See ion\Timestamp\Format.
    • -
- - - -

Functions:

-
    - -
  • -

    Timestamp::__construct

    -

    Create a new ION timestamp.

    - -

    void ion\Timestamp::__construct(ion\Timestamp\Precision|int $precision, [ion\Timestamp\Format|string|null $format = NULL, [?string $datetime = NULL, [?DateTimeZone $timezone = NULL]]])

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Format

    -

    Timestamp format.

    - -

    enum ion\Timestamp\Format implements BackedEnum, UnitEnum

    -
    • - -
  • -

    Precision

    -

    Timestamp precision.

    - -

    enum ion\Timestamp\Precision implements BackedEnum, UnitEnum

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Timestamp/Format.html b/docs/html/ion/Timestamp/Format.html deleted file mode 100644 index 51d0821..0000000 --- a/docs/html/ion/Timestamp/Format.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Format - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

enum ion\Timestamp\Format implements BackedEnum, UnitEnum

-

Timestamp format.

-

Constants:

-
    -
  • -Year = 'Y\T' -
    • -
  • -Month = 'Y-m\T' -
    • -
  • -Day = 'Y-m-d\T' -
    • -
  • -Min = 'Y-m-d\TH:i' -
    • -
  • -Sec = 'Y-m-d\TH:i:s' -
    • -
  • -Frac = 'Y-m-d\TH:i:s.v' -
    • -
  • -MinTZ = 'Y-m-d\TH:iP' -
    • -
  • -SecTZ = 'Y-m-d\TH:i:sP' -
    • -
  • -FracTZ = 'Y-m-d\TH:i:s.vP' -
    • -
-

Properties:

-
    -
  • public string $name
    -Timestamp format.
    • -
  • public string $value
    -Timestamp format.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Timestamp/Precision.html b/docs/html/ion/Timestamp/Precision.html deleted file mode 100644 index e1029fa..0000000 --- a/docs/html/ion/Timestamp/Precision.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - Precision - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

enum ion\Timestamp\Precision implements BackedEnum, UnitEnum

-

Timestamp precision.

-

Constants:

-
    -
  • -Year = 1 -
    • -
  • -Month = 3 -
    • -
  • -Day = 7 -
    • -
  • -Min = 23 -
    • -
  • -Sec = 55 -
    • -
  • -Frac = 119 -
    • -
  • -MinTZ = 151 -
    • -
  • -SecTZ = 183 -
    • -
  • -FracTZ = 247 -
    • -
-

Properties:

-
    -
  • public string $name
    -Timestamp precision.
    • -
  • public int $value
    -Timestamp precision.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Timestamp/__construct.html b/docs/html/ion/Timestamp/__construct.html deleted file mode 100644 index 3351d9b..0000000 --- a/docs/html/ion/Timestamp/__construct.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - Timestamp::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Timestamp::__construct(ion\Timestamp\Precision|int $precision, [ion\Timestamp\Format|string|null $format = NULL, [?string $datetime = NULL, [?DateTimeZone $timezone = NULL]]])

-

Create a new ION timestamp.

-

Params:

-
    -
  • ion\Timestamp\Precision|int $precision
    -The timestamp's precision. See ion\Timestamp\Precision.
    • -
  • Optional ion\Timestamp\Format|string|null $format = NULL
    -The timestamp's format. See ion\Timestamp\Format.
    • -
  • Optional ?string $datetime = NULL
    -The timestamp's value.
    • -
  • Optional ?DateTimeZone $timezone = NULL
    -The timestamp's timezone.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Type.html b/docs/html/ion/Type.html deleted file mode 100644 index 40724cd..0000000 --- a/docs/html/ion/Type.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - Type - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

enum ion\Type implements BackedEnum, UnitEnum

-

ION data type.

-

The following special PHP classes are provided for some data types:

-
    -
  • ion\Decimal
    • -
  • ion\Timestamp
    • -
  • ion\Symbol
    • -
  • ion\Lob
    • -
-

Constants:

-
    -
  • -Null = 0 -
    • -
  • -Bool = 256 -
    • -
  • -Int = 512 -
    • -
  • -Float = 1024 -
    • -
  • -Decimal = 1280 -
    • -
  • -Timestamp = 1536 -
    • -
  • -Symbol = 1792 -
    • -
  • -String = 2048 -
    • -
  • -CLob = 2304 -
    • -
  • -BLob = 2560 -
    • -
  • -List = 2816 -
    • -
  • -SExp = 3072 -
    • -
  • -Struct = 3328 -
    • -
  • -Datagram = 3840 -
    • -
  • -EOF = -256 -
    • -
  • -NONE = -512 -
    • -
-

Properties:

-
    -
  • public string $name
    -ION data type.
    • -
  • public int $value
    -ION data type.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Unserializer.html b/docs/html/ion/Unserializer.html deleted file mode 100644 index 1f67ec6..0000000 --- a/docs/html/ion/Unserializer.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - Unserializer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Unserializer

-

Unserializer interface, used to customize ion\unserialize()'s behavior.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

- - - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    PHP

    -

    Specialization of the unserializer for PHP.

    - -

    class ion\Unserializer\PHP implements ion\Unserializer

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Unserializer/PHP.html b/docs/html/ion/Unserializer/PHP.html deleted file mode 100644 index 24a5fba..0000000 --- a/docs/html/ion/Unserializer/PHP.html +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - PHP - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Unserializer\PHP implements ion\Unserializer

-

Specialization of the unserializer for PHP.

-

Constants:

-

None.

-

Properties:

-
    -
  • public ?ion\Reader\Options $readerOptions
    -Reader options.
    • -
  • public bool $multiSequence
    -Whether to continue reading multiple ION sequences after the first one.
    • -
  • public bool $callMagicUnserialize
    -Whether to call magic __unserialize() methods on objects to unserialize.
    • -
  • public ?string $callCustomUnserialize
    -Whether and which custom unserialize method to call on objects to unserialize.
    • -
- - - -

Functions:

-
    - -
  • -

    PHP::__construct

    -

    Create a new ION PHP unserializer.

    - -

    void ion\Unserializer\PHP::__construct([?ion\Reader\Options $readerOptions = NULL, [bool $multiSequence = false, [bool $callMagicUnserialize = true, [?string $callCustomUnserialize = NULL]]]])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Unserializer/PHP/__construct.html b/docs/html/ion/Unserializer/PHP/__construct.html deleted file mode 100644 index 482da6a..0000000 --- a/docs/html/ion/Unserializer/PHP/__construct.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - PHP::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Unserializer\PHP::__construct([?ion\Reader\Options $readerOptions = NULL, [bool $multiSequence = false, [bool $callMagicUnserialize = true, [?string $callCustomUnserialize = NULL]]]])

-

Create a new ION PHP unserializer.

-

Params:

-
    -
  • Optional ?ion\Reader\Options $readerOptions = NULL
    -Reader options.
    • -
  • Optional bool $multiSequence = false
    -Whether to continue reading multiple ION sequences after the first one.
    • -
  • Optional bool $callMagicUnserialize = true
    -Whether to call magic __unserialize() methods on objects to unserialize.
    • -
  • Optional ?string $callCustomUnserialize = NULL
    -Whether and which custom unserialize method to call on objects to unserialize.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Unserializer/unserialize.html b/docs/html/ion/Unserializer/unserialize.html deleted file mode 100644 index 39922c5..0000000 --- a/docs/html/ion/Unserializer/unserialize.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - Unserializer::unserialize - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

mixed ion\Unserializer::unserialize(string|resource $data)

-

Params:

-
    -
  • string|resource $data
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer.html b/docs/html/ion/Writer.html deleted file mode 100644 index 3a32ae8..0000000 --- a/docs/html/ion/Writer.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - Writer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Writer

-

ION writer API.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

- - - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Buffer

    -

    ION buffer writer API.

    - -

    interface ion\Writer\Buffer implements ion\Writer

    -
    • - -
  • -

    Options

    -

    ION writer options.

    - -

    class ion\Writer\Options

    -
    • - -
  • -

    Stream

    -

    ION stream writer API.

    - -

    interface ion\Writer\Stream implements ion\Writer

    -
    • - -
  • -

    Writer

    -

    Base implementation of common functionality of ION writers.

    - -

    abstract class ion\Writer\Writer implements ion\Writer

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Buffer.html b/docs/html/ion/Writer/Buffer.html deleted file mode 100644 index 46aee18..0000000 --- a/docs/html/ion/Writer/Buffer.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - Buffer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Writer\Buffer implements ion\Writer

-

ION buffer writer API.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Buffer::getBuffer

    -

    Get the buffer written to.

    - -

    string ion\Writer\Buffer::getBuffer()

    -
    • - -
  • -

    Buffer::resetBuffer

    -

    Reset the buffer written to.

    - -

    void ion\Writer\Buffer::resetBuffer()

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Writer

    -

    IO buffer writer.

    - -

    class ion\Writer\Buffer\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Buffer

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Buffer/Writer.html b/docs/html/ion/Writer/Buffer/Writer.html deleted file mode 100644 index 6fb2aec..0000000 --- a/docs/html/ion/Writer/Buffer/Writer.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Writer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Writer\Buffer\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Buffer

-

IO buffer writer.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Writer::__construct

    -

    Create a new buffer writer.

    - -

    void ion\Writer\Buffer\Writer::__construct([?ion\Writer\Options $options = NULL])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Buffer/Writer/__construct.html b/docs/html/ion/Writer/Buffer/Writer/__construct.html deleted file mode 100644 index 58fdae7..0000000 --- a/docs/html/ion/Writer/Buffer/Writer/__construct.html +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - Writer::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer\Buffer\Writer::__construct([?ion\Writer\Options $options = NULL])

-

Create a new buffer writer.

-

Params:

-
    -
  • Optional ?ion\Writer\Options $options = NULL
    -Writer options.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Buffer/getBuffer.html b/docs/html/ion/Writer/Buffer/getBuffer.html deleted file mode 100644 index 7ea8eff..0000000 --- a/docs/html/ion/Writer/Buffer/getBuffer.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Buffer::getBuffer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\Writer\Buffer::getBuffer()

-

Get the buffer written to.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Buffer/resetBuffer.html b/docs/html/ion/Writer/Buffer/resetBuffer.html deleted file mode 100644 index 0e25545..0000000 --- a/docs/html/ion/Writer/Buffer/resetBuffer.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Buffer::resetBuffer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer\Buffer::resetBuffer()

-

Reset the buffer written to.

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Options.html b/docs/html/ion/Writer/Options.html deleted file mode 100644 index b7364ad..0000000 --- a/docs/html/ion/Writer/Options.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - Options - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Writer\Options

-

ION writer options.

-

Constants:

-

None.

-

Properties:

-
    -
  • public ?ion\Catalog $catalog
    -ION catalog to use for symbol lookup.
    • -
  • public ?ion\Decimal\Context $decimalContext
    -Decimal context to use.
    • -
  • public bool $outputBinary
    -Whether to output binary ION.
    • -
  • public bool $compactFloats
    -Whether to write doubles which fit in 32 bits as floats.
    • -
  • public bool $escapeNonAscii
    -Whether to slash-escape all non ASCII bytes.
    • -
  • public bool $prettyPrint
    -Whether to produce pretty-printed output.
    • -
  • public bool $indentTabs
    -Whether to indent with tabs, when pretty-printing.
    • -
  • public int $indentSize
    -The number of spaces to use for indentation instead of tabs, when pretty-printing.
    • -
  • public bool $flushEveryValue
    -Whether to immediately flush every value written.
    • -
  • public int $maxContainerDepth
    -Maximum depth of nested containers.
    • -
  • public int $maxAnnotations
    -The maximum number of annotations allowed on a single value.
    • -
  • public int $tempBufferSize
    -Temporary buffer size.
    • -
- - - -

Functions:

-
    - -
  • -

    Options::__construct

    -

    Create custom ION writer options.

    - -

    void ion\Writer\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [bool $outputBinary = false, [bool $compactFloats = false, [bool $escapeNonAscii = false, [bool $prettyPrint = false, [bool $indentTabs = true, [int $indentSize = 2, [bool $flushEveryValue = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $tempBufferSize = 16384]]]]]]]]]]]])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Options/__construct.html b/docs/html/ion/Writer/Options/__construct.html deleted file mode 100644 index 4e5d259..0000000 --- a/docs/html/ion/Writer/Options/__construct.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Options::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [bool $outputBinary = false, [bool $compactFloats = false, [bool $escapeNonAscii = false, [bool $prettyPrint = false, [bool $indentTabs = true, [int $indentSize = 2, [bool $flushEveryValue = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $tempBufferSize = 16384]]]]]]]]]]]])

-

Create custom ION writer options.

-

Params:

-
    -
  • Optional ?ion\Catalog $catalog = NULL
    -ION catalog to use for symbol lookup.
    • -
  • Optional ?ion\Decimal\Context $decimalContext = NULL
    -Decimal context to use.
    • -
  • Optional bool $outputBinary = false
    -Whether to output binary ION.
    • -
  • Optional bool $compactFloats = false
    -Whether to write doubles which fit in 32 bits as floats.
    • -
  • Optional bool $escapeNonAscii = false
    -Whether to slash-escape all non ASCII bytes.
    • -
  • Optional bool $prettyPrint = false
    -Whether to produce pretty-printed output.
    • -
  • Optional bool $indentTabs = true
    -Whether to indent with tabs, when pretty-printing.
    • -
  • Optional int $indentSize = 2
    -The number of spaces to use for indentation instead of tabs, when pretty-printing.
    • -
  • Optional bool $flushEveryValue = false
    -Whether to immediately flush every value written.
    • -
  • Optional int $maxContainerDepth = 10
    -Maximum depth of nested containers.
    • -
  • Optional int $maxAnnotations = 10
    -The maximum number of annotations allowed on a single value.
    • -
  • Optional int $tempBufferSize = 16384
    -Temporary buffer size.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Stream.html b/docs/html/ion/Writer/Stream.html deleted file mode 100644 index 54d332f..0000000 --- a/docs/html/ion/Writer/Stream.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - Stream - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

interface ion\Writer\Stream implements ion\Writer

-

ION stream writer API.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Stream::getStream

    -

    Get the stream being written to.

    - -

    void ion\Writer\Stream::getStream()

    -
    • - -
- - -

Namespaces, Interfaces and Classes:

-
    - -
  • -

    Writer

    -

    ION stream writer.

    - -

    class ion\Writer\Stream\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Stream

    -
    • - -
- -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Stream/Writer.html b/docs/html/ion/Writer/Stream/Writer.html deleted file mode 100644 index a2f7a2e..0000000 --- a/docs/html/ion/Writer/Stream/Writer.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Writer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

class ion\Writer\Stream\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Stream

-

ION stream writer.

-

Constants:

-

None.

-

Properties:

-

None.

- - - -

Functions:

-
    - -
  • -

    Writer::__construct

    -

    Create a new stream writer.

    - -

    void ion\Writer\Stream\Writer::__construct(resource $stream, [?ion\Writer\Options $options = NULL])

    -
    • - -
- - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Stream/Writer/__construct.html b/docs/html/ion/Writer/Stream/Writer/__construct.html deleted file mode 100644 index a3de760..0000000 --- a/docs/html/ion/Writer/Stream/Writer/__construct.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - Writer::__construct - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer\Stream\Writer::__construct(resource $stream, [?ion\Writer\Options $options = NULL])

-

Create a new stream writer.

-

Params:

-
    -
  • resource $stream
    -The stream to write to.
    • -
  • Optional ?ion\Writer\Options $options = NULL
    -Writer options.
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Stream/getStream.html b/docs/html/ion/Writer/Stream/getStream.html deleted file mode 100644 index 9bb1412..0000000 --- a/docs/html/ion/Writer/Stream/getStream.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - Stream::getStream - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer\Stream::getStream()

-

Get the stream being written to.

-

Params:

-

None.

-

Returns:

-
    -
  • resource,
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/Writer.html b/docs/html/ion/Writer/Writer.html deleted file mode 100644 index 296bef1..0000000 --- a/docs/html/ion/Writer/Writer.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - Writer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

abstract class ion\Writer\Writer implements ion\Writer

-

Base implementation of common functionality of ION writers.

-

Constants:

-

None.

-

Properties:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/appendLob.html b/docs/html/ion/Writer/appendLob.html deleted file mode 100644 index de141fb..0000000 --- a/docs/html/ion/Writer/appendLob.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::appendLob - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::appendLob(string $data)

-

Params:

-
    -
  • string $data
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/finish.html b/docs/html/ion/Writer/finish.html deleted file mode 100644 index de6d10a..0000000 --- a/docs/html/ion/Writer/finish.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Writer::finish - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Writer::finish()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/finishContainer.html b/docs/html/ion/Writer/finishContainer.html deleted file mode 100644 index 4429d5e..0000000 --- a/docs/html/ion/Writer/finishContainer.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Writer::finishContainer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::finishContainer()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/finishLob.html b/docs/html/ion/Writer/finishLob.html deleted file mode 100644 index 1b7b77e..0000000 --- a/docs/html/ion/Writer/finishLob.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Writer::finishLob - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::finishLob()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/flush.html b/docs/html/ion/Writer/flush.html deleted file mode 100644 index 70afb8f..0000000 --- a/docs/html/ion/Writer/flush.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Writer::flush - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Writer::flush()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/getDepth.html b/docs/html/ion/Writer/getDepth.html deleted file mode 100644 index 8e74323..0000000 --- a/docs/html/ion/Writer/getDepth.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Writer::getDepth - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

int ion\Writer::getDepth()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/startContainer.html b/docs/html/ion/Writer/startContainer.html deleted file mode 100644 index e8de287..0000000 --- a/docs/html/ion/Writer/startContainer.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::startContainer - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::startContainer(ion\Type $type)

-

Params:

-
    -
  • ion\Type $type
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/startLob.html b/docs/html/ion/Writer/startLob.html deleted file mode 100644 index 7a746d4..0000000 --- a/docs/html/ion/Writer/startLob.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::startLob - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::startLob(ion\Type $type)

-

Params:

-
    -
  • ion\Type $type
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeAnnotation.html b/docs/html/ion/Writer/writeAnnotation.html deleted file mode 100644 index 58331d4..0000000 --- a/docs/html/ion/Writer/writeAnnotation.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeAnnotation - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeAnnotation([ion\Symbol|string ?>...$annotation])

-

Params:

-
    -
  • Optional ion\Symbol|string ?>...$annotation
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeBLob.html b/docs/html/ion/Writer/writeBLob.html deleted file mode 100644 index cae1e69..0000000 --- a/docs/html/ion/Writer/writeBLob.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeBLob - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeBLob(string $value)

-

Params:

-
    -
  • string $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeBool.html b/docs/html/ion/Writer/writeBool.html deleted file mode 100644 index b077308..0000000 --- a/docs/html/ion/Writer/writeBool.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeBool - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeBool(bool $value)

-

Params:

-
    -
  • bool $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeCLob.html b/docs/html/ion/Writer/writeCLob.html deleted file mode 100644 index 9024b64..0000000 --- a/docs/html/ion/Writer/writeCLob.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeCLob - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeCLob(string $value)

-

Params:

-
    -
  • string $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeDecimal.html b/docs/html/ion/Writer/writeDecimal.html deleted file mode 100644 index f80a23c..0000000 --- a/docs/html/ion/Writer/writeDecimal.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeDecimal - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeDecimal(ion\Decimal|string $value)

-

Params:

-
    -
  • ion\Decimal|string $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeFieldName.html b/docs/html/ion/Writer/writeFieldName.html deleted file mode 100644 index 3894a13..0000000 --- a/docs/html/ion/Writer/writeFieldName.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeFieldName - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeFieldName(string $name)

-

Params:

-
    -
  • string $name
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeFloat.html b/docs/html/ion/Writer/writeFloat.html deleted file mode 100644 index 11400f5..0000000 --- a/docs/html/ion/Writer/writeFloat.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeFloat - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeFloat(float $value)

-

Params:

-
    -
  • float $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeInt.html b/docs/html/ion/Writer/writeInt.html deleted file mode 100644 index b034ec9..0000000 --- a/docs/html/ion/Writer/writeInt.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeInt - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeInt(string|int $value)

-

Params:

-
    -
  • string|int $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeNull.html b/docs/html/ion/Writer/writeNull.html deleted file mode 100644 index 975cda7..0000000 --- a/docs/html/ion/Writer/writeNull.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - Writer::writeNull - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeNull()

-

Params:

-

None.

- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeString.html b/docs/html/ion/Writer/writeString.html deleted file mode 100644 index fd56299..0000000 --- a/docs/html/ion/Writer/writeString.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeString - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeString(string $value)

-

Params:

-
    -
  • string $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeSymbol.html b/docs/html/ion/Writer/writeSymbol.html deleted file mode 100644 index af5500c..0000000 --- a/docs/html/ion/Writer/writeSymbol.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeSymbol - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeSymbol(ion\Symbol|string $value)

-

Params:

-
    -
  • ion\Symbol|string $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeTimestamp.html b/docs/html/ion/Writer/writeTimestamp.html deleted file mode 100644 index cd574d8..0000000 --- a/docs/html/ion/Writer/writeTimestamp.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeTimestamp - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeTimestamp(ion\Timestamp|string $value)

-

Params:

-
    -
  • ion\Timestamp|string $value
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/Writer/writeTypedNull.html b/docs/html/ion/Writer/writeTypedNull.html deleted file mode 100644 index 9295b2c..0000000 --- a/docs/html/ion/Writer/writeTypedNull.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - Writer::writeTypedNull - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

void ion\Writer::writeTypedNull(ion\Type $type)

-

Params:

-
    -
  • ion\Type $type
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/serialize.html b/docs/html/ion/serialize.html deleted file mode 100644 index 9265d24..0000000 --- a/docs/html/ion/serialize.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - serialize - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL])

-

Serialize a PHP value as ION data.

-

Serializes supported PHP values with the optionally provided \ion\Serializer:

-
    -
  • NULL
    • -
  • bool
    • -
  • int
    • -
  • float
    • -
  • string
    • -
  • references
    • -
  • arrays
    • -
  • objects (incl. \Serializable, and classes implementing magic and custom __serialize)
    • -
-

Params:

-
    -
  • mixed $data
    -PHP value(s).
    • -
  • Optional ?ion\Serializer $serializer = NULL
    -Custom serializer.
    • -
-

Returns:

-
    -
  • string, serialized ION data
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/html/ion/unserialize.html b/docs/html/ion/unserialize.html deleted file mode 100644 index 45c9cf3..0000000 --- a/docs/html/ion/unserialize.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - unserialize - - mdref - - - - - - - - - - - -
- -
- -
- Edit -
- - - -
- -

mixed ion\unserialize(string|resource $data, [?ion\Unserializer $unserializer = NULL])

-

Unserialize ION data (stream) as PHP value(s).

-

Params:

-
    -
  • string|resource $data
    -Serialized ION data, either as string buffer or stream,.
    • -
  • Optional ?ion\Unserializer $unserializer = NULL
    -Unserialize ION data (stream) as PHP value(s).
    • -
-

Returns:

-
    -
  • mixed, unserialized PHP values
    • -
- - - - -
- - - - - - -
- - diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..54c82b0 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,3 @@ + + + diff --git a/docs/latest b/docs/latest new file mode 120000 index 0000000..92f146b --- /dev/null +++ b/docs/latest @@ -0,0 +1 @@ +v0.0/ \ No newline at end of file diff --git a/docs/src/ion.md b/docs/src/ion.md deleted file mode 100644 index 66e6d4e..0000000 --- a/docs/src/ion.md +++ /dev/null @@ -1,45 +0,0 @@ -# pecl/ion - -## About: -PHP extension wrapping [amzn/ion-c](https://github.com/amzn/ion-c). -See the [Amazon ION specification](https://amzn.github.io/ion-docs/). - -## License: -[BSD-2-Clause](https://github.com/awesomized/ext-ion/blob/master/LICENSE); -see [spdx.org](https://spdx.org/licenses/BSD-2-Clause.html). - -## Installation: - -[PECL](https://pecl.php.net) and [PHARext](https://pharext.org) is WIP. - -### Dependencies: -#### Required: -* PHP-8.1 - * ext/date (standard) - * ext/spl (standard) -#### Optional: -* [amzn/ion-c](https://github.com/amzn/ion-c) (bundled as git submodule) - -### Trinity: -```shell -phpize -./configure -make # -j$(nproc) -sudo make install # INSTALL=install -``` -### Try with Docker: -```shell -docker build -t php-ion -docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\Table\PHP());' -``` - -## Editor Stub: -See [ion.stub.php](https://github.com/awesomized/ext-ion/blob/master/ion.stub.php). - -## Known Issues: -Due to private internal state of ion-c's readers and writers, -instances of the following PHP classes cannot be cloned: -* ion\Reader\Reader -* ion\Writer\Writer -* ion\Serializer\PHP -* ion\Unserializer\PHP diff --git a/docs/src/ion.mdref b/docs/src/ion.mdref deleted file mode 100644 index 3c65265..0000000 --- a/docs/src/ion.mdref +++ /dev/null @@ -1 +0,0 @@ -./%s \ No newline at end of file diff --git a/docs/src/ion/Catalog.md b/docs/src/ion/Catalog.md deleted file mode 100644 index 8cd4bae..0000000 --- a/docs/src/ion/Catalog.md +++ /dev/null @@ -1,19 +0,0 @@ -# class ion\Catalog implements Countable - -The Catalog holds a collection of ion\Symbol\Table instances queried from ion\Reader and ion\Writer instances. - - - -See also [the ION spec's symbol guide chapter on catalog.](https://amzn.github.io/ion-docs/docs/symbols.html#the-catalog). - - -## Constants: - -None. - -## Properties: - - * private array $symbolTables = array ( -) - Internal cache. - diff --git a/docs/src/ion/Catalog/__construct.md b/docs/src/ion/Catalog/__construct.md deleted file mode 100644 index 4f5f703..0000000 --- a/docs/src/ion/Catalog/__construct.md +++ /dev/null @@ -1,13 +0,0 @@ -# void ion\Catalog::__construct() - -Create a new Catalog. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Catalog/add.md b/docs/src/ion/Catalog/add.md deleted file mode 100644 index 0cf16ed..0000000 --- a/docs/src/ion/Catalog/add.md +++ /dev/null @@ -1,20 +0,0 @@ -# void ion\Catalog::add(ion\Symbol\Table $table) - -Add a shared symbol table to the catalog. - - - - - - -## Params: - -* ion\Symbol\Table $table - The new table to add. - - -## Returns: - -* void, - - diff --git a/docs/src/ion/Catalog/find.md b/docs/src/ion/Catalog/find.md deleted file mode 100644 index f43917e..0000000 --- a/docs/src/ion/Catalog/find.md +++ /dev/null @@ -1,22 +0,0 @@ -# ?ion\Symbol\Table ion\Catalog::find(string $name, [int $version = 0]) - -Find a shared symbol table within the catalog. - - - - - - -## Params: - -* string $name - The name of the symbol table. -* Optional int $version = 0 - The version the symbol table should match. - - -## Returns: - -* \Symbol\Table|null, The symbol table found, if any. - - diff --git a/docs/src/ion/Catalog/findBest.md b/docs/src/ion/Catalog/findBest.md deleted file mode 100644 index f779baf..0000000 --- a/docs/src/ion/Catalog/findBest.md +++ /dev/null @@ -1,22 +0,0 @@ -# ?ion\Symbol\Table ion\Catalog::findBest(string $name, [int $version = 0]) - -Find a "best match" for a shared symbol table within the catalog. - - - - - - -## Params: - -* string $name - The name of the symbol table, -* Optional int $version = 0 - The minimum version of the symbol table. - - -## Returns: - -* \Symbol\Table|null, The symbol table found, if any. - - diff --git a/docs/src/ion/Catalog/remove.md b/docs/src/ion/Catalog/remove.md deleted file mode 100644 index ff0d184..0000000 --- a/docs/src/ion/Catalog/remove.md +++ /dev/null @@ -1,20 +0,0 @@ -# bool ion\Catalog::remove(ion\Symbol\Table|string $table) - -Remove a shared symbol table from the catalog. - - - - - - -## Params: - -* ion\Symbol\Table|string $table - The symbol table to renmove. - - -## Returns: - -* bool, Success. - - diff --git a/docs/src/ion/Decimal.md b/docs/src/ion/Decimal.md deleted file mode 100644 index 8a91cfe..0000000 --- a/docs/src/ion/Decimal.md +++ /dev/null @@ -1,20 +0,0 @@ -# class ion\Decimal implements Stringable - -An arbitrary precision fixed point decimal. - - - -See also \ion\Decimal\Context, and [the ION spec's decimal docs](https://amzn.github.io/ion-docs/docs/decimal.html). - - -## Constants: - -None. - -## Properties: - - * public string|int $number - The decimal number. - * public ?ion\Decimal\Context $context - The decimal context. - diff --git a/docs/src/ion/Decimal/Context.md b/docs/src/ion/Decimal/Context.md deleted file mode 100644 index df471ba..0000000 --- a/docs/src/ion/Decimal/Context.md +++ /dev/null @@ -1,26 +0,0 @@ -# class ion\Decimal\Context - -An ion\Decimal's context. - - - - - - -## Constants: - -None. - -## Properties: - - * public int $digits - Maximum digits. - * public int $eMax - Maximum exponent. - * public int $eMin - Minimum exponent. - * public ion\Decimal\Context\Rounding|int $round - Rounding mode. - * public bool $clamp - Whether to clamp. - diff --git a/docs/src/ion/Decimal/Context/Dec128.md b/docs/src/ion/Decimal/Context/Dec128.md deleted file mode 100644 index 31f047e..0000000 --- a/docs/src/ion/Decimal/Context/Dec128.md +++ /dev/null @@ -1,13 +0,0 @@ -# static ion\Decimal\Context ion\Decimal\Context::Dec128() - -Create a context suitable for 128bit decimals. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Decimal/Context/Dec32.md b/docs/src/ion/Decimal/Context/Dec32.md deleted file mode 100644 index eb0d090..0000000 --- a/docs/src/ion/Decimal/Context/Dec32.md +++ /dev/null @@ -1,13 +0,0 @@ -# static ion\Decimal\Context ion\Decimal\Context::Dec32() - -Create a context suitable for 32bit decimals. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Decimal/Context/Dec64.md b/docs/src/ion/Decimal/Context/Dec64.md deleted file mode 100644 index 46ea1b4..0000000 --- a/docs/src/ion/Decimal/Context/Dec64.md +++ /dev/null @@ -1,13 +0,0 @@ -# static ion\Decimal\Context ion\Decimal\Context::Dec64() - -Create a context suitable for 64bit decimals. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Decimal/Context/DecMax.md b/docs/src/ion/Decimal/Context/DecMax.md deleted file mode 100644 index 9d1cf7f..0000000 --- a/docs/src/ion/Decimal/Context/DecMax.md +++ /dev/null @@ -1,15 +0,0 @@ -# static ion\Decimal\Context ion\Decimal\Context::DecMax([ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven]) - -Create a context with maximum settings. - - - - - - -## Params: - -* Optional ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven - Rounding mode. - - diff --git a/docs/src/ion/Decimal/Context/Rounding.md b/docs/src/ion/Decimal/Context/Rounding.md deleted file mode 100644 index 64aded3..0000000 --- a/docs/src/ion/Decimal/Context/Rounding.md +++ /dev/null @@ -1,28 +0,0 @@ -# enum ion\Decimal\Context\Rounding implements BackedEnum, UnitEnum - -Rounding mode. - - - - - - -## Constants: - - * Ceiling = 0 - * Up = 1 - * HalfUp = 2 - * HalfEven = 3 - * HalfDown = 4 - * Down = 5 - * Floor = 6 - * Down05Up = 7 - - -## Properties: - - * public string $name - Rounding mode. - * public int $value - Rounding mode. - diff --git a/docs/src/ion/Decimal/Context/__construct.md b/docs/src/ion/Decimal/Context/__construct.md deleted file mode 100644 index 38f1f69..0000000 --- a/docs/src/ion/Decimal/Context/__construct.md +++ /dev/null @@ -1,23 +0,0 @@ -# void ion\Decimal\Context::__construct(int $digits, int $eMax, int $eMin, ion\Decimal\Context\Rounding|int $round, bool $clamp) - -Create a new decimal context. - - - - - - -## Params: - -* int $digits - Maximum digits. -* int $eMax - Maximum exponent. -* int $eMin - Minimum exponent. -* ion\Decimal\Context\Rounding|int $round - Rounding mode. -* bool $clamp - Whether to clamp. - - diff --git a/docs/src/ion/Decimal/__construct.md b/docs/src/ion/Decimal/__construct.md deleted file mode 100644 index 3beef24..0000000 --- a/docs/src/ion/Decimal/__construct.md +++ /dev/null @@ -1,17 +0,0 @@ -# void ion\Decimal::__construct(string|int $number, [?ion\Decimal\Context $context = NULL]) - -Create a new fixed point decimal. - - - - - - -## Params: - -* string|int $number - The decimal number. -* Optional ?ion\Decimal\Context $context = NULL - The decimal context. - - diff --git a/docs/src/ion/Decimal/equals.md b/docs/src/ion/Decimal/equals.md deleted file mode 100644 index 56e25e1..0000000 --- a/docs/src/ion/Decimal/equals.md +++ /dev/null @@ -1,20 +0,0 @@ -# bool ion\Decimal::equals(ion\Decimal $decimal) - -Check two decimals for equality. - - - - - - -## Params: - -* ion\Decimal $decimal - The decimal to compare to. - - -## Returns: - -* bool, Whether both decimals equal. - - diff --git a/docs/src/ion/Decimal/isInt.md b/docs/src/ion/Decimal/isInt.md deleted file mode 100644 index 211643b..0000000 --- a/docs/src/ion/Decimal/isInt.md +++ /dev/null @@ -1,18 +0,0 @@ -# bool ion\Decimal::isInt() - -Check whether the decimal is actually a big integer. - - - - - - -## Params: - -None. - -## Returns: - -* bool, Whether the decimal is actually an integer. - - diff --git a/docs/src/ion/Decimal/toInt.md b/docs/src/ion/Decimal/toInt.md deleted file mode 100644 index 741be28..0000000 --- a/docs/src/ion/Decimal/toInt.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Decimal::toInt() - -Get the integer represention of the decimal. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Decimal/toString.md b/docs/src/ion/Decimal/toString.md deleted file mode 100644 index f5da7b5..0000000 --- a/docs/src/ion/Decimal/toString.md +++ /dev/null @@ -1,13 +0,0 @@ -# string ion\Decimal::toString() - -Get the string representation of the decimal. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Exception.md b/docs/src/ion/Exception.md deleted file mode 100644 index 73f3f54..0000000 --- a/docs/src/ion/Exception.md +++ /dev/null @@ -1,16 +0,0 @@ -# class ion\Exception extends Exception implements Stringable, Throwable - -Base exception for the ION extension. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/LOB.md b/docs/src/ion/LOB.md deleted file mode 100644 index e6a3afe..0000000 --- a/docs/src/ion/LOB.md +++ /dev/null @@ -1,20 +0,0 @@ -# class ion\LOB - -A large object. - - - -See also \ion\Type, [the ION spec's BLob definition](https://amzn.github.io/ion-docs/docs/spec.html#blob), and [the ION sepc's CLob definition](https://amzn.github.io/ion-docs/docs/spec.html#clob). - - -## Constants: - -None. - -## Properties: - - * public string $value - The value of the large object. - * public ion\Type $type - The type (CLob/BLob). - diff --git a/docs/src/ion/LOB/__construct.md b/docs/src/ion/LOB/__construct.md deleted file mode 100644 index d1b7324..0000000 --- a/docs/src/ion/LOB/__construct.md +++ /dev/null @@ -1,17 +0,0 @@ -# void ion\LOB::__construct(string $value, [ion\Type $type = ion\Type::CLob]) - -Create an ION large object. - - - - - - -## Params: - -* string $value - The value of the large object. -* Optional ion\Type $type = ion\Type::CLob - The type (CLob/BLob). - - diff --git a/docs/src/ion/Reader.md b/docs/src/ion/Reader.md deleted file mode 100644 index 3de045f..0000000 --- a/docs/src/ion/Reader.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Reader implements Iterator, RecursiveIterator, Traversable - -ION reader API. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Reader/Buffer.md b/docs/src/ion/Reader/Buffer.md deleted file mode 100644 index 32a9f99..0000000 --- a/docs/src/ion/Reader/Buffer.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Reader\Buffer implements Iterator, RecursiveIterator, Traversable, ion\Reader - -ION string buffer reader API. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Reader/Buffer/Reader.md b/docs/src/ion/Reader/Buffer/Reader.md deleted file mode 100644 index bcdabf9..0000000 --- a/docs/src/ion/Reader/Buffer/Reader.md +++ /dev/null @@ -1,16 +0,0 @@ -# class ion\Reader\Buffer\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Buffer - -ION string buffer reader. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Reader/Buffer/Reader/__construct.md b/docs/src/ion/Reader/Buffer/Reader/__construct.md deleted file mode 100644 index 01ba839..0000000 --- a/docs/src/ion/Reader/Buffer/Reader/__construct.md +++ /dev/null @@ -1,17 +0,0 @@ -# void ion\Reader\Buffer\Reader::__construct(string $buffer, [?ion\Reader\Options $options = NULL]) - -Create a new string buffer reader. - - - - - - -## Params: - -* string $buffer - The buffer to read from. -* Optional ?ion\Reader\Options $options = NULL - Reader options. - - diff --git a/docs/src/ion/Reader/Buffer/getBuffer.md b/docs/src/ion/Reader/Buffer/getBuffer.md deleted file mode 100644 index 98c93da..0000000 --- a/docs/src/ion/Reader/Buffer/getBuffer.md +++ /dev/null @@ -1,18 +0,0 @@ -# string ion\Reader\Buffer::getBuffer() - -Get the buffer read from. - - - - - - -## Params: - -None. - -## Returns: - -* string, The buffer read from. - - diff --git a/docs/src/ion/Reader/Options.md b/docs/src/ion/Reader/Options.md deleted file mode 100644 index 76245b7..0000000 --- a/docs/src/ion/Reader/Options.md +++ /dev/null @@ -1,34 +0,0 @@ -# class ion\Reader\Options - -Reader options. - - - - - - -## Constants: - -None. - -## Properties: - - * public ?ion\Catalog $catalog - ION catalog to use for symbol lookup. - * public ?ion\Decimal\Context $decimalContext - Decimal context to use. - * public ?Closure $onContextChange - Callback as function(\ion\Reader):void called upon local symbol table context change. - * public bool $returnSystemValues - Whether to return otherwise hidden system values. - * public int $maxContainerDepth - The maximum depth of nested containers. - * public int $maxAnnotations - The maximum number of annotations allowed on a single value. - * public int $annotationBufferSize - The maximum number of bytes of all annotations on a single value. - * public int $tempBufferSize - The maximum number of bytes of a symbol/value/chunk. - * public bool $skipCharacterValidation - Whether to skip UTF-8 validation. - diff --git a/docs/src/ion/Reader/Options/__construct.md b/docs/src/ion/Reader/Options/__construct.md deleted file mode 100644 index 1ff508c..0000000 --- a/docs/src/ion/Reader/Options/__construct.md +++ /dev/null @@ -1,31 +0,0 @@ -# void ion\Reader\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [?Closure $onContextChange = NULL, [bool $returnSystemValues = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $annotationBufferSize = 16384, [int $tempBufferSize = 16384, [bool $skipCharacterValidation = false]]]]]]]]]) - - - - - - - - -## Params: - -* Optional ?ion\Catalog $catalog = NULL - ION catalog to use for symbol lookup. -* Optional ?ion\Decimal\Context $decimalContext = NULL - Decimal context to use. -* Optional ?Closure $onContextChange = NULL - Callback as function(\ion\Reader):void called upon local symbol table context change. -* Optional bool $returnSystemValues = false - Whether to return otherwise hidden system values. -* Optional int $maxContainerDepth = 10 - The maximum depth of nested containers. -* Optional int $maxAnnotations = 10 - The maximum number of annotations allowed on a single value. -* Optional int $annotationBufferSize = 16384 - The maximum number of bytes of all annotations on a single value. -* Optional int $tempBufferSize = 16384 - The maximum number of bytes of a symbol/value/chunk. -* Optional bool $skipCharacterValidation = false - Whether to skip UTF-8 validation. - - diff --git a/docs/src/ion/Reader/Reader.md b/docs/src/ion/Reader/Reader.md deleted file mode 100644 index d97f194..0000000 --- a/docs/src/ion/Reader/Reader.md +++ /dev/null @@ -1,18 +0,0 @@ -# abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader - -Base implementation of ION readers. - - - - - - -## Constants: - -None. - -## Properties: - - * public ?ion\Reader\Options $options - Reader options. - diff --git a/docs/src/ion/Reader/Stream.md b/docs/src/ion/Reader/Stream.md deleted file mode 100644 index 82cd808..0000000 --- a/docs/src/ion/Reader/Stream.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader - -ION stream reader API. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Reader/Stream/Reader.md b/docs/src/ion/Reader/Stream/Reader.md deleted file mode 100644 index 351f926..0000000 --- a/docs/src/ion/Reader/Stream/Reader.md +++ /dev/null @@ -1,16 +0,0 @@ -# class ion\Reader\Stream\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Stream - -ION stream reader. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Reader/Stream/Reader/__construct.md b/docs/src/ion/Reader/Stream/Reader/__construct.md deleted file mode 100644 index badd8fb..0000000 --- a/docs/src/ion/Reader/Stream/Reader/__construct.md +++ /dev/null @@ -1,17 +0,0 @@ -# void ion\Reader\Stream\Reader::__construct(resource $stream, [?ion\Reader\Options $options = NULL]) - -Create a new stream reader. - - - - - - -## Params: - -* resource $stream - The stream to read from. -* Optional ?ion\Reader\Options $options = NULL - Reader options. - - diff --git a/docs/src/ion/Reader/Stream/getStream.md b/docs/src/ion/Reader/Stream/getStream.md deleted file mode 100644 index ac5c1a8..0000000 --- a/docs/src/ion/Reader/Stream/getStream.md +++ /dev/null @@ -1,18 +0,0 @@ -# void ion\Reader\Stream::getStream() - -Get the stream read from. - - - - - - -## Params: - -None. - -## Returns: - -* resource, The stream read from. - - diff --git a/docs/src/ion/Reader/Stream/resetStream.md b/docs/src/ion/Reader/Stream/resetStream.md deleted file mode 100644 index 54fd83c..0000000 --- a/docs/src/ion/Reader/Stream/resetStream.md +++ /dev/null @@ -1,15 +0,0 @@ -# void ion\Reader\Stream::resetStream(resource $stream) - -Reset the stream read from. - - - - - - -## Params: - -* resource $stream - The new stream to from. - - diff --git a/docs/src/ion/Reader/Stream/resetStreamWithLength.md b/docs/src/ion/Reader/Stream/resetStreamWithLength.md deleted file mode 100644 index 5bd3436..0000000 --- a/docs/src/ion/Reader/Stream/resetStreamWithLength.md +++ /dev/null @@ -1,17 +0,0 @@ -# void ion\Reader\Stream::resetStreamWithLength(resource $stream, int $length) - -Reset the stream read from, limiting length to read. - - - - - - -## Params: - -* resource $stream - The stream to read from. -* int $length - The maximum length to read from $stream. - - diff --git a/docs/src/ion/Reader/countAnnotations.md b/docs/src/ion/Reader/countAnnotations.md deleted file mode 100644 index c6ce471..0000000 --- a/docs/src/ion/Reader/countAnnotations.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Reader::countAnnotations() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getAnnotation.md b/docs/src/ion/Reader/getAnnotation.md deleted file mode 100644 index f9d1ea6..0000000 --- a/docs/src/ion/Reader/getAnnotation.md +++ /dev/null @@ -1,14 +0,0 @@ -# string ion\Reader::getAnnotation(int $index) - - - - - - - - -## Params: - -* int $index - - diff --git a/docs/src/ion/Reader/getAnnotationSymbol.md b/docs/src/ion/Reader/getAnnotationSymbol.md deleted file mode 100644 index c81654c..0000000 --- a/docs/src/ion/Reader/getAnnotationSymbol.md +++ /dev/null @@ -1,14 +0,0 @@ -# ion\Symbol ion\Reader::getAnnotationSymbol(int $index) - - - - - - - - -## Params: - -* int $index - - diff --git a/docs/src/ion/Reader/getAnnotationSymbols.md b/docs/src/ion/Reader/getAnnotationSymbols.md deleted file mode 100644 index 7ce7d7f..0000000 --- a/docs/src/ion/Reader/getAnnotationSymbols.md +++ /dev/null @@ -1,13 +0,0 @@ -# array ion\Reader::getAnnotationSymbols() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getAnnotations.md b/docs/src/ion/Reader/getAnnotations.md deleted file mode 100644 index 8ff8d5c..0000000 --- a/docs/src/ion/Reader/getAnnotations.md +++ /dev/null @@ -1,13 +0,0 @@ -# array ion\Reader::getAnnotations() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getDepth.md b/docs/src/ion/Reader/getDepth.md deleted file mode 100644 index a47ccdf..0000000 --- a/docs/src/ion/Reader/getDepth.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Reader::getDepth() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getFieldName.md b/docs/src/ion/Reader/getFieldName.md deleted file mode 100644 index 9f4c904..0000000 --- a/docs/src/ion/Reader/getFieldName.md +++ /dev/null @@ -1,13 +0,0 @@ -# string ion\Reader::getFieldName() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getFieldNameSymbol.md b/docs/src/ion/Reader/getFieldNameSymbol.md deleted file mode 100644 index 98481e7..0000000 --- a/docs/src/ion/Reader/getFieldNameSymbol.md +++ /dev/null @@ -1,13 +0,0 @@ -# ion\Symbol ion\Reader::getFieldNameSymbol() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getPosition.md b/docs/src/ion/Reader/getPosition.md deleted file mode 100644 index 80e0ad0..0000000 --- a/docs/src/ion/Reader/getPosition.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Reader::getPosition() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getType.md b/docs/src/ion/Reader/getType.md deleted file mode 100644 index e1961a1..0000000 --- a/docs/src/ion/Reader/getType.md +++ /dev/null @@ -1,13 +0,0 @@ -# ion\Type ion\Reader::getType() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getValueLength.md b/docs/src/ion/Reader/getValueLength.md deleted file mode 100644 index 180c30e..0000000 --- a/docs/src/ion/Reader/getValueLength.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Reader::getValueLength() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/getValueOffset.md b/docs/src/ion/Reader/getValueOffset.md deleted file mode 100644 index 703643d..0000000 --- a/docs/src/ion/Reader/getValueOffset.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Reader::getValueOffset() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/hasAnnotation.md b/docs/src/ion/Reader/hasAnnotation.md deleted file mode 100644 index 0301a49..0000000 --- a/docs/src/ion/Reader/hasAnnotation.md +++ /dev/null @@ -1,14 +0,0 @@ -# bool ion\Reader::hasAnnotation(string $annotation) - - - - - - - - -## Params: - -* string $annotation - - diff --git a/docs/src/ion/Reader/hasAnnotations.md b/docs/src/ion/Reader/hasAnnotations.md deleted file mode 100644 index cc54365..0000000 --- a/docs/src/ion/Reader/hasAnnotations.md +++ /dev/null @@ -1,13 +0,0 @@ -# bool ion\Reader::hasAnnotations() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/isInStruct.md b/docs/src/ion/Reader/isInStruct.md deleted file mode 100644 index b1e74f6..0000000 --- a/docs/src/ion/Reader/isInStruct.md +++ /dev/null @@ -1,13 +0,0 @@ -# bool ion\Reader::isInStruct() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/isNull.md b/docs/src/ion/Reader/isNull.md deleted file mode 100644 index bd341ae..0000000 --- a/docs/src/ion/Reader/isNull.md +++ /dev/null @@ -1,13 +0,0 @@ -# bool ion\Reader::isNull() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readBool.md b/docs/src/ion/Reader/readBool.md deleted file mode 100644 index 3ae3dc6..0000000 --- a/docs/src/ion/Reader/readBool.md +++ /dev/null @@ -1,13 +0,0 @@ -# bool ion\Reader::readBool() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readDecimal.md b/docs/src/ion/Reader/readDecimal.md deleted file mode 100644 index dfbfe1d..0000000 --- a/docs/src/ion/Reader/readDecimal.md +++ /dev/null @@ -1,13 +0,0 @@ -# ion\Decimal ion\Reader::readDecimal() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readFloat.md b/docs/src/ion/Reader/readFloat.md deleted file mode 100644 index 4e93dd5..0000000 --- a/docs/src/ion/Reader/readFloat.md +++ /dev/null @@ -1,13 +0,0 @@ -# float ion\Reader::readFloat() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readInt.md b/docs/src/ion/Reader/readInt.md deleted file mode 100644 index bcb1cb2..0000000 --- a/docs/src/ion/Reader/readInt.md +++ /dev/null @@ -1,13 +0,0 @@ -# string|int ion\Reader::readInt() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readLob.md b/docs/src/ion/Reader/readLob.md deleted file mode 100644 index 22e2a9d..0000000 --- a/docs/src/ion/Reader/readLob.md +++ /dev/null @@ -1,13 +0,0 @@ -# string ion\Reader::readLob() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readLobPart.md b/docs/src/ion/Reader/readLobPart.md deleted file mode 100644 index 81136af..0000000 --- a/docs/src/ion/Reader/readLobPart.md +++ /dev/null @@ -1,16 +0,0 @@ -# bool ion\Reader::readLobPart( &$string, [int $length = 4096]) - - - - - - - - -## Params: - -* Reference &$string - -* Optional int $length = 4096 - - diff --git a/docs/src/ion/Reader/readNull.md b/docs/src/ion/Reader/readNull.md deleted file mode 100644 index 6a962fe..0000000 --- a/docs/src/ion/Reader/readNull.md +++ /dev/null @@ -1,13 +0,0 @@ -# ion\Type ion\Reader::readNull() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readString.md b/docs/src/ion/Reader/readString.md deleted file mode 100644 index dfd9732..0000000 --- a/docs/src/ion/Reader/readString.md +++ /dev/null @@ -1,13 +0,0 @@ -# string ion\Reader::readString() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readStringPart.md b/docs/src/ion/Reader/readStringPart.md deleted file mode 100644 index 65258b0..0000000 --- a/docs/src/ion/Reader/readStringPart.md +++ /dev/null @@ -1,16 +0,0 @@ -# bool ion\Reader::readStringPart( &$string, [int $length = 4096]) - - - - - - - - -## Params: - -* Reference &$string - -* Optional int $length = 4096 - - diff --git a/docs/src/ion/Reader/readSymbol.md b/docs/src/ion/Reader/readSymbol.md deleted file mode 100644 index ca64dea..0000000 --- a/docs/src/ion/Reader/readSymbol.md +++ /dev/null @@ -1,13 +0,0 @@ -# ion\Symbol ion\Reader::readSymbol() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/readTimestamp.md b/docs/src/ion/Reader/readTimestamp.md deleted file mode 100644 index c01d40b..0000000 --- a/docs/src/ion/Reader/readTimestamp.md +++ /dev/null @@ -1,13 +0,0 @@ -# ion\Timestamp ion\Reader::readTimestamp() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Reader/seek.md b/docs/src/ion/Reader/seek.md deleted file mode 100644 index c6bad2a..0000000 --- a/docs/src/ion/Reader/seek.md +++ /dev/null @@ -1,15 +0,0 @@ -# void ion\Reader::seek(int $offset, [int $length = -1]) - - - - - - - - -## Params: - -* int $offset -* Optional int $length = -1 - - diff --git a/docs/src/ion/Serializer.md b/docs/src/ion/Serializer.md deleted file mode 100644 index f55b5d2..0000000 --- a/docs/src/ion/Serializer.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Serializer - -Serializer interface, used to customize ion\serialize()'s behavior. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Serializer/PHP.md b/docs/src/ion/Serializer/PHP.md deleted file mode 100644 index 4dec9eb..0000000 --- a/docs/src/ion/Serializer/PHP.md +++ /dev/null @@ -1,24 +0,0 @@ -# class ion\Serializer\PHP implements ion\Serializer - -Specialization of the serializer for PHP. - - - - - - -## Constants: - -None. - -## Properties: - - * public ?ion\Writer\Options $writerOptions - Writer options. - * public bool $multiSequence - Whether to write the top level array as multiple ION sequences. - * public bool $callMagicSerialize - Whether to call magic __serialize() methods on objects to serialize. - * public ?string $callCustomSerialize - Whether and which custom serialize method to call on objects to serialize. - diff --git a/docs/src/ion/Serializer/PHP/__construct.md b/docs/src/ion/Serializer/PHP/__construct.md deleted file mode 100644 index 4cbce8a..0000000 --- a/docs/src/ion/Serializer/PHP/__construct.md +++ /dev/null @@ -1,21 +0,0 @@ -# void ion\Serializer\PHP::__construct([?ion\Writer\Options $writerOptions = NULL, [bool $multiSequence = false, [bool $callMagicSerialize = true, [?string $callCustomSerialize = NULL]]]]) - -Create a new PHP ION serializer. - - - - - - -## Params: - -* Optional ?ion\Writer\Options $writerOptions = NULL - Writer options. -* Optional bool $multiSequence = false - Whether to write the top level array as multiple ION sequences. -* Optional bool $callMagicSerialize = true - Whether to call magic __serialize() methods on objects to serialize. -* Optional ?string $callCustomSerialize = NULL - Whether and which custom serialize method to call on objects to serialize. - - diff --git a/docs/src/ion/Serializer/serialize.md b/docs/src/ion/Serializer/serialize.md deleted file mode 100644 index f0c89a6..0000000 --- a/docs/src/ion/Serializer/serialize.md +++ /dev/null @@ -1,14 +0,0 @@ -# string ion\Serializer::serialize(mixed $data) - - - - - - - - -## Params: - -* mixed $data - - diff --git a/docs/src/ion/Symbol.md b/docs/src/ion/Symbol.md deleted file mode 100644 index 9ccfad9..0000000 --- a/docs/src/ion/Symbol.md +++ /dev/null @@ -1,22 +0,0 @@ -# class ion\Symbol implements Stringable - - - - - -See also [ION spec's symbol definition](https://amzn.github.io/ion-docs/docs/spec.html#symbol), and [ION spec's symbol guide](https://amzn.github.io/ion-docs/guides/symbols-guide.html). - - -## Constants: - -None. - -## Properties: - - * public ?string $value - The symbol's text representation. - * public int $sid - The symbols ID, referencing its location within a shared symbol table. - * public ?ion\Symbol\ImportLocation $importLocation - The import location referencing a shared symbol table. - diff --git a/docs/src/ion/Symbol/Enum.md b/docs/src/ion/Symbol/Enum.md deleted file mode 100644 index 26ff533..0000000 --- a/docs/src/ion/Symbol/Enum.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Symbol\Enum - -Base interface of built-in shared symbol tables. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Symbol/Enum/toSID.md b/docs/src/ion/Symbol/Enum/toSID.md deleted file mode 100644 index 3b61090..0000000 --- a/docs/src/ion/Symbol/Enum/toSID.md +++ /dev/null @@ -1,18 +0,0 @@ -# int ion\Symbol\Enum::toSID() - - - - - - - - -## Params: - -None. - -## Returns: - -* int, The symbol id. - - diff --git a/docs/src/ion/Symbol/Enum/toString.md b/docs/src/ion/Symbol/Enum/toString.md deleted file mode 100644 index dd67145..0000000 --- a/docs/src/ion/Symbol/Enum/toString.md +++ /dev/null @@ -1,18 +0,0 @@ -# string ion\Symbol\Enum::toString() - - - - - - - - -## Params: - -None. - -## Returns: - -* string, The symbol's textual representation. - - diff --git a/docs/src/ion/Symbol/Enum/toSymbol.md b/docs/src/ion/Symbol/Enum/toSymbol.md deleted file mode 100644 index 7701670..0000000 --- a/docs/src/ion/Symbol/Enum/toSymbol.md +++ /dev/null @@ -1,18 +0,0 @@ -# ion\Symbol ion\Symbol\Enum::toSymbol() - - - - - - - - -## Params: - -None. - -## Returns: - -* \ion\Symbol, Instance of the symbol. - - diff --git a/docs/src/ion/Symbol/ImportLocation.md b/docs/src/ion/Symbol/ImportLocation.md deleted file mode 100644 index 18280d6..0000000 --- a/docs/src/ion/Symbol/ImportLocation.md +++ /dev/null @@ -1,20 +0,0 @@ -# class ion\Symbol\ImportLocation - -The import location (referring to a shared table= of a symbol. - - - - - - -## Constants: - -None. - -## Properties: - - * public string $name - The name of the shared symbol table. - * public int $location - The location (sid) of the symbol within the table. - diff --git a/docs/src/ion/Symbol/ImportLocation/__construct.md b/docs/src/ion/Symbol/ImportLocation/__construct.md deleted file mode 100644 index 2697eb6..0000000 --- a/docs/src/ion/Symbol/ImportLocation/__construct.md +++ /dev/null @@ -1,17 +0,0 @@ -# void ion\Symbol\ImportLocation::__construct(string $name, int $location) - -Create a new import location. - - - - - - -## Params: - -* string $name - The name of the shared symbol table. -* int $location - The location (sid) of the symbol within the table. - - diff --git a/docs/src/ion/Symbol/Table.md b/docs/src/ion/Symbol/Table.md deleted file mode 100644 index 12403eb..0000000 --- a/docs/src/ion/Symbol/Table.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Symbol\Table - -Base interface of an ION symbol table. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Symbol/Table/Local.md b/docs/src/ion/Symbol/Table/Local.md deleted file mode 100644 index 31ce291..0000000 --- a/docs/src/ion/Symbol/Table/Local.md +++ /dev/null @@ -1,22 +0,0 @@ -# class ion\Symbol\Table\Local implements ion\Symbol\Table - -A local symbol table. - - - -See also [the ION spec's symbol guide](https://amzn.github.io/ion-docs/guides/symbols-guide.html), and [the ION doc's cookbook](https://amzn.github.io/ion-docs/guides/cookbook.html#using-a-local-symbol-table). - - -## Constants: - -None. - -## Properties: - - * private array $imports = array ( -) - Internal cache. - * private array $symbols = array ( -) - Internal cache. - diff --git a/docs/src/ion/Symbol/Table/Local/__construct.md b/docs/src/ion/Symbol/Table/Local/__construct.md deleted file mode 100644 index 1221557..0000000 --- a/docs/src/ion/Symbol/Table/Local/__construct.md +++ /dev/null @@ -1,13 +0,0 @@ -# void ion\Symbol\Table\Local::__construct() - -Create a local symbol table. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Symbol/Table/Local/import.md b/docs/src/ion/Symbol/Table/Local/import.md deleted file mode 100644 index bc39050..0000000 --- a/docs/src/ion/Symbol/Table/Local/import.md +++ /dev/null @@ -1,20 +0,0 @@ -# void ion\Symbol\Table\Local::import(ion\Symbol\Table $table) - -Import a symbol table. - - - - - - -## Params: - -* ion\Symbol\Table $table - The symbol table to import. - - -## Returns: - -* void, - - diff --git a/docs/src/ion/Symbol/Table/PHP.md b/docs/src/ion/Symbol/Table/PHP.md deleted file mode 100644 index e7662ba..0000000 --- a/docs/src/ion/Symbol/Table/PHP.md +++ /dev/null @@ -1,30 +0,0 @@ -# enum ion\Symbol\Table\PHP implements BackedEnum, UnitEnum, ion\Symbol\Enum - -The built-in PHP symbols. - - - - - - -## Constants: - - * PHP = 'PHP' - * Reference = 'R' - * Backref = 'r' - * Property = 'p' - * Object = 'o' - * ClassObject = 'c' - * MagicObject = 'O' - * CustomObject = 'C' - * Enum = 'E' - * Serializable = 'S' - - -## Properties: - - * public string $name - The built-in PHP symbols. - * public string $value - The built-in PHP symbols. - diff --git a/docs/src/ion/Symbol/Table/Shared.md b/docs/src/ion/Symbol/Table/Shared.md deleted file mode 100644 index 59d9b32..0000000 --- a/docs/src/ion/Symbol/Table/Shared.md +++ /dev/null @@ -1,23 +0,0 @@ -# class ion\Symbol\Table\Shared implements ion\Symbol\Table - -A shared symbol table. - - - -See also [the ION spec's symbol guide](https://amzn.github.io/ion-docs/guides/symbols-guide.html), and [the ION doc's cookbook](https://amzn.github.io/ion-docs/guides/cookbook.html#using-a-shared-symbol-table). - - -## Constants: - -None. - -## Properties: - - * public string $name - The name of the shared symbol table. - * public int $version - The version of the shared symbol table. - * private array $symbols = array ( -) - Internal cache. - diff --git a/docs/src/ion/Symbol/Table/Shared/__construct.md b/docs/src/ion/Symbol/Table/Shared/__construct.md deleted file mode 100644 index 047059c..0000000 --- a/docs/src/ion/Symbol/Table/Shared/__construct.md +++ /dev/null @@ -1,19 +0,0 @@ -# void ion\Symbol\Table\Shared::__construct(string $name, [int $version = 1, [?array $symbols = NULL]]) - -Create a shared symbol table. - - - - - - -## Params: - -* string $name - The name of the shared symbol table. -* Optional int $version = 1 - The version of the shared symbol table. -* Optional ?array $symbols = NULL - Internal cache. - - diff --git a/docs/src/ion/Symbol/Table/System.md b/docs/src/ion/Symbol/Table/System.md deleted file mode 100644 index 4051228..0000000 --- a/docs/src/ion/Symbol/Table/System.md +++ /dev/null @@ -1,29 +0,0 @@ -# enum ion\Symbol\Table\System implements BackedEnum, UnitEnum, ion\Symbol\Enum - -The built-in ION system symbols. - - - - - - -## Constants: - - * Ion = '$ion' - * Ivm_1_0 = '$ion_1_0' - * IonSymbolTable = '$ion_symbol_table' - * Name = 'name' - * Version = 'version' - * Imports = 'imports' - * Symbols = 'symbols' - * MaxId = 'max_id' - * SharedSymbolTable = '$ion_shared_symbol_table' - - -## Properties: - - * public string $name - The built-in ION system symbols. - * public string $value - The built-in ION system symbols. - diff --git a/docs/src/ion/Symbol/Table/add.md b/docs/src/ion/Symbol/Table/add.md deleted file mode 100644 index 293b7f1..0000000 --- a/docs/src/ion/Symbol/Table/add.md +++ /dev/null @@ -1,20 +0,0 @@ -# int ion\Symbol\Table::add(ion\Symbol|string $symbol) - -Add a symbol to the table. - - - - - - -## Params: - -* ion\Symbol|string $symbol - The symbol (value) to add. - - -## Returns: - -* int, The symbol ID. - - diff --git a/docs/src/ion/Symbol/Table/find.md b/docs/src/ion/Symbol/Table/find.md deleted file mode 100644 index bc46bb2..0000000 --- a/docs/src/ion/Symbol/Table/find.md +++ /dev/null @@ -1,20 +0,0 @@ -# ?ion\Symbol ion\Symbol\Table::find(string|int $id) - -Find a symbol within the symbol table, including imports. - - - - - - -## Params: - -* string|int $id - The ID or text of the symbol to find. - - -## Returns: - -* \ion\Symbol|null, The symbol found, if any. - - diff --git a/docs/src/ion/Symbol/Table/findLocal.md b/docs/src/ion/Symbol/Table/findLocal.md deleted file mode 100644 index 0bee077..0000000 --- a/docs/src/ion/Symbol/Table/findLocal.md +++ /dev/null @@ -1,20 +0,0 @@ -# ?ion\Symbol ion\Symbol\Table::findLocal(string|int $id) - -Find a symbol within **only this** symbol table, ignoring imports. - - - - - - -## Params: - -* string|int $id - The ID or text of the symbol to find. - - -## Returns: - -* \ion\Symbol|null, The symbol found, if any. - - diff --git a/docs/src/ion/Symbol/Table/getMaxId.md b/docs/src/ion/Symbol/Table/getMaxId.md deleted file mode 100644 index 09e2b4c..0000000 --- a/docs/src/ion/Symbol/Table/getMaxId.md +++ /dev/null @@ -1,18 +0,0 @@ -# int ion\Symbol\Table::getMaxId() - -Get the maximum symbol ID within the symbol table. - - - - - - -## Params: - -None. - -## Returns: - -* int, The maximum symbol ID. - - diff --git a/docs/src/ion/Symbol/__construct.md b/docs/src/ion/Symbol/__construct.md deleted file mode 100644 index d4894e7..0000000 --- a/docs/src/ion/Symbol/__construct.md +++ /dev/null @@ -1,19 +0,0 @@ -# void ion\Symbol::__construct([?string $value = NULL, [int $sid = -1, [?ion\Symbol\ImportLocation $importLocation = NULL]]]) - -Create an ION symbol. - - - - - - -## Params: - -* Optional ?string $value = NULL - The symbol's text representation. -* Optional int $sid = -1 - The symbols ID, referencing its location within a shared symbol table. -* Optional ?ion\Symbol\ImportLocation $importLocation = NULL - The import location referencing a shared symbol table. - - diff --git a/docs/src/ion/Symbol/equals.md b/docs/src/ion/Symbol/equals.md deleted file mode 100644 index 8f98ba3..0000000 --- a/docs/src/ion/Symbol/equals.md +++ /dev/null @@ -1,23 +0,0 @@ -# bool ion\Symbol::equals(ion\Symbol $symbol) - -Compare two symbols for equality. - -Two symbols are considered equal, if either: -* both are the same object or NULL -* both values are NULL (unknown text), and both $importLocations match -* both values match, regardless of $sid and $importLocation - - - - -## Params: - -* ion\Symbol $symbol - - - -## Returns: - -* bool, whether the two Symbols equal - - diff --git a/docs/src/ion/Symbol/toString.md b/docs/src/ion/Symbol/toString.md deleted file mode 100644 index 7d6ce0b..0000000 --- a/docs/src/ion/Symbol/toString.md +++ /dev/null @@ -1,13 +0,0 @@ -# string ion\Symbol::toString() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Timestamp.md b/docs/src/ion/Timestamp.md deleted file mode 100644 index f771414..0000000 --- a/docs/src/ion/Timestamp.md +++ /dev/null @@ -1,20 +0,0 @@ -# class ion\Timestamp extends DateTime implements DateTimeInterface, Stringable - -An ION Timestamp. - - - -See also [the ION sepc's timestamp definintion](https://amzn.github.io/ion-docs/docs/spec.html#timestamp), and [PHP's date documentation](https://php.net/date). - - -## Constants: - -None. - -## Properties: - - * public int $precision - The timestamp's precision. See ion\Timestamp\Precision. - * public string $format - The timestamp's format. See ion\Timestamp\Format. - diff --git a/docs/src/ion/Timestamp/Format.md b/docs/src/ion/Timestamp/Format.md deleted file mode 100644 index 3adee4e..0000000 --- a/docs/src/ion/Timestamp/Format.md +++ /dev/null @@ -1,29 +0,0 @@ -# enum ion\Timestamp\Format implements BackedEnum, UnitEnum - -Timestamp format. - - - - - - -## Constants: - - * Year = 'Y\\T' - * Month = 'Y-m\\T' - * Day = 'Y-m-d\\T' - * Min = 'Y-m-d\\TH:i' - * Sec = 'Y-m-d\\TH:i:s' - * Frac = 'Y-m-d\\TH:i:s.v' - * MinTZ = 'Y-m-d\\TH:iP' - * SecTZ = 'Y-m-d\\TH:i:sP' - * FracTZ = 'Y-m-d\\TH:i:s.vP' - - -## Properties: - - * public string $name - Timestamp format. - * public string $value - Timestamp format. - diff --git a/docs/src/ion/Timestamp/Precision.md b/docs/src/ion/Timestamp/Precision.md deleted file mode 100644 index 6c86ffa..0000000 --- a/docs/src/ion/Timestamp/Precision.md +++ /dev/null @@ -1,29 +0,0 @@ -# enum ion\Timestamp\Precision implements BackedEnum, UnitEnum - -Timestamp precision. - - - - - - -## Constants: - - * Year = 1 - * Month = 3 - * Day = 7 - * Min = 23 - * Sec = 55 - * Frac = 119 - * MinTZ = 151 - * SecTZ = 183 - * FracTZ = 247 - - -## Properties: - - * public string $name - Timestamp precision. - * public int $value - Timestamp precision. - diff --git a/docs/src/ion/Timestamp/__construct.md b/docs/src/ion/Timestamp/__construct.md deleted file mode 100644 index 77b8953..0000000 --- a/docs/src/ion/Timestamp/__construct.md +++ /dev/null @@ -1,21 +0,0 @@ -# void ion\Timestamp::__construct(ion\Timestamp\Precision|int $precision, [ion\Timestamp\Format|string|null $format = NULL, [?string $datetime = NULL, [?DateTimeZone $timezone = NULL]]]) - -Create a new ION timestamp. - - - - - - -## Params: - -* ion\Timestamp\Precision|int $precision - The timestamp's precision. See ion\Timestamp\Precision. -* Optional ion\Timestamp\Format|string|null $format = NULL - The timestamp's format. See ion\Timestamp\Format. -* Optional ?string $datetime = NULL - The timestamp's value. -* Optional ?DateTimeZone $timezone = NULL - The timestamp's timezone. - - diff --git a/docs/src/ion/Type.md b/docs/src/ion/Type.md deleted file mode 100644 index 428bc68..0000000 --- a/docs/src/ion/Type.md +++ /dev/null @@ -1,40 +0,0 @@ -# enum ion\Type implements BackedEnum, UnitEnum - -ION data type. - -The following special PHP classes are provided for some data types: -* ion\Decimal -* ion\Timestamp -* ion\Symbol -* ion\Lob - - - - -## Constants: - - * Null = 0 - * Bool = 256 - * Int = 512 - * Float = 1024 - * Decimal = 1280 - * Timestamp = 1536 - * Symbol = 1792 - * String = 2048 - * CLob = 2304 - * BLob = 2560 - * List = 2816 - * SExp = 3072 - * Struct = 3328 - * Datagram = 3840 - * EOF = -256 - * NONE = -512 - - -## Properties: - - * public string $name - ION data type. - * public int $value - ION data type. - diff --git a/docs/src/ion/Unserializer.md b/docs/src/ion/Unserializer.md deleted file mode 100644 index d0622ce..0000000 --- a/docs/src/ion/Unserializer.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Unserializer - -Unserializer interface, used to customize ion\unserialize()'s behavior. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Unserializer/PHP.md b/docs/src/ion/Unserializer/PHP.md deleted file mode 100644 index f64da55..0000000 --- a/docs/src/ion/Unserializer/PHP.md +++ /dev/null @@ -1,24 +0,0 @@ -# class ion\Unserializer\PHP implements ion\Unserializer - -Specialization of the unserializer for PHP. - - - - - - -## Constants: - -None. - -## Properties: - - * public ?ion\Reader\Options $readerOptions - Reader options. - * public bool $multiSequence - Whether to continue reading multiple ION sequences after the first one. - * public bool $callMagicUnserialize - Whether to call magic __unserialize() methods on objects to unserialize. - * public ?string $callCustomUnserialize - Whether and which custom unserialize method to call on objects to unserialize. - diff --git a/docs/src/ion/Unserializer/PHP/__construct.md b/docs/src/ion/Unserializer/PHP/__construct.md deleted file mode 100644 index e8ccbec..0000000 --- a/docs/src/ion/Unserializer/PHP/__construct.md +++ /dev/null @@ -1,21 +0,0 @@ -# void ion\Unserializer\PHP::__construct([?ion\Reader\Options $readerOptions = NULL, [bool $multiSequence = false, [bool $callMagicUnserialize = true, [?string $callCustomUnserialize = NULL]]]]) - -Create a new ION PHP unserializer. - - - - - - -## Params: - -* Optional ?ion\Reader\Options $readerOptions = NULL - Reader options. -* Optional bool $multiSequence = false - Whether to continue reading multiple ION sequences after the first one. -* Optional bool $callMagicUnserialize = true - Whether to call magic __unserialize() methods on objects to unserialize. -* Optional ?string $callCustomUnserialize = NULL - Whether and which custom unserialize method to call on objects to unserialize. - - diff --git a/docs/src/ion/Unserializer/unserialize.md b/docs/src/ion/Unserializer/unserialize.md deleted file mode 100644 index 1b15722..0000000 --- a/docs/src/ion/Unserializer/unserialize.md +++ /dev/null @@ -1,15 +0,0 @@ -# mixed ion\Unserializer::unserialize(string|resource $data) - - - - - - - - -## Params: - -* string|resource $data - - - diff --git a/docs/src/ion/Writer.md b/docs/src/ion/Writer.md deleted file mode 100644 index 82250d5..0000000 --- a/docs/src/ion/Writer.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Writer - -ION writer API. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Writer/Buffer.md b/docs/src/ion/Writer/Buffer.md deleted file mode 100644 index 4f82f52..0000000 --- a/docs/src/ion/Writer/Buffer.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Writer\Buffer implements ion\Writer - -ION buffer writer API. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Writer/Buffer/Writer.md b/docs/src/ion/Writer/Buffer/Writer.md deleted file mode 100644 index da37e42..0000000 --- a/docs/src/ion/Writer/Buffer/Writer.md +++ /dev/null @@ -1,16 +0,0 @@ -# class ion\Writer\Buffer\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Buffer - -IO buffer writer. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Writer/Buffer/Writer/__construct.md b/docs/src/ion/Writer/Buffer/Writer/__construct.md deleted file mode 100644 index 841add5..0000000 --- a/docs/src/ion/Writer/Buffer/Writer/__construct.md +++ /dev/null @@ -1,15 +0,0 @@ -# void ion\Writer\Buffer\Writer::__construct([?ion\Writer\Options $options = NULL]) - -Create a new buffer writer. - - - - - - -## Params: - -* Optional ?ion\Writer\Options $options = NULL - Writer options. - - diff --git a/docs/src/ion/Writer/Buffer/getBuffer.md b/docs/src/ion/Writer/Buffer/getBuffer.md deleted file mode 100644 index 8124851..0000000 --- a/docs/src/ion/Writer/Buffer/getBuffer.md +++ /dev/null @@ -1,13 +0,0 @@ -# string ion\Writer\Buffer::getBuffer() - -Get the buffer written to. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/Buffer/resetBuffer.md b/docs/src/ion/Writer/Buffer/resetBuffer.md deleted file mode 100644 index f9b35d5..0000000 --- a/docs/src/ion/Writer/Buffer/resetBuffer.md +++ /dev/null @@ -1,13 +0,0 @@ -# void ion\Writer\Buffer::resetBuffer() - -Reset the buffer written to. - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/Options.md b/docs/src/ion/Writer/Options.md deleted file mode 100644 index d95da31..0000000 --- a/docs/src/ion/Writer/Options.md +++ /dev/null @@ -1,40 +0,0 @@ -# class ion\Writer\Options - -ION writer options. - - - - - - -## Constants: - -None. - -## Properties: - - * public ?ion\Catalog $catalog - ION catalog to use for symbol lookup. - * public ?ion\Decimal\Context $decimalContext - Decimal context to use. - * public bool $outputBinary - Whether to output binary ION. - * public bool $compactFloats - Whether to write doubles which fit in 32 bits as floats. - * public bool $escapeNonAscii - Whether to slash-escape all non ASCII bytes. - * public bool $prettyPrint - Whether to produce pretty-printed output. - * public bool $indentTabs - Whether to indent with tabs, when pretty-printing. - * public int $indentSize - The number of spaces to use for indentation instead of tabs, when pretty-printing. - * public bool $flushEveryValue - Whether to immediately flush every value written. - * public int $maxContainerDepth - Maximum depth of nested containers. - * public int $maxAnnotations - The maximum number of annotations allowed on a single value. - * public int $tempBufferSize - Temporary buffer size. - diff --git a/docs/src/ion/Writer/Options/__construct.md b/docs/src/ion/Writer/Options/__construct.md deleted file mode 100644 index 0f8bddc..0000000 --- a/docs/src/ion/Writer/Options/__construct.md +++ /dev/null @@ -1,37 +0,0 @@ -# void ion\Writer\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [bool $outputBinary = false, [bool $compactFloats = false, [bool $escapeNonAscii = false, [bool $prettyPrint = false, [bool $indentTabs = true, [int $indentSize = 2, [bool $flushEveryValue = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $tempBufferSize = 16384]]]]]]]]]]]]) - -Create custom ION writer options. - - - - - - -## Params: - -* Optional ?ion\Catalog $catalog = NULL - ION catalog to use for symbol lookup. -* Optional ?ion\Decimal\Context $decimalContext = NULL - Decimal context to use. -* Optional bool $outputBinary = false - Whether to output binary ION. -* Optional bool $compactFloats = false - Whether to write doubles which fit in 32 bits as floats. -* Optional bool $escapeNonAscii = false - Whether to slash-escape all non ASCII bytes. -* Optional bool $prettyPrint = false - Whether to produce pretty-printed output. -* Optional bool $indentTabs = true - Whether to indent with tabs, when pretty-printing. -* Optional int $indentSize = 2 - The number of spaces to use for indentation instead of tabs, when pretty-printing. -* Optional bool $flushEveryValue = false - Whether to immediately flush every value written. -* Optional int $maxContainerDepth = 10 - Maximum depth of nested containers. -* Optional int $maxAnnotations = 10 - The maximum number of annotations allowed on a single value. -* Optional int $tempBufferSize = 16384 - Temporary buffer size. - - diff --git a/docs/src/ion/Writer/Stream.md b/docs/src/ion/Writer/Stream.md deleted file mode 100644 index de84c44..0000000 --- a/docs/src/ion/Writer/Stream.md +++ /dev/null @@ -1,16 +0,0 @@ -# interface ion\Writer\Stream implements ion\Writer - -ION stream writer API. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Writer/Stream/Writer.md b/docs/src/ion/Writer/Stream/Writer.md deleted file mode 100644 index 9a4675a..0000000 --- a/docs/src/ion/Writer/Stream/Writer.md +++ /dev/null @@ -1,16 +0,0 @@ -# class ion\Writer\Stream\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Stream - -ION stream writer. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Writer/Stream/Writer/__construct.md b/docs/src/ion/Writer/Stream/Writer/__construct.md deleted file mode 100644 index d5fe0c5..0000000 --- a/docs/src/ion/Writer/Stream/Writer/__construct.md +++ /dev/null @@ -1,17 +0,0 @@ -# void ion\Writer\Stream\Writer::__construct(resource $stream, [?ion\Writer\Options $options = NULL]) - -Create a new stream writer. - - - - - - -## Params: - -* resource $stream - The stream to write to. -* Optional ?ion\Writer\Options $options = NULL - Writer options. - - diff --git a/docs/src/ion/Writer/Stream/getStream.md b/docs/src/ion/Writer/Stream/getStream.md deleted file mode 100644 index 883b0e5..0000000 --- a/docs/src/ion/Writer/Stream/getStream.md +++ /dev/null @@ -1,18 +0,0 @@ -# void ion\Writer\Stream::getStream() - -Get the stream being written to. - - - - - - -## Params: - -None. - -## Returns: - -* resource, - - diff --git a/docs/src/ion/Writer/Writer.md b/docs/src/ion/Writer/Writer.md deleted file mode 100644 index 424a96b..0000000 --- a/docs/src/ion/Writer/Writer.md +++ /dev/null @@ -1,16 +0,0 @@ -# abstract class ion\Writer\Writer implements ion\Writer - -Base implementation of common functionality of ION writers. - - - - - - -## Constants: - -None. - -## Properties: - -None. diff --git a/docs/src/ion/Writer/appendLob.md b/docs/src/ion/Writer/appendLob.md deleted file mode 100644 index 042e38e..0000000 --- a/docs/src/ion/Writer/appendLob.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::appendLob(string $data) - - - - - - - - -## Params: - -* string $data - - diff --git a/docs/src/ion/Writer/finish.md b/docs/src/ion/Writer/finish.md deleted file mode 100644 index c90c935..0000000 --- a/docs/src/ion/Writer/finish.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Writer::finish() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/finishContainer.md b/docs/src/ion/Writer/finishContainer.md deleted file mode 100644 index 637cb36..0000000 --- a/docs/src/ion/Writer/finishContainer.md +++ /dev/null @@ -1,13 +0,0 @@ -# void ion\Writer::finishContainer() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/finishLob.md b/docs/src/ion/Writer/finishLob.md deleted file mode 100644 index 4fa960d..0000000 --- a/docs/src/ion/Writer/finishLob.md +++ /dev/null @@ -1,13 +0,0 @@ -# void ion\Writer::finishLob() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/flush.md b/docs/src/ion/Writer/flush.md deleted file mode 100644 index 9ed2c84..0000000 --- a/docs/src/ion/Writer/flush.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Writer::flush() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/getDepth.md b/docs/src/ion/Writer/getDepth.md deleted file mode 100644 index f089235..0000000 --- a/docs/src/ion/Writer/getDepth.md +++ /dev/null @@ -1,13 +0,0 @@ -# int ion\Writer::getDepth() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/startContainer.md b/docs/src/ion/Writer/startContainer.md deleted file mode 100644 index 7f7e83a..0000000 --- a/docs/src/ion/Writer/startContainer.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::startContainer(ion\Type $type) - - - - - - - - -## Params: - -* ion\Type $type - - diff --git a/docs/src/ion/Writer/startLob.md b/docs/src/ion/Writer/startLob.md deleted file mode 100644 index 9a8e173..0000000 --- a/docs/src/ion/Writer/startLob.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::startLob(ion\Type $type) - - - - - - - - -## Params: - -* ion\Type $type - - diff --git a/docs/src/ion/Writer/writeAnnotation.md b/docs/src/ion/Writer/writeAnnotation.md deleted file mode 100644 index 9c18eda..0000000 --- a/docs/src/ion/Writer/writeAnnotation.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeAnnotation([ion\Symbol|string ?>...$annotation]) - - - - - - - - -## Params: - -* Optional ion\Symbol|string ?>...$annotation - - diff --git a/docs/src/ion/Writer/writeBLob.md b/docs/src/ion/Writer/writeBLob.md deleted file mode 100644 index 4c6ddbe..0000000 --- a/docs/src/ion/Writer/writeBLob.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeBLob(string $value) - - - - - - - - -## Params: - -* string $value - - diff --git a/docs/src/ion/Writer/writeBool.md b/docs/src/ion/Writer/writeBool.md deleted file mode 100644 index f6fa611..0000000 --- a/docs/src/ion/Writer/writeBool.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeBool(bool $value) - - - - - - - - -## Params: - -* bool $value - - diff --git a/docs/src/ion/Writer/writeCLob.md b/docs/src/ion/Writer/writeCLob.md deleted file mode 100644 index 33ea7af..0000000 --- a/docs/src/ion/Writer/writeCLob.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeCLob(string $value) - - - - - - - - -## Params: - -* string $value - - diff --git a/docs/src/ion/Writer/writeDecimal.md b/docs/src/ion/Writer/writeDecimal.md deleted file mode 100644 index 90a4bef..0000000 --- a/docs/src/ion/Writer/writeDecimal.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeDecimal(ion\Decimal|string $value) - - - - - - - - -## Params: - -* ion\Decimal|string $value - - diff --git a/docs/src/ion/Writer/writeFieldName.md b/docs/src/ion/Writer/writeFieldName.md deleted file mode 100644 index a145e04..0000000 --- a/docs/src/ion/Writer/writeFieldName.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeFieldName(string $name) - - - - - - - - -## Params: - -* string $name - - diff --git a/docs/src/ion/Writer/writeFloat.md b/docs/src/ion/Writer/writeFloat.md deleted file mode 100644 index 7258cd2..0000000 --- a/docs/src/ion/Writer/writeFloat.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeFloat(float $value) - - - - - - - - -## Params: - -* float $value - - diff --git a/docs/src/ion/Writer/writeInt.md b/docs/src/ion/Writer/writeInt.md deleted file mode 100644 index 9ad467f..0000000 --- a/docs/src/ion/Writer/writeInt.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeInt(string|int $value) - - - - - - - - -## Params: - -* string|int $value - - diff --git a/docs/src/ion/Writer/writeNull.md b/docs/src/ion/Writer/writeNull.md deleted file mode 100644 index 52eba4a..0000000 --- a/docs/src/ion/Writer/writeNull.md +++ /dev/null @@ -1,13 +0,0 @@ -# void ion\Writer::writeNull() - - - - - - - - -## Params: - -None. - diff --git a/docs/src/ion/Writer/writeString.md b/docs/src/ion/Writer/writeString.md deleted file mode 100644 index 1bee7b2..0000000 --- a/docs/src/ion/Writer/writeString.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeString(string $value) - - - - - - - - -## Params: - -* string $value - - diff --git a/docs/src/ion/Writer/writeSymbol.md b/docs/src/ion/Writer/writeSymbol.md deleted file mode 100644 index c39822e..0000000 --- a/docs/src/ion/Writer/writeSymbol.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeSymbol(ion\Symbol|string $value) - - - - - - - - -## Params: - -* ion\Symbol|string $value - - diff --git a/docs/src/ion/Writer/writeTimestamp.md b/docs/src/ion/Writer/writeTimestamp.md deleted file mode 100644 index a098afb..0000000 --- a/docs/src/ion/Writer/writeTimestamp.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeTimestamp(ion\Timestamp|string $value) - - - - - - - - -## Params: - -* ion\Timestamp|string $value - - diff --git a/docs/src/ion/Writer/writeTypedNull.md b/docs/src/ion/Writer/writeTypedNull.md deleted file mode 100644 index 4da68c2..0000000 --- a/docs/src/ion/Writer/writeTypedNull.md +++ /dev/null @@ -1,14 +0,0 @@ -# void ion\Writer::writeTypedNull(ion\Type $type) - - - - - - - - -## Params: - -* ion\Type $type - - diff --git a/docs/src/ion/serialize.md b/docs/src/ion/serialize.md deleted file mode 100644 index 16015a0..0000000 --- a/docs/src/ion/serialize.md +++ /dev/null @@ -1,30 +0,0 @@ -# string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL]) - -Serialize a PHP value as ION data. - -Serializes supported PHP values with the optionally provided \ion\Serializer: -* NULL -* bool -* int -* float -* string -* references -* arrays -* objects (incl. \Serializable, and classes implementing magic and custom __serialize) - - - - -## Params: - -* mixed $data - PHP value(s). -* Optional ?ion\Serializer $serializer = NULL - Custom serializer. - - -## Returns: - -* string, serialized ION data - - diff --git a/docs/src/ion/unserialize.md b/docs/src/ion/unserialize.md deleted file mode 100644 index e9ac009..0000000 --- a/docs/src/ion/unserialize.md +++ /dev/null @@ -1,22 +0,0 @@ -# mixed ion\unserialize(string|resource $data, [?ion\Unserializer $unserializer = NULL]) - -Unserialize ION data (stream) as PHP value(s). - - - - - - -## Params: - -* string|resource $data - Serialized ION data, either as string buffer or stream,. -* Optional ?ion\Unserializer $unserializer = NULL - Unserialize ION data (stream) as PHP value(s). - - -## Returns: - -* mixed, unserialized PHP values - - diff --git a/docs/v0.0/.htaccess b/docs/v0.0/.htaccess new file mode 100644 index 0000000..aa71b43 --- /dev/null +++ b/docs/v0.0/.htaccess @@ -0,0 +1,11 @@ +Options -Indexes +MultiViews +FollowSymLinks +DirectorySlash Off + +RewriteEngine On +RewriteCond %{REQUEST_FILENAME} -d +RewriteRule ^(.+)$ $1.html [L] + + + ForceType text/x-php + SetHandler default-handler + diff --git a/docs/v0.0/.nojekyll b/docs/v0.0/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/v0.0/AUTHORS b/docs/v0.0/AUTHORS new file mode 100644 index 0000000..67bbd91 --- /dev/null +++ b/docs/v0.0/AUTHORS @@ -0,0 +1 @@ +Michael Wallner diff --git a/docs/v0.0/LICENSE b/docs/v0.0/LICENSE new file mode 100644 index 0000000..816ff40 --- /dev/null +++ b/docs/v0.0/LICENSE @@ -0,0 +1,23 @@ +Copyright (c) 2013, Michael Wallner . +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/docs/v0.0/VERSION b/docs/v0.0/VERSION new file mode 100644 index 0000000..cd5ac03 --- /dev/null +++ b/docs/v0.0/VERSION @@ -0,0 +1 @@ +2.0 diff --git a/docs/v0.0/favicon.ico b/docs/v0.0/favicon.ico new file mode 100644 index 0000000..d28351c Binary files /dev/null and b/docs/v0.0/favicon.ico differ diff --git a/docs/v0.0/index.css b/docs/v0.0/index.css new file mode 100644 index 0000000..c0204cd --- /dev/null +++ b/docs/v0.0/index.css @@ -0,0 +1,317 @@ +html { + font-size: 18px; +} +html, body{ + height: 100%; + min-height: 100%; +} +body, code { + font-family: Inconsolata, 'Inconsolata Awesome', 'Andale Mono', Monaco, 'Courier New', Courier, monospace; +} +body { + line-height: 1.5; + font-size: 1.1em; + margin: 0; + padding: 0; + color: #3f3f3f; +} + +div.page { + margin: auto; +/* max-width: 1200px; +*/ min-height: 100%; + padding-bottom: 5em; + box-shadow: 0 0 20px 10px rgba(0, 0, 0, 0.5); +} + +div.page>* { + margin-left: 1em; +} +div.page>footer { + margin-left: 0; +} +div.page>ul, div.page>div>ul { + margin-left: 2em; +} + +.sidebar { + float: right; + background: #f0f0f0; + border-bottom-left-radius: 10px; + padding: 0; + width: auto; + min-width: 200px; + padding-right: 1em; + padding-bottom: 1em; + margin-bottom: 1em; +} +.sidebar>ul { +} +.sidebar ul { + margin-left: 1em; + margin-top: .5em; + margin-bottom: 0; + padding: 0; + list-style-type: none; +} + +.sidebar .edit { + display: block; + position: relative; + top: 2em; + right: 0; + -webkit-transform: rotate(45deg); + transform: rotate(45deg); + text-decoration: none; + font-weight: bold; + text-shadow: 0 0 5px red; + float: right; +} + +.sidebar .edit a { + color: white !important; +} +code { + border-radius: 2px; + padding: 0px 2px 2px 2px; + background: #f0f0f0; + color: #606060; + box-shadow: 0 0 1px #999; +} + +code code { + display: inline; + padding: 0; + background: transparent; + border: none; + box-shadow: none; +} + +pre>code { + display: inline-block; + padding: 1em; + min-width: 50%; + line-height: 1.2; +} + +pre>code, pre>code code { + background: #333; + color: #eee; +} + +p, pre, table, dl { + margin: 1em 2em; + margin-left: 2em !important; +} + +pre>code, table, dl { + margin-bottom: 2em !important; +} + +li>p { + margin: 1em 0; +} + +blockquote { + border-top: 1px solid #800000; + border-bottom: 1px solid #800000; + background: #ffe4e1; + margin: 2em 0 !important; +} + +ul { + margin-top: 1em; + margin-bottom: 2em; +} +ol { + list-style-type: none; +} +ol ul { + margin-top: 0; + margin-bottom: 0; +} +ol li { + margin-bottom: 0; +} +ol>li { + font-weight: bold; + margin-bottom: .5em; +} +ol>li>* { + font-weight: normal; +} +li { + margin-bottom: .5em; +} +a, h1 code>a { + color: #2f4f4f; +} +a:hover { + text-decoration: none; +} +a[href^="http:"]:after, a[href^="https:"]:after { + content: " ⬈"; +} + +a.permalink { + position: relative; + top: 0; + right: 0; + color: #999999; + opacity: 0.25; +} + +.var { + color: #800000; +} +.constant { + color: #2e8b57; +} + +h1, li h3, th, footer { + background: #708090; + color: #f5f5dc; +} + +h1, footer { + margin: 0; +/* max-width: 1200px; +*/ padding: 1em; +} + +h1 { + line-height: 1.5; + margin-left: 0 !important; + padding-left: 2em; +} +h1 code { + font-weight: normal; + font-size: .9em; + line-height: 1.33; +} +h1 a.permalink { + left: -.8em; + margin-right: -.6em; +} + +li h3 { + border-radius: 4px; + display: inline-block; + width: auto; + padding: .2em; + margin: .5em 0 0 0; +} + +div.page>h3, div.page>div>h3 { + margin-left: 1.25em; +} +div.page>h4, div.page>div>h4 { + margin-left: 1.5em; +} +div.page>h5, div.page>div>h5 { + margin-left: 1.75em; +} +div.page>h6, div.page>div>h6 { + margin-left: 2em; +} + +h1 .constant, pre>code .consant, li h3 .constant { + color: #98fb98; +} + +h1 .var, pre>code .var, li h3 .var { + color: #f4a460; +} +h1 { + font-size: 125%; +} +h2 { + font-size: 120%; +} +h3 { + font-size: 110%; +} +h4 { + font-size: 100%; +} +footer a, h1 a, pre>code a, li h3 a { + color: #b0e0e6; +} +li h3 { +} +li h3 a { + text-decoration: none; +} +li h3 a:hover { + text-decoration: underline; +} + +#disqus_thread { + margin-top: 8em; + margin-right: 2em; +} +#disqus_activator { + margin: auto; + width: 80%; + padding: 1em; + background-color: slategrey; + color: white; + font-size: 1em; + font-weight: bold; + border: 0; + border-radius: 2px; + box-shadow: 0 0 4px #999; +} + +footer { + font-size: smaller; + text-align: center; + clear: both; + position: fixed; + bottom: 0; + width: 100%; + padding: 0; + transition: margin-bottom 2s ease 0.1s; +} +footer.hidden { + margin-bottom: -10em; + transition: margin-bottom 2s ease 0.1s; +} + +footer ul { + margin: 0; + padding: 1em 0; +} + +footer li { + list-style-type: none; + display: inline-block; + margin: 0 1em; +} + +footer a { + text-decoration: none; +} + +footer a:hover { + text-decoration: underline; +} + +table { + border-collapse: collapse; +} +th, td { + padding: .4em; + border-bottom: 1px solid rgba(112, 128, 144, 0.1); +} +dt { + font-weight: bold; + margin-top: 1em; +} +dd { + line-height: 1.33; + margin-left: 1em; +} +h1, footer, table, .sidebar, pre>code, li h3 { + box-shadow: 0 0 4px #708090; +} diff --git a/docs/v0.0/index.html b/docs/v0.0/index.html new file mode 100644 index 0000000..1895bff --- /dev/null +++ b/docs/v0.0/index.html @@ -0,0 +1,71 @@ + + + + + + mdref + + + + + + + + + + + +
+ +
+ + + +
+ +

mdref

+ + +

+ pecl/ion

+

PHP extension wrapping amzn/ion-c. +See the Amazon ION specification.

+
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/index.js b/docs/v0.0/index.js new file mode 100644 index 0000000..5124ffe --- /dev/null +++ b/docs/v0.0/index.js @@ -0,0 +1,250 @@ +"use strict"; + +$(function() { + var mdref = { + log: function log() { + console.log.apply(console, arguments); + }, + is_constant: function is_constant(s) { + s = s.replace(/v\d+(_\d+)?$/, ""); + if (s.length < 2) { + return false; + } + return s.toUpperCase(s) === s; + }, + is_variable: function is_variable(s) { + return s.substring(0,1) === "$"; + }, + type: function type(s, nn) { + var i, j, t; + // mdref.log("type", s); + // nothing + if (!s.match(/[a-zA-Z]/)) { + return; + } + + switch (s) { + // types + case "void": + case "bool": + case "int": + case "float": + case "string": + case "resource": + case "array": + case "object": + case "callable": + case "mixed": + // Zend/SPL + case "stdClass": + case "Exception": + case "ErrorException": + case "RuntimeException": + case "UnexpectedValueException": + case "DomainException": + case "InvalidArgumentException": + case "BadMethodCallException": + case "Closure": + case "Generator": + case "Countable": + case "Serializable": + case "Traversable": + case "Iterator": + case "IteratorAggregate": + case "RecursiveIterator": + case "ArrayAccess": + case "ArrayObject": + case "ArrayIterator": + case "RecursiveArrayIterator": + case "SeekableIterator": + case "SplObserver": + case "SplSubject": + case "SplObjectStorage": + case "JsonSerializable": + return ""; + + // keywords + case "is": + if (nn !== "H1") { + return; + } + case "extends": + case "implements": + if (nn === "H1") { + return "
 "; + } + case "class": + case "enum": + case "interface": + case "namespace": + case "public": + case "protected": + case "private": + case "static": + case "final": + case "abstract": + case "self": + case "parent": + // phrases + case "Optional": + case "optional": + return ""; + } + + // class members + if (-1 !== (i = s.indexOf("::"))) { + t = s.substring(i+2); + if (!mdref.is_constant(t) && !mdref.is_variable(t)) { + // methods + return ""; + } + } + if (-1 !== (j = s.lastIndexOf("\\")) && s.substr(j+1,1) !== "n") { + t = s.substring(j+1); + if (!mdref.is_constant(t) || s.match(/\\/g).length <= 1) { + return ""; + } + return ""; + } + + switch (s.toLowerCase()) { + // variables + default: + if (!mdref.is_variable(s)) { + break; + } + // special constants + case "null": + case "true": + case "false": + return ""; + } + + // constants + if (mdref.is_constant(s)) { + return ""; + } + }, + wrap: function wrap(n, nn) { + var $n = $(n) + var a = []; + + $n.text().split(/([^a-zA-Z0-9_\\\$:]+)/).forEach(function(v) { + var t; + + if ((t = mdref.type(v.replace(/:$/, ""), nn))) { + a.push($(t).text(v)); + } else if (a.length && a[a.length-1].nodeName === "#text") { + /* if we already have a text node and the next is also gonna be a text + * node, then join them, becuase chrome v30+ or something eats whitespace + * for breakfast, lunch and dinner! + */ + a[a.length-1].textContent += v; + } else { + a.push(document.createTextNode(v)); + } + }); + $n.replaceWith(a); + }, + walk: function walk(i, e) { + // mdref.log("walk", i, e); + + switch (e.nodeName) { + case "H1": + case "H2": + case "H3": + case "H4": + case "H5": + case "H6": + if (e.id.length) { + var href = document.location.pathname; + var perm = $("#"); + if (e.nodeName === "H1") { + perm.prependTo(e); + } else { + perm.attr("href", function(i, href) { + return href + e.id; + }); + perm.appendTo(e); + } + } + break; + } + + $.each($.makeArray(e.childNodes), function(i, n) { + switch (n.nodeName) { + case "A": + case "BR": + case "HR": + case "EM": + case "CODE": + case "SPAN": + break; + case "#text": + mdref.wrap(n, e.nodeName); + break; + default: + mdref.walk(-1, n); + break; + } + }); + }, + blink: function blink(c) { + var $c = $(c); + + $c.fadeOut("fast").queue(function(next) { + this.style.color = "red"; + next(); + }).fadeIn("fast").fadeOut("slow").queue(function(next) { + this.style.color = ""; + next(); + }).fadeIn("slow"); + }, + hashchange: function hashchange() { + if (location.hash.length > 1) { + var e; + if ((e = document.getElementById(location.hash.substring(1)))) { + mdref.blink(e); + } else { + var hash = location.hash.substring(1); + var name = mdref.is_variable(hash) ? ".var" : ".constant"; + var scrolled = false; + + $(name).each(hash.substring(hash.length-1) === "_" ? function(i, c) { + if (c.textContent.substring(0, hash.length) === hash) { + if (!scrolled) { + $(window).scrollTop($(c).offset().top - 100); + scrolled = true; + } + mdref.blink(c); + } + } : function(i, c) { + if (c.textContent === hash) { + $(window).scrollTop($(c).offset().top - 100); + mdref.blink(c); + return false; + } + }); + } + } + } + }; + + $("h1,h2,h3,h4,h5,h6,p,li,code,td").each(mdref.walk); + $(window).on("hashchange", mdref.hashchange); + mdref.hashchange(); + + $("#disqus_activator").on("click", function() { + var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; + dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js'; + (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); + }); + $.ajax("https://disqus.com/api/3.0/threads/details.json?thread:ident="+(disqus_identifier||"index")+"&forum=mdref&api_key=VmhVG4z5jjtY8SCaMstOjfUuwniMv43Xy9FCU9YfEzhsrl95dNz1epykXSJn8jt9"). then(function(json) { + if (json && json.response) { + $("#disqus_activator span").text(json.response.posts); + } + }); + setTimeout(function() { + $("footer").addClass("hidden"); + }, 1000); +}); diff --git a/docs/v0.0/ion.html b/docs/v0.0/ion.html new file mode 100644 index 0000000..ab01a31 --- /dev/null +++ b/docs/v0.0/ion.html @@ -0,0 +1,424 @@ + + + + + + ion - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

pecl/ion

+

About:

+

PHP extension wrapping amzn/ion-c. +See the Amazon ION specification.

+

License:

+

BSD-2-Clause; +see spdx.org.

+

Installation:

+

PECL and PHARext is WIP.

+

Dependencies:

+

Required:

+
    +
  • PHP-8.1 +
      +
    • ext/date (standard)
      • +
    • ext/spl (standard)
      • +
    +
    • +
+

Optional:

+ +

Trinity:

+
phpize
+./configure
+make # -j$(nproc)
+sudo make install # INSTALL=install
+
+

Try with Docker:

+
docker build -t php-ion
+docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\Table\PHP());'
+
+

Editor Stub:

+

See ion.stub.php.

+

Known Issues:

+

Due to private internal state of ion-c's readers and writers, +instances of the following PHP classes cannot be cloned:

+
    +
  • ion\Reader\Reader
    • +
  • ion\Writer\Writer
    • +
  • ion\Serializer\PHP
    • +
  • ion\Unserializer\PHP
    • +
+ + + +

Functions:

+
    + +
  • +

    serialize

    +

    Serialize a PHP value as ION data.

    + +

    string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL])

    +
    • + +
  • +

    unserialize

    +

    Unserialize ION data (stream) as PHP value(s).

    + +

    mixed ion\unserialize(string|resource $data, [?ion\Unserializer $unserializer = NULL])

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Catalog

    +

    The Catalog holds a collection of ion\Symbol\Table instances queried from ion\Reader and ion\Writer instances.

    + +

    class ion\Catalog implements Countable

    +
    • + +
  • +

    Decimal

    +

    An arbitrary precision fixed point decimal.

    + +

    class ion\Decimal implements Stringable

    +
    • + +
  • +

    Exception

    +

    Base exception for the ION extension.

    + +

    class ion\Exception extends Exception implements Stringable, Throwable

    +
    • + +
  • +

    LOB

    +

    A large object.

    + +

    class ion\LOB

    +
    • + +
  • +

    Reader

    +

    ION reader API.

    + +

    interface ion\Reader implements Iterator, RecursiveIterator, Traversable

    +
    • + +
  • +

    Serializer

    +

    Serializer interface, used to customize ion\serialize()'s behavior.

    + +

    interface ion\Serializer

    +
    • + +
  • +

    Symbol

    + +

    class ion\Symbol implements Stringable

    +
    • + +
  • +

    Timestamp

    +

    An ION Timestamp.

    + +

    class ion\Timestamp extends DateTime implements DateTimeInterface, Stringable

    +
    • + +
  • +

    Type

    +

    ION data type.

    + +

    enum ion\Type implements BackedEnum, UnitEnum

    +
    • + +
  • +

    Unserializer

    +

    Unserializer interface, used to customize ion\unserialize()'s behavior.

    + +

    interface ion\Unserializer

    +
    • + +
  • +

    Writer

    +

    ION writer API.

    + +

    interface ion\Writer

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Catalog.html b/docs/v0.0/ion/Catalog.html new file mode 100644 index 0000000..5135e9b --- /dev/null +++ b/docs/v0.0/ion/Catalog.html @@ -0,0 +1,183 @@ + + + + + + Catalog - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Catalog implements Countable

+

The Catalog holds a collection of ion\Symbol\Table instances queried from ion\Reader and ion\Writer instances.

+

See also the ION spec's symbol guide chapter on catalog..

+

Constants:

+

None.

+

Properties:

+
    +
  • private array $symbolTables = array ( +)
    +Internal cache.
    • +
+ + + +

Functions:

+
    + +
  • +

    Catalog::__construct

    +

    Create a new Catalog.

    + +

    void ion\Catalog::__construct()

    +
    • + +
  • +

    Catalog::add

    +

    Add a shared symbol table to the catalog.

    + +

    void ion\Catalog::add(ion\Symbol\Table $table)

    +
    • + +
  • +

    Catalog::find

    +

    Find a shared symbol table within the catalog.

    + +

    ?ion\Symbol\Table ion\Catalog::find(string $name, [int $version = 0])

    +
    • + +
  • +

    Catalog::findBest

    +

    Find a "best match" for a shared symbol table within the catalog.

    + +

    ?ion\Symbol\Table ion\Catalog::findBest(string $name, [int $version = 0])

    +
    • + +
  • +

    Catalog::remove

    +

    Remove a shared symbol table from the catalog.

    + +

    bool ion\Catalog::remove(ion\Symbol\Table|string $table)

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Catalog/__construct.html b/docs/v0.0/ion/Catalog/__construct.html new file mode 100644 index 0000000..d20e19f --- /dev/null +++ b/docs/v0.0/ion/Catalog/__construct.html @@ -0,0 +1,99 @@ + + + + + + Catalog::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Catalog::__construct()

+

Create a new Catalog.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Catalog/add.html b/docs/v0.0/ion/Catalog/add.html new file mode 100644 index 0000000..71434af --- /dev/null +++ b/docs/v0.0/ion/Catalog/add.html @@ -0,0 +1,106 @@ + + + + + + Catalog::add - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Catalog::add(ion\Symbol\Table $table)

+

Add a shared symbol table to the catalog.

+

Params:

+
    +
  • ion\Symbol\Table $table
    +The new table to add.
    • +
+

Returns:

+
    +
  • void,
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Catalog/find.html b/docs/v0.0/ion/Catalog/find.html new file mode 100644 index 0000000..14e1e78 --- /dev/null +++ b/docs/v0.0/ion/Catalog/find.html @@ -0,0 +1,108 @@ + + + + + + Catalog::find - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

?ion\Symbol\Table ion\Catalog::find(string $name, [int $version = 0])

+

Find a shared symbol table within the catalog.

+

Params:

+
    +
  • string $name
    +The name of the symbol table.
    • +
  • Optional int $version = 0
    +The version the symbol table should match.
    • +
+

Returns:

+
    +
  • \Symbol\Table|null, The symbol table found, if any.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Catalog/findBest.html b/docs/v0.0/ion/Catalog/findBest.html new file mode 100644 index 0000000..b43433a --- /dev/null +++ b/docs/v0.0/ion/Catalog/findBest.html @@ -0,0 +1,108 @@ + + + + + + Catalog::findBest - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

?ion\Symbol\Table ion\Catalog::findBest(string $name, [int $version = 0])

+

Find a "best match" for a shared symbol table within the catalog.

+

Params:

+
    +
  • string $name
    +The name of the symbol table,
    • +
  • Optional int $version = 0
    +The minimum version of the symbol table.
    • +
+

Returns:

+
    +
  • \Symbol\Table|null, The symbol table found, if any.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Catalog/remove.html b/docs/v0.0/ion/Catalog/remove.html new file mode 100644 index 0000000..51da9ca --- /dev/null +++ b/docs/v0.0/ion/Catalog/remove.html @@ -0,0 +1,106 @@ + + + + + + Catalog::remove - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Catalog::remove(ion\Symbol\Table|string $table)

+

Remove a shared symbol table from the catalog.

+

Params:

+
    +
  • ion\Symbol\Table|string $table
    +The symbol table to renmove.
    • +
+

Returns:

+
    +
  • bool, Success.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal.html b/docs/v0.0/ion/Decimal.html new file mode 100644 index 0000000..3d82c80 --- /dev/null +++ b/docs/v0.0/ion/Decimal.html @@ -0,0 +1,220 @@ + + + + + + Decimal - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Decimal implements Stringable

+

An arbitrary precision fixed point decimal.

+

See also \ion\Decimal\Context, and the ION spec's decimal docs.

+

Constants:

+

None.

+

Properties:

+
    +
  • public string|int $number
    +The decimal number.
    • +
  • public ?ion\Decimal\Context $context
    +The decimal context.
    • +
+ + + +

Functions:

+
    + +
  • +

    Decimal::__construct

    +

    Create a new fixed point decimal.

    + +

    void ion\Decimal::__construct(string|int $number, [?ion\Decimal\Context $context = NULL])

    +
    • + +
  • +

    Decimal::equals

    +

    Check two decimals for equality.

    + +

    bool ion\Decimal::equals(ion\Decimal $decimal)

    +
    • + +
  • +

    Decimal::isInt

    +

    Check whether the decimal is actually a big integer.

    + +

    bool ion\Decimal::isInt()

    +
    • + +
  • +

    Decimal::toInt

    +

    Get the integer represention of the decimal.

    + +

    int ion\Decimal::toInt()

    +
    • + +
  • +

    Decimal::toString

    +

    Get the string representation of the decimal.

    + +

    string ion\Decimal::toString()

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Context

    +

    An ion\Decimal's context.

    + +

    class ion\Decimal\Context

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/Context.html b/docs/v0.0/ion/Decimal/Context.html new file mode 100644 index 0000000..781f738 --- /dev/null +++ b/docs/v0.0/ion/Decimal/Context.html @@ -0,0 +1,200 @@ + + + + + + Context - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Decimal\Context

+

An ion\Decimal's context.

+

Constants:

+

None.

+

Properties:

+
    +
  • public int $digits
    +Maximum digits.
    • +
  • public int $eMax
    +Maximum exponent.
    • +
  • public int $eMin
    +Minimum exponent.
    • +
  • public ion\Decimal\Context\Rounding|int $round
    +Rounding mode.
    • +
  • public bool $clamp
    +Whether to clamp.
    • +
+ + + +

Functions:

+
    + +
  • +

    Context::__construct

    +

    Create a new decimal context.

    + +

    void ion\Decimal\Context::__construct(int $digits, int $eMax, int $eMin, ion\Decimal\Context\Rounding|int $round, bool $clamp)

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Dec128

    +

    Create a context suitable for 128bit decimals.

    + +

    static ion\Decimal\Context ion\Decimal\Context::Dec128()

    +
    • + +
  • +

    Dec32

    +

    Create a context suitable for 32bit decimals.

    + +

    static ion\Decimal\Context ion\Decimal\Context::Dec32()

    +
    • + +
  • +

    Dec64

    +

    Create a context suitable for 64bit decimals.

    + +

    static ion\Decimal\Context ion\Decimal\Context::Dec64()

    +
    • + +
  • +

    DecMax

    +

    Create a context with maximum settings.

    + +

    static ion\Decimal\Context ion\Decimal\Context::DecMax([ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven])

    +
    • + +
  • +

    Rounding

    +

    Rounding mode.

    + +

    enum ion\Decimal\Context\Rounding implements BackedEnum, UnitEnum

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/Context/Dec128.html b/docs/v0.0/ion/Decimal/Context/Dec128.html new file mode 100644 index 0000000..e684eff --- /dev/null +++ b/docs/v0.0/ion/Decimal/Context/Dec128.html @@ -0,0 +1,111 @@ + + + + + + Dec128 - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

static ion\Decimal\Context ion\Decimal\Context::Dec128()

+

Create a context suitable for 128bit decimals.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/Context/Dec32.html b/docs/v0.0/ion/Decimal/Context/Dec32.html new file mode 100644 index 0000000..f1baef5 --- /dev/null +++ b/docs/v0.0/ion/Decimal/Context/Dec32.html @@ -0,0 +1,111 @@ + + + + + + Dec32 - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

static ion\Decimal\Context ion\Decimal\Context::Dec32()

+

Create a context suitable for 32bit decimals.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/Context/Dec64.html b/docs/v0.0/ion/Decimal/Context/Dec64.html new file mode 100644 index 0000000..51264c0 --- /dev/null +++ b/docs/v0.0/ion/Decimal/Context/Dec64.html @@ -0,0 +1,111 @@ + + + + + + Dec64 - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

static ion\Decimal\Context ion\Decimal\Context::Dec64()

+

Create a context suitable for 64bit decimals.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/Context/DecMax.html b/docs/v0.0/ion/Decimal/Context/DecMax.html new file mode 100644 index 0000000..6132c47 --- /dev/null +++ b/docs/v0.0/ion/Decimal/Context/DecMax.html @@ -0,0 +1,114 @@ + + + + + + DecMax - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

static ion\Decimal\Context ion\Decimal\Context::DecMax([ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven])

+

Create a context with maximum settings.

+

Params:

+
    +
  • Optional ion\Decimal\Context\Rounding|int $round = ion\Decimal\Context\Rounding::HalfEven
    +Rounding mode.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/Context/Rounding.html b/docs/v0.0/ion/Decimal/Context/Rounding.html new file mode 100644 index 0000000..66a50f0 --- /dev/null +++ b/docs/v0.0/ion/Decimal/Context/Rounding.html @@ -0,0 +1,143 @@ + + + + + + Rounding - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

enum ion\Decimal\Context\Rounding implements BackedEnum, UnitEnum

+

Rounding mode.

+

Constants:

+
    +
  • +Ceiling = 0 +
    • +
  • +Up = 1 +
    • +
  • +HalfUp = 2 +
    • +
  • +HalfEven = 3 +
    • +
  • +HalfDown = 4 +
    • +
  • +Down = 5 +
    • +
  • +Floor = 6 +
    • +
  • +Down05Up = 7 +
    • +
+

Properties:

+
    +
  • public string $name
    +Rounding mode.
    • +
  • public int $value
    +Rounding mode.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/Context/__construct.html b/docs/v0.0/ion/Decimal/Context/__construct.html new file mode 100644 index 0000000..de5f2b6 --- /dev/null +++ b/docs/v0.0/ion/Decimal/Context/__construct.html @@ -0,0 +1,122 @@ + + + + + + Context::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Decimal\Context::__construct(int $digits, int $eMax, int $eMin, ion\Decimal\Context\Rounding|int $round, bool $clamp)

+

Create a new decimal context.

+

Params:

+
    +
  • int $digits
    +Maximum digits.
    • +
  • int $eMax
    +Maximum exponent.
    • +
  • int $eMin
    +Minimum exponent.
    • +
  • ion\Decimal\Context\Rounding|int $round
    +Rounding mode.
    • +
  • bool $clamp
    +Whether to clamp.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/__construct.html b/docs/v0.0/ion/Decimal/__construct.html new file mode 100644 index 0000000..841957d --- /dev/null +++ b/docs/v0.0/ion/Decimal/__construct.html @@ -0,0 +1,106 @@ + + + + + + Decimal::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Decimal::__construct(string|int $number, [?ion\Decimal\Context $context = NULL])

+

Create a new fixed point decimal.

+

Params:

+
    +
  • string|int $number
    +The decimal number.
    • +
  • Optional ?ion\Decimal\Context $context = NULL
    +The decimal context.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/equals.html b/docs/v0.0/ion/Decimal/equals.html new file mode 100644 index 0000000..5934652 --- /dev/null +++ b/docs/v0.0/ion/Decimal/equals.html @@ -0,0 +1,108 @@ + + + + + + Decimal::equals - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Decimal::equals(ion\Decimal $decimal)

+

Check two decimals for equality.

+

Params:

+
    +
  • ion\Decimal $decimal
    +The decimal to compare to.
    • +
+

Returns:

+
    +
  • bool, Whether both decimals equal.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/isInt.html b/docs/v0.0/ion/Decimal/isInt.html new file mode 100644 index 0000000..86e5de4 --- /dev/null +++ b/docs/v0.0/ion/Decimal/isInt.html @@ -0,0 +1,105 @@ + + + + + + Decimal::isInt - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Decimal::isInt()

+

Check whether the decimal is actually a big integer.

+

Params:

+

None.

+

Returns:

+
    +
  • bool, Whether the decimal is actually an integer.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/toInt.html b/docs/v0.0/ion/Decimal/toInt.html new file mode 100644 index 0000000..fc58083 --- /dev/null +++ b/docs/v0.0/ion/Decimal/toInt.html @@ -0,0 +1,101 @@ + + + + + + Decimal::toInt - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Decimal::toInt()

+

Get the integer represention of the decimal.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Decimal/toString.html b/docs/v0.0/ion/Decimal/toString.html new file mode 100644 index 0000000..f95ae6a --- /dev/null +++ b/docs/v0.0/ion/Decimal/toString.html @@ -0,0 +1,101 @@ + + + + + + Decimal::toString - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Decimal::toString()

+

Get the string representation of the decimal.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Exception.html b/docs/v0.0/ion/Exception.html new file mode 100644 index 0000000..bf97b1a --- /dev/null +++ b/docs/v0.0/ion/Exception.html @@ -0,0 +1,109 @@ + + + + + + Exception - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Exception extends Exception implements Stringable, Throwable

+

Base exception for the ION extension.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/LOB.html b/docs/v0.0/ion/LOB.html new file mode 100644 index 0000000..0eb1eef --- /dev/null +++ b/docs/v0.0/ion/LOB.html @@ -0,0 +1,136 @@ + + + + + + LOB - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\LOB

+

A large object.

+

See also \ion\Type, the ION spec's BLob definition, and the ION sepc's CLob definition.

+

Constants:

+

None.

+

Properties:

+
    +
  • public string $value
    +The value of the large object.
    • +
  • public ion\Type $type
    +The type (CLob/BLob).
    • +
+ + + +

Functions:

+
    + +
  • +

    LOB::__construct

    +

    Create an ION large object.

    + +

    void ion\LOB::__construct(string $value, [ion\Type $type = ion\Type::CLob])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/LOB/__construct.html b/docs/v0.0/ion/LOB/__construct.html new file mode 100644 index 0000000..33106ef --- /dev/null +++ b/docs/v0.0/ion/LOB/__construct.html @@ -0,0 +1,96 @@ + + + + + + LOB::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\LOB::__construct(string $value, [ion\Type $type = ion\Type::CLob])

+

Create an ION large object.

+

Params:

+
    +
  • string $value
    +The value of the large object.
    • +
  • Optional ion\Type $type = ion\Type::CLob
    +The type (CLob/BLob).
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader.html b/docs/v0.0/ion/Reader.html new file mode 100644 index 0000000..8dbe242 --- /dev/null +++ b/docs/v0.0/ion/Reader.html @@ -0,0 +1,493 @@ + + + + + + Reader - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Reader implements Iterator, RecursiveIterator, Traversable

+

ION reader API.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+ + + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Buffer

    +

    ION string buffer reader API.

    + +

    interface ion\Reader\Buffer implements Iterator, RecursiveIterator, Traversable, ion\Reader

    +
    • + +
  • +

    Options

    +

    Reader options.

    + +

    class ion\Reader\Options

    +
    • + +
  • +

    Reader

    +

    Base implementation of ION readers.

    + +

    abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader

    +
    • + +
  • +

    Stream

    +

    ION stream reader API.

    + +

    interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Buffer.html b/docs/v0.0/ion/Reader/Buffer.html new file mode 100644 index 0000000..9af4b2f --- /dev/null +++ b/docs/v0.0/ion/Reader/Buffer.html @@ -0,0 +1,193 @@ + + + + + + Buffer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Reader\Buffer implements Iterator, RecursiveIterator, Traversable, ion\Reader

+

ION string buffer reader API.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Buffer::getBuffer

    +

    Get the buffer read from.

    + +

    string ion\Reader\Buffer::getBuffer()

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Reader

    +

    ION string buffer reader.

    + +

    class ion\Reader\Buffer\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Buffer

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Buffer/Reader.html b/docs/v0.0/ion/Reader/Buffer/Reader.html new file mode 100644 index 0000000..0d2be81 --- /dev/null +++ b/docs/v0.0/ion/Reader/Buffer/Reader.html @@ -0,0 +1,126 @@ + + + + + + Reader - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Reader\Buffer\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Buffer

+

ION string buffer reader.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Reader::__construct

    +

    Create a new string buffer reader.

    + +

    void ion\Reader\Buffer\Reader::__construct(string $buffer, [?ion\Reader\Options $options = NULL])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Buffer/Reader/__construct.html b/docs/v0.0/ion/Reader/Buffer/Reader/__construct.html new file mode 100644 index 0000000..98a122b --- /dev/null +++ b/docs/v0.0/ion/Reader/Buffer/Reader/__construct.html @@ -0,0 +1,116 @@ + + + + + + Reader::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Reader\Buffer\Reader::__construct(string $buffer, [?ion\Reader\Options $options = NULL])

+

Create a new string buffer reader.

+

Params:

+
    +
  • string $buffer
    +The buffer to read from.
    • +
  • Optional ?ion\Reader\Options $options = NULL
    +Reader options.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Buffer/getBuffer.html b/docs/v0.0/ion/Reader/Buffer/getBuffer.html new file mode 100644 index 0000000..9b9ce5f --- /dev/null +++ b/docs/v0.0/ion/Reader/Buffer/getBuffer.html @@ -0,0 +1,107 @@ + + + + + + Buffer::getBuffer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Reader\Buffer::getBuffer()

+

Get the buffer read from.

+

Params:

+

None.

+

Returns:

+
    +
  • string, The buffer read from.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Options.html b/docs/v0.0/ion/Reader/Options.html new file mode 100644 index 0000000..b3f5389 --- /dev/null +++ b/docs/v0.0/ion/Reader/Options.html @@ -0,0 +1,194 @@ + + + + + + Options - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Reader\Options

+

Reader options.

+

Constants:

+

None.

+

Properties:

+
    +
  • public ?ion\Catalog $catalog
    +ION catalog to use for symbol lookup.
    • +
  • public ?ion\Decimal\Context $decimalContext
    +Decimal context to use.
    • +
  • public ?Closure $onContextChange
    +Callback as function(\ion\Reader):void called upon local symbol table context change.
    • +
  • public bool $returnSystemValues
    +Whether to return otherwise hidden system values.
    • +
  • public int $maxContainerDepth
    +The maximum depth of nested containers.
    • +
  • public int $maxAnnotations
    +The maximum number of annotations allowed on a single value.
    • +
  • public int $annotationBufferSize
    +The maximum number of bytes of all annotations on a single value.
    • +
  • public int $tempBufferSize
    +The maximum number of bytes of a symbol/value/chunk.
    • +
  • public bool $skipCharacterValidation
    +Whether to skip UTF-8 validation.
    • +
+ + + +

Functions:

+
    + +
  • +

    Options::__construct

    + +

    void ion\Reader\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [?Closure $onContextChange = NULL, [bool $returnSystemValues = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $annotationBufferSize = 16384, [int $tempBufferSize = 16384, [bool $skipCharacterValidation = false]]]]]]]]])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Options/__construct.html b/docs/v0.0/ion/Reader/Options/__construct.html new file mode 100644 index 0000000..8dff27d --- /dev/null +++ b/docs/v0.0/ion/Reader/Options/__construct.html @@ -0,0 +1,119 @@ + + + + + + Options::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Reader\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [?Closure $onContextChange = NULL, [bool $returnSystemValues = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $annotationBufferSize = 16384, [int $tempBufferSize = 16384, [bool $skipCharacterValidation = false]]]]]]]]])

+

Params:

+
    +
  • Optional ?ion\Catalog $catalog = NULL
    +ION catalog to use for symbol lookup.
    • +
  • Optional ?ion\Decimal\Context $decimalContext = NULL
    +Decimal context to use.
    • +
  • Optional ?Closure $onContextChange = NULL
    +Callback as function(\ion\Reader):void called upon local symbol table context change.
    • +
  • Optional bool $returnSystemValues = false
    +Whether to return otherwise hidden system values.
    • +
  • Optional int $maxContainerDepth = 10
    +The maximum depth of nested containers.
    • +
  • Optional int $maxAnnotations = 10
    +The maximum number of annotations allowed on a single value.
    • +
  • Optional int $annotationBufferSize = 16384
    +The maximum number of bytes of all annotations on a single value.
    • +
  • Optional int $tempBufferSize = 16384
    +The maximum number of bytes of a symbol/value/chunk.
    • +
  • Optional bool $skipCharacterValidation = false
    +Whether to skip UTF-8 validation.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Reader.html b/docs/v0.0/ion/Reader/Reader.html new file mode 100644 index 0000000..848c67d --- /dev/null +++ b/docs/v0.0/ion/Reader/Reader.html @@ -0,0 +1,158 @@ + + + + + + Reader - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

abstract class ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader

+

Base implementation of ION readers.

+

Constants:

+

None.

+

Properties:

+
    +
  • public ?ion\Reader\Options $options
    +Reader options.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Stream.html b/docs/v0.0/ion/Reader/Stream.html new file mode 100644 index 0000000..40d4a23 --- /dev/null +++ b/docs/v0.0/ion/Reader/Stream.html @@ -0,0 +1,217 @@ + + + + + + Stream - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Reader\Stream implements Iterator, RecursiveIterator, Traversable, ion\Reader

+

ION stream reader API.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Stream::getStream

    +

    Get the stream read from.

    + +

    void ion\Reader\Stream::getStream()

    +
    • + +
  • +

    Stream::resetStream

    +

    Reset the stream read from.

    + +

    void ion\Reader\Stream::resetStream(resource $stream)

    +
    • + +
  • +

    Stream::resetStreamWithLength

    +

    Reset the stream read from, limiting length to read.

    + +

    void ion\Reader\Stream::resetStreamWithLength(resource $stream, int $length)

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Reader

    +

    ION stream reader.

    + +

    class ion\Reader\Stream\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Stream

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Stream/Reader.html b/docs/v0.0/ion/Reader/Stream/Reader.html new file mode 100644 index 0000000..12d0f6a --- /dev/null +++ b/docs/v0.0/ion/Reader/Stream/Reader.html @@ -0,0 +1,130 @@ + + + + + + Reader - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Reader\Stream\Reader extends ion\Reader\Reader implements Iterator, RecursiveIterator, Traversable, ion\Reader, ion\Reader\Stream

+

ION stream reader.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Reader::__construct

    +

    Create a new stream reader.

    + +

    void ion\Reader\Stream\Reader::__construct(resource $stream, [?ion\Reader\Options $options = NULL])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Stream/Reader/__construct.html b/docs/v0.0/ion/Reader/Stream/Reader/__construct.html new file mode 100644 index 0000000..2949fbb --- /dev/null +++ b/docs/v0.0/ion/Reader/Stream/Reader/__construct.html @@ -0,0 +1,116 @@ + + + + + + Reader::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Reader\Stream\Reader::__construct(resource $stream, [?ion\Reader\Options $options = NULL])

+

Create a new stream reader.

+

Params:

+
    +
  • resource $stream
    +The stream to read from.
    • +
  • Optional ?ion\Reader\Options $options = NULL
    +Reader options.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Stream/getStream.html b/docs/v0.0/ion/Reader/Stream/getStream.html new file mode 100644 index 0000000..ee9a9c6 --- /dev/null +++ b/docs/v0.0/ion/Reader/Stream/getStream.html @@ -0,0 +1,111 @@ + + + + + + Stream::getStream - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Reader\Stream::getStream()

+

Get the stream read from.

+

Params:

+

None.

+

Returns:

+
    +
  • resource, The stream read from.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Stream/resetStream.html b/docs/v0.0/ion/Reader/Stream/resetStream.html new file mode 100644 index 0000000..ea36b27 --- /dev/null +++ b/docs/v0.0/ion/Reader/Stream/resetStream.html @@ -0,0 +1,110 @@ + + + + + + Stream::resetStream - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Reader\Stream::resetStream(resource $stream)

+

Reset the stream read from.

+

Params:

+
    +
  • resource $stream
    +The new stream to from.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/Stream/resetStreamWithLength.html b/docs/v0.0/ion/Reader/Stream/resetStreamWithLength.html new file mode 100644 index 0000000..18b915f --- /dev/null +++ b/docs/v0.0/ion/Reader/Stream/resetStreamWithLength.html @@ -0,0 +1,112 @@ + + + + + + Stream::resetStreamWithLength - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Reader\Stream::resetStreamWithLength(resource $stream, int $length)

+

Reset the stream read from, limiting length to read.

+

Params:

+
    +
  • resource $stream
    +The stream to read from.
    • +
  • int $length
    +The maximum length to read from $stream.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/countAnnotations.html b/docs/v0.0/ion/Reader/countAnnotations.html new file mode 100644 index 0000000..02a8379 --- /dev/null +++ b/docs/v0.0/ion/Reader/countAnnotations.html @@ -0,0 +1,152 @@ + + + + + + Reader::countAnnotations - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Reader::countAnnotations()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getAnnotation.html b/docs/v0.0/ion/Reader/getAnnotation.html new file mode 100644 index 0000000..7902670 --- /dev/null +++ b/docs/v0.0/ion/Reader/getAnnotation.html @@ -0,0 +1,154 @@ + + + + + + Reader::getAnnotation - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Reader::getAnnotation(int $index)

+

Params:

+
    +
  • int $index
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getAnnotationSymbol.html b/docs/v0.0/ion/Reader/getAnnotationSymbol.html new file mode 100644 index 0000000..bdf86bc --- /dev/null +++ b/docs/v0.0/ion/Reader/getAnnotationSymbol.html @@ -0,0 +1,154 @@ + + + + + + Reader::getAnnotationSymbol - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Symbol ion\Reader::getAnnotationSymbol(int $index)

+

Params:

+
    +
  • int $index
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getAnnotationSymbols.html b/docs/v0.0/ion/Reader/getAnnotationSymbols.html new file mode 100644 index 0000000..0c680cf --- /dev/null +++ b/docs/v0.0/ion/Reader/getAnnotationSymbols.html @@ -0,0 +1,152 @@ + + + + + + Reader::getAnnotationSymbols - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

array ion\Reader::getAnnotationSymbols()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getAnnotations.html b/docs/v0.0/ion/Reader/getAnnotations.html new file mode 100644 index 0000000..7c2f4f1 --- /dev/null +++ b/docs/v0.0/ion/Reader/getAnnotations.html @@ -0,0 +1,152 @@ + + + + + + Reader::getAnnotations - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

array ion\Reader::getAnnotations()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getDepth.html b/docs/v0.0/ion/Reader/getDepth.html new file mode 100644 index 0000000..e890f74 --- /dev/null +++ b/docs/v0.0/ion/Reader/getDepth.html @@ -0,0 +1,152 @@ + + + + + + Reader::getDepth - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Reader::getDepth()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getFieldName.html b/docs/v0.0/ion/Reader/getFieldName.html new file mode 100644 index 0000000..b7c32bb --- /dev/null +++ b/docs/v0.0/ion/Reader/getFieldName.html @@ -0,0 +1,152 @@ + + + + + + Reader::getFieldName - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Reader::getFieldName()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getFieldNameSymbol.html b/docs/v0.0/ion/Reader/getFieldNameSymbol.html new file mode 100644 index 0000000..4dd3b3d --- /dev/null +++ b/docs/v0.0/ion/Reader/getFieldNameSymbol.html @@ -0,0 +1,152 @@ + + + + + + Reader::getFieldNameSymbol - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Symbol ion\Reader::getFieldNameSymbol()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getPosition.html b/docs/v0.0/ion/Reader/getPosition.html new file mode 100644 index 0000000..7b7646f --- /dev/null +++ b/docs/v0.0/ion/Reader/getPosition.html @@ -0,0 +1,152 @@ + + + + + + Reader::getPosition - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Reader::getPosition()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getType.html b/docs/v0.0/ion/Reader/getType.html new file mode 100644 index 0000000..da6fe53 --- /dev/null +++ b/docs/v0.0/ion/Reader/getType.html @@ -0,0 +1,152 @@ + + + + + + Reader::getType - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Type ion\Reader::getType()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getValueLength.html b/docs/v0.0/ion/Reader/getValueLength.html new file mode 100644 index 0000000..d0620cf --- /dev/null +++ b/docs/v0.0/ion/Reader/getValueLength.html @@ -0,0 +1,152 @@ + + + + + + Reader::getValueLength - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Reader::getValueLength()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/getValueOffset.html b/docs/v0.0/ion/Reader/getValueOffset.html new file mode 100644 index 0000000..511cfb1 --- /dev/null +++ b/docs/v0.0/ion/Reader/getValueOffset.html @@ -0,0 +1,152 @@ + + + + + + Reader::getValueOffset - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Reader::getValueOffset()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/hasAnnotation.html b/docs/v0.0/ion/Reader/hasAnnotation.html new file mode 100644 index 0000000..3d81baa --- /dev/null +++ b/docs/v0.0/ion/Reader/hasAnnotation.html @@ -0,0 +1,154 @@ + + + + + + Reader::hasAnnotation - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Reader::hasAnnotation(string $annotation)

+

Params:

+
    +
  • string $annotation
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/hasAnnotations.html b/docs/v0.0/ion/Reader/hasAnnotations.html new file mode 100644 index 0000000..87cd127 --- /dev/null +++ b/docs/v0.0/ion/Reader/hasAnnotations.html @@ -0,0 +1,152 @@ + + + + + + Reader::hasAnnotations - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Reader::hasAnnotations()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/isInStruct.html b/docs/v0.0/ion/Reader/isInStruct.html new file mode 100644 index 0000000..cd4dd59 --- /dev/null +++ b/docs/v0.0/ion/Reader/isInStruct.html @@ -0,0 +1,152 @@ + + + + + + Reader::isInStruct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Reader::isInStruct()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/isNull.html b/docs/v0.0/ion/Reader/isNull.html new file mode 100644 index 0000000..6ae61ef --- /dev/null +++ b/docs/v0.0/ion/Reader/isNull.html @@ -0,0 +1,152 @@ + + + + + + Reader::isNull - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Reader::isNull()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readBool.html b/docs/v0.0/ion/Reader/readBool.html new file mode 100644 index 0000000..aad5d86 --- /dev/null +++ b/docs/v0.0/ion/Reader/readBool.html @@ -0,0 +1,152 @@ + + + + + + Reader::readBool - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Reader::readBool()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readDecimal.html b/docs/v0.0/ion/Reader/readDecimal.html new file mode 100644 index 0000000..6ffc9e5 --- /dev/null +++ b/docs/v0.0/ion/Reader/readDecimal.html @@ -0,0 +1,152 @@ + + + + + + Reader::readDecimal - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Decimal ion\Reader::readDecimal()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readFloat.html b/docs/v0.0/ion/Reader/readFloat.html new file mode 100644 index 0000000..bc4a944 --- /dev/null +++ b/docs/v0.0/ion/Reader/readFloat.html @@ -0,0 +1,152 @@ + + + + + + Reader::readFloat - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

float ion\Reader::readFloat()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readInt.html b/docs/v0.0/ion/Reader/readInt.html new file mode 100644 index 0000000..91a3524 --- /dev/null +++ b/docs/v0.0/ion/Reader/readInt.html @@ -0,0 +1,152 @@ + + + + + + Reader::readInt - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string|int ion\Reader::readInt()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readLob.html b/docs/v0.0/ion/Reader/readLob.html new file mode 100644 index 0000000..e536a17 --- /dev/null +++ b/docs/v0.0/ion/Reader/readLob.html @@ -0,0 +1,152 @@ + + + + + + Reader::readLob - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Reader::readLob()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readLobPart.html b/docs/v0.0/ion/Reader/readLobPart.html new file mode 100644 index 0000000..0d704cc --- /dev/null +++ b/docs/v0.0/ion/Reader/readLobPart.html @@ -0,0 +1,159 @@ + + + + + + Reader::readLobPart - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Reader::readLobPart( &$string, [int $length = 4096])

+

Params:

+
    +
  • +

    Reference &$string

    +
    • +
  • +

    Optional int $length = 4096

    +
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readNull.html b/docs/v0.0/ion/Reader/readNull.html new file mode 100644 index 0000000..4f9cb58 --- /dev/null +++ b/docs/v0.0/ion/Reader/readNull.html @@ -0,0 +1,152 @@ + + + + + + Reader::readNull - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Type ion\Reader::readNull()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readString.html b/docs/v0.0/ion/Reader/readString.html new file mode 100644 index 0000000..69f23b4 --- /dev/null +++ b/docs/v0.0/ion/Reader/readString.html @@ -0,0 +1,152 @@ + + + + + + Reader::readString - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Reader::readString()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readStringPart.html b/docs/v0.0/ion/Reader/readStringPart.html new file mode 100644 index 0000000..20c0abd --- /dev/null +++ b/docs/v0.0/ion/Reader/readStringPart.html @@ -0,0 +1,159 @@ + + + + + + Reader::readStringPart - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Reader::readStringPart( &$string, [int $length = 4096])

+

Params:

+
    +
  • +

    Reference &$string

    +
    • +
  • +

    Optional int $length = 4096

    +
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readSymbol.html b/docs/v0.0/ion/Reader/readSymbol.html new file mode 100644 index 0000000..95e5fbb --- /dev/null +++ b/docs/v0.0/ion/Reader/readSymbol.html @@ -0,0 +1,152 @@ + + + + + + Reader::readSymbol - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Symbol ion\Reader::readSymbol()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/readTimestamp.html b/docs/v0.0/ion/Reader/readTimestamp.html new file mode 100644 index 0000000..33bc31c --- /dev/null +++ b/docs/v0.0/ion/Reader/readTimestamp.html @@ -0,0 +1,152 @@ + + + + + + Reader::readTimestamp - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Timestamp ion\Reader::readTimestamp()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Reader/seek.html b/docs/v0.0/ion/Reader/seek.html new file mode 100644 index 0000000..eabf0c3 --- /dev/null +++ b/docs/v0.0/ion/Reader/seek.html @@ -0,0 +1,155 @@ + + + + + + Reader::seek - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Reader::seek(int $offset, [int $length = -1])

+

Params:

+
    +
  • int $offset
    • +
  • Optional int $length = -1
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Serializer.html b/docs/v0.0/ion/Serializer.html new file mode 100644 index 0000000..e22108c --- /dev/null +++ b/docs/v0.0/ion/Serializer.html @@ -0,0 +1,146 @@ + + + + + + Serializer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Serializer

+

Serializer interface, used to customize ion\serialize()'s behavior.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+ + + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    PHP

    +

    Specialization of the serializer for PHP.

    + +

    class ion\Serializer\PHP implements ion\Serializer

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Serializer/PHP.html b/docs/v0.0/ion/Serializer/PHP.html new file mode 100644 index 0000000..e6244b4 --- /dev/null +++ b/docs/v0.0/ion/Serializer/PHP.html @@ -0,0 +1,125 @@ + + + + + + PHP - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Serializer\PHP implements ion\Serializer

+

Specialization of the serializer for PHP.

+

Constants:

+

None.

+

Properties:

+
    +
  • public ?ion\Writer\Options $writerOptions
    +Writer options.
    • +
  • public bool $multiSequence
    +Whether to write the top level array as multiple ION sequences.
    • +
  • public bool $callMagicSerialize
    +Whether to call magic __serialize() methods on objects to serialize.
    • +
  • public ?string $callCustomSerialize
    +Whether and which custom serialize method to call on objects to serialize.
    • +
+ + + +

Functions:

+
    + +
  • +

    PHP::__construct

    +

    Create a new PHP ION serializer.

    + +

    void ion\Serializer\PHP::__construct([?ion\Writer\Options $writerOptions = NULL, [bool $multiSequence = false, [bool $callMagicSerialize = true, [?string $callCustomSerialize = NULL]]]])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Serializer/PHP/__construct.html b/docs/v0.0/ion/Serializer/PHP/__construct.html new file mode 100644 index 0000000..efc7984 --- /dev/null +++ b/docs/v0.0/ion/Serializer/PHP/__construct.html @@ -0,0 +1,110 @@ + + + + + + PHP::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Serializer\PHP::__construct([?ion\Writer\Options $writerOptions = NULL, [bool $multiSequence = false, [bool $callMagicSerialize = true, [?string $callCustomSerialize = NULL]]]])

+

Create a new PHP ION serializer.

+

Params:

+
    +
  • Optional ?ion\Writer\Options $writerOptions = NULL
    +Writer options.
    • +
  • Optional bool $multiSequence = false
    +Whether to write the top level array as multiple ION sequences.
    • +
  • Optional bool $callMagicSerialize = true
    +Whether to call magic __serialize() methods on objects to serialize.
    • +
  • Optional ?string $callCustomSerialize = NULL
    +Whether and which custom serialize method to call on objects to serialize.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Serializer/serialize.html b/docs/v0.0/ion/Serializer/serialize.html new file mode 100644 index 0000000..eee7814 --- /dev/null +++ b/docs/v0.0/ion/Serializer/serialize.html @@ -0,0 +1,94 @@ + + + + + + Serializer::serialize - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Serializer::serialize(mixed $data)

+

Params:

+
    +
  • mixed $data
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol.html b/docs/v0.0/ion/Symbol.html new file mode 100644 index 0000000..5856a4a --- /dev/null +++ b/docs/v0.0/ion/Symbol.html @@ -0,0 +1,217 @@ + + + + + + Symbol - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Symbol implements Stringable

+

See also ION spec's symbol definition, and ION spec's symbol guide.

+

Constants:

+

None.

+

Properties:

+
    +
  • public ?string $value
    +The symbol's text representation.
    • +
  • public int $sid
    +The symbols ID, referencing its location within a shared symbol table.
    • +
  • public ?ion\Symbol\ImportLocation $importLocation
    +The import location referencing a shared symbol table.
    • +
+ + + +

Functions:

+
    + +
  • +

    Symbol::__construct

    +

    Create an ION symbol.

    + +

    void ion\Symbol::__construct([?string $value = NULL, [int $sid = -1, [?ion\Symbol\ImportLocation $importLocation = NULL]]])

    +
    • + +
  • +

    Symbol::equals

    +

    Compare two symbols for equality.

    + +

    bool ion\Symbol::equals(ion\Symbol $symbol)

    +
    • + +
  • +

    Symbol::toString

    + +

    string ion\Symbol::toString()

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Enum

    +

    Base interface of built-in shared symbol tables.

    + +

    interface ion\Symbol\Enum

    +
    • + +
  • +

    ImportLocation

    +

    The import location (referring to a shared table= of a symbol.

    + +

    class ion\Symbol\ImportLocation

    +
    • + +
  • +

    Table

    +

    Base interface of an ION symbol table.

    + +

    interface ion\Symbol\Table

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Enum.html b/docs/v0.0/ion/Symbol/Enum.html new file mode 100644 index 0000000..df85adb --- /dev/null +++ b/docs/v0.0/ion/Symbol/Enum.html @@ -0,0 +1,145 @@ + + + + + + Enum - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Symbol\Enum

+

Base interface of built-in shared symbol tables.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+ + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Enum/toSID.html b/docs/v0.0/ion/Symbol/Enum/toSID.html new file mode 100644 index 0000000..4c68788 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Enum/toSID.html @@ -0,0 +1,108 @@ + + + + + + Enum::toSID - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Symbol\Enum::toSID()

+

Params:

+

None.

+

Returns:

+
    +
  • int, The symbol id.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Enum/toString.html b/docs/v0.0/ion/Symbol/Enum/toString.html new file mode 100644 index 0000000..6aa0b5a --- /dev/null +++ b/docs/v0.0/ion/Symbol/Enum/toString.html @@ -0,0 +1,108 @@ + + + + + + Enum::toString - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Symbol\Enum::toString()

+

Params:

+

None.

+

Returns:

+
    +
  • string, The symbol's textual representation.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Enum/toSymbol.html b/docs/v0.0/ion/Symbol/Enum/toSymbol.html new file mode 100644 index 0000000..326f838 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Enum/toSymbol.html @@ -0,0 +1,108 @@ + + + + + + Enum::toSymbol - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

ion\Symbol ion\Symbol\Enum::toSymbol()

+

Params:

+

None.

+

Returns:

+
    +
  • \ion\Symbol, Instance of the symbol.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/ImportLocation.html b/docs/v0.0/ion/Symbol/ImportLocation.html new file mode 100644 index 0000000..b231f78 --- /dev/null +++ b/docs/v0.0/ion/Symbol/ImportLocation.html @@ -0,0 +1,129 @@ + + + + + + ImportLocation - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Symbol\ImportLocation

+

The import location (referring to a shared table= of a symbol.

+

Constants:

+

None.

+

Properties:

+
    +
  • public string $name
    +The name of the shared symbol table.
    • +
  • public int $location
    +The location (sid) of the symbol within the table.
    • +
+ + + +

Functions:

+
    + +
  • +

    ImportLocation::__construct

    +

    Create a new import location.

    + +

    void ion\Symbol\ImportLocation::__construct(string $name, int $location)

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/ImportLocation/__construct.html b/docs/v0.0/ion/Symbol/ImportLocation/__construct.html new file mode 100644 index 0000000..476d91e --- /dev/null +++ b/docs/v0.0/ion/Symbol/ImportLocation/__construct.html @@ -0,0 +1,106 @@ + + + + + + ImportLocation::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Symbol\ImportLocation::__construct(string $name, int $location)

+

Create a new import location.

+

Params:

+
    +
  • string $name
    +The name of the shared symbol table.
    • +
  • int $location
    +The location (sid) of the symbol within the table.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table.html b/docs/v0.0/ion/Symbol/Table.html new file mode 100644 index 0000000..a043f90 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table.html @@ -0,0 +1,213 @@ + + + + + + Table - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Symbol\Table

+

Base interface of an ION symbol table.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Table::add

    +

    Add a symbol to the table.

    + +

    int ion\Symbol\Table::add(ion\Symbol|string $symbol)

    +
    • + +
  • +

    Table::find

    +

    Find a symbol within the symbol table, including imports.

    + +

    ?ion\Symbol ion\Symbol\Table::find(string|int $id)

    +
    • + +
  • +

    Table::findLocal

    +

    Find a symbol within only this symbol table, ignoring imports.

    + +

    ?ion\Symbol ion\Symbol\Table::findLocal(string|int $id)

    +
    • + +
  • +

    Table::getMaxId

    +

    Get the maximum symbol ID within the symbol table.

    + +

    int ion\Symbol\Table::getMaxId()

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Local

    +

    A local symbol table.

    + +

    class ion\Symbol\Table\Local implements ion\Symbol\Table

    +
    • + +
  • +

    PHP

    +

    The built-in PHP symbols.

    + +

    enum ion\Symbol\Table\PHP implements BackedEnum, UnitEnum, ion\Symbol\Enum

    +
    • + +
  • +

    Shared

    +

    A shared symbol table.

    + +

    class ion\Symbol\Table\Shared implements ion\Symbol\Table

    +
    • + +
  • +

    System

    +

    The built-in ION system symbols.

    + +

    enum ion\Symbol\Table\System implements BackedEnum, UnitEnum, ion\Symbol\Enum

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/Local.html b/docs/v0.0/ion/Symbol/Table/Local.html new file mode 100644 index 0000000..50b261f --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/Local.html @@ -0,0 +1,158 @@ + + + + + + Local - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Symbol\Table\Local implements ion\Symbol\Table

+

A local symbol table.

+

See also the ION spec's symbol guide, and the ION doc's cookbook.

+

Constants:

+

None.

+

Properties:

+
    +
  • private array $imports = array ( +)
    +Internal cache.
    • +
  • private array $symbols = array ( +)
    +Internal cache.
    • +
+ + + +

Functions:

+
    + +
  • +

    Local::__construct

    +

    Create a local symbol table.

    + +

    void ion\Symbol\Table\Local::__construct()

    +
    • + +
  • +

    Local::import

    +

    Import a symbol table.

    + +

    void ion\Symbol\Table\Local::import(ion\Symbol\Table $table)

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/Local/__construct.html b/docs/v0.0/ion/Symbol/Table/Local/__construct.html new file mode 100644 index 0000000..0f81ada --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/Local/__construct.html @@ -0,0 +1,113 @@ + + + + + + Local::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Symbol\Table\Local::__construct()

+

Create a local symbol table.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/Local/import.html b/docs/v0.0/ion/Symbol/Table/Local/import.html new file mode 100644 index 0000000..5dfd078 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/Local/import.html @@ -0,0 +1,120 @@ + + + + + + Local::import - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Symbol\Table\Local::import(ion\Symbol\Table $table)

+

Import a symbol table.

+

Params:

+
    +
  • ion\Symbol\Table $table
    +The symbol table to import.
    • +
+

Returns:

+
    +
  • void,
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/PHP.html b/docs/v0.0/ion/Symbol/Table/PHP.html new file mode 100644 index 0000000..7373e3b --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/PHP.html @@ -0,0 +1,153 @@ + + + + + + PHP - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

enum ion\Symbol\Table\PHP implements BackedEnum, UnitEnum, ion\Symbol\Enum

+

The built-in PHP symbols.

+

Constants:

+
    +
  • +PHP = 'PHP' +
    • +
  • +Reference = 'R' +
    • +
  • +Backref = 'r' +
    • +
  • +Property = 'p' +
    • +
  • +Object = 'o' +
    • +
  • +ClassObject = 'c' +
    • +
  • +MagicObject = 'O' +
    • +
  • +CustomObject = 'C' +
    • +
  • +Enum = 'E' +
    • +
  • +Serializable = 'S' +
    • +
+

Properties:

+
    +
  • public string $name
    +The built-in PHP symbols.
    • +
  • public string $value
    +The built-in PHP symbols.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/Shared.html b/docs/v0.0/ion/Symbol/Table/Shared.html new file mode 100644 index 0000000..74ff55e --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/Shared.html @@ -0,0 +1,147 @@ + + + + + + Shared - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Symbol\Table\Shared implements ion\Symbol\Table

+

A shared symbol table.

+

See also the ION spec's symbol guide, and the ION doc's cookbook.

+

Constants:

+

None.

+

Properties:

+
    +
  • public string $name
    +The name of the shared symbol table.
    • +
  • public int $version
    +The version of the shared symbol table.
    • +
  • private array $symbols = array ( +)
    +Internal cache.
    • +
+ + + +

Functions:

+
    + +
  • +

    Shared::__construct

    +

    Create a shared symbol table.

    + +

    void ion\Symbol\Table\Shared::__construct(string $name, [int $version = 1, [?array $symbols = NULL]])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/Shared/__construct.html b/docs/v0.0/ion/Symbol/Table/Shared/__construct.html new file mode 100644 index 0000000..3ff3803 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/Shared/__construct.html @@ -0,0 +1,118 @@ + + + + + + Shared::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Symbol\Table\Shared::__construct(string $name, [int $version = 1, [?array $symbols = NULL]])

+

Create a shared symbol table.

+

Params:

+
    +
  • string $name
    +The name of the shared symbol table.
    • +
  • Optional int $version = 1
    +The version of the shared symbol table.
    • +
  • Optional ?array $symbols = NULL
    +Internal cache.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/System.html b/docs/v0.0/ion/Symbol/Table/System.html new file mode 100644 index 0000000..71e8e54 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/System.html @@ -0,0 +1,150 @@ + + + + + + System - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

enum ion\Symbol\Table\System implements BackedEnum, UnitEnum, ion\Symbol\Enum

+

The built-in ION system symbols.

+

Constants:

+
    +
  • +Ion = '$ion' +
    • +
  • +Ivm_1_0 = '$ion_1_0' +
    • +
  • +IonSymbolTable = '$ion_symbol_table' +
    • +
  • +Name = 'name' +
    • +
  • +Version = 'version' +
    • +
  • +Imports = 'imports' +
    • +
  • +Symbols = 'symbols' +
    • +
  • +MaxId = 'max_id' +
    • +
  • +SharedSymbolTable = '$ion_shared_symbol_table' +
    • +
+

Properties:

+
    +
  • public string $name
    +The built-in ION system symbols.
    • +
  • public string $value
    +The built-in ION system symbols.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/add.html b/docs/v0.0/ion/Symbol/Table/add.html new file mode 100644 index 0000000..ef50e1d --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/add.html @@ -0,0 +1,122 @@ + + + + + + Table::add - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Symbol\Table::add(ion\Symbol|string $symbol)

+

Add a symbol to the table.

+

Params:

+
    +
  • ion\Symbol|string $symbol
    +The symbol (value) to add.
    • +
+

Returns:

+
    +
  • int, The symbol ID.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/find.html b/docs/v0.0/ion/Symbol/Table/find.html new file mode 100644 index 0000000..03d64c7 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/find.html @@ -0,0 +1,122 @@ + + + + + + Table::find - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

?ion\Symbol ion\Symbol\Table::find(string|int $id)

+

Find a symbol within the symbol table, including imports.

+

Params:

+
    +
  • string|int $id
    +The ID or text of the symbol to find.
    • +
+

Returns:

+
    +
  • \ion\Symbol|null, The symbol found, if any.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/findLocal.html b/docs/v0.0/ion/Symbol/Table/findLocal.html new file mode 100644 index 0000000..e4afe91 --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/findLocal.html @@ -0,0 +1,122 @@ + + + + + + Table::findLocal - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

?ion\Symbol ion\Symbol\Table::findLocal(string|int $id)

+

Find a symbol within only this symbol table, ignoring imports.

+

Params:

+
    +
  • string|int $id
    +The ID or text of the symbol to find.
    • +
+

Returns:

+
    +
  • \ion\Symbol|null, The symbol found, if any.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/Table/getMaxId.html b/docs/v0.0/ion/Symbol/Table/getMaxId.html new file mode 100644 index 0000000..0c1e5cd --- /dev/null +++ b/docs/v0.0/ion/Symbol/Table/getMaxId.html @@ -0,0 +1,119 @@ + + + + + + Table::getMaxId - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Symbol\Table::getMaxId()

+

Get the maximum symbol ID within the symbol table.

+

Params:

+

None.

+

Returns:

+
    +
  • int, The maximum symbol ID.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/__construct.html b/docs/v0.0/ion/Symbol/__construct.html new file mode 100644 index 0000000..a505d94 --- /dev/null +++ b/docs/v0.0/ion/Symbol/__construct.html @@ -0,0 +1,108 @@ + + + + + + Symbol::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Symbol::__construct([?string $value = NULL, [int $sid = -1, [?ion\Symbol\ImportLocation $importLocation = NULL]]])

+

Create an ION symbol.

+

Params:

+
    +
  • Optional ?string $value = NULL
    +The symbol's text representation.
    • +
  • Optional int $sid = -1
    +The symbols ID, referencing its location within a shared symbol table.
    • +
  • Optional ?ion\Symbol\ImportLocation $importLocation = NULL
    +The import location referencing a shared symbol table.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/equals.html b/docs/v0.0/ion/Symbol/equals.html new file mode 100644 index 0000000..426d216 --- /dev/null +++ b/docs/v0.0/ion/Symbol/equals.html @@ -0,0 +1,113 @@ + + + + + + Symbol::equals - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

bool ion\Symbol::equals(ion\Symbol $symbol)

+

Compare two symbols for equality.

+

Two symbols are considered equal, if either:

+
    +
  • both are the same object or NULL
    • +
  • both values are NULL (unknown text), and both $importLocations match
    • +
  • both values match, regardless of $sid and $importLocation
    • +
+

Params:

+
    +
  • ion\Symbol $symbol
    • +
+

Returns:

+
    +
  • bool, whether the two Symbols equal
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Symbol/toString.html b/docs/v0.0/ion/Symbol/toString.html new file mode 100644 index 0000000..f82e923 --- /dev/null +++ b/docs/v0.0/ion/Symbol/toString.html @@ -0,0 +1,100 @@ + + + + + + Symbol::toString - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Symbol::toString()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Timestamp.html b/docs/v0.0/ion/Timestamp.html new file mode 100644 index 0000000..bfec2b3 --- /dev/null +++ b/docs/v0.0/ion/Timestamp.html @@ -0,0 +1,165 @@ + + + + + + Timestamp - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Timestamp extends DateTime implements DateTimeInterface, Stringable

+

An ION Timestamp.

+

See also the ION sepc's timestamp definintion, and PHP's date documentation.

+

Constants:

+

None.

+

Properties:

+
    +
  • public int $precision
    +The timestamp's precision. See ion\Timestamp\Precision.
    • +
  • public string $format
    +The timestamp's format. See ion\Timestamp\Format.
    • +
+ + + +

Functions:

+
    + +
  • +

    Timestamp::__construct

    +

    Create a new ION timestamp.

    + +

    void ion\Timestamp::__construct(ion\Timestamp\Precision|int $precision, [ion\Timestamp\Format|string|null $format = NULL, [?string $datetime = NULL, [?DateTimeZone $timezone = NULL]]])

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Format

    +

    Timestamp format.

    + +

    enum ion\Timestamp\Format implements BackedEnum, UnitEnum

    +
    • + +
  • +

    Precision

    +

    Timestamp precision.

    + +

    enum ion\Timestamp\Precision implements BackedEnum, UnitEnum

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Timestamp/Format.html b/docs/v0.0/ion/Timestamp/Format.html new file mode 100644 index 0000000..62f861a --- /dev/null +++ b/docs/v0.0/ion/Timestamp/Format.html @@ -0,0 +1,130 @@ + + + + + + Format - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

enum ion\Timestamp\Format implements BackedEnum, UnitEnum

+

Timestamp format.

+

Constants:

+
    +
  • +Year = 'Y\T' +
    • +
  • +Month = 'Y-m\T' +
    • +
  • +Day = 'Y-m-d\T' +
    • +
  • +Min = 'Y-m-d\TH:i' +
    • +
  • +Sec = 'Y-m-d\TH:i:s' +
    • +
  • +Frac = 'Y-m-d\TH:i:s.v' +
    • +
  • +MinTZ = 'Y-m-d\TH:iP' +
    • +
  • +SecTZ = 'Y-m-d\TH:i:sP' +
    • +
  • +FracTZ = 'Y-m-d\TH:i:s.vP' +
    • +
+

Properties:

+
    +
  • public string $name
    +Timestamp format.
    • +
  • public string $value
    +Timestamp format.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Timestamp/Precision.html b/docs/v0.0/ion/Timestamp/Precision.html new file mode 100644 index 0000000..5632a8b --- /dev/null +++ b/docs/v0.0/ion/Timestamp/Precision.html @@ -0,0 +1,130 @@ + + + + + + Precision - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

enum ion\Timestamp\Precision implements BackedEnum, UnitEnum

+

Timestamp precision.

+

Constants:

+
    +
  • +Year = 1 +
    • +
  • +Month = 3 +
    • +
  • +Day = 7 +
    • +
  • +Min = 23 +
    • +
  • +Sec = 55 +
    • +
  • +Frac = 119 +
    • +
  • +MinTZ = 151 +
    • +
  • +SecTZ = 183 +
    • +
  • +FracTZ = 247 +
    • +
+

Properties:

+
    +
  • public string $name
    +Timestamp precision.
    • +
  • public int $value
    +Timestamp precision.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Timestamp/__construct.html b/docs/v0.0/ion/Timestamp/__construct.html new file mode 100644 index 0000000..eb9c7c9 --- /dev/null +++ b/docs/v0.0/ion/Timestamp/__construct.html @@ -0,0 +1,104 @@ + + + + + + Timestamp::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Timestamp::__construct(ion\Timestamp\Precision|int $precision, [ion\Timestamp\Format|string|null $format = NULL, [?string $datetime = NULL, [?DateTimeZone $timezone = NULL]]])

+

Create a new ION timestamp.

+

Params:

+
    +
  • ion\Timestamp\Precision|int $precision
    +The timestamp's precision. See ion\Timestamp\Precision.
    • +
  • Optional ion\Timestamp\Format|string|null $format = NULL
    +The timestamp's format. See ion\Timestamp\Format.
    • +
  • Optional ?string $datetime = NULL
    +The timestamp's value.
    • +
  • Optional ?DateTimeZone $timezone = NULL
    +The timestamp's timezone.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Type.html b/docs/v0.0/ion/Type.html new file mode 100644 index 0000000..9351ae3 --- /dev/null +++ b/docs/v0.0/ion/Type.html @@ -0,0 +1,170 @@ + + + + + + Type - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

enum ion\Type implements BackedEnum, UnitEnum

+

ION data type.

+

The following special PHP classes are provided for some data types:

+
    +
  • ion\Decimal
    • +
  • ion\Timestamp
    • +
  • ion\Symbol
    • +
  • ion\Lob
    • +
+

Constants:

+
    +
  • +Null = 0 +
    • +
  • +Bool = 256 +
    • +
  • +Int = 512 +
    • +
  • +Float = 1024 +
    • +
  • +Decimal = 1280 +
    • +
  • +Timestamp = 1536 +
    • +
  • +Symbol = 1792 +
    • +
  • +String = 2048 +
    • +
  • +CLob = 2304 +
    • +
  • +BLob = 2560 +
    • +
  • +List = 2816 +
    • +
  • +SExp = 3072 +
    • +
  • +Struct = 3328 +
    • +
  • +Datagram = 3840 +
    • +
  • +EOF = -256 +
    • +
  • +NONE = -512 +
    • +
+

Properties:

+
    +
  • public string $name
    +ION data type.
    • +
  • public int $value
    +ION data type.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Unserializer.html b/docs/v0.0/ion/Unserializer.html new file mode 100644 index 0000000..2154235 --- /dev/null +++ b/docs/v0.0/ion/Unserializer.html @@ -0,0 +1,146 @@ + + + + + + Unserializer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Unserializer

+

Unserializer interface, used to customize ion\unserialize()'s behavior.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+ + + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    PHP

    +

    Specialization of the unserializer for PHP.

    + +

    class ion\Unserializer\PHP implements ion\Unserializer

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Unserializer/PHP.html b/docs/v0.0/ion/Unserializer/PHP.html new file mode 100644 index 0000000..70aaefe --- /dev/null +++ b/docs/v0.0/ion/Unserializer/PHP.html @@ -0,0 +1,125 @@ + + + + + + PHP - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Unserializer\PHP implements ion\Unserializer

+

Specialization of the unserializer for PHP.

+

Constants:

+

None.

+

Properties:

+
    +
  • public ?ion\Reader\Options $readerOptions
    +Reader options.
    • +
  • public bool $multiSequence
    +Whether to continue reading multiple ION sequences after the first one.
    • +
  • public bool $callMagicUnserialize
    +Whether to call magic __unserialize() methods on objects to unserialize.
    • +
  • public ?string $callCustomUnserialize
    +Whether and which custom unserialize method to call on objects to unserialize.
    • +
+ + + +

Functions:

+
    + +
  • +

    PHP::__construct

    +

    Create a new ION PHP unserializer.

    + +

    void ion\Unserializer\PHP::__construct([?ion\Reader\Options $readerOptions = NULL, [bool $multiSequence = false, [bool $callMagicUnserialize = true, [?string $callCustomUnserialize = NULL]]]])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Unserializer/PHP/__construct.html b/docs/v0.0/ion/Unserializer/PHP/__construct.html new file mode 100644 index 0000000..7b078c9 --- /dev/null +++ b/docs/v0.0/ion/Unserializer/PHP/__construct.html @@ -0,0 +1,110 @@ + + + + + + PHP::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Unserializer\PHP::__construct([?ion\Reader\Options $readerOptions = NULL, [bool $multiSequence = false, [bool $callMagicUnserialize = true, [?string $callCustomUnserialize = NULL]]]])

+

Create a new ION PHP unserializer.

+

Params:

+
    +
  • Optional ?ion\Reader\Options $readerOptions = NULL
    +Reader options.
    • +
  • Optional bool $multiSequence = false
    +Whether to continue reading multiple ION sequences after the first one.
    • +
  • Optional bool $callMagicUnserialize = true
    +Whether to call magic __unserialize() methods on objects to unserialize.
    • +
  • Optional ?string $callCustomUnserialize = NULL
    +Whether and which custom unserialize method to call on objects to unserialize.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Unserializer/unserialize.html b/docs/v0.0/ion/Unserializer/unserialize.html new file mode 100644 index 0000000..ae48910 --- /dev/null +++ b/docs/v0.0/ion/Unserializer/unserialize.html @@ -0,0 +1,94 @@ + + + + + + Unserializer::unserialize - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

mixed ion\Unserializer::unserialize(string|resource $data)

+

Params:

+
    +
  • string|resource $data
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer.html b/docs/v0.0/ion/Writer.html new file mode 100644 index 0000000..148914a --- /dev/null +++ b/docs/v0.0/ion/Writer.html @@ -0,0 +1,416 @@ + + + + + + Writer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Writer

+

ION writer API.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+ + + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Buffer

    +

    ION buffer writer API.

    + +

    interface ion\Writer\Buffer implements ion\Writer

    +
    • + +
  • +

    Options

    +

    ION writer options.

    + +

    class ion\Writer\Options

    +
    • + +
  • +

    Stream

    +

    ION stream writer API.

    + +

    interface ion\Writer\Stream implements ion\Writer

    +
    • + +
  • +

    Writer

    +

    Base implementation of common functionality of ION writers.

    + +

    abstract class ion\Writer\Writer implements ion\Writer

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Buffer.html b/docs/v0.0/ion/Writer/Buffer.html new file mode 100644 index 0000000..3bdc16c --- /dev/null +++ b/docs/v0.0/ion/Writer/Buffer.html @@ -0,0 +1,191 @@ + + + + + + Buffer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Writer\Buffer implements ion\Writer

+

ION buffer writer API.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Buffer::getBuffer

    +

    Get the buffer written to.

    + +

    string ion\Writer\Buffer::getBuffer()

    +
    • + +
  • +

    Buffer::resetBuffer

    +

    Reset the buffer written to.

    + +

    void ion\Writer\Buffer::resetBuffer()

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Writer

    +

    IO buffer writer.

    + +

    class ion\Writer\Buffer\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Buffer

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Buffer/Writer.html b/docs/v0.0/ion/Writer/Buffer/Writer.html new file mode 100644 index 0000000..1481e4b --- /dev/null +++ b/docs/v0.0/ion/Writer/Buffer/Writer.html @@ -0,0 +1,128 @@ + + + + + + Writer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Writer\Buffer\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Buffer

+

IO buffer writer.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Writer::__construct

    +

    Create a new buffer writer.

    + +

    void ion\Writer\Buffer\Writer::__construct([?ion\Writer\Options $options = NULL])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Buffer/Writer/__construct.html b/docs/v0.0/ion/Writer/Buffer/Writer/__construct.html new file mode 100644 index 0000000..2258072 --- /dev/null +++ b/docs/v0.0/ion/Writer/Buffer/Writer/__construct.html @@ -0,0 +1,114 @@ + + + + + + Writer::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer\Buffer\Writer::__construct([?ion\Writer\Options $options = NULL])

+

Create a new buffer writer.

+

Params:

+
    +
  • Optional ?ion\Writer\Options $options = NULL
    +Writer options.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Buffer/getBuffer.html b/docs/v0.0/ion/Writer/Buffer/getBuffer.html new file mode 100644 index 0000000..561d54d --- /dev/null +++ b/docs/v0.0/ion/Writer/Buffer/getBuffer.html @@ -0,0 +1,105 @@ + + + + + + Buffer::getBuffer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\Writer\Buffer::getBuffer()

+

Get the buffer written to.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Buffer/resetBuffer.html b/docs/v0.0/ion/Writer/Buffer/resetBuffer.html new file mode 100644 index 0000000..f75029d --- /dev/null +++ b/docs/v0.0/ion/Writer/Buffer/resetBuffer.html @@ -0,0 +1,105 @@ + + + + + + Buffer::resetBuffer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer\Buffer::resetBuffer()

+

Reset the buffer written to.

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Options.html b/docs/v0.0/ion/Writer/Options.html new file mode 100644 index 0000000..318bbac --- /dev/null +++ b/docs/v0.0/ion/Writer/Options.html @@ -0,0 +1,187 @@ + + + + + + Options - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Writer\Options

+

ION writer options.

+

Constants:

+

None.

+

Properties:

+
    +
  • public ?ion\Catalog $catalog
    +ION catalog to use for symbol lookup.
    • +
  • public ?ion\Decimal\Context $decimalContext
    +Decimal context to use.
    • +
  • public bool $outputBinary
    +Whether to output binary ION.
    • +
  • public bool $compactFloats
    +Whether to write doubles which fit in 32 bits as floats.
    • +
  • public bool $escapeNonAscii
    +Whether to slash-escape all non ASCII bytes.
    • +
  • public bool $prettyPrint
    +Whether to produce pretty-printed output.
    • +
  • public bool $indentTabs
    +Whether to indent with tabs, when pretty-printing.
    • +
  • public int $indentSize
    +The number of spaces to use for indentation instead of tabs, when pretty-printing.
    • +
  • public bool $flushEveryValue
    +Whether to immediately flush every value written.
    • +
  • public int $maxContainerDepth
    +Maximum depth of nested containers.
    • +
  • public int $maxAnnotations
    +The maximum number of annotations allowed on a single value.
    • +
  • public int $tempBufferSize
    +Temporary buffer size.
    • +
+ + + +

Functions:

+
    + +
  • +

    Options::__construct

    +

    Create custom ION writer options.

    + +

    void ion\Writer\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [bool $outputBinary = false, [bool $compactFloats = false, [bool $escapeNonAscii = false, [bool $prettyPrint = false, [bool $indentTabs = true, [int $indentSize = 2, [bool $flushEveryValue = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $tempBufferSize = 16384]]]]]]]]]]]])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Options/__construct.html b/docs/v0.0/ion/Writer/Options/__construct.html new file mode 100644 index 0000000..73a8aa1 --- /dev/null +++ b/docs/v0.0/ion/Writer/Options/__construct.html @@ -0,0 +1,126 @@ + + + + + + Options::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer\Options::__construct([?ion\Catalog $catalog = NULL, [?ion\Decimal\Context $decimalContext = NULL, [bool $outputBinary = false, [bool $compactFloats = false, [bool $escapeNonAscii = false, [bool $prettyPrint = false, [bool $indentTabs = true, [int $indentSize = 2, [bool $flushEveryValue = false, [int $maxContainerDepth = 10, [int $maxAnnotations = 10, [int $tempBufferSize = 16384]]]]]]]]]]]])

+

Create custom ION writer options.

+

Params:

+
    +
  • Optional ?ion\Catalog $catalog = NULL
    +ION catalog to use for symbol lookup.
    • +
  • Optional ?ion\Decimal\Context $decimalContext = NULL
    +Decimal context to use.
    • +
  • Optional bool $outputBinary = false
    +Whether to output binary ION.
    • +
  • Optional bool $compactFloats = false
    +Whether to write doubles which fit in 32 bits as floats.
    • +
  • Optional bool $escapeNonAscii = false
    +Whether to slash-escape all non ASCII bytes.
    • +
  • Optional bool $prettyPrint = false
    +Whether to produce pretty-printed output.
    • +
  • Optional bool $indentTabs = true
    +Whether to indent with tabs, when pretty-printing.
    • +
  • Optional int $indentSize = 2
    +The number of spaces to use for indentation instead of tabs, when pretty-printing.
    • +
  • Optional bool $flushEveryValue = false
    +Whether to immediately flush every value written.
    • +
  • Optional int $maxContainerDepth = 10
    +Maximum depth of nested containers.
    • +
  • Optional int $maxAnnotations = 10
    +The maximum number of annotations allowed on a single value.
    • +
  • Optional int $tempBufferSize = 16384
    +Temporary buffer size.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Stream.html b/docs/v0.0/ion/Writer/Stream.html new file mode 100644 index 0000000..df9983b --- /dev/null +++ b/docs/v0.0/ion/Writer/Stream.html @@ -0,0 +1,179 @@ + + + + + + Stream - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

interface ion\Writer\Stream implements ion\Writer

+

ION stream writer API.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Stream::getStream

    +

    Get the stream being written to.

    + +

    void ion\Writer\Stream::getStream()

    +
    • + +
+ + +

Namespaces, Interfaces and Classes:

+
    + +
  • +

    Writer

    +

    ION stream writer.

    + +

    class ion\Writer\Stream\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Stream

    +
    • + +
+ +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Stream/Writer.html b/docs/v0.0/ion/Writer/Stream/Writer.html new file mode 100644 index 0000000..1513568 --- /dev/null +++ b/docs/v0.0/ion/Writer/Stream/Writer.html @@ -0,0 +1,126 @@ + + + + + + Writer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

class ion\Writer\Stream\Writer extends ion\Writer\Writer implements ion\Writer, ion\Writer\Stream

+

ION stream writer.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + +

Functions:

+
    + +
  • +

    Writer::__construct

    +

    Create a new stream writer.

    + +

    void ion\Writer\Stream\Writer::__construct(resource $stream, [?ion\Writer\Options $options = NULL])

    +
    • + +
+ + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Stream/Writer/__construct.html b/docs/v0.0/ion/Writer/Stream/Writer/__construct.html new file mode 100644 index 0000000..d73513a --- /dev/null +++ b/docs/v0.0/ion/Writer/Stream/Writer/__construct.html @@ -0,0 +1,116 @@ + + + + + + Writer::__construct - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer\Stream\Writer::__construct(resource $stream, [?ion\Writer\Options $options = NULL])

+

Create a new stream writer.

+

Params:

+
    +
  • resource $stream
    +The stream to write to.
    • +
  • Optional ?ion\Writer\Options $options = NULL
    +Writer options.
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Stream/getStream.html b/docs/v0.0/ion/Writer/Stream/getStream.html new file mode 100644 index 0000000..6d7d1d7 --- /dev/null +++ b/docs/v0.0/ion/Writer/Stream/getStream.html @@ -0,0 +1,107 @@ + + + + + + Stream::getStream - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer\Stream::getStream()

+

Get the stream being written to.

+

Params:

+

None.

+

Returns:

+
    +
  • resource,
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/Writer.html b/docs/v0.0/ion/Writer/Writer.html new file mode 100644 index 0000000..987f04e --- /dev/null +++ b/docs/v0.0/ion/Writer/Writer.html @@ -0,0 +1,141 @@ + + + + + + Writer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

abstract class ion\Writer\Writer implements ion\Writer

+

Base implementation of common functionality of ION writers.

+

Constants:

+

None.

+

Properties:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/appendLob.html b/docs/v0.0/ion/Writer/appendLob.html new file mode 100644 index 0000000..ede51b0 --- /dev/null +++ b/docs/v0.0/ion/Writer/appendLob.html @@ -0,0 +1,140 @@ + + + + + + Writer::appendLob - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::appendLob(string $data)

+

Params:

+
    +
  • string $data
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/finish.html b/docs/v0.0/ion/Writer/finish.html new file mode 100644 index 0000000..eab0a16 --- /dev/null +++ b/docs/v0.0/ion/Writer/finish.html @@ -0,0 +1,138 @@ + + + + + + Writer::finish - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Writer::finish()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/finishContainer.html b/docs/v0.0/ion/Writer/finishContainer.html new file mode 100644 index 0000000..94dcfb5 --- /dev/null +++ b/docs/v0.0/ion/Writer/finishContainer.html @@ -0,0 +1,138 @@ + + + + + + Writer::finishContainer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::finishContainer()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/finishLob.html b/docs/v0.0/ion/Writer/finishLob.html new file mode 100644 index 0000000..673ec56 --- /dev/null +++ b/docs/v0.0/ion/Writer/finishLob.html @@ -0,0 +1,138 @@ + + + + + + Writer::finishLob - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::finishLob()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/flush.html b/docs/v0.0/ion/Writer/flush.html new file mode 100644 index 0000000..6ede70b --- /dev/null +++ b/docs/v0.0/ion/Writer/flush.html @@ -0,0 +1,138 @@ + + + + + + Writer::flush - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Writer::flush()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/getDepth.html b/docs/v0.0/ion/Writer/getDepth.html new file mode 100644 index 0000000..3895f7d --- /dev/null +++ b/docs/v0.0/ion/Writer/getDepth.html @@ -0,0 +1,138 @@ + + + + + + Writer::getDepth - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

int ion\Writer::getDepth()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/startContainer.html b/docs/v0.0/ion/Writer/startContainer.html new file mode 100644 index 0000000..1edd307 --- /dev/null +++ b/docs/v0.0/ion/Writer/startContainer.html @@ -0,0 +1,140 @@ + + + + + + Writer::startContainer - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::startContainer(ion\Type $type)

+

Params:

+
    +
  • ion\Type $type
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/startLob.html b/docs/v0.0/ion/Writer/startLob.html new file mode 100644 index 0000000..c52b0e9 --- /dev/null +++ b/docs/v0.0/ion/Writer/startLob.html @@ -0,0 +1,140 @@ + + + + + + Writer::startLob - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::startLob(ion\Type $type)

+

Params:

+
    +
  • ion\Type $type
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeAnnotation.html b/docs/v0.0/ion/Writer/writeAnnotation.html new file mode 100644 index 0000000..b7b0d29 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeAnnotation.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeAnnotation - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeAnnotation([ion\Symbol|string ?>...$annotation])

+

Params:

+
    +
  • Optional ion\Symbol|string ?>...$annotation
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeBLob.html b/docs/v0.0/ion/Writer/writeBLob.html new file mode 100644 index 0000000..0b34518 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeBLob.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeBLob - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeBLob(string $value)

+

Params:

+
    +
  • string $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeBool.html b/docs/v0.0/ion/Writer/writeBool.html new file mode 100644 index 0000000..4c74d87 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeBool.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeBool - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeBool(bool $value)

+

Params:

+
    +
  • bool $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeCLob.html b/docs/v0.0/ion/Writer/writeCLob.html new file mode 100644 index 0000000..1570b12 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeCLob.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeCLob - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeCLob(string $value)

+

Params:

+
    +
  • string $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeDecimal.html b/docs/v0.0/ion/Writer/writeDecimal.html new file mode 100644 index 0000000..d3343d1 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeDecimal.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeDecimal - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeDecimal(ion\Decimal|string $value)

+

Params:

+
    +
  • ion\Decimal|string $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeFieldName.html b/docs/v0.0/ion/Writer/writeFieldName.html new file mode 100644 index 0000000..df36f12 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeFieldName.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeFieldName - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeFieldName(string $name)

+

Params:

+
    +
  • string $name
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeFloat.html b/docs/v0.0/ion/Writer/writeFloat.html new file mode 100644 index 0000000..a80dfd9 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeFloat.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeFloat - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeFloat(float $value)

+

Params:

+
    +
  • float $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeInt.html b/docs/v0.0/ion/Writer/writeInt.html new file mode 100644 index 0000000..a89f122 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeInt.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeInt - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeInt(string|int $value)

+

Params:

+
    +
  • string|int $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeNull.html b/docs/v0.0/ion/Writer/writeNull.html new file mode 100644 index 0000000..00b1832 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeNull.html @@ -0,0 +1,138 @@ + + + + + + Writer::writeNull - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeNull()

+

Params:

+

None.

+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeString.html b/docs/v0.0/ion/Writer/writeString.html new file mode 100644 index 0000000..7368d52 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeString.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeString - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeString(string $value)

+

Params:

+
    +
  • string $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeSymbol.html b/docs/v0.0/ion/Writer/writeSymbol.html new file mode 100644 index 0000000..445f97d --- /dev/null +++ b/docs/v0.0/ion/Writer/writeSymbol.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeSymbol - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeSymbol(ion\Symbol|string $value)

+

Params:

+
    +
  • ion\Symbol|string $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeTimestamp.html b/docs/v0.0/ion/Writer/writeTimestamp.html new file mode 100644 index 0000000..13f146d --- /dev/null +++ b/docs/v0.0/ion/Writer/writeTimestamp.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeTimestamp - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeTimestamp(ion\Timestamp|string $value)

+

Params:

+
    +
  • ion\Timestamp|string $value
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/Writer/writeTypedNull.html b/docs/v0.0/ion/Writer/writeTypedNull.html new file mode 100644 index 0000000..78a7b55 --- /dev/null +++ b/docs/v0.0/ion/Writer/writeTypedNull.html @@ -0,0 +1,140 @@ + + + + + + Writer::writeTypedNull - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

void ion\Writer::writeTypedNull(ion\Type $type)

+

Params:

+
    +
  • ion\Type $type
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/serialize.html b/docs/v0.0/ion/serialize.html new file mode 100644 index 0000000..265ce7d --- /dev/null +++ b/docs/v0.0/ion/serialize.html @@ -0,0 +1,127 @@ + + + + + + serialize - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL])

+

Serialize a PHP value as ION data.

+

Serializes supported PHP values with the optionally provided \ion\Serializer:

+
    +
  • NULL
    • +
  • bool
    • +
  • int
    • +
  • float
    • +
  • string
    • +
  • references
    • +
  • arrays
    • +
  • objects (incl. \Serializable, and classes implementing magic and custom __serialize)
    • +
+

Params:

+
    +
  • mixed $data
    +PHP value(s).
    • +
  • Optional ?ion\Serializer $serializer = NULL
    +Custom serializer.
    • +
+

Returns:

+
    +
  • string, serialized ION data
    • +
+ + + + +
+ + + + + + +
+ + diff --git a/docs/v0.0/ion/unserialize.html b/docs/v0.0/ion/unserialize.html new file mode 100644 index 0000000..83d3856 --- /dev/null +++ b/docs/v0.0/ion/unserialize.html @@ -0,0 +1,116 @@ + + + + + + unserialize - + mdref + + + + + + + + + + + +
+ +
+ +
+ Edit +
+ + + +
+ +

mixed ion\unserialize(string|resource $data, [?ion\Unserializer $unserializer = NULL])

+

Unserialize ION data (stream) as PHP value(s).

+

Params:

+
    +
  • string|resource $data
    +Serialized ION data, either as string buffer or stream,.
    • +
  • Optional ?ion\Unserializer $unserializer = NULL
    +Unserialize ION data (stream) as PHP value(s).
    • +
+

Returns:

+
    +
  • mixed, unserialized PHP values
    • +
+ + + + +
+ + + + + + +
+ +