AnimalController.php

<?php

declare(strict_types=1);

namespace Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Controller;

use Sofascore\PurgatoryBundle\Attribute\PurgeOn;
use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\CompoundValues;
use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\DynamicValues;
use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\EnumValues;
use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\ExpressionValues;
use Sofascore\PurgatoryBundle\Attribute\RouteParamValue\RawValues;
use Sofascore\PurgatoryBundle\Attribute\Target\ForGroups;
use Sofascore\PurgatoryBundle\Attribute\Target\ForProperties;
use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Entity\Animal;
use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Entity\Person;
use Sofascore\PurgatoryBundle\Tests\Functional\TestApplication\Enum\Country;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\Routing\Attribute\Route;

#[AsController]
#[Route('/animal')]
class AnimalController
{
    #[Route('/{animal_id}', 'animal_details')]
    #[PurgeOn(Animal::class,
        target: new ForGroups('common'),
        routeParams: [
            'animal_id' => 'id',
        ],
    )]
    public function detailAction(Animal $animal)
    {
    }

    #[Route('/{animal_id}/measurements', 'animal_measurements')]
    #[PurgeOn(Animal::class,
        target: new ForProperties(['measurements.height', 'measurements.weight']),
        routeParams: [
            'animal_id' => 'id',
        ],
    )]
    public function measurementsAction(Animal $animal)
    {
    }

    #[Route('/{animal_id}/measurements-alt', 'animal_measurements_alt')]
    #[PurgeOn(Animal::class,
        target: new ForProperties(['goodBoy']),
        routeParams: [
            'animal_id' => 'id',
        ],
    )]
    public function measurementsAltAction(Animal $animal)
    {
    }

    #[Route('/{id}/route1', 'animal_route_1')]
    #[Route('/{id}/route2', 'animal_route_2')]
    #[PurgeOn(Animal::class,
        target: 'measurements.height',
    )]
    #[PurgeOn(Animal::class,
        target: 'measurements.weight',
        route: 'animal_route_1',
    )]
    #[PurgeOn(Animal::class,
        target: 'measurements.width',
        route: 'animal_route_2',
    )]
    public function someRandomRouteAction(Animal $animal)
    {
    }

    #[Route('/pet-of-the-day/{country}', 'pet_of_the_day')]
    #[PurgeOn(Animal::class,
        target: new ForGroups('common'),
        routeParams: [
            'country' => new EnumValues(Country::class),
        ],
    )]
    public function petOfTheDayAction(Country $country)
    {
    }

    #[Route('/pet-of-the-month/{country}', 'pet_of_the_month')]
    #[PurgeOn(Animal::class,
        target: new ForGroups('common'),
        routeParams: [
            'country' => new CompoundValues(
                new EnumValues(Country::class),
                new RawValues('ar'),
            ),
        ],
    )]
    public function petOfTheMonthAction(string $country)
    {
    }

    #[Route('/tag/{tag}', 'animal_tag')]
    #[PurgeOn(Animal::class,
        target: 'tags',
        routeParams: [
            'tag' => 'tags',
        ],
    )]
    public function tagAction(string $tag)
    {
    }

    #[Route('/for-rating/{rating}', 'animals_with_rating')]
    #[PurgeOn(Animal::class,
        target: ['measurements'],
        routeParams: [
            'rating' => new CompoundValues(
                new DynamicValues(alias: 'purgatory.animal_rating2'),
                new DynamicValues(alias: 'purgatory.animal_rating1'),
                new DynamicValues(alias: 'purgatory.animal_rating3', propertyPath: 'owner'),
            ),
        ],
    )]
    #[PurgeOn(Person::class,
        target: ['pets'],
        routeParams: [
            'rating' => new CompoundValues(
                new DynamicValues(alias: 'purgatory.animal_rating3'),
            ),
        ],
    )]
    public function animalsForRatingAction(int $rating)
    {
    }

    #[Route('/{id}/owner-details', 'pet_owner_details')]
    #[PurgeOn(Person::class,
        routeParams: [
            'id' => 'pets[*].id',
        ],
    )]
    public function petOwnerDetails(Animal $animal)
    {
    }

    #[Route('/{id}/owner-details-alt', 'pet_owner_details_alternative')]
    #[PurgeOn(Person::class,
        routeParams: [
            'id' => 'petsIds',
        ],
    )]
    public function petOwnerDetailsAlternative(Animal $animal)
    {
    }

    #[Route('/good-boy-ranking', 'good_boy_ranking')]
    #[PurgeOn(Animal::class,
        target: new ForProperties(['isGoodBoy']),
    )]
    public function goodBoyRankingAction()
    {
    }

    #[Route('/for-veterinarian/{id}', 'animals_for_veterinarian')]
    #[PurgeOn(Animal::class,
        target: 'veterinarian',
        routeParams: [
            'id' => 'veterinarian?.id',
        ],
        if: 'obj.name === "Sharp Dressed Dog"', // temporary because sf5 does not support optional property accesses
    )]
    public function animalsForVeterinarianAction(Person $veterinarian)
    {
    }

    #[Route('/for-owner-and-veterinarian/{owner_id}-{vet_id}', 'animals_for_owner_and_veterinarian')]
    #[PurgeOn(Animal::class,
        target: 'owner',
        routeParams: [
            'owner_id' => 'owner.id',
            'vet_id' => 'veterinarian?.id',
        ],
        if: 'obj.name === "Sharp Dressed Dog"', // temporary because sf5 does not support optional property accesses
    )]
    public function animalsForOwnerAndVeterinarianAction(Person $veterinarian)
    {
    }

    #[Route('/owner-full-name/{full_name}', 'list_by_owner_full_name')]
    #[PurgeOn(Person::class,
        target: ['firstName', 'lastName', 'pets'],
        routeParams: [
            'full_name' => new ExpressionValues('obj.firstName~"-"~obj.lastName'),
        ],
    )]
    public function listByOwnerFullName()
    {
    }

    #[Route('/veterinarian-full-name/{full_name}', 'list_by_veterinarian_full_name')]
    #[PurgeOn(Person::class,
        target: ['firstName', 'lastName', 'animalPatients'],
        routeParams: [
            'full_name' => new ExpressionValues('obj.firstName~"-"~obj.lastName'),
        ],
        if: 'obj.isVeterinarian === true',
    )]
    public function listByVeterinarianFullName()
    {
    }
}