<?php

namespace SilverStripe\CMS\Controllers;

use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\ORM\SS_List;
use SilverStripe\ORM\Versioning\Versioned;

/**
 * Filters pages which have a status "Deleted".
 */
class CMSSiteTreeFilter_StatusDeletedPages extends CMSSiteTreeFilter
{

	/**
	 * @var string
	 */
	protected $childrenMethod = "AllHistoricalChildren";

	/**
	 * @var string
	 */
	protected $numChildrenMethod = 'numHistoricalChildren';

	static public function title()
	{
		return _t('CMSSiteTreeFilter_StatusDeletedPages.Title', 'Archived pages');
	}

	/**
	 * Filters out all pages who's status is set to "Deleted".
	 *
	 * @see {@link SiteTree::getStatusFlags()}
	 * @return SS_List
	 */
	public function getFilteredPages()
	{
		$pages = Versioned::get_including_deleted('SilverStripe\\CMS\\Model\\SiteTree');
		$pages = $this->applyDefaultFilters($pages);

		$pages = $pages->filterByCallback(function (SiteTree $page) {
			// Doesn't exist on either stage or live
			return $page->getIsDeletedFromStage() && !$page->getExistsOnLive();
		});
		return $pages;
	}
}