10quality / php-class-to-javascript
PHP trait that casts (transforms, converts) classes into javascript objects (string version).
v1.0.0
2017-02-23 20:47 UTC
Requires
- php: >=5.4
Requires (Dev)
- phpunit/phpunit: 4.4.*
This package is auto-updated.
Last update: 2024-08-09 03:25:43 UTC
README
PHP trait that casts (transforms, converts) classes into javascript objects (string version).
Installation
With composer, make the dependecy required in your project:
composer require 10quality/php-class-to-javascript
Usage
Add trait to the wanted class:
use TenQuality\Traits\CastJavascriptTrait; class MyClass { use CastJavascriptTrait; }
The user the casting methods:
$class = new MyClass; $class->toJS(); $class->to_js(); // Alias
Hide properties
To hide properties on casting, add the hidden
property to the class:
class MyClass { use CastJavascriptTrait; protected $hidden = [ 'propertyA', 'property_2', ]; }
Properties selection
To select a specific selection of properties to cast, add the castingProperties
property to the class:
class MyClass { use CastJavascriptTrait; // (1) As array protected $castingProperties = [ 'propertyA', 'property_2', ]; }
class MyClass { use CastJavascriptTrait; protected $attributes = [ 'id', 'name', ]; // (1) As property mapping protected $castingProperties = 'attributes'; }
Coding guidelines
PSR-4.
LICENSE
The MIT License (MIT)
Copyright (c) 2017 10Quality.