PeekAndPoke\Component\Slumber\Data\Addon\PublicReference\SlumberReferenced

Complexity

Total Complexity

2

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

40%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getReference()	0	4	1
A	setReference()	0	6	1

<?php
/**
 * File was created 05.10.2015 17:18
 */

namespace PeekAndPoke\Component\Slumber\Data\Addon\PublicReference;

use PeekAndPoke\Component\Slumber\Annotation\Slumber;

/**
 * Use this to auto fill the public reference of a persisted object when it is saved.
 *
 * This is handy if one does NOT want to expose internal database ids or similar.
 *
 * The implementation depends on a service being present.
 *
 * @see    SlumberDependencies
 * @see    PublicReferenceGenerator
 *
 * @author Karsten J. Gerber <kontakt@karsten-gerber.de>
 */
trait SlumberReferenced
{
    /**
     * @var string
     *
     * @see PublicReferenceGenerator
     *
     * @Slumber\AsString()
     *
     * @Slumber\Store\AsPublicReference(
     *      service = \PeekAndPoke\Component\Slumber\Data\Addon\PublicReference\PublicReferenceGenerator::SERVICE_ID,
     *      ofClass = \PeekAndPoke\Component\Slumber\Data\Addon\PublicReference\PublicReferenceGenerator::class,
     * )
     *
     * @Slumber\Store\Indexed(
     *     unique     = false,
     *     background = true,
     *     direction  = "ASC",
     *     sparse     = false,
     * )
     */
    protected $reference;

    /**
     * @return string
     */
    public function getReference()
    {
        return $this->reference;
    }

    /**
     * @param string $reference
     *
     * @return $this
     */
    public function setReference($reference)
    {
        $this->reference = $reference;

        return $this;
    }
}