Maslosoft Mangan API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Interfaces;
/**
* Implement this interface to allow dynamic/callable collection names in documents
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface CollectionNameInterface
{
/**
* This method must return collection name for use with this model
* this must be implemented in child classes
*
* this is read-only defined only at class define
* if you want to set different collection during run-time
* use {@see setCollection()}.
* @return string collection name
* @since v1.0
*/
public function getCollectionName();
}
API documentation generated by ApiGen