Pink-Crab/Perique-Ajax

View on GitHub
src/Dispatcher/Ajax_Dispatcher.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

declare(strict_types=1);

/**
 * Primary service for dispatching ajax calls.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @author Glynn Quelch <glynn.quelch@gmail.com>
 * @license http://www.opensource.org/licenses/mit-license.html  MIT License
 * @package PinkCrab\Ajax
 */

namespace PinkCrab\Ajax\Dispatcher;

use PinkCrab\Ajax\Ajax;
use PinkCrab\Loader\Hook_Loader;
use PinkCrab\Ajax\Ajax_Exception;
use PinkCrab\Ajax\Dispatcher\Ajax_Controller;

class Ajax_Dispatcher {

    protected Hook_Loader $loader;
    protected Ajax_Controller $ajax_controller;

    public function __construct( Ajax_Controller $ajax_controller ) {
        $this->loader          = new Hook_Loader();
        $this->ajax_controller = $ajax_controller;
    }

    /**
     * Adds an ajax call to the loader
     *
     * @param \PinkCrab\Ajax\Ajax $ajax
     * @return void
     * @throws Ajax_Exception (code 101) If no action defined
     */
    public function add_ajax_call( Ajax $ajax ): void {

        if ( ! $ajax->has_valid_action() ) {
            throw Ajax_Exception::undefined_action( \get_class( $ajax ) );
        }

        $this->loader->ajax(
            $ajax->get_action(), /* @phpstan-ignore-line, action existance checked above */
            $this->ajax_controller->create_callback( $ajax ),
            $ajax->get_logged_out(),
            $ajax->get_logged_in()
        );
    }

    /**
     * Register all hooks
     *
     * @return void
     */
    public function execute(): void {
        $this->loader->register_hooks();
    }

}