Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/trapvincenzo/var-type-check

Simple var type checker for Twig
https://github.com/trapvincenzo/var-type-check

php symfony symfony-bundle twig

Last synced: about 18 hours ago
JSON representation

Simple var type checker for Twig

Host: GitHub
URL: https://github.com/trapvincenzo/var-type-check
Owner: trapvincenzo
Created: 2017-11-14T23:22:51.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2017-11-25T10:34:33.000Z (almost 7 years ago)
Last Synced: 2024-02-14T21:37:16.919Z (9 months ago)
Topics: php, symfony, symfony-bundle, twig
Language: PHP
Size: 24.4 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Var type check for Twig
With var type check, is easy to create a list of requirements that the vars passed into a template must meet.

## DSL
The structure of the check is really simple and expressive

`varType` **nameOfTheVariable** `expects` **type** `required (optional, the default is false)`

## Example
```twig
... inside the template we declare the requirements

{# this is optional and if defined needs to be a string #}
{% varType title expects string %}

{# this is required and needs to be a int #}
{% varType age expects int required %}
```

## Structure definition
Some types allow to define a structure of types using the word `of` followed by an object.

```twig
... inside the template we declare the requirements

{% varType data expects array of {title: {type: 'string', required: true}, desc: {type: 'string'}} %}
```

## Available checkers

| Checker | Type | Allow structure |
| ------- | :------: | :----------------:|
| `array` | Array | Yes |
| `bool` | Bool | No |
| `float` | Float | No |
| `int` | Integer | No |
| `numeric` | Numeric | No |
| `object` | Object | Yes |
| `string` | String | No |

## Install
Install the bundle with [Composer](https://getcomposer.org): `composer require trapvincenzo/var-type-check`.

Add to your `AppKernel.php` the following:

```php
$bundles[] = new \Trapvincenzo\Bundle\VarTypeCheckBundle\TrapvincenzoVarTypeCheckBundle();
```
Probably you want to enable this bundle only on `dev` and not in `prod`.

## Create a custom type checker
If you need to add some custom type checker to your app, it needs to implement the `Trapvincenzo\Bundle\VarTypeCheckBundle\Service\Type\TypeCheckerInterface` and the service must be tagged with `trapvincenzo.vartypecheck.type_checker`.

```php
class CustomTypeChecker implements TypeCheckerInterface
{
...
}

```

```yml
services:
vartypecheck.typer_checker_custom:
class: CustomTypeChecker
tags:
- { name: trapvincenzo.vartypecheck.type_checker }
```

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## Contribute
* Clone the repo
* Install the dependencies `composer install`
* Run the tests `composer test`

The bundle is open for improvements, new type checkers and so on!