Skip to content

Add possibility to define XML namespace for tags #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cumuru wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add possibility to define XML namespace for tags #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ $inky->releaseTheKraken('html...');
use Hampe\Inky\Inky;

$inky = new Inky();
$inky->addAlias('test', 'callout')
$inky->addAlias('test', 'callout');

$inky->releaseTheKraken('<test>123</test>'); //equal to "<callout>123</callout>"
```
Expand All @@ -52,7 +52,7 @@ class TestComponentFactory implements ComponentFactoryInterface
{
public function getName()
{
return 'test' // name of the html tag.
return 'test'; // name of the html tag.
}

public function parse(HtmlNode $element, Inky $inkyInstance)
Expand All @@ -66,6 +66,37 @@ $inky->addComponentFactory(new TestComponentFactory());
$inky->releaseTheKraken('<test></test>');
```

### XML Namespace

If you want to prefix all your inky tags with an XML namespace
you can set this prefix either in constructor or via setter:

```php
use Hampe\Inky\Inky;

// Constructor way
$inky = new Inky(12, [], 'inky');

// Setter way
$inky2 = new Inky();
$inky2->setXmlNamespace('inky');
```
If you declare your namespace, create a XSD and make
it know to your IDE you can benefit from autocompletion and
validation features of your IDE. Your inky templates might look as
follows:

```xml
<inky:container>
<inky:row class="my-row">
<inky:columns large="6" small="4">
...
</inky:columns>
</inky:row>
</inky:container>
```


## License
See the [LICENSE](LICENSE) file for license info (it's the MIT license).

5 changes: 5 additions & 0 deletions phpunit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,9 @@
<directory>tests</directory>
</testsuite>
</testsuites>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">src</directory>
</whitelist>
</filter>
</phpunit>
43 changes: 39 additions & 4 deletions src/Inky.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
* @filename Inky.php
* @package inky-parse
* @author Thomas Hampe <github@hampe.co>
* @copyright 2013-2016 Thomas Hampe
* @date 10.01.16
* @author Felix Althaus <felix.althaus@undkonsorten.com>
* @copyright 2013-2017 Thomas Hampe
* @date 10.10.17
*/


Expand Down Expand Up @@ -43,14 +44,20 @@ class Inky

protected $componentFactory = array();

/**
* @var string
*/
protected $xmlNamespace;

/**
* @var int
*/
protected $gridColumns;

public function __construct($gridColumns = 12, $componentFactories = array())
public function __construct($gridColumns = 12, $componentFactories = array(), $xmlNamespace = null)
{
$this->setGridColumns($gridColumns);
$this->setXmlNamespace($xmlNamespace);
$this->addComponentFactory(new RowFactory());
$this->addComponentFactory(new ContainerFactory());
$this->addComponentFactory(new ButtonFactory());
Expand Down Expand Up @@ -218,7 +225,7 @@ protected function parse(Dom $dom)
{
$parseInComplete = false;
foreach($this->getAllComponentFactories() as $tag => $factory) {
$elements = $dom->getElementsByTag($tag);
$elements = $dom->getElementsByTag($this->getXmlNamespacePrefix() . $tag);
foreach($elements as $element) {
/** @var AbstractNode|Collection $element */
$newElement = $factory->parse($element, $this);
Expand Down Expand Up @@ -265,4 +272,32 @@ protected function parse(Dom $dom)
return $parseInComplete;
}

/**
* @param string $xmlNamespace The XML namespace for all inky tags, without colon (:)
* Set to null or empty string to skip XML namespace
* @return $this Inky object for method chaining
*/
public function setXmlNamespace($xmlNamespace)
{
$xmlNamespace = trim($xmlNamespace);
$this->xmlNamespace = $xmlNamespace ?: null;
return $this;
}

/**
* @return string
*/
public function getXmlNamespace()
{
return $this->xmlNamespace;
}

/**
* @return string The XML namespace prefix including colon (:), empty string if no namespace is set
*/
protected function getXmlNamespacePrefix()
{
return $this->xmlNamespace ? $this->xmlNamespace . ':' : '';
}

}
36 changes: 34 additions & 2 deletions tests/InkyTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
* @filename Test.php
* @package inky-parse
* @author Thomas Hampe <github@hampe.co>
* @copyright 2013-2016 Thomas Hampe
* @date 13.03.16
* @author Felix Althaus <felix.althaus@undkonsorten.com>
* @copyright 2013-2017 Thomas Hampe
* @date 10.10.17
*/

use PHPHtmlParser\Dom;
Expand Down Expand Up @@ -42,6 +43,37 @@ public function testAlias()

}

public function testXmlNamespace()
{
$inky = new \Hampe\Inky\Inky(12, [], 'inky');
$this->assertEquals('<table class="callout"><tr><th class="callout-inner">Test</th><th class="expander"></th></tr></table>',
$inky->releaseTheKraken('<inky:callout>Test</inky:callout>'));
$this->assertNotEquals('<table class="callout"><tr><th class="callout-inner">Test</th><th class="expander"></th></tr></table>',
'<callout>Test</callout>');
$inky->addAlias('test', 'callout');
$this->assertEquals('<table class="callout"><tr><th class="callout-inner">Test</th><th class="expander"></th></tr></table>',
$inky->releaseTheKraken('<inky:test>Test</inky:test>'));
$this->assertEquals('<inky:unknown>Test</inky:unknown>', $inky->releaseTheKraken('<inky:unknown>Test</inky:unknown>'));
}

public function testXmlNamespaceViaSetter()
{
$inky = new \Hampe\Inky\Inky();
$inky->setXmlNamespace('inky');
$this->assertEquals('<table class="callout"><tr><th class="callout-inner">Test</th><th class="expander"></th></tr></table>',
$inky->releaseTheKraken('<inky:callout>Test</inky:callout>'));
$inky->setXmlNamespace(null);
$this->assertNotEquals('<table class="callout"><tr><th class="callout-inner">Test</th><th class="expander"></th></tr></table>',
$inky->releaseTheKraken('<inky:callout>Test</inky:callout>'));
}

public function testXmlNamespaceGetterAndSetter()
{
$inky = new Hampe\Inky\Inky();
$inky->setXmlNamespace('testns');
$this->assertEquals('testns', $inky->getXmlNamespace());
}

public function testStyles()
{
$inky = new \Hampe\Inky\Inky();
Expand Down