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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 <?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\Model;
use Maslosoft\Mangan\Document;
use Maslosoft\Mangan\Interfaces\TrashInterface;
use Maslosoft\Mangan\Sanitizers\DateSanitizer;
use Maslosoft\Mangan\Traits\Model\TrashableTrait;
use MongoDate;
/**
* TrashItem
*
* @Label('Trashed item')
* @author Piotr
*/
class TrashItem extends Document implements TrashInterface
{
use TrashableTrait;
/**
* Element name
* @Label('Name')
* @var string
*/
public $name = '';
/**
* Type of trashed item
* @Label('Type')
* @var string
*/
public $type = '';
/**
* When it was trashed.
* @Sanitizer(DateSanitizer)
* @see DateSanitizer
* @var MongoDate
*/
public $createDate = '';
public function getCollectionName()
{
return 'Mangan.Trash';
}
/**
* Purge all items from trash. Returns number of removed items.
* @return int
*/
public function purge()
{
$removed = 0;
// Remove with loop to fire before/afterDelete events
foreach ($this->findAll() as $trash)
{
if ($trash->delete())
{
$removed++;
}
}
return $removed;
}
public function __toString()
{
return 'Trashed';
}
}
API documentation generated by ApiGen