sanusart/sxml

Simplest, basic XML document creation

dev-master 2014-10-19 18:07 UTC

Requires

• php: >=5.4.0

MIT

• Sasha Khamkov

README

This class will assist in very basic XML document creation.

Autoload (with composer)

Add "sanusart/sxml": "dev-master" to require array in composer.json

Use as:

<?php
require 'vendor/autoload.php';          // add autoloader
$xml = new \sanusart\sxml\sxml(true);   // create new instance

Regular php (without composer)

<?php
include_once '../src/Sxml.php';
$xml = new \sanusart\sxml\sxml(true);

Example

if you have PHP > 5.4.0 and php-cli - you can run php -s localhost:8080 inside example directory.

Basic usage

<?php

include_once '../src/Sxml.php';
$xml = new \sanusart\sxml\sxml(true);

$xml->doctype();
$xml->open('users', array('requered' => 'true', 'type' => 'meta'));

$xml->open('user');
$xml->node('name', 'Sasha');
$xml->node('last_name', 'Khamkov');
$xml->node('alias', 'sanusart');
$xml->node('twitter', '@sanusart');
$xml->node('website', 'http://www.sanusart.com');
$xml->close('user');

$xml->open('no_closing_tag');
$xml->node('node', null, array('requered' => 'true', 'type' => 'data'));
$xml->node('node', null, array('requered' => 'false', 'type' => 'data'));
$xml->node('node', null);
$xml->close('no_closing_tag');

$xml->close('users');

will result in:

<?xml version="1.0" encoding="utf-8"?>
<users type="meta">
<user>
    <name><![CDATA[Sasha]]></name>
	<last_name><![CDATA[Khamkov]]></last_name>
	<alias><![CDATA[sanusart]]></alias>
	<twitter><![CDATA[@sanusart]]></twitter>
	<website><![CDATA[http://www.sanusart.com]]></website>
</user>
</users>

Methods

Constructor()

If $safe is set to true - values of XML nodes will be enclosed inside CDATA

Constructor __construct
sXml __construct ([bool $safe = false])

doctype()

access: public

Ommiting method attributes for $version and/or $encoding will use default values.

void doctype ([string $version = '1.0'], [string $encoding = 'utf=8'])
string $version (optional)
string $encoding (optional)

open()

access: public

void open ([string $tag], [array $attr = array()])
string $tag
array $attr (optional)

close()

access: public

void close ([string $tag])
string $tag

node()

access: public

If $value is set - regular node with closing tag will be created e.g. <node></node>. To create a self closed tag <node /> set $value to null.

void node ([string $tag], [mixed $value], [array $attr = array()])
string $tag
mixed $value | null
array $attr (optional)