Search Results | SymfonyCasts

1000 search results

Sort By

Comment

Learn Symfony 5

API Platform 2 Part 2: Security

Api Tests & Assertions

For anyone getting Error in Evaluate() method of arraysubset inside src/ApiPlatform/Test/ Check your api version if it is greater than 2.4 using composer show api-platform/core instead of pasting ApiPlatform inside App just Use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase…

Sakshi G.

Read Full Comment

Comment

Learn Symfony 5

API Platform 2 Part 1: Serious RESTful APIs

Subresources

…like : * /transactions/{id}/comments provide data from Postgresql database where id is a column inside the database (but not the Primary Key). We tried with a @ApiSubresource for property Comments inside Entity but it doesn't work. How can we do that with API Platform …

Carl C.

Read Full Comment

Code

Learn APIs

API Platform 3 Part 3: Custom Resources

Quick! Create a DragonTreasure DTO

            Copy Code

                            Show All Lines

                        26 lines
            |
            src/ApiResource/DragonTreasureApi.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\ApiResource;
        
            use ApiPlatform\Doctrine\Orm\State\Options;
        
                Show Lines

                                                    // ... line 6
                            
            use ApiPlatform\Metadata\ApiResource;
        
            use App\Entity\DragonTreasure;
        
            use App\State\EntityClassDtoStateProcessor;
        
            use App\State\EntityToDtoStateProvider;
        
            #[ApiResource(
        
                shortName: 'Treasure',
        
                paginationItemsPerPage: 10,
        
                provider: EntityToDtoStateProvider::class,
        
                processor: EntityClassDtoStateProcessor::class,
        
                stateOptions: new Options(entityClass: DragonTreasure::class),
        
            )]
        
            class DragonTreasureApi
        
            {
        
                Show Lines

                                                    // ... lines 21 - 24
                            
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 3: Custom Resources

Quick! Create a DragonTreasure DTO

            Copy Code

                            Show All Lines

                        26 lines
            |
            src/ApiResource/DragonTreasureApi.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\ApiResource;
        
            use ApiPlatform\Doctrine\Orm\State\Options;
        
            use ApiPlatform\Metadata\ApiProperty;
        
            use ApiPlatform\Metadata\ApiResource;
        
            use App\Entity\DragonTreasure;
        
            use App\State\EntityClassDtoStateProcessor;
        
            use App\State\EntityToDtoStateProvider;
        
            #[ApiResource(
        
                shortName: 'Treasure',
        
                paginationItemsPerPage: 10,
        
                provider: EntityToDtoStateProvider::class,
        
                processor: EntityClassDtoStateProcessor::class,
        
                stateOptions: new Options(entityClass: DragonTreasure::class),
        
            )]
        
            class DragonTreasureApi
        
            {
        
                #[ApiProperty(readable: false, writable: false, identifier: true)]
        
                public ?int $id = null;
        
                public ?string $name = null;
        
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 3: Custom Resources

DTO -> Entity State Processor

            Copy Code

                            Show All Lines

                        15 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\State;
        
            use ApiPlatform\Metadata\Operation;
        
            use ApiPlatform\State\ProcessorInterface;
        
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): void
        
                {
        
                    // Handle the state
        
                }
        
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 3: Custom Resources

