<?php
/*
 * Copyright 2024 Cloud Creativity Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace CloudCreativity\LaravelJsonApi\Utils;

/**
 * Trait InvokesHooks
 *
 * @package CloudCreativity\LaravelJsonApi
 */
trait InvokesHooks
{

    /**
     * Should the invoked result be returned?
     *
     * @param mixed $result
     * @return bool
     */
    abstract protected function isInvokedResult($result): bool;

    /**
     * Invoke a hook.
     *
     * @param string $hook
     * @param mixed ...$arguments
     * @return mixed|null
     */
    protected function invoke(string $hook, ...$arguments)
    {
        if (!method_exists($this, $hook)) {
            return null;
        }

        $result = $this->{$hook}(...$arguments);

        return $this->isInvokedResult($result) ? $result : null;
    }

    /**
     * Invoke multiple hooks.
     *
     * @param iterable $hooks
     * @param mixed ...$arguments
     * @return mixed|null
     */
    protected function invokeMany(iterable $hooks, ...$arguments)
    {
        foreach ($hooks as $hook) {
            $result = $this->invoke($hook, ...$arguments);

            if (!is_null($result)) {
                return $result;
            }
        }

        return null;
    }

}
