File "Factory.php"

Full Path: /home/pulsehostuk9/public_html/invoicer.pulsehost.co.uk/vendor/silber/bouncer/src/Factory.php
File size: 4.08 KB
MIME-type: text/x-php
Charset: utf-8

<?php

namespace Silber\Bouncer;

use Illuminate\Auth\Access\Gate;
use Illuminate\Cache\ArrayStore;
use Illuminate\Container\Container;
use Illuminate\Contracts\Auth\Access\Gate as GateContract;
use Illuminate\Contracts\Cache\Store;

class Factory
{
    /**
     * The cache instance to use for the clipboard.
     *
     * @var \Illuminate\Contracts\Cache\Store
     */
    protected $cache;

    /**
     * The clipboard instance to use.
     *
     * @var \Silber\Bouncer\Contracts\Clipboard
     */
    protected $clipboard;

    /**
     * The gate instance to use.
     *
     * @var \Illuminate\Contracts\Auth\Access\Gate
     */
    protected $gate;

    /**
     * The user model to use for the gate.
     *
     * @var mixed
     */
    protected $user;

    /**
     * Determines whether the clipboard instance will be registered at the container.
     *
     * @var bool
     */
    protected $registerAtContainer = true;

    /**
     * Determines whether the guard instance will be registered at the gate.
     *
     * @var bool
     */
    protected $registerAtGate = true;

    /**
     * Create a new Factory instance.
     *
     * @param  mixed  $user
     */
    public function __construct($user = null)
    {
        $this->user = $user;
    }

    /**
     * Create an instance of Bouncer.
     *
     * @return \Silber\Bouncer\Bouncer
     */
    public function create()
    {
        $gate = $this->getGate();
        $guard = $this->getGuard();

        $bouncer = (new Bouncer($guard))->setGate($gate);

        if ($this->registerAtGate) {
            $guard->registerAt($gate);
        }

        if ($this->registerAtContainer) {
            $bouncer->registerClipboardAtContainer();
        }

        return $bouncer;
    }

    /**
     * Set the cache instance to use for the clipboard.
     *
     * @return $this
     */
    public function withCache(Store $cache)
    {
        $this->cache = $cache;

        return $this;
    }

    /**
     * Set the instance of the clipboard to use.
     *
     * @return $this
     */
    public function withClipboard(Contracts\Clipboard $clipboard)
    {
        $this->clipboard = $clipboard;

        return $this;
    }

    /**
     * Set the gate instance to use.
     *
     * @return $this
     */
    public function withGate(GateContract $gate)
    {
        $this->gate = $gate;

        return $this;
    }

    /**
     * Set the user model to use for the gate.
     *
     * @param  mixed  $user
     * @return $this
     */
    public function withUser($user)
    {
        $this->user = $user;

        return $this;
    }

    /**
     * Set whether the factory registers the clipboard instance with the container.
     *
     * @param  bool  $bool
     * @return $this
     */
    public function registerClipboardAtContainer($bool = true)
    {
        $this->registerAtContainer = $bool;

        return $this;
    }

    /**
     * Set whether the factory registers the guard instance with the gate.
     *
     * @param  bool  $bool
     * @return $this
     */
    public function registerAtGate($bool = true)
    {
        $this->registerAtGate = $bool;

        return $this;
    }

    /**
     * Get an instance of the clipboard.
     *
     * @return \Silber\Bouncer\Guard
     */
    protected function getGuard()
    {
        return new Guard($this->getClipboard());
    }

    /**
     * Get an instance of the clipboard.
     *
     * @return \Silber\Bouncer\Contracts\Clipboard
     */
    protected function getClipboard()
    {
        return $this->clipboard ?: new CachedClipboard($this->getCacheStore());
    }

    /**
     * Get an instance of the cache store.
     *
     * @return \Illuminate\Contracts\Cache\Store
     */
    protected function getCacheStore()
    {
        return $this->cache ?: new ArrayStore;
    }

    /**
     * Get an instance of the gate.
     *
     * @return \Illuminate\Contracts\Auth\Access\Gate
     */
    protected function getGate()
    {
        if ($this->gate) {
            return $this->gate;
        }

        return new Gate(Container::getInstance(), function () {
            return $this->user;
        });
    }
}