Download the PHP package andrej-griniuk/cakephp-fractal-transformer-view without Composer

On this page you can find all versions of the php package andrej-griniuk/cakephp-fractal-transformer-view. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of andrej-griniuk/cakephp-fractal-transformer-view

Informations about the package cakephp-fractal-transformer-view

Build Status codecov

FractalTransformerView plugin for CakePHP

This plugin is a thin wrapper for JsonView that allows using Fractal transformers for your API output. What is Fractal?

Fractal provides a presentation and transformation layer for complex data output, the like found in RESTful APIs, and works really well with JSON. Think of this as a view layer for your JSON/YAML/etc. When building an API it is common for people to just grab stuff from the database and pass it to json_encode(). This might be passable for “trivial” APIs but if they are in use by the public, or used by mobile applications then this will quickly lead to inconsistent output.

Requirements

Installation

You can install this plugin into your CakePHP application using Composer.

Usage

To enable the plugin set FractalTransformerView.FractalTransformer class name for viewBuilder. Then you just do what you would normally do in your data views - specify which view vars you want to get serialized by setting serialize view builder option. E.g.:

The view will look for transformer class starting with entity name. E.g.:

If transformer class not found the variable is serialized the normal way.

Custom transformer class name can be set by defining transformer view builder option:

You can also define if you don't want to use transformer for certain variables:

You can set a custom serializer (class name or object) via serializer view builder option:

Baking Transformers

To bake transformers you must include the plugin in your src/Application.php file. Add the following to your bootstrap method:

You must also have the cakephp/bake composer package installed.

You can now run bin/cake bake transformer YOUR_MODEL to create transformers.

Bugs & Feedback

https://github.com/andrej-griniuk/cakephp-fractal-transformer-view/issues

Credits

Inspired by @josegonzalez Using Fractal to transform entities for custom api endpoints.

License

Copyright (c) 2016, Andrej Griniuk and licensed under The MIT License.

All versions of cakephp-fractal-transformer-view with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
cakephp/cakephp Version ^5.0
league/fractal Version ^0.20.1
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package andrej-griniuk/cakephp-fractal-transformer-view contains the following files

Loading the files please wait ....