Download the PHP package ccmbenchmark/ting_bundle without Composer

Installation

1. Require Ting Bundle with

2. Load Bundles in AppKernel.php

Table of contents

• Configuration
  • Main configuration
  • About public properties
  • Declare metadata with attributes
• Using Ting as a User Provider
• Declare a unique constraint
• Using Ting as a Value Resolver

Configuration

Main configuration

About public properties

Public properties can be used in your entities, however for PHP < 8.4, you should declare a setter to notify the property change.

PHP < 8.4:

For PHP >= 8.4, you may use a property hook instead. This hook will be bypassed by Ting for hydratation.

A note about uninitialized typed properties

• When persisting an entity with uninitialized typed property, the property will be ignored ; a default value must be defined in your database for this column to prevent a failure
• You cannot access an uninitialized typed property, PHP will trigger an error

Declare metadata with attributes

Attributes are provided to declare an entity. Relevant attributes are available in CCMBenchmark\TingBundle\Schema.

Table

• Full name: CCMBenchmark\TingBundle\Schema\Table
• This attribute must be added to your class, with all relevant options (table, connection, etc.).

Column

• Full name: CCMBenchmark\TingBundle\Schema\Column
• This attribute must be added to every property mapped to the database. Serialization is inferred from the type, if available.

Full example

Using Ting as a User Provider

User providers (re)load users from a storage based on a "user identifier" (extract from symfony documentation).

Ting can be used as a User Provider, it's automatically registered by the bundle as the provider ting. To do so, update your security configuration.

Your entity will have to implements the following interfaces: Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface (for password authenticated users) and Symfony\Component\Security\Core\User\UserInterface (common to all kind of users). It needs to implement __serialize too.

Declare a Unique constraint in a table

If you use the component symfony/validator, you may need to ensure that a value (or a combination of them) is unique in your table.

You can use the Constraint CCMBenchmark\TingBundle\Validator\Constraints\UniqueEntity to do so. In can be used as an annotation, or as an attribute.

Example:

With that example you can assert, when creating a new user, that the email address is unique:

Using Ting as a Value Resolver

This bundle automatically registers a Value Resolver.

You can automatically map request parameters to entities:

1. Declare a parameter in your route (i.e: /api/users/{userId}), using the property in your entity you'll use to fetch data (in this case: userId)
2. Map it to your action parameters:
   1. Add it to your signature: public function getUser(User $user)
   2. Update the route to do the mapping: /api/users/{userId:user} (in this case: the User having userId matching the request will be fetched and injected to your action with the argument $user)

For more advanced use cases, you can leverage:

• The Expression Language component
• The CCMBenchmark\TingBundle\Attribute\MapEntity attribute

Example: