Skip to main content

Property Path

Some ValueResolvers accept property path as their argument. This allows you to specify a path to a specific property from the root entity, traversing through related entities. The framework will automatically make the necessary joins behind the scenes.

Example of Using a Property Path in a Dimension​

This is how you can use a property path in a dimension:

use Doctrine\DBAL\Types\Types;
use Doctrine\ORM\Mapping as ORM;
use Rekalogika\Analytics\Core\Metadata as Analytics;
use Rekalogika\Analytics\Core\ValueResolver\PropertyValue;

#[ORM\Entity()]
#[Analytics\Summary(
    sourceClass: Order::class,
)]
class OrderSummary extends Summary
{
    #[ORM\Column(type: Types::STRING)]
    #[Analytics\Dimension(
        source: new PropertyValue('customer.country.name'),
    )]
    private ?string $countryName = null;
}

In this example, from the root Order object, we traverse the customer relation, and then the country relation to get the name property.

In the following sections, we will only include how to use property paths in ValueResolver objects, omitting the rest of the code for brevity.

Resolve to a Property​

The most common usage is to resolve to a property:

use Rekalogika\Analytics\Core\ValueResolver\PropertyValue;

$valueResolver = new PropertyValue('customer.country.name');

Resolve to the Identifier of the Current Entity​

You can resolve to the identifier of the current entity using the special __id property:

use Rekalogika\Analytics\Core\ValueResolver\PropertyValue;

// This will resolve to the identifier of the root entity
$valueResolver = new PropertyValue('__id');

// This will resolve to the identifier of the customer entity, e.g. Customer.id
$valueResolver = new PropertyValue('customer.__id');

Some DQL clauses expect the alias of a related entity to be passed as an argument, including the INSTANCE OF clause. You can use the * symbol to get the alias of a related entity:

use Rekalogika\Analytics\Core\ValueResolver\CustomExpression;

$valueResolver = new CustomExpression("
    CASE
        WHEN [customer.*] INSTANCE OF App\Entity\IndividualCustomer
        THEN [customer(App\Entity\IndividualCustomer).gender]

        ELSE NULLIF('a','a')
    END
");

Casting to a Class​

It is possible to cast a related entity to a specific class using parentheses. This is useful if you need to access a property that is not defined in the root entity. This is an advanced feature, and probably only makes sense if you are using CustomExpression.

use Rekalogika\Analytics\Core\ValueResolver\CustomExpression;

$valueResolver = new CustomExpression("
    CASE
        WHEN [customer.*] INSTANCE OF App\Entity\IndividualCustomer
        THEN [customer(App\Entity\IndividualCustomer).gender]

        ELSE NULLIF('a','a')
    END
");
info

To implement the class casting, the framework will create an additional join using the WITH clause:

use Doctrine\ORM\QueryBuilder;

/** @var QueryBuilder $queryBuilder */

$queryBuilder
    ->from(Order::class, '_a0')
    ->leftJoin('_a0.customer', '_a1') // Customer::class
    ->leftJoin(
        IndividualCustomer::class,
        '_a2',
        'WITH',
        '_a2.id = _a1.id',
    );