Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mpalourdio/zf2-twitter-widget
ZF2 view helper to easily display twitter timelines widgets
https://github.com/mpalourdio/zf2-twitter-widget
module twitter twitter-widget zend-framework zf2 zf2-module
Last synced: 28 days ago
JSON representation
ZF2 view helper to easily display twitter timelines widgets
- Host: GitHub
- URL: https://github.com/mpalourdio/zf2-twitter-widget
- Owner: mpalourdio
- License: mit
- Created: 2014-10-02T20:46:46.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-29T09:12:40.000Z (almost 6 years ago)
- Last Synced: 2023-09-29T10:40:08.174Z (about 1 year ago)
- Topics: module, twitter, twitter-widget, zend-framework, zf2, zf2-module
- Language: PHP
- Size: 26.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/mpalourdio/zf2-twitter-widget)
[](https://scrutinizer-ci.com/g/mpalourdio/zf2-twitter-widget/?branch=master)
[](https://scrutinizer-ci.com/g/mpalourdio/zf2-twitter-widget/?branch=master)
[](https://insight.sensiolabs.com/projects/e3049656-58e8-406e-b85a-48e2c79d81df)
[![PHP 7.0+][ico-engine]][lang]
[![MIT Licensed][ico-license]][license]
[ico-engine]: http://img.shields.io/badge/php-7.0+-8892BF.svg
[lang]: http://php.net
[ico-license]: http://img.shields.io/packagist/l/adlawson/veval.svg
[license]: LICENSE
zf2-twitter-widget
==================
ZF2 view helper to easily display twitter embedded timelines widgets in a ZF2 project. Based on this library : https://github.com/mpalourdio/TwitterWidgets
Requirements
============
PHP 7.0+ - Only Composer installation supported
Installation
============
Run the command below to install via Composer
```shell
composer require mpalourdio/zf2-twitter-widget
```
Add "ZfTwitterWidget" to your **modules list** in **application.config.php**
Usage
=====
- 1) Create a timeline widget here : https://twitter.com/settings/widgets/new
- 2) In the javascript generated code, get the URL and the data-widget-id (minimum information required)
- 3) Finally, in a view, use with
```php
echo $this->tw(
[
'dataWidgetId' => '1245687955000', => the id must be a string (quotes), because of long integer converted to float
'href' => 'https://twitter.com/NickName',
'hrefText' => 'Here type a title'
],
true/false (true is default)
);
```
All the following options are handled : https://dev.twitter.com/web/embedded-timelines#options
Their PHP equivalent as array keys to use in the view helper are :
```php
'class' => 'A css class, by default it will be twitter-timeline',
'href' => 'The link to the timeline',
'hrefText' => 'A title for your timeline to display',
'dataWidgetId' => 'Your data widget ID : must be a string (!)',
'dataTheme' => 'ex: dark',
'dataLinkColor' => 'ex: #cc0000',
'width' => 300 (integer),
'height' => 400 (integer),
'dataChrome' => 'noheader nofooter noborders noscrollbar transparent', => a string with options separated by a single space
'dataBorderColor' => 'border color used by the widget',
'language' => 'The widget language detected from the page, based on the HTML lang attribute of your content. You can also set the HTML lang attribute on the embed code itself.',
'dataTweetLimit' => 20,
'dataRelated' => 'benward,endform',
'dataAriaPolite' => 'polite or assertive',
```
You can give an instance of ```TwitterWidgets\Options\WidgetOptions``` instead of an array (or any implementation of ```TwitterWidgets\Timeline\WidgetOptionsInterface```).
```php
$options = new TwitterWidgets\Options\WidgetOptions();
$options->setDataWidgetId('1245687955000');
$options->setHref('https://twitter.com/NickName');
$options->setHrefText('Here type a title');
echo $this->tw($options);
```
The view helper second parameter is a boolean (true by default), that indicates if you must render the javascript code for your widget. If you have more that one widget on your page,
use the ```OneTimeJsViewHelper``` to only add once the javascript code, just before your ```