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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 <?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\Traits;
use Maslosoft\Mangan\Interfaces\CollectionNameInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
/**
* This trait contains default `getCollectionName` implementation. It will first
* try to get collection name from annotations, then it will fall back to
* current class name with slashes renamed to dots.
*
* Example auto generated collection name for class `\ManganExamples\Model\User`:
*
* ```
* ManganExamples.Model.User
* ```
*
* @see CollectionNameInterface
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
trait CollectionNameTrait
{
/**
* This method must return collection name for use with this model.
* By default it uses full class name, with slashes replaced by dots.
*
* If `CollectionName` annotation is defined, it will collection name defined
* by this annotation.
*
* @return string collection name
* @Ignored
*/
public function getCollectionName()
{
$collectionName = ManganMeta::create($this)->type()->collectionName;
if (!empty($collectionName))
{
return $collectionName;
}
$name = get_class($this);
return ltrim(str_replace('\\', '.', $name), '\\');
}
}
API documentation generated by ApiGen