Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imponeer/smarty-xo
Smarty template engine plugins collections based on ideas for plugins from @xoops
https://github.com/imponeer/smarty-xo
hacktoberfest links pagination smarty smarty-plugins xoops
Last synced: about 2 months ago
JSON representation
Smarty template engine plugins collections based on ideas for plugins from @xoops
- Host: GitHub
- URL: https://github.com/imponeer/smarty-xo
- Owner: imponeer
- License: mit
- Created: 2021-02-05T21:54:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T07:08:16.000Z (5 months ago)
- Last Synced: 2024-09-01T09:02:22.648Z (4 months ago)
- Topics: hacktoberfest, links, pagination, smarty, smarty-plugins, xoops
- Language: PHP
- Homepage:
- Size: 65.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE)
[](https://github.com/imponeer/smarty-xo/releases) [](https://codeclimate.com/github/imponeer/smarty-xo/maintainability) [](http://php.net)
[](https://packagist.org/packages/imponeer/smarty-xo)
# Smarty XO
Rewritten (due licensing issues) collection [Smarty](https://smarty.net) plugins that where originally written for [Xoops](https://xoops.org) but now can be used everywhere.
## Installation
To install and use this package, we recommend to use [Composer](https://getcomposer.org):
```bash
composer require imponeer/smarty-xo
```
Otherwise, you need to include manually files from `src/` directory.
## Registering in Smarty
If you want to use these extensions from this package in your project you need register them with [`registerPlugin` function](https://www.smarty.net/docs/en/api.register.plugin.tpl) from [Smarty](https://www.smarty.net). For example:
```php
$smarty = new \Smarty();
$plugins = [
new \Imponeer\Smarty\Extensions\XO\XOAppUrlCompiler(
function (string $url): string { // function that converts url into path
return $url;
},
function (string $url, array $params = []): string { // function that adds params to path
return $url . '?' . http_build_query($params);
}
),
new \Imponeer\Smarty\Extensions\XO\XOPageNavFunction(
function (string $url): string { // function that generates real url
return $url;
},
$strPreviousPage = '<',
$strNextPage = '>',
$oldSchoolUrlMode = true
),
new \Imponeer\Smarty\Extensions\XO\XOImgUrlCompiler(
function (string $imgPath): string { // function that makes psiaudo path into real assets path
return $imgPath;
}
),
new \Imponeer\Smarty\Extensions\XO\XOInboxCountFunction(
function (): ?int { // function that calc unread messages in user inbox
return 0;
}
)
];
foreach ($plugins as $plugin) {
if ($plugin instanceof \Imponeer\Contracts\Smarty\Extension\SmartyFunctionInterface) {
$type = 'function';
} else {
$type = 'compiler';
}
$smarty->registerPlugin($type, $plugin->getName(), [$plugin, 'execute']);
}
```
## Inspirations list
This list can be useful for comparing current plugins code with original version to see differences and find some useful data how to use these plugins.
| XO Smarty plugin | Original Plugin (from [Xoops](https://xoops.org)) |
|---------------|-----------------|
| [\Imponeer\Smarty\Extensions\XO\XOPageNavFunction](./src/XOPageNavFunction.php) | [smarty_function_xoPageNav](https://github.com/XOOPS/XoopsCore25/blob/v2.5.8/htdocs/class/smarty/xoops_plugins/function.xoPageNav.php) |
| [\Imponeer\Smarty\Extensions\XO\XOAppUrlCompiler](./src/XOAppUrlCompiler.php) | [smarty_compiler_xoAppUrl](https://github.com/XOOPS/XoopsCore25/blob/v2.5.8/htdocs/class/smarty/xoops_plugins/compiler.xoAppUrl.php) |
| [\Imponeer\Smarty\Extensions\XO\XOImgUrlCompiler](./src/XOImgUrlCompiler.php) | [smarty_compiler_xoImgUrl](https://github.com/XOOPS/XoopsCore25/blob/v2.5.8/htdocs/class/smarty/xoops_plugins/compiler.xoImgUrl.php) |
| [\Imponeer\Smarty\Extensions\XO\XOInboxCountFunction](./src/XOInboxCountFunction.php) | [smarty_function_xoInboxCount](https://github.com/XOOPS/XoopsCore25/blob/v2.5.8/htdocs/class/smarty/xoops_plugins/function.xoInboxCount.php) |
## 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-xo/issues) and write there your questions.