VGirol / JsonApi-Faker

src/Factory/HasLinks.php

<?php

declare(strict_types=1);

namespace VGirol\JsonApiFaker\Factory;

use VGirol\JsonApiConstant\Members;

/**
 * Add "links" member to a factory.
 */
trait HasLinks
{
    /**
     * The "links" member
     *
     * @var array
     */
    protected $links;

    /**
     * Set the "links" member.
     *
     * @param array $links
     *
     * @return static
     */
    public function setLinks(array $links)
    {
        $this->links = $links;

        return $this;
    }

    /**
     * Set the "links" member.
     *
     * @return array|null
     */
    public function getLinks(): ?array
    {
        return $this->links;
    }

    /**
     * Add some links to the "links" member.
     *
     * @param array $links
     *
     * @return static
     */
    public function addLinks(array $links)
    {
        foreach ($links as $name => $link) {
            $this->addLink($name, $link);
        }

        return $this;
    }

    /**
     * Add a single link to the "links" member
     *
     * @param string $name
     * @param array|string|null $link
     *
     * @return static
     */
    public function addLink(string $name, $link)
    {
        $this->addToObject(Members::LINKS, $name, $link);

It seems like addToObject() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    /**
     * Fill the "links" member with fake values.
     *
     * @param array $links
     *
     * @return static
     */
    public function fakeLinks($links = [Members::LINK_SELF => ['url']])
    {
        $this->setLinks(
            $this->fakeMembers($links)

It seems like fakeMembers() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        );

        return $this;
    }
}