<?php
namespace Komma\KMS\Core\Attributes\Traits;

use Komma\KMS\Core\Attributes\Attribute;

/**
 * Trait LabelTrait
 *
 * Used to give users the ability to add a label to an attribute, clarifying its purpose.
 * Attributes implementing this trait must use the $labelText variable in their associated views.
 *
 * @package App\Kms\Core\Attributes
 */
trait LabelTrait {
    /**
     * @var string $labelText
     */
    private $labelText = '';

    /**
     * Get the text for the label
     *
     * @return string
     */
    public function getLabelText(): string
    {
        return $this->labelText;
    }

    /**
     * Set the text for the label
     *
     * @param string $labelText
     * @return Attribute
     */
    public function setLabelText(string $labelText): Attribute
    {
        $this->labelText = $labelText;
        return $this;
    }
}