PHP Classes

Saad Laravel PHP Fractal Transformer: Transform data presented by Laravel applications

Recommend this page to a friend!
  Info   View files Documentation   View files View files (17)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog (1)    
Last Updated Ratings Unique User Downloads Download Rankings
2022-01-23 (8 months ago) RSS 2.0 feedNot yet rated by the usersTotal: 23 All time: 10,695 This week: 204Up
Version License PHP version Categories
saad-fractal 1.0.0GNU General Publi...5HTTP, PHP 5, Libraries
Description Author

This class can transform data presented by Laravel applications.

It provides classes that transform data retrieved from data sources using the current HTTP request parameter values that configure the data transformation details.

The package provides an abstract transformation class that applications can use to create their own rules to transform the source data more conveniently to the application data presentation purposes.

Innovation Award
PHP Programming Innovation award nominee
January 2022
Number 6
This class can transform data presented by Laravel applications.

It provides classes that transform data retrieved from data sources using the current HTTP request parameter values that configure the data transformation details.

The package provides an abstract transformation class that applications can use to create their own rules to transform the source data more conveniently to the application data presentation purposes.

Manuel Lemos
Picture of Ahmed Saad
  Performance   Level  
Name: Ahmed Saad <contact>
Classes: 10 packages by
Country: Egypt Egypt
Age: ???
All time rank: 223321 in Egypt Egypt
Week rank: 94 Up4 in Egypt Egypt Up
Innovation award
Innovation award
Nominee: 7x

Details

An easy to use Fractal wrapper built for Laravel applications upon Spatie/Fractal Package

Spatie/Fractal

Install

You can pull in the package via composer:

	composer require saad/fractal

The package will automatically register itself.

Laravel Version

this package is compatible with laravel versions >= 5.5

Changelog

> __V 1.2.0__ 1. Add Strict Mode, so for null resources instead of returning empty array it will return null, By Default strict mode is Enabled


use

Exactly as spatie except that this package is automatically parse includes or excludes from parameters first if defined, otherwise it will look for query string includes and excludes

Default serializer is ArraySerializer

Console Generator

you can generate a new transformer class using the following command

the following command will create "App\Transformers\UserTransformer.php"

	php artisan make:transformer 'App\User'

to create in nested folders "App\Transformers\Sub1\Sub2\UserTransformer.php"

	php artisan make:transformer 'App\User' --nest='Sub1\Sub2'
	
	# Nest Name could be:
	
	# Sub1/Sub2
	# /Sub1/Sub2/
	# Sub1\\Sub2

Request Includes

> will include defined includes from __availableIncludes__ array

	
	// assume that Request Url = /countries?include=name,code,iso
	
	$couintries = Country::all();
	$transformed_data = \Saad\Fractal\Fractal::create($countries, new CountryTransformer());
	
	// CountryTransformer will include name, code and iso
	

Force Includes

> we could also pass includes to create method as the 4th argument which will have the heighest periority than request include > will include defined includes from __availableIncludes__ array


	
	// assume that Request Url = /countries?include=name,code,iso
	
	$couintries = Country::all();
	$transformed_data = \Saad\Fractal\Fractal::create($countries, new CountryTransformer(), null, 'name,iso');
	
	// CountryTransformer will include only name and iso
	

Request Excludes

> will exclude defined includes from __defaultIncludes__ array

	
	// assume that Request Url = /countries?exclude=name,code
	
	$couintries = Country::all();
	$transformed_data = \Saad\Fractal\Fractal::create($countries, new CountryTransformer());
	
	// CountryTransformer will exclude name and code from default includes
	

Force Excludes

>we could also pass excludes to create method as the 5th argument which will have the heighest periority than request include > will include defined includes from __defaultIncludes__ array


	
	// assume that Request Url = /countries?exclude=name,code,iso
	
	$couintries = Country::all();
	$transformed_data = \Saad\Fractal\Fractal::create($countries, new CountryTransformer(), null, null, 'name');
	
	// CountryTransformer will exclude only name from defaultIncludes
	

Transformer Abstract Class

this package has a base abstract Transformer Class Saad\Fractal\Transformers\TransformerAbstract you could use as the base class of your transformers, this class is based on extends League\Fractal\TransformerAbstract and adds the following features:

TransformerAbstract::strictMode(bool)

> This mode added since V 1.2.0 <br>

null resources is returning empty array, when enable strict mode it will return NULL instead. By default strict mode is enabled

To control strict mode you could call one of these methods in one of the service providers boot method:

> Enable Strict Mode (Enabled By Default): <br> > TransformerAbstract::strictMode(true) <br> > TransformerAbstract::enableStrictMode()

