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\Annotations;
use Maslosoft\Mangan\Meta\DocumentTypeMeta;
use Maslosoft\Mangan\Meta\ManganPropertyAnnotation;
/**
* To define simple primary key mark field with `PrimaryKey` annotation.
* To define composite primary key, use this annotation on several fields.
*
* @Target('property')
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class PrimaryKeyAnnotation extends ManganPropertyAnnotation
{
public function init()
{
// Set primaryKey value on type
$type = $this->getMeta()->type();
/* @var $type DocumentTypeMeta */
$name = $this->getEntity()->name;
// If key is already defined it means that it is composite
if ($type->primaryKey)
{
// If it is array then add field
if (is_array($type->primaryKey))
{
$type->primaryKey[] = $name;
}
else
{
// it is not array so create composite from existing
// field and add new field to definition
$type->primaryKey = [$type->primaryKey, $name];
}
}
else
{
// Simple primary key
$type->primaryKey = $name;
}
}
}
API documentation generated by ApiGen