User Class Dto

            Copy Code

                            Show All Lines

                        12 lines
            |
            src/ApiResource/UserApi.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\ApiResource;
        
            use ApiPlatform\Metadata\ApiResource;
        
            #[ApiResource]
        
            class UserApi
        
            {
        
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 3: Custom Resources

User Class Dto

            Copy Code

                            Show All Lines

                        12 lines
            |
            src/ApiResource/UserApi.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\ApiResource;
        
            use ApiPlatform\Metadata\ApiResource;
        
            #[ApiResource]
        
            class UserApi
        
            {
        
                public ?int $id = null;
        
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 3: Custom Resources

Custom Resource State Provider

            Copy Code

                            Show All Lines

                        15 lines
            |
            src/State/DailyQuestStateProvider.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\State;
        
            use ApiPlatform\Metadata\Operation;
        
            use ApiPlatform\State\ProviderInterface;
        
            class DailyQuestStateProvider implements ProviderInterface
        
            {
        
                public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
        
                {
        
                    // Retrieve the state from somewhere
        
                }
        
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 3: Custom Resources

Totally Custom Resource

            Copy Code

                            Show All Lines

                        12 lines
            |
            src/ApiResource/DailyQuest.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\ApiResource;
        
            use ApiPlatform\Metadata\ApiResource;
        
            #[ApiResource]
        
            class DailyQuest
        
            {
        
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 2: Security for your Treasures

Auto Setting the "owner"

            Copy Code

                            Show All Lines

                        15 lines
            |
            src/State/DragonTreasureSetOwnerProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\State;
        
            use ApiPlatform\Metadata\Operation;
        
            use ApiPlatform\State\ProcessorInterface;
        
            class DragonTreasureSetOwnerProcessor implements ProcessorInterface
        
            {
        
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): void
        
                {
        
                    // Handle the state
        
                }
        
            }

See Code Block in Script

Code

Learn APIs

API Platform 3 Part 2: Security for your Treasures

State Processors: Hashing the User Password

            Copy Code

                            Show All Lines

                        15 lines
            |
            src/State/UserHashPasswordStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\State;
        
            use ApiPlatform\Metadata\Operation;
        
            use ApiPlatform\State\ProcessorInterface;
        
            class UserHashPasswordStateProcessor implements ProcessorInterface
        
            {
        
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): void
        
                {
        
                    // Handle the state
        
                }
        
            }

See Code Block in Script

Comment

Learn Symfony 5

API Platform 2 Part 2: Security

Normalizer & Completely Custom Fields

…using PHP8 and SF 5.3.9 ApiPlatform 2.6 When I run the tests, I get an error message: ``` App\Tests\Functional\UserResourceTest::testUpdateUser Failed asserting that an array has the subset Array &0 ( 'username' => 'zanoni' ). --- Expected +++ Actual @@ @@ '@id' => '/api/users/149', …

Stephane

Read Full Comment

Comment

Learn Symfony 5

API Platform 2 Part 1: Serious RESTful APIs

User API Resource

namespace App\Entity; use ApiPlatform\Core\Annotation\ApiFilter; use ApiPlatform\Core\Annotation\ApiResource; use ApiPlatform\Core\Serializer\Filter\PropertyFilter; use App\Repository\UserRepository; use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Collections\Collection; use Doctrine\ORM\Mapping as ORM; use Symfony\Bridge\Doctrine\Validator\Constraints…

JavierMendezK

Read Full Comment

Code

Learn Symfony 5

API Platform 2 Part 3: Custom Resources

Custom Resource PUT Operation

            Copy Code

                            Show All Lines

                        21 lines
            |
            src/DataPersister/DailyStatsPersister.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\DataPersister;
        
            use ApiPlatform\Core\DataPersister\DataPersisterInterface;
        
            class DailyStatsPersister implements DataPersisterInterface
        
            {
        
                Show Lines

                                                    // ... lines 9 - 19
                            
            }

See Code Block in Script

Code

Learn Symfony 5

API Platform 2 Part 3: Custom Resources

Detecting the "Published" State Change

            Copy Code

                            Show All Lines

                        21 lines
            |
            src/DataPersister/CheeseListingDataPersister.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\DataPersister;
        
            use ApiPlatform\Core\DataPersister\DataPersisterInterface;
        
            class CheeseListingDataPersister implements DataPersisterInterface
        
            {
        
                Show Lines

                                                    // ... lines 9 - 19
                            
            }

See Code Block in Script

Code

Learn Symfony 5

API Platform 2 Part 2: Security

Context Builder & Service Decoration

            Copy Code

                            Show All Lines

                        32 lines
            |
            src/Serializer/AdminGroupsContextBuilder.php
        
                Show Lines

                                                    // ... lines 1 - 2
                            
            namespace App\Serializer;
        
            use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
        
            use Symfony\Component\HttpFoundation\Request;
        
            use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
        
            final class AdminGroupsContextBuilder implements SerializerContextBuilderInterface
        
            {
        
                private $decorated;
        
                private $authorizationChecker;
        
                public function __construct(SerializerContextBuilderInterface $decorated, AuthorizationCheckerInterface $authorizationChecker)
        
                {
        
                    $this->decorated = $decorated;
        
                    $this->authorizationChecker = $authorizationChecker;
        
                }
        
                public function createFromRequest(Request $request, bool $normalization, ?array $extractedAttributes = null): array
        
                {
        
                    $context = $this->decorated->createFromRequest($request, $normalization, $extractedAttributes);
        
                    $resourceClass = $context['resource_class'] ?? null;
        
                    if ($resourceClass === Book::class && isset($context['groups']) && $this->authorizationChecker->isGranted('ROLE_ADMIN') && false === $normalization) {
        
                        $context['groups'][] = 'admin:input';
        
                    }
        
                    return $context;
        
                }
        
            }

See Code Block in Script

Comment

Learn APIs

API Platform 3 Part 1: Mythically Good RESTful APIs

Subresources

…I am on api platform 4.3 and currently it is possible to do the following using the `openapi` parameter and a `Parameter` definition for the input ``` #[ApiResource( uriTemplate: '/treasures/{treasure_id}/owner.{_format}', operations: [new Get()], uriVariables: [ 'treasure_id' => new Link( fromProperty: 'owner…

HiddeHiddema

Read Full Comment

Comment

Learn APIs

API Platform 3 Part 3: Custom Resources

Reusable Entity->Dto Provider & Processor

Hey |mention:78989| I think you can access that data through an ApiPlatform state provider. Here are the docs about them: https://api-platform.com/docs/core/state-providers/ Cheers!

MolloKhan

Read Full Comment

Comment

Learn APIs

API Platform 3 Part 2: Security for your Treasures

Customizing the OpenAPI Docs

I got it. Instead of `api_platform.open_api.factory` should be `api_platform.openapi.factory`. But I still don't realize where the `factory` option is coming from, it doesn't exists in the config.

Jared

Read Full Comment

Comment

Learn APIs

API Platform 3 Part 1: Mythically Good RESTful APIs

Swagger UI: Interactive Docs

Hi |mention:3768| , Thanks for the answer. Still not sure how to configure API Platform to avoid this duplication? Here is my ApiResource enabled Symfony Entity class: ```

Zhivko

Read Full Comment

Show Lines	// ... lines 1 - 2
	namespace App\ApiResource;

	use ApiPlatform\Doctrine\Orm\State\Options;
Show Lines	// ... line 6
	use ApiPlatform\Metadata\ApiResource;
	use App\Entity\DragonTreasure;
	use App\State\EntityClassDtoStateProcessor;
	use App\State\EntityToDtoStateProvider;

	#[ApiResource(
	shortName: 'Treasure',
	paginationItemsPerPage: 10,
	provider: EntityToDtoStateProvider::class,
	processor: EntityClassDtoStateProcessor::class,
	stateOptions: new Options(entityClass: DragonTreasure::class),
	)]
	class DragonTreasureApi
	{
Show Lines	// ... lines 21 - 24
	}

Show Lines	// ... lines 1 - 2
	namespace App\State;

	use ApiPlatform\Metadata\Operation;
	use ApiPlatform\State\ProcessorInterface;

	class EntityClassDtoStateProcessor implements ProcessorInterface
	{
	public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = []): void
	{
	// Handle the state
	}
	}

Show Lines	// ... lines 1 - 2
	namespace App\DataPersister;

	use ApiPlatform\Core\DataPersister\DataPersisterInterface;

	class DailyStatsPersister implements DataPersisterInterface
	{
Show Lines	// ... lines 9 - 19
	}

Show Lines	// ... lines 1 - 2
	namespace App\Serializer;

	use ApiPlatform\Core\Serializer\SerializerContextBuilderInterface;
	use Symfony\Component\HttpFoundation\Request;
	use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;

	final class AdminGroupsContextBuilder implements SerializerContextBuilderInterface
	{
	private $decorated;
	private $authorizationChecker;

	public function __construct(SerializerContextBuilderInterface $decorated, AuthorizationCheckerInterface $authorizationChecker)
	{
	$this->decorated = $decorated;
	$this->authorizationChecker = $authorizationChecker;
	}

	public function createFromRequest(Request $request, bool $normalization, ?array $extractedAttributes = null): array
	{
	$context = $this->decorated->createFromRequest($request, $normalization, $extractedAttributes);
	$resourceClass = $context['resource_class'] ?? null;

	if ($resourceClass === Book::class && isset($context['groups']) && $this->authorizationChecker->isGranted('ROLE_ADMIN') && false === $normalization) {
	$context['groups'][] = 'admin:input';
	}

	return $context;
	}
	}