https://github.com/webbywe/veneer
Set of Drupal 8 service wrappers disguising some complex core functions
https://github.com/webbywe/veneer
Last synced: 11 months ago
JSON representation
Set of Drupal 8 service wrappers disguising some complex core functions
- Host: GitHub
- URL: https://github.com/webbywe/veneer
- Owner: webbywe
- Created: 2018-04-20T13:54:20.000Z (about 8 years ago)
- Default Branch: 8.x-5.x
- Last Pushed: 2018-04-22T03:28:02.000Z (about 8 years ago)
- Last Synced: 2025-01-17T16:15:03.838Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Veneer /vəˈnir/
=======================
An attractive appearance that covers or disguises something's true nature.
What Is This?
-------------
This is a Drupal 8 module for site building development purposes that is loosely
based on the idea of a Facade pattern for Drupal. It does not do anything on
it's own when enabled. It provides several utility functions to a developer
through the Services container.
How To Use The Examples
-----------------------
The module allows for chainable functions to get output desired.
The render() function will return FALSE if during the course of chaining
a parameter or object required did not pass validation for that service.
This module is not set to throw Exceptions and will not kill an site.
It is responsibility of developer to perform necessary validations.
Examples for Developers
-----------------------
Below are variables syntax examples for the available services.
### Node
```
use Drupal\veneer\Veneer;
Veneer::node($id)->render();
// Or access directly through Drupal Services.
/** @var \Drupal\veneer\VeneerNode $veneer_node */
$veneer_node = \Drupal::service('veneer.node');
$veneer_node->load($id)->render();
```
Render the current node with default "full" display.
```php
Veneer::node()->render();
```
Add the current node with "default" display to twig as a generic Veneer variable.
Syntax for Twig: ```{{ veneer.nodes.[id].view }}```
```php
Veneer::node()->twig();
```
Render the current node and open a variable name "veneer_node" up to Twig.
```php
Veneer::node()->twig('veneer_node');
```
Render a node by id with default "full" display and assure it's an "article".
```php
Veneer::node([id => $id, type => 'article'])->render();
```
Render a node's teaser using a node id.
```php
Veneer::node($id)->display(’teaser')->render();
```
Render the field of current node.
```php
Veneer::node()->field(‘body')->render();
```
TODO
-----------------------
1. Add unit tests.
2. Add more functions to access PITA data to retrieve.