https://github.com/wp-forge/fluent
A PHP utility class which allows for more flexible ways of getting and setting data.
https://github.com/wp-forge/fluent
Last synced: about 1 year ago
JSON representation
A PHP utility class which allows for more flexible ways of getting and setting data.
- Host: GitHub
- URL: https://github.com/wp-forge/fluent
- Owner: wp-forge
- Created: 2022-03-03T21:48:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-26T17:39:11.000Z (almost 4 years ago)
- Last Synced: 2025-03-16T16:47:33.378Z (over 1 year ago)
- Language: PHP
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fluent Class
A PHP utility class which allows for more flexible ways of getting and setting data.
## Installation
```shell
composer require wp-forge/fluent
```
## Usage
- [Setting Values](#setting-values)
- [Getting Values](#getting-values)
- [Checking if a Key Exists](#checking-if-a-key-exists)
- [Deleting Values](#deleting-values)
### Setting Values
Populate data from an existing array, object, or iterable
```php
1 ] );
var_dump( $fluent->toJson() ); // {"a":1}
// Populate using an object
$fluent = new Fluent( (object) [ 'b' => 2 ] );
var_dump( $fluent->toJson() ); // {"b":2}
// Populate using an iterable
$fluent = new Fluent( (function () { yield 1; yield 2; })() );
var_dump( $fluent->toJson() ); // [1,2]
```
Set values using array syntax
```php
toJson() ); // {"isActive":true}
```
Set values using property syntax
```php
isActive = true;
var_dump( $fluent->toJson() ); // {"isActive":true}
```
Set values using the `set()` method
```php
set('isActive', true);
var_dump( $fluent->toJson() ); // {"isActive":true}
```
Set values using by calling non-existent methods
```php
isActive(); // Will set to true by default
var_dump( $fluent->toJson() ); // {"isActive":true}
$fluent->isActive( false );
var_dump( $fluent->toJson() ); // {"isActive":false}
```
### Getting Values
Get values using array syntax
```php
true] );
var_dump( $fluent['isActive'] ); // true
```
Get values using property syntax
```php
true] );
var_dump( $fluent->isActive ); // true
```
Get values using the `get()` method
```php
true] );
var_dump( $fluent->get( 'isActive' ) ); // true
// Since "isRegistered" doesn't exist, it returns the defined default value instead
var_dump( $fluent->get( 'isRegistered', 'Ask again later' ) ); // Ask again later
```
Fetch all data using special methods
```php
1] );
$fluent->toArray(); // Returns all data as an array
$fluent->toJson(); // Returns all data as JSON
```
### Checking if a Key Exists
Using array syntax
```php
1] );
var_dump( isset( $fluent['a'] ) ); // true
var_dump( isset( $fluent['b'] ) ); // false
```
Using property syntax
```php
1] );
var_dump( isset( $fluent->a ) ); // true
var_dump( isset( $fluent->b ) ); // false
```
Using the `has()` method
```php
1] );
var_dump( $fluent->has( 'a' ) ); // true
var_dump( $fluent->has( 'b' ) ); // false
```
### Deleting Values
Using array syntax
```php
1] );
unset( $fluent['a'] );
var_dump( $fluent->toJson() ); // []
```
Using property syntax
```php
1] );
unset( $fluent->a );
var_dump( $fluent->toJson() ) ); // []
```
Using the `delete()` method
```php
1] );
$fluent->delete( 'a' );
var_dump( $fluent->toJson() ); // []
```