misc_pterodactyl-panel/app/Contracts/Repository/DatabaseRepositoryInterface.php

84 lines
2.2 KiB
PHP
Raw Normal View History

2017-07-15 16:52:34 +00:00
<?php
2017-09-26 02:43:01 +00:00
/**
2017-07-15 16:52:34 +00:00
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
2017-09-26 02:43:01 +00:00
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
2017-07-15 16:52:34 +00:00
*/
namespace Pterodactyl\Contracts\Repository;
interface DatabaseRepositoryInterface extends RepositoryInterface
{
/**
* Create a new database if it does not already exist on the host with
* the provided details.
*
2017-08-22 03:10:48 +00:00
* @param array $data
2017-07-15 16:52:34 +00:00
* @return mixed
*
* @throws \Pterodactyl\Exceptions\DisplayException
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
*/
public function createIfNotExists(array $data);
/**
* Create a new database on a given connection.
*
2017-08-22 03:10:48 +00:00
* @param string $database
* @param null|string $connection
2017-07-15 16:52:34 +00:00
* @return bool
*/
public function createDatabase($database, $connection = null);
/**
* Create a new database user on a given connection.
*
2017-08-22 03:10:48 +00:00
* @param string $username
* @param string $remote
* @param string $password
* @param null|string $connection
2017-07-15 16:52:34 +00:00
* @return bool
*/
public function createUser($username, $remote, $password, $connection = null);
/**
* Give a specific user access to a given database.
*
2017-08-22 03:10:48 +00:00
* @param string $database
* @param string $username
* @param string $remote
* @param null|string $connection
2017-07-15 16:52:34 +00:00
* @return bool
*/
public function assignUserToDatabase($database, $username, $remote, $connection = null);
/**
* Flush the privileges for a given connection.
*
2017-08-22 03:10:48 +00:00
* @param null|string $connection
2017-07-15 16:52:34 +00:00
* @return mixed
*/
public function flush($connection = null);
/**
* Drop a given database on a specific connection.
*
2017-08-22 03:10:48 +00:00
* @param string $database
* @param null|string $connection
2017-07-15 16:52:34 +00:00
* @return bool
*/
public function dropDatabase($database, $connection = null);
/**
* Drop a given user on a specific connection.
*
2017-08-22 03:10:48 +00:00
* @param string $username
* @param string $remote
* @param null|string $connection
2017-07-15 16:52:34 +00:00
* @return mixed
*/
public function dropUser($username, $remote, $connection = null);
}