Download .zip |
Info | Documentation | View files (5) | Download .zip | Reputation | Support forum | Blog | Links |
Last Updated | Ratings | Unique User Downloads | Download Rankings | |||||
2018-11-03 (9 days ago) | Not yet rated by the users | Total: 1 This week: 1 | All time: 9,416 This week: 370 |
Version | License | PHP version | Categories | |||
yii2-template-render 1.0.1 | MIT/X Consortium ... | 5.4 | PHP 5, Templates |
Description | Author | |
This package can be used to render templates in any format with YII2 framework. |
Facilitates rendering data in any custom format/structure with just a parent-view, child-view and DataProvider(Supports pagination, sorting, filtering and all other operations supported by DataProvider).
Though this extension is mainly intended for RESTful APIs built in Yii 2, it can be used anywhere in the application as explained below.
The preferred way to install this extension is through composer.
Either run
php composer.phar require codespede/yii2-template-renderer "*"
or add
"codespede/yii2-template-renderer": "*"
to the require
section of your composer.json.
`
title,image,content
ABC,abc.jpg,Content of ABC
MNO,mno.jpg,Content of MNO
XYZ,xyz.jpg,Content of XYZ
`
- Suppose you have to render the API response in a specific format like below:
`
-begin-
--title=ABC
--image=abc.jpg
--content=Content of ABC
---
--title=MNO
--image=mno.jpg
--content=Content of MNO
---
--title=XYZ
--image=xyz.jpg
--content=Content of XYZ
-end-
`
- Or in any situation where the you have to deliver custom formatted data through the API.One can use this by simply returning the TemplateRenderer object in any action as shown in the below code:
public function actionRender(){
$dataProvider = new ActiveDataProvider(['query' => Model::find()->where($condition)])
return new \cs\templaterenderer\TemplateRenderer([
'dataProvider' => $dataProvider,
'parentView' => '/path/to/parent-view', //path to the parent or wrapper view file
'itemView' => '/path/to/item-view', //path to the item view file
]);
}
In the $parentView
file, a placeholder {{items}}
in the code will be replaced automatically with the collectively rendered result of $itemView
for the models in the current page.
For example, if the content has to be rendered as shown in the second use case above, the $parentView
file should be like:
-begin-
{{items}}
-end-
and the $itemView
should be like:
--title=<?=$model->title?>
--image=<?=$model->image?>
--content=<?=$model->content?>
Files |
File | Role | Description |
---|---|---|
composer.json | Data | Auxiliary data |
LICENSE | Lic. | License text |
README.md | Doc. | Read me |
Serializer.php | Class | Class source |
TemplateRenderer.php | Class | Class source |
Version Control | Unique User Downloads | Download Rankings | |||||||||||||||
100% |
|
|
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.