Download the PHP package nicmart/string-template without Composer
On this page you can find all versions of the php package nicmart/string-template. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nicmart/string-template
More information about nicmart/string-template
Files in nicmart/string-template
Package string-template
Short Description StringTemplate is a very simple string template engine for php. I've written it to have a thing like sprintf, but with named and nested substutions.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package string-template
StringTemplate
StringTemplate is a very simple string template engine for php.
I've written it to have a thing like sprintf, but with named and nested substitutions.
For installing instructions, go to the end of this README.
Why
I have often struggled against sprintf's lack of a named placeholders feature, so I have decided to write once and for all a simple component that allows you to render a template string in which placeholders are named.
Furthermore, its placeholders can be nested as much as you want (multidimensional arrays allowed).
Usage
Simply create an instance of StringTemplate\Engine, and use its render method.
Placeholders are delimited by default by { and }, but you can specify others through
the class constructor.
You can also provide an array value:
Nested array values are allowed too! Example:
Object values will be converted to strings:
You can change the delimiters as you want:
SprintfEngine
You can use a more powerful version of the engine if you want to specify convertion specifications for placeholders. The conversion syntax is identical to sprintf one, you need only to specify the optional parameter after the placeholder name.
Example:
Keep in mind that power comes at a cost: SprintfEngine is 3 times slower than Engine
(although if there are no '%' in the template string then performance is almost the same).
NestedKeyIterator and NestedKeyArray
Internally the engine iterates through the value array with the NestedKeyIterator. NestedKeyIterator
iterates through multi-dimensional arrays giving as key the imploded keys stack.
It can be useful even if you don't need the Engine. Keep in mind that it is an RecursiveIteratorIterator,
and so you have to pass a RecursiveIterator to its constructor (or, better, a StringTemplate\RecursiveArrayOnlyIterator if you do not want to iterate through objects).
Example:
NestedKeyArray
In addition to iteration with nested keys, the library offers a class that allows you to access
a multidimensional array with flatten nested keys as the ones seen above. It's called NestedKeyArray.
Example:
Where is it used
I use StringTemplate in DomainSpecificQuery
to implement the Lucene\TemplateExpression class.
Install
The best way to install StringTemplate is through composer.
Just create a composer.json file for your project:
Then you can run these two commands to install it:
$ curl -s http://getcomposer.org/installer | php
$ php composer.phar installor simply run composer install if you have have already installed the composer globally.
Then you can include the autoloader, and you will have access to the library classes:
