Source of file DatabaseInterface.php

<?php

/**

 * Copyright 2019 University of Liverpool

 *

 * 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 pgb_liv\php_ms\Core\Database;

/**

 * Common interface methods to database instances.

 *

 * @author Andrew Collins

 */

interface DatabaseInterface

{

    /**

     * Gets the prefix used by this database instance in FASTA files

     *

     * @return string

     */

    public function getPrefix();

    /**

     * Gets the full name of this database instance

     *

     * @return string|null

     */

    public function getName();

    /**

     * Gets the source URI for this database instance

     *

     * @return string|null

     */

    public function getSource();

}