<?php

/*
 * This file is part of the Kimai package.
 *
 * (c) Kevin Papst <kevin@kevinpapst.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App\Repository\Query;

/**
 * Query class for Repositories with a visibility field.
 *
 * @author Kevin Papst <kevin@kevinpapst.de>
 */
class VisibilityQuery extends BaseQuery
{

    const SHOW_VISIBLE = 1;
    const SHOW_HIDDEN = 2;
    const SHOW_BOTH = 3;

    /**
     * @var integer
     */
    protected $visibility = self::SHOW_VISIBLE;
    /**
     * @var bool
     */
    protected $exclusiveVisibility = false;

    /**
     * @return int
     */
    public function getVisibility()
    {
        return $this->visibility;
    }

    /**
     * @param int $visibility
     * @return $this
     */
    public function setVisibility($visibility)
    {
        if (!is_int($visibility) && $visibility != (int) $visibility) {
            return $this;
        }

        $visibility = (int) $visibility;
        if (in_array($visibility, [self::SHOW_BOTH, self::SHOW_VISIBLE, self::SHOW_HIDDEN], true)) {
            $this->visibility = $visibility;
        }

        return $this;
    }

    /**
     * @return bool
     */
    public function isExclusiveVisibility()
    {
        return $this->exclusiveVisibility;
    }

    /**
     * If set to true, this will ONLY filter the visibility on the main queried object.
     *
     * @param bool $exclusiveVisibility
     * @return $this
     */
    public function setExclusiveVisibility($exclusiveVisibility)
    {
        $this->exclusiveVisibility = (bool) $exclusiveVisibility;
        return $this;
    }
}