148 lines
4 KiB
PHP
148 lines
4 KiB
PHP
<?php
|
|
/*
|
|
* Pterodactyl - Panel
|
|
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
namespace Pterodactyl\Contracts\Repository;
|
|
|
|
interface RepositoryInterface
|
|
{
|
|
/**
|
|
* Return an identifier or Model object to be used by the repository.
|
|
*
|
|
* @return string|\Closure|object
|
|
*/
|
|
public function model();
|
|
|
|
/**
|
|
* Return the model being used for this repository instance.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getModel();
|
|
|
|
/**
|
|
* Returns an instance of a query builder.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getBuilder();
|
|
|
|
/**
|
|
* Returns the colummns to be selected or returned by the query.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getColumns();
|
|
|
|
/**
|
|
* An array of columns to filter the response by.
|
|
*
|
|
* @param array $columns
|
|
* @return $this
|
|
*/
|
|
public function withColumns($columns = ['*']);
|
|
|
|
/**
|
|
* Disable returning a fresh model when data is inserted or updated.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function withoutFresh();
|
|
|
|
/**
|
|
* Create a new model instance and persist it to the database.
|
|
*
|
|
* @param array $fields
|
|
* @param bool $validate
|
|
* @return mixed
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
|
*/
|
|
public function create(array $fields, $validate = true);
|
|
|
|
/**
|
|
* Delete a given record from the database.
|
|
*
|
|
* @param int $id
|
|
* @return bool|null
|
|
*/
|
|
public function delete($id);
|
|
|
|
/**
|
|
* Find a model that has the specific ID passed.
|
|
*
|
|
* @param int $id
|
|
* @return mixed
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
|
*/
|
|
public function find($id);
|
|
|
|
/**
|
|
* Find a model matching an array of where clauses.
|
|
*
|
|
* @param array $fields
|
|
* @return mixed
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
|
*/
|
|
public function findWhere(array $fields);
|
|
|
|
/**
|
|
* Find and return the first matching instance for the given fields.
|
|
*
|
|
* @param array $fields
|
|
* @return mixed
|
|
*/
|
|
public function findFirstWhere(array $fields);
|
|
|
|
/**
|
|
* Update a given ID with the passed array of fields.
|
|
*
|
|
* @param int $id
|
|
* @param array $fields
|
|
* @param bool $validate
|
|
* @param bool $force
|
|
* @return mixed
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
|
*/
|
|
public function update($id, array $fields, $validate = true, $force = false);
|
|
|
|
/**
|
|
* Update multiple records matching the passed clauses.
|
|
*
|
|
* @param array $where
|
|
* @param array $fields
|
|
* @return mixed
|
|
*/
|
|
public function massUpdate(array $where, array $fields);
|
|
|
|
/**
|
|
* Return all records from the model.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function all();
|
|
}
|