Download the PHP package nexocentric/silkworm without Composer
On this page you can find all versions of the php package nexocentric/silkworm. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nexocentric/silkworm
More information about nexocentric/silkworm
Files in nexocentric/silkworm
Package silkworm
Short Description Silkworm is a flexible HTML generator for use in PHP projects.
License MIT
Homepage http://github.com/nexocentric/silkworm
Informations about the package silkworm
(ml)Silkworm
日本語はこちらです。
中文说明见。
(ml)Silkworm, or just Silkworm, is a markup language library for PHP to aid in the creation of HTML and XML documents. Silkworm acts as an abstraction layer allowing you to focus solely on PHP when you're programming eliminating the need to worry about properly formatting your HTML \t\t<tags>\n
manually.
Silkworm generates nicely carriaged, returned and indented HTML or XML from your PHP files. The library is dynamic and can be used in a modular fashion allowing you to break up the document creation process into logical chunks throughout your program.
History
Silkworm was built from the ground up and has been throughly tested using PhpUnit.
Changelog
Version | Name | Changes |
---|---|---|
1.00 | ao | initial release |
1.01 | beige | fixed code formatting |
1.02 | cyan | updated English readme |
1.03 | daidai | drafted Japanese readme |
1.04 | emerald | completed Japanese readme |
1.05 | fen | drafted Chinese readme |
1.06 | gin | fixed clipping issues, added new tests |
1.07 | hui | completed Chinese readme, removed work files |
2.00 | jade | added some new functionality as listed below |
1) htmlspecialchars escaping | ||
2) ability to define extra boolean attributes | ||
3) ability to define extra self-closing tags | ||
4) ability to adjust last minute indentation | ||
for each silkworm before outputting text | ||
5) padding to integer defined array keys for | ||
improved and more reliable sorting | ||
changelog on English readme file, added | ||
additional tests, added LICENSE file |
Installation and Configuration
Installation
Silkworm has no dependencies and can be installed the following ways:
-
GitHub Copy and Include
- Copy the library from GitHub
- Move Silkworm.php to the directory of your choice
- Include Silkworm.php in the file that you'll be using it in
- Via Composer
- Add the following to your composer requirements
Instantiate $html = new Silkworm();
and go.
Testing
All tests for Silkworm have been conducted with PhpUnit. The tests are contained in the tests folder, so feel free to run them to make sure your version is working.
Configuration
Silkworm doesn't require any configuration before use. However, there are a number of settings that you can use as demonstrated below.
Usage
There are a number of ways to use Silkworm.
Basic
Snippet Saving
You can make and save snippets as follows.
Setup
If you use the (string)$html
as a string, all of the snippets will automatically be joined in numerical then alphabetical order.
Output
You can also choose which snippet you would like to use.
If you need the snippet to include header information like <!DOCTYPE>
, you can wrap the string with the following function.
Advanced
For advanced usage please see the examples folder. The examples are set up and ready for display. You should be able to access the files from your browser and see how they display there. Feel free to tinker with the examples to test out the system.
Contact
General
You can contact me via:
- Twitter: @nexocentric
- GitHub: nexocentric
Bugs
If you find any bugs while using Silkworm, I'd like to know so that I can fix them as soon as possible.
Please submit the issue via GitHub and I'll contact you for more information.
Contributing
Your contributions are greatly appreciated!
If you would like to contribute, please:
- Fork the library on GitHub
- Make any changes that you think will better the project
- Make tests for the changes that you've made
- Make a pull request
- I'll message you about making any needed documentation changes (so that you don't make documentation changes before you know if the pull request can be accepted or not)
I'll go through the request to make sure that everything is okay and usable.*
[*] I would like to apologize in advance for not being able to accept all pull requests.
Feedback
I would like to hear feedback, bad and good. Anything that promotes discussion is appreciated.
Acknowledgements
I would like to thank all of the people who supported me through out development for all of their help and advice.
- Amy Kuwahara
- John Goodland
- Leo Lee
- Tommie Barlow
- Tom Griffin
- Wataru Kitamura
Copyright
See LICENSE file for more information.