> Disable Strict Mode: <br> > TransformerAbstract::strictMode(false) <br> > TransformerAbstract::disableStrictMode()


    // Assume we have this transformer
    class CountryTransformer extends TransformerAbstract {
        ...
        
        includeRegions(Country $country) {
            // assume there are no regions
            return $this->null();
        }
    }
    
	$transformer = new CountryTransformer();
	
	$output = Fractal::create($country, $transformer);
	
	// output when strict mode is enabled (default status)
	[
	    ...
		'regions' => null,
	]
	
	
	// Disable Strict Mode
	TransformerAbstract::disableStrictMode();
	
	$output = Fractal::create($country, $transformer);
    	
    // output when strict mode is disabled
    [
        ...
        'regions' => [],
    ]
	

transform() replaced by transforWithDefault()

> you should use __transforWithDefault()__ methodcinstead of __transform()__ method > this is because the new addEexternal feature

addExternal($key, $value)

> you can add external value to output

	$transformer = new CountryTransformer();
	
	$output = Fractal::create($country, $transformer);
	
	// assume this output of country is 
	[
		'name' => 'Egypt',
		'iso' => 'EG' 
	]
	
	
	// If we want to add another key to output
	
	$transformer->addExternal('new_key', 'Iam New Value');
	$output = Fractal::create($country, $transformer);
	
	// Then output of country will be
	[
		'name' => 'Egypt',
		'iso' => 'EG',
		'new_key' => 'Iam New Value',
	]
	
	
	// We can also add external which have a calculated value depends on transformed object
	// assume we want to add new key to output named 'name_iso' which its value is the concatenation of both 'name' and 'iso' properies
	
	$transformer->addExternal('name_iso', function ($country_object) {
		return $country_object->name . '_' . $country_object->iso;
	});
	
	$output = Fractal::create($country, $transformer);
	
	// Then output of country will be
	[
		'name' => 'Egypt',
		'iso' => 'EG',
		'name_iso' => 'Egypt_EG',
	]
	
	

addDefaultInclude(string|array $defaults_to_add)

> will add provided keys to defaultIncludes array


	// assume that defaultIncludes are ['id', 'name']
	$transformer = new CountryTransformer();
	$transformer->addDefaultInclude(['iso']);
	
	$output = Fractal::create($country, $transformer);
	
	// assume this output of country is 
	[
		'id' => 1,
		'name' => 'Egypt',
		
		'iso' => 'EG' // added to defaultIncludes
	]

Fractal Request Parser Singletone

this package also contains a singletone __Saad\Fractal\FractalRequestParser__ which is a helper class that provides usefull methods about Request includes and excludes with the following methods :

__Saad\Fractal\FractalRequestParser::includesHas($key_path)__

__Saad\Fractal\FractalRequestParser::excludesHas($key_path)__

> assume we have the following request URI ?include=name,sub.name:lang(ar),sub.country

 	$parser = Saad\Fractal\FractalRequestParser::getInstance();
 
 	// we can check the following
 	$parser->includesHas('name');  // true
 	$parser->includesHas('sub');  // true
 	$parser->includesHas('sub.name');  // true
 	$parser->includesHas('sub.country');  // true
 	
 	$parser->includesHas('iso');  // false
 	$parser->includesHas('sub.country.name');  // false

the same for __excludesHas()__

  Files folder image Files  
File Role Description
Files folder image.idea (5 files)
Files folder imageresources (1 directory)
Files folder imagesrc (5 files, 2 directories)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  .idea  
File Role Description
  Accessible without login Plain text file misc.xml Data Auxiliary data
  Accessible without login Plain text file modules.xml Data Auxiliary data
  Accessible without login Plain text file saad-fractal.iml Data Auxiliary data
  Accessible without login Plain text file vcs.xml Data Auxiliary data
  Accessible without login Plain text file workspace.xml Data Auxiliary data

  Files folder image Files  /  resources  
File Role Description
Files folder imagestubs (1 file)

  Files folder image Files  /  resources  /  stubs  
File Role Description
  Plain text file Transformer.stub Class Class source

  Files folder image Files  /  src  
File Role Description
Files folder imageCommands (2 files)
Files folder imageTransformers (1 file)
  Accessible without login Plain text file fallback.php Example Example script
  Plain text file Fractal.php Class Class source
  Plain text file FractalFacade.php Class Class source
  Plain text file FractalRequestParser.php Class Class source
  Plain text file FractalServiceProvider.php Class Class source

  Files folder image Files  /  src  /  Commands  
File Role Description
  Plain text file BaseMakeCommand.php Class Class source
  Plain text file MakeTransformer.php Class Class source

  Files folder image Files  /  src  /  Transformers  
File Role Description
  Plain text file TransformerAbstract.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:23
This week:0
All time:10,695
This week:204Up
For more information send a message to info at phpclasses dot org.