Zemit\Mvc\Controller\Traits\Query\Fields\ExposeFields

Complexity

Total Complexity

3

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getExposeFields()	0	3	1
A	setExposeFields()	0	3	1
A	initializeExposeFields()	0	3	1

<?php

/**
 * This file is part of the Zemit Framework.
 *
 * (c) Zemit Team <contact@zemit.com>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

namespace Zemit\Mvc\Controller\Traits\Query\Fields;

use Phalcon\Support\Collection;

trait ExposeFields
{
    protected ?Collection $exposeFields;
    
    /**
     * Initializes the expose fields.
     *
     * This method is responsible for initializing the necessary expose fields for the model
     *
     * @return void
     */
    public function initializeExposeFields(): void
    {
        $this->setExposeFields(null);
    }
    
    /**
     * Sets the fields for exposing data.
     *
     * @param Collection|null $exposeFields The array of expose fields.
     *                                      Pass null to allow exposing all fields.
     */
    public function setExposeFields(?Collection $exposeFields): void
    {
        $this->exposeFields = $exposeFields;
    }
    
    /**
     * Returns the expose fields.
     *
     * This method retrieves the expose fields for the model.
     * If expose fields have been set, it returns the collection of expose fields.
     * If no expose fields have been set, it returns null.
     *
     * Note: The expose fields are the fields that are exposed with the response.
     *
     * @return Collection|null The collection of expose fields or null if no expose fields have been set.
     */
    public function getExposeFields(): ?Collection
    {
        return $this->exposeFields;
    }
}