ion -
mdref
</title>
+ <meta property="og:title" content="ion">
<meta name="viewport" content="width=1200, initial-scale=0.5">
<base href="/ext-ion/v0.1/">
<meta http-equiv="Content-Location" content="/ext-ion/v0.1/ion">
<link rel="stylesheet" href="index.css">
- <link href="https://fonts.googleapis.com/css?family=Inconsolata&subset=latin-ext" rel="stylesheet">
- <script src="//ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<link rel="shortcut icon" href="/ext-ion/v0.1/favicon.ico">
</head>
<body>
<div class="sidebar">
<div class="edit">
- <a href="./ion">Edit</a>
+ <a href="https://github.com/awesomized/ext-ion/edit/master/ion.stub.php">Edit</a>
</div>
</li>
+ <li>
+ ↳ <a href="./ion/: Tutorial">★ Tutorial</a>
+
+ </li>
+
<li>
↳ <a href="./ion/Catalog">Catalog</a>
<ul>
- <li>↳ <a href="./ion/Serializer/PHP">PHP</a>
+ <li>↳ <a href="./ion/Serializer/Serializer">Serializer</a>
</li>
</ul>
<ul>
- <li>↳ <a href="./ion/Unserializer/PHP">PHP</a>
+ <li>↳ <a href="./ion/Unserializer/Unserializer">Unserializer</a>
</li>
</ul>
See the <a href="https://amzn.github.io/ion-docs/">Amazon ION specification</a>.</p><h2 id="License:">License:<a class="permalink" href="ion#License:">#</a>
</h2><p><a href="https://github.com/awesomized/ext-ion/blob/master/LICENSE">BSD-2-Clause</a>;
see <a href="https://spdx.org/licenses/BSD-2-Clause.html">spdx.org</a>.</p><h2 id="Installation:">Installation:<a class="permalink" href="ion#Installation:">#</a>
-</h2><h3 id="PECL">PECL<a class="permalink" href="ion#PECL">#</a>
-</h3><pre><code><span style="color: inherit" class="html">
-pecl install ion<br></span>
-</code></pre><h3 id="PHARext">PHARext<a class="permalink" href="ion#PHARext">#</a>
-</h3><p>Watch out for <a href="https://replicator.pharext.org?ion">PECL replicates</a>
-and pharext packages attached to <a href="./releases">releases</a>.</p><h3 id="Checkout">Checkout<a class="permalink" href="ion#Checkout">#</a>
-</h3><pre><code><span style="color: inherit" class="html">
-git clone github.com:awesomized/ext-ion<br><br>cd ext-ion<br><br>/path/to/phpize<br>./configure --with-php-config=/path/to/php-config<br>make<br>sudo make install<br></span>
-</code></pre><h3 id="Dependencies:">Dependencies:<a class="permalink" href="ion#Dependencies:">#</a>
+</h2><h3 id="Dependencies:">Dependencies:<a class="permalink" href="ion#Dependencies:">#</a>
</h3><h4 id="Required:">Required:<a class="permalink" href="ion#Required:">#</a>
</h4><ul>
<li>PHP-8.1
<a href="https://github.com/amzn/ion-c">amzn/ion-c</a> (bundled as git submodule)</li>
</ul><h3 id="Trinity:">Trinity:<a class="permalink" href="ion#Trinity:">#</a>
</h3><pre><code><span style="color: inherit" class="html">
-phpize<br>./configure<br>make # -j$(nproc)<br>sudo make install # INSTALL=install<br></span>
-</code></pre><h3 id="Try.with.Docker:">Try with Docker:<a class="permalink" href="ion#Try.with.Docker:">#</a>
+phpize<br>./configure # --with-php-config=<path/to/php-config><br>make # -j$(nproc)<br>sudo make install # INSTALL=install<br></span>
+</code></pre><h3 id="PECL">PECL<a class="permalink" href="ion#PECL">#</a>
+</h3><pre><code><span style="color: inherit" class="html">
+pecl install ion<br></span>
+</code></pre><h3 id="PHARext">PHARext<a class="permalink" href="ion#PHARext">#</a>
+</h3><p>Watch out for <a href="https://replicator.pharext.org?ion">PECL replicates</a>
+and pharext packages attached to <a href="./releases">releases</a>.</p><h3 id="Try.with.Docker:">Try with Docker:<a class="permalink" href="ion#Try.with.Docker:">#</a>
</h3><pre><code><span style="color: inherit" class="html">
docker build -t php-ion<br>docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\PHP::asTable());'<br></span>
</code></pre><h2 id="Editor.Stub:">Editor Stub:<a class="permalink" href="ion#Editor.Stub:">#</a>
instances of the following PHP classes cannot be cloned:</p><ul>
<li><a href="ion/Reader/Reader">ion\Reader\Reader</a></li>
<li><a href="ion/Writer/Writer">ion\Writer\Writer</a></li>
-<li><a href="ion/Serializer/PHP">ion\Serializer\PHP</a></li>
-<li><a href="ion/Unserializer/PHP">ion\Unserializer\PHP</a></li>
+<li><a href="ion/Serializer#PHP">ion\Serializer\PHP</a></li>
+<li><a href="ion/Unserializer#PHP">ion\Unserializer\PHP</a></li>
</ul><h2 id="Editor.Stub:">Editor Stub:<a class="permalink" href="ion#Editor.Stub:">#</a>
</h2><p>This extension provides a stub file four your editor's auto-completion.</p><div>
<p><strong>Download the Stub file:</strong></p>
<a href="ion.stub.php">ion.stub.php</a><br>
<small>
Last modified:
- 2022-01-28 09:29:47 UTC </small>
+ 2022-04-01 16:15:03 UTC </small>
</li>
</ul>
</div><h2 id="Functions:">Functions:<a class="permalink" href="ion#Functions:">#</a>
-</h2><ul>
+</h2><ul class="sub-entries sub-functions">
<li>
<h3 id="serialize">
</h3>
<p>Serialize a PHP value as ION data.</p>
- <p><code><a href="https://php.net/manual/en/language.types.string">string</a></code> <a href="ion/serialize">ion\serialize</a>(<code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <span class="var">$data</span>, [
?<a href="ion/Serializer">ion\Serializer</a> <span class="var">$serializer</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</p>
+ <p><code><a href="https://php.net/manual/en/language.types.string">string</a></code> <a href="ion/serialize">ion\serialize</a>(<code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <span class="var">$data</span>, [
<a href="ion/Serializer">ion\Serializer</a>|<code><a href="https://php.net/manual/en/language.types.array">array</a></code>|<code><a href="https://php.net/manual/en/language.types.null">null</a></code> <span class="var">$serializer</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</p>
</li>
<li>
</h3>
<p>Unserialize ION data (stream) as PHP value(s).</p>
- <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <a href="ion/unserialize">ion\unserialize</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code>|<code><a href="https://php.net/manual/en/language.types.resource">resource</a></code> <span class="var">$data</span>, [
?<a href="ion/Unserializer">ion\Unserializer</a> <span class="var">$unserializer</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</p>
+ <p><code><a href="https://php.net/manual/en/language.types.declarations#language.types.declarations.mixed">mixed</a></code> <a href="ion/unserialize">ion\unserialize</a>(<code><a href="https://php.net/manual/en/language.types.string">string</a></code>|<code><a href="https://php.net/manual/en/language.types.resource">resource</a></code> <span class="var">$data</span>, [
<a href="ion/Unserializer">ion\Unserializer</a>|<code><a href="https://php.net/manual/en/language.types.array">array</a></code>|<code><a href="https://php.net/manual/en/language.types.null">null</a></code> <span class="var">$unserializer</span> = <code><a href="https://php.net/manual/en/language.types.null">NULL</a></code>])</p>
</li>
</ul><h2 id="Namespaces.Interfaces.and.Classes:">Namespaces, Interfaces and Classes:<a class="permalink" href="ion#Namespaces.Interfaces.and.Classes:">#</a>
-</h2><ul>
+</h2><ul class="sub-entries sub-ns-classes">
<li>
<h3 id="Catalog">
<p><em>interface</em> <a href="ion/Writer">ion\Writer</a></p>
</li>
-</ul>
- <div id="disqus_thread"><button id="disqus_activator">Show <span> </span> Comment(s)</button></div>
- <script>
- var disqus_shortname = 'mdref';
- var disqus_identifier = 'ion';
- </script>
-
+</ul>
+ <div class="comments">
+ <style>.giscus-frame {min-height: 16em;}</style>
+ <script>
+ function giscus_load(button) {
+ let script = document.createElement("script");
+ script.setAttribute("data-repo", 'awesomized/ext-ion');
+ script.setAttribute("data-category", 'Comments on Docs');
+ script.setAttribute("data-repo-id", 'R_kgDOGfXEXw');
+ script.setAttribute("data-category-id", 'DIC_kwDOGfXEX84CBHuf');
+ script.setAttribute("data-mapping", 'og:title');
+ script.setAttribute("data-input-position", 'bottom');
+ script.setAttribute("data-reactions-enabled", false);
+ script.setAttribute("data-theme", 'light');
+ script.setAttribute("data-lang", 'en');
+
+ script.src = "//giscus.app/client.js";
+ button.parentNode.replaceChild(script, button);
+ }
+ </script>
+ <button class="activator" onclick="giscus_load(this)">Show Comments from Github Discussions</button>
+
+ </div>
+
<footer>
<ul>
</footer>
- <script src="index.js"></script>
+ <script src="index.js" defer></script>
</div>
</body>
projects / awesomized / ext-ion / blobdiff