Skip to content

Latest commit

 

History

History
209 lines (160 loc) · 6.12 KB

customization.md

File metadata and controls

209 lines (160 loc) · 6.12 KB
Raw

Customization

Available services you can decorate and forms you can extend

$ bin/console debug:container | grep bitbag.sylius_graphql

There are generic events dispatched after completion of every custom mutation and command handler .e.g.

    public const EVENT_NAME = 'bitbag.sylius_graphql.some_handler.complete';

    public function __invoke(Command $command)
    {
        # logic...
        $this->eventDispatcher->dispatch(new GenericEvent($arg, [$command]), self::EVENT_NAME);
    }

Parameters you can override in your parameters.yml(.dist) file

$ bin/console debug:container --parameters | grep bitbag

##Hints

  1. While adding some resource to GraphQL - be sure you are using proper model, the safest way would be to use %sylius.model..class% notation.

    They are defined in _sylius.yaml like

    sylius_promotion:
    resources:
        promotion_coupon:
            classes:
                model: Sylius\Component\Core\Model\PromotionCoupon
        promotion:
            classes:
                model: Sylius\Component\Core\Model\Promotion

    That can be sometimes tricky as GraphQL is not following inheritance and sometimes default models point to specific components e.g.

    Some components like Promotion have defined their models (%sylius.model.promotion.class%) as class from specific Component by default (check promotion component extension)

    Serializer would then expect Sylius\Component\Promotion\Model\Promotion on output on every mutation when You could expect Sylius\Component\Core\Model\Promotion as the models from Core extends the models from distinct Components.

    For GraphQL at the moment Sylius\Component\Core\Model\Promotion =/= Sylius\Component\Promotion\Model\Promotion

  2. Why my properties are not visible as available to query ?

    There might be few options:

    • Forgot to add property to api_resources/YourModel.xml

    • Forgot to add property to serialization in serialization/YourModel.xml with proper groups

    In Your api_resources/YourModel.xml You have something like:

    <attribute name="normalization_context">
    <attribute name="groups">
        <attribute>admin:order:read</attribute>
        <attribute>shop:cart:read</attribute>
    </attribute>
</attribute>

    That’s changing available properties and if Your application does not need to have strict serialization groups (e.g. security wise) for the sake of GraphQL we would suggest dropping it as the whole point is to allow client to browse what he needs.

  3. Serializing methods

    Add normalization context in api_resources part for resource description

    <attribute name="normalization_context">
    <attribute name="groups">some:group:read</attribute>
</attribute>

    Add property in same file

    <property name="value" readable="true" />

    Your model has to have getter with return type specified at least by @return tag

    /**
* @return string|null
*/
public function getValue(): ?string
{
//logic...
}

    Add serializer config for that model

    <?xml version="1.0" ?>

<serializer xmlns="http://symfony.com/schema/dic/serializer-mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/serializer-mapping https://symfony.com/schema/dic/serializer-mapping/serializer-mapping-1.0.xsd"
>
    <class name="Your\Class\Here">
        <attribute name="value">
            <group>some:group:read</group>
        </attribute>
    </class>
</serializer>

  4. Adding DTO

    • Add Output DTO to operation configuration:
    <operation>
...
    <attribute name="output">App\DTO\SomeOperationOutput</attribute>
</operation>
    • Create DTO:
    <?php

declare(strict_types=1);

namespace App\DTO;

class SomeOperationOutput
{
    public int $id; //id is required for IRI generation
    public string $data;
    public SomeClass $object;
}
    • Create Transfomer:
    <?php

declare(strict_types=1);

namespace App\DataTransformer;

use ApiPlatform\Core\DataTransformer\DataTransformerInterface;

class SomeOperationOutputDataTransformer implements DataTransformerInterface
{

    public function transform(
        $object, 
        string $to, 
        array $context = []
    ): SomeOperationOutput
    {
        $output = new SomeOperationOutput();

        $output->id = $object->getId();
        $output->object = $object->getObject();
        $output->data = $object->getData();

        return $output;
    }

    public function supportsTransformation($data, string $to, array $context = []): bool
    {
        //OperationModel is a class that You resolver would return 
        //or just the resource class in which your operation is defined
        return $data instanceof OperationModel && $to === SomeOperationOutput::class;
    }
}
    • Register Transformer:
    <service id="my_app.data_transformer.some_operation_output_data_transformer"
         class="App\DataTransformer\SomeOperationOutputDataTransformer">
     <tag name="api_platform.data_transformer" />
</service>

Testing

$ composer install
$ cd tests/Application
$ yarn install
$ yarn run gulp
$ bin/console assets:install public -e test
$ bin/console doctrine:schema:create -e test

$ bin/console server:run 127.0.0.1:8000 -d public -e test
OR
$ APP_ENV=test symfony server:start -d --dir=public

$ open http://127.0.0.1:8000
$ vendor/bin/behat
$ vendor/bin/ecs check src --fix
$ vendor/bin/psalm
$ vendor/bin/phpspec run
$ vendor/bin/phpstan analyse -c phpstan.neon -l max src/