libreworks / caridea-module

src/Module.php

<?php
declare(strict_types=1);
/**
 * Caridea Module
 *
 * 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.
 *
 * @copyright 2015-2017 Appertly
 * @copyright 2017-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
namespace Caridea\Module;

use Caridea\Container\Builder;
use Caridea\Container\Properties;

/**
 * A module definition.
 */
abstract class Module
{
    /**
     * Gets the module metadata.
     *
     * This array should contain at the very least the keys `name`, `version`,
     * and `description`. Feel free to add any additional fields you like, such
     * as `author`, `license`, or `copyright`.
     *
     * @return array<string,string> An associative array of the module metadata
     */
    public function getMeta(): array
    {
        return [];
    }

    /**
     * Gets static configuration settings.
     *
     * @return array<string,mixed> The module configuration settings
     */
    public function getConfig(): array
    {
        return [];
    }

    /**
     * Allows the module to register classes in the backend container.
     *
     * This method must only invoke the `eager`, `lazy`, and `proto` methods. It
     * should *not* attempt to build the container.
     *
     * @param \Caridea\Container\Builder $builder  The backend dependency injection container builder
     * @param \Caridea\Container\Properties $properties  The configuration settings
     * @return void
     */
    public function setupBackend(Builder $builder, Properties $properties)

The parameter $builder is not used and could be removed.

The parameter $properties is not used and could be removed.

    {
    }

    /**
     * Allows the module to register classes in the frontend container.
     *
     * This method must only invoke the `eager`, `lazy`, and `proto` methods. It
     * should *not* attempt to build the container.
     *
     * @param \Caridea\Container\Builder $builder  The frontend dependency injection container builder
     * @param \Caridea\Container\Properties $properties  The configuration settings
     * @return void
     */
    public function setupFrontend(Builder $builder, Properties $properties)

The parameter $builder is not used and could be removed.

The parameter $properties is not used and could be removed.

    {
    }
}