Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imponeer/smarty-extensions-contracts
Interfaces for defining smarty template engine extensions in object way
https://github.com/imponeer/smarty-extensions-contracts
contracts extensions hacktoberfest php-library smarty smarty-template-engine
Last synced: about 2 months ago
JSON representation
Interfaces for defining smarty template engine extensions in object way
- Host: GitHub
- URL: https://github.com/imponeer/smarty-extensions-contracts
- Owner: imponeer
- License: mit
- Created: 2021-01-31T08:45:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T11:19:13.000Z (5 months ago)
- Last Synced: 2024-10-02T10:18:47.644Z (3 months ago)
- Topics: contracts, extensions, hacktoberfest, php-library, smarty, smarty-template-engine
- Language: PHP
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE)
[](https://github.com/imponeer/smarty-extensions-contracts/releases) [](https://codeclimate.com/github/imponeer/smarty-extensions-contracts/maintainability) [](http://php.net)
[](https://packagist.org/packages/imponeer/smarty-extensions-contracts)
# Smarty Extensions Contracts
[Smarty 3](https://github.com/smarty-php/smarty) still doesn't use classes for define most of the possible extensions types. This library tries to fix that - it provides all needed interfaces to define extensions in object way.
Defining smarty extensions in object way also can be useful when working with containers. Smarty extensions that could be registered with tags and then loaded when needed.
## Installation
To install and use this package, we recommend to use [Composer](https://getcomposer.org):
```bash
composer require imponeer/smarty-extensions-contracts
```
Otherwise, you need to include manually files from `src/` directory.
## Mapping
| Extension type | Interface name | What it for? |
|----------------|----------------|--------------|
| [Template Function](https://www.smarty.net/docs/en/plugins.functions.tpl) | [\Imponeer\Contracts\Smarty\Extension\SmartyFunctionInterface](src/Extension/SmartyFunctionInterface.php) | Interface that lets to define smarty function extension |
| [Modifier](https://www.smarty.net/docs/en/plugins.modifiers.tpl) | [\Imponeer\Contracts\Smarty\Extension\SmartyModifierInterface](src/Extension/SmartyModifierInterface.php) | Interface that lets to define smarty function extension |
| [Block Function](https://www.smarty.net/docs/en/plugins.block.functions.tpl) | [\Imponeer\Contracts\Smarty\Extension\SmartyBlockInterface](src/Extension/SmartyBlockInterface.php) | Extension interface for smarty block functions |
| [Compiler Function](https://www.smarty.net/docs/en/plugins.compiler.functions.tpl) | [\Imponeer\Contracts\Smarty\Extension\SmartyCompilerInterface](src/Extension/SmartyCompilerInterface.php) | Interface that lets to define smarty compiler extension (that is not internal function based) |
| [Prefilter](https://www.smarty.net/docs/en/plugins.prefilters.postfilters.tpl) | [\Imponeer\Contracts\Smarty\Filter\SmartyPreFilterInterface](src/Filter/SmartyPreFilterInterface.php) | Defines filter that is executed to process template source before compilation |
| [Postfilter](https://www.smarty.net/docs/en/plugins.prefilters.postfilters.tpl) | [\Imponeer\Contracts\Smarty\Filter\SmartyPostFilterInterface](src/Filter/SmartyPostFilterInterface.php) | Defines filter that is executed to process template source after compilation |
| [Output filter](https://www.smarty.net/docs/en/plugins.outputfilters.tpl) | [\Imponeer\Contracts\Smarty\Filter\SmartyOutputFilterInterface](src/Filter/SmartyOutputFilterInterface.php) | Defines filter that is executed before template is loaded and executed but before displayed |
| [Resource](https://www.smarty.net/docs/en/plugins.resources.tpl) | [\Imponeer\Contracts\Smarty\Extension\SmartyResourceInterface](src/Extension/SmartyResourceInterface.php) | Defines custom smarty resource type |
## How to contribute?
If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try [interactive GitHub tutorial](https://skills.github.com).
If you found any bug or have some questions, use [issues tab](https://github.com/imponeer/smarty-extensions-contracts/issues) and write there your questions.