<?php
/**
 * FuzeWorks Component.
 *
 * The FuzeWorks PHP FrameWork
 *
 * Copyright (C) 2013-2019 TechFuze
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * @author    TechFuze
 * @copyright Copyright (c) 2013 - 2019, TechFuze. (http://techfuze.net)
 * @license   https://opensource.org/licenses/MIT MIT License
 *
 * @link  http://techfuze.net/fuzeworks
 * @since Version 1.2.0
 *
 * @version Version 1.2.0
 */

namespace FuzeWorks\Event;
use FuzeWorks\Event;
use FuzeWorks\Model\iDatabaseTableModel;

class DatabaseLoadTableModelEvent extends Event
{
    /**
     * A possible database that can be loaded.
     *
     * Provide a database in this variable and it will be loaded. It shall be identified as default if
     * the parameters variable is empty. If there is a string in parameters this database shall be identified as
     * such.
     *
     * @var iDatabaseTableModel|null
     */
    public ?iDatabaseTableModel $tableModel = null;

    /**
     * The name of the engine to be loaded
     *
     * @var string
     */
    public string $engineName;

    /**
     * The name of the table this model manages
     *
     * @var string
     */
    public string $tableName;

    /**
     * Parameters of the database to be loaded
     *
     * @var array
     */
    public array $parameters;

    /**
     * Database group to load
     *
     * @var string
     */
    public string $connectionName;


    public function init(string $engineName, array $parameters, string $connectionName, string $tableName)
    {
        $this->engineName = $engineName;
        $this->parameters = $parameters;
        $this->connectionName = $connectionName;
        $this->tableName = $tableName;
    }
}