MH_Widget: Generate HTML for embedded widgets from parameters

Recommend this page to a friend!
  Info   View files Example   Demos   View files View files (11)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not enough user ratingsTotal: 159 All time: 8,739 This week: 344Up
Version License PHP version Categories
mh_widget 0.2MIT/X Consortium ...5.3HTML, PHP 5, Content management, Temp...
Description Author

This package can Generate HTML for embedded widgets from parameters.

The main class can be called directly passing the name of the widget. The class will load the respective widget class from the configured widgets directory and passes it any parameters that determine how it will render the widget HTML.

HTML pages may may contain custom tags that are parsed by a separate class that identifies the widget tags, extracts the parameters from the tag attributes and replace them by the HTML generated for the respective widget.

Example widget classes are provided for simple hello world widget and a widget to embed gravatar images.

Picture of Matteo Hertel
Name: Matteo Hertel <contact>
Classes: 2 packages by
Country: United Kingdom
Age: 29
All time rank: 3659152 in United Kingdom
Week rank: 738 Up25 in United Kingdom Up

Details

MH_Widget

Scrutinizer Code Quality Build Status

Demo: http://test.matteohertel.uk/mh_widget/

Flexible, highly configurable widget system replace an HTML place holder with any content.

The main purpose for this package was to be used alongside a text editor like CKEditor to implement a flexible widget system for the end user(http://docs.ckeditor.com/#!/guide/widget_sdk_tutorial_1)

This package will provide a nice and neat interface to create widgets ready to use in any project, there are a lots of feature straight out of the box, but with its flexible nature can fit any need.

There are two main ways to use this package: - Use the widget system standalone as easy way to render HTML - Use the widget system with the integrated parser

To use the widget standalone:

  1. Create an instance of \MHDev\WidgetCore\MH_Widget
  2. Call the instance as a function (to trigger the magic `__invkoke`) passing two arguments (one optional): namespace, config array
  3. under the hood the class will: - create a new instance of the requested widget in the given namespace(or use the default one \MHDev\Widgets\ and pass the config object - call the instance as function (to trigger the magic `__invkoke`) and return the result

The single widget workflow is:

  1. from the magic invoke the the `controller` method is called
  2. the `controller` method call the `model` method to get data
  3. the `controlle`r will call and return the view method passing the data from the model - if the `prevent_view` kay is found in the config array the controller will return the data from the model without call the view

Using the parser

With the integrated parser you can use a custom non-standard html tag mhwidget with attributes to render content from the widget, and example of a working tag:

<mhwidget size="128" email="youremail@gravatr.com">Gravatar</mhwidget>

Under the hood

To be a proper widget the class must extend the WidgetAbstract class and override the __invoke, controller, model and view methods,

Usage

Simple hello world

$widget = new \MHDev\WidgetCore\MH_Widget("\MHDev\Widgets\\");
echo $widget("Example\HelloWorld");

Gravatar

$widget = new \MHDev\WidgetCore\MH_Widget("\MHDev\Widgets\\");
echo $widget("Gravatar", ["email" => "info@matteohertel.com", "size" => 80]);

Example

To see the package in action run the following(php must be available in the console):

git clone https://github.com/matteo-hertel/MH_Widget.git
cd MH_Widget
php -S localhost:8080 -t ./Example

the open your browser to http://localhost:8080

Version

0.2

Feedback

Please, send me your feedback, using the issue tracker on github or via email to info[at]matteohertel.com

Dependencies

There are no external dependencies but the Parser require the native DOMDocument class and a the widget tag syntax must be right to work properly

License

MIT

  Files folder image Files  
File Role Description
Files folder imageExample (2 files)
Files folder imageMHDev (2 directories)
Accessible without login Plain text file .gitignore Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file LICENSE Data Auxiliary data
Accessible without login Plain text file README.MD Doc. Auxiliary data

  Files folder image Files  /  Example  
File Role Description
  Accessible without login Plain text file index.php Example Example script
  Accessible without login Plain text file TestWidget.php Example Example script

  Files folder image Files  /  MHDev  
File Role Description
Files folder imageWidgetCore (3 files)
Files folder imageWidgets (1 file, 1 directory)

  Files folder image Files  /  MHDev  /  WidgetCore  
File Role Description
  Plain text file MH_Widget.php Class Class source
  Plain text file WidgetAbstract.php Class Class source
  Plain text file WidgetParser.php Class Class source

  Files folder image Files  /  MHDev  /  Widgets  
File Role Description
Files folder imageExample (1 file)
  Plain text file Gravatar.php Class Example script

  Files folder image Files  /  MHDev  /  Widgets  /  Example  
File Role Description
  Plain text file HelloWorld.php Class Example script

 Version Control Unique User Downloads Download Rankings  
 100%
Total:159
This week:0
All time:8,739
This week:344Up

For more information send a message to info at phpclasses dot org.