Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yidas/codeigniter-widget
CodeIgniter 3 Widget for reusable building view blocks
https://github.com/yidas/codeigniter-widget
codeigniter3 mvc view-block view-model widget
Last synced: 3 months ago
JSON representation
CodeIgniter 3 Widget for reusable building view blocks
- Host: GitHub
- URL: https://github.com/yidas/codeigniter-widget
- Owner: yidas
- License: mit
- Created: 2017-12-28T10:53:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-17T16:09:19.000Z (over 3 years ago)
- Last Synced: 2024-10-01T11:05:53.096Z (4 months ago)
- Topics: codeigniter3, mvc, view-block, view-model, widget
- Language: PHP
- Homepage:
- Size: 22.5 KB
- Stars: 4
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CodeIgniter Widget
CodeIgniter 3 Widget for reusable building view blocks
[](https://packagist.org/packages/yidas/codeigniter-widget)
[](https://packagist.org/packages/yidas/codeigniter-widget)
[](https://packagist.org/packages/yidas/codeigniter-widget)
This Widget extension is collected into [yidas/codeigniter-pack](https://github.com/yidas/codeigniter-pack) which is a complete solution for Codeigniter framework.
Features
--------
- *Common interface with Yii2 pattern like*
- ***Reusable building blocks** implementation*
- ***PSR-4 Namespace** support for static call*
---
OUTLINE
-------
- [Demonstration](#demonstration)
- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration](#configuration)
- [Create Widgets](#create-widgets)
- [Rendering View](#rendering-view)
- [Utilizing CodeIgniter Resources](#utilizing-codeigniter-resources)
- [Usage](#usage)
- [Reference](#reference)
---
DEMONSTRATION
-------------
Define a widget then use it in Codeigniter's view:
```html
=Hello::widget(['message' => 'Good morning']);?>
```
---
REQUIREMENTS
------------
This library requires the following:
- PHP 5.4.0+
- CodeIgniter 3.0.0+
- yidas/codeigniter-psr4-autoload 1.0.0+
---
INSTALLATION
------------
Run Composer in your Codeigniter project under the folder `\application`:
composer require yidas/codeigniter-widget
Check Codeigniter `application/config/config.php`:
```php
$config['composer_autoload'] = TRUE;
```
> You could customize the vendor path into `$config['composer_autoload']`
---
CONFIGURATION
-------------
Widget extension require [yidas/codeigniter-psr4-autoload](https://github.com/yidas/codeigniter-psr4-autoload) to implement PSR-4 Namespace, which you need to [configure](https://github.com/yidas/codeigniter-psr4-autoload#configuration) at first:
### 1. Enabling Hooks
The hooks feature can be globally enabled/disabled by setting the following item in the `application/config/config.php` file:
```php
$config['enable_hooks'] = TRUE;
```
### 2. Adding a Hook
Hooks are defined in the `application/config/hooks.php` file, add above hook into it:
```php
$hook['pre_system'][] = [new yidas\Psr4Autoload, 'register'];
```
After the configuration, you are able to create widgets.
---
CREATE WIDGETS
--------------
To create a widget, extend from `yidas\Widget` and override the `init()` and/or `run()` methods, remember to defind this widget a current namespace refering by [yidas/codeigniter-psr4-autoload](https://github.com/yidas/codeigniter-psr4-autoload).
`init()` contains the code that initializes the widget properties.
`run()` contains the code that generates the rendering result of the widget.
In the following example, `Hello` widget display the partial view with assigning to its `message` property. If the property is not set, it will display your Codeigniter `base_url` by default. This widget file should place in `application/widgets/Hello.php`:
```php
CI for accessing Codeigniter object
$baseUrl = $this->CI->config->item('base_url');
if ($this->message === null) {
$this->message = "Your Site: {$baseUrl}";
}
}
public function run()
{
// Render the view `test.php` in `WidgetPath/views` directory,
return $this->render('test', [
'message' => $this->message,
]);
}
}
```
> [yidas/codeigniter-psr4-autoload](https://github.com/yidas/codeigniter-psr4-autoload) provides the PSR-4 Namespace ability for Codeigniter framework.
### Rendering View
```php
public string render(string $view, array $variables=[])
```
By default, views for a widget should be stored in files in the `WidgetPath/views` directory, where WidgetPath stands for the directory containing the widget class file.
Therefore, the above example will render the view file `app/widgets/views/hello.php`, assuming the widget class is located under `app/widgets`.
You may override the `yidas\Widget::getViewPath()` method to customize the directory containing the widget view files.
*Example:*
```php
public function run()
{
return $this->render('view_name', [
'variable' => $this->property,
]);
}
```
### Utilizing CodeIgniter Resources
Widget already prepared `$CI` property which is CodeIgniter Resources object, you could access it by `$this->CI` in your widget's `init()` or `run()` methods.
```php
public function run()
{
// Get data from a model
$this->CI->load->model('Menu_model');
$list = $this->CI->Menu_model->getList();
// Build widget's view with list data
return $this->render('test', [
'list' => $list,
]);
}
```
---
USAGE
-----
### Widget on View
Statically call `widget()` with config in view, and the widget would render into that place:
```html
=Hello::widget(['message' => 'Good morning']);?>
```
---
REFERENCE
---------
- [Application Structure: Widgets | The Definitive Guide to Yii 2.0 | Yii PHP Framework](https://www.yiiframework.com/doc/guide/2.0/en/structure-widgets)