feature-php
Back to top  

A feature model represented in XML.

The XML syntax of FeatureIDE feature models is used. A short valid model might look like this:

<featureModel>
   <struct>
    <and abstract="true" mandatory="true" name="root feature"></and>
   </struct>
 <constraints></constraints>
</featureModel>

It is recommended to generate a model using FeatureIDE's graphical feature model editor.

package Default

 Methods

Creates an XML feature model.

__construct(\FeaturePhp\Helper\XmlParser $xmlParser) 

Parameters

$xmlParser

\FeaturePhp\Helper\XmlParser

Creates an XML feature model from an XML file.

fromFile(string $fileName) : \FeaturePhp\Model\XmlModel
Static

Parameters

$fileName

string

Returns

\FeaturePhp\Model\XmlModel

Creates an XML feature model from an XML string.

fromString(string $str, string $directory = null) : \FeaturePhp\Model\XmlModel
Static

Parameters

$str

string

$directory

string

ignored

Returns

\FeaturePhp\Model\XmlModel

Returns the XML feature model's root feature element.

getRoot() : \SimpleXMLElement

Returns

\SimpleXMLElement

Returns the XML feature model's cross-tree constraint elements.

getRules() : array<mixed,\SimpleXMLElement>

Returns

array<mixed,\SimpleXMLElement>

Returns the XML feature model's underlying XML document.

getXml() : \SimpleXMLElement

Returns

\SimpleXMLElement

Returns the XML feature model's underlying XML parser.

getXmlParser() : \FeaturePhp\Helper\XmlParser

Returns

\FeaturePhp\Helper\XmlParser

Traverses the whole XML feature model's tree.

traverse(callable $callback) 

Parameters

$callback

callable

called with the current node and its parent

Traverses a part of the XML feature model's tree.

_traverse(\SimpleXMLElement $node, \SimpleXMLElement $parent, callable $callback) 
Static

This is a preorder traversal (in particular, the root is visited first).

Parameters

$node

\SimpleXMLElement

$parent

\SimpleXMLElement

$callback

callable

callback called with the current node and its parent

 Properties

 

the XML element containing the root feature

$root : \SimpleXMLElement

Default

 

XML elements containing cross-tree constraints

$rules : array<mixed,\SimpleXMLElement>

Default

 

the underlying XML document

$xml : \SimpleXMLElement

Default

 

the underlying XML parser

$xmlParser : \FeaturePhp\Helper\XmlParser

Default