kickupx/hsc

Hierarchal String Config, for dealing with large strings in config

1.0.0 2016-02-11 11:49 UTC

This package is not auto-updated.

Last update: 2025-01-04 19:53:35 UTC


README

Hierarchal String Config, For dealing with customizable strings where input is wanted in the middle of it. For example HTML strings.

#Configformat

Really simple

<<<<< NAME

<body>
======
</body>

>>>>> /NAME

Where NAME is the name of the config. Normal characters, numbers, _ and . are recognized ===== denotes where insertion is meant to happen. And last row denotes the end. Notice name is required.

#Usage

Dealing with this is done using the Parser and Document class.

Parse

$code =
     "
     <<<<<< Config
        Text, Text
        ===========
        More More
     >>>>>>> /Config

     <<<<<<<<< Super
        Start, Start
        ===============
        End End
     >>>>>>>>> /Super

";
$parser = new Parser();
$doc = $parser->parse($code);

Get entries

$doc->get('Config');
$doc->get('Config', 'default start', 'default end');

##Add entries

$doc->addEntry(new Entry('Config');
$doc->addEntry(new Entry('Config', 'default start', 'default end'));

##Serializing

$doc->__toString();