Maslosoft\Mangan\Model\TrashItem

Complexity

Total Complexity

5

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

80%

Importance

Changes	4
Bugs	0	Features	2

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getCollectionName()	0	4	1
A	purge()	0	13	3
A	__toString()	0	4	1

<?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 http://maslosoft.com/mangan/
 */

namespace Maslosoft\Mangan\Model;

use Maslosoft\Mangan\Document;
use Maslosoft\Mangan\Interfaces\TrashInterface;
use Maslosoft\Mangan\Sanitizers\DateSanitizer;
use MongoDate;

/**
 * TrashItem
 *
 * @Label('Trashed item')
 * @author Piotr
 */
class TrashItem extends Document implements TrashInterface
{

	use \Maslosoft\Mangan\Traits\Model\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';
	}

}