ILIAS\Mail\Folder\MailFolderSearch Class Reference

Search in mail folders. More...

Collaboration diagram for ILIAS\Mail\Folder\MailFolderSearch:

Public Member Functions
	__construct (private readonly MailFolderData $folder, private readonly MailFilterData $filter, private readonly bool $lucene_enabled,)
	getCount ()
	Get a cached count of mails for the filter criteria. More...
	getUnread ()
	Get a cached count of unread mails for the filter criteria. More...
	getMaiIds ()
	Get the ids of all filtered mails. More...
	getRecords ()
	Get record objects of all filtered mails. More...
	getPagedRecords (int $limit, int $offset, ?MailBoxOrderColumn $order_column, ?string $order_direction)
	Get record objects of filtered and paged mails. More...
	forMailIds (array $ids)
	Inject already filtered mail ids, e.g. More...

Private Member Functions
	getFilteredIds ()
	Get the cached mail ids from a lucene search for selected filter criteria These will be used as additional filter for the mailbox query. More...

Private Attributes
MailBoxQuery	$mailbox_query
ilMailLuceneSearcher	$lucene_searcher = null
ilMailSearchResult	$lucene_result = null
array	$filtered_ids = null
int	$count = null
int	$unread = null

Detailed Description

Search in mail folders.

• utilises database and (if active) lucene based searchers
• caches results for counting of all or unread mails

Definition at line 35 of file MailFolderSearch.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Mail\Folder\MailFolderSearch::__construct	(	private readonly MailFolderData	$folder,
		private readonly MailFilterData	$filter,
		private readonly bool	$lucene_enabled
	)

Definition at line 45 of file MailFolderSearch.php.

References ILIAS\Repository\filter().

      {
        $this->mailbox_query = (new MailBoxQuery(
            $this->folder->getUserId()
        ))
            ->withFolderId($this->folder->getFolderId())
            ->withSender($this->filter->getSender())
            ->withRecipients($this->filter->getRecipients())
            ->withSubject($this->filter->getSubject())
            ->withBody($this->filter->getBody())
            ->withPeriodStart($this->filter->getPeriodStart())
            ->withPeriodEnd($this->filter->getPeriodEnd())
            ->withIsUnread($this->filter->isUnread())
            ->withIsSystem($this->filter->isSystem())
            ->withHasAttachment($this->filter->hasAttachment());

        if ($this->lucene_enabled && (
            ($this->filter->getSender() ?? '') !== '' ||
            ($this->filter->getRecipients() ?? '') !== '' ||
            ($this->filter->getSubject() ?? '') !== '' ||
            ($this->filter->getBody() ?? '') !== '' ||
            ($this->filter->getAttachment() ?? '') !== ''
        )) {
            $query_parser = new ilMailLuceneQueryParser('');
            $query_parser->setFields([
                'title' => $this->filter->getSubject(),
                'content' => $this->filter->getBody(),
                'mattachment' => $this->filter->getAttachment(), // only possible with lucene
                'msender' => $this->filter->getSender(),
            ]);
            $query_parser->parse();

            // lucene search wil be done and cached by getFilteredIds
            $this->lucene_result = new ilMailSearchResult();
            $this->lucene_searcher = new ilMailLuceneSearcher($query_parser, $this->lucene_result);
        }
    }

Here is the call graph for this function:

Member Function Documentation

forMailIds()

ILIAS\Mail\Folder\MailFolderSearch::forMailIds

(

array

$ids

)

Inject already filtered mail ids, e.g.

from a selection

Parameters

int[]

$ids

Definition at line 172 of file MailFolderSearch.php.

                                          : self
    {
        $clone = clone $this;
        $clone->filtered_ids = $ids;
        return $clone;
    }

getCount()

ILIAS\Mail\Folder\MailFolderSearch::getCount

(

)

Get a cached count of mails for the filter criteria.

Definition at line 89 of file MailFolderSearch.php.

References ILIAS\Mail\Folder\MailFolderSearch\$count, and ILIAS\Mail\Folder\MailFolderSearch\getFilteredIds().

                              : int
    {
        if ($this->count === null) {
            $this->count = $this->mailbox_query->withFilteredIds($this->getFilteredIds())->count();
        }

        return $this->count;
    }

Here is the call graph for this function:

getFilteredIds()

ILIAS\Mail\Folder\MailFolderSearch::getFilteredIds ( )

private

Get the cached mail ids from a lucene search for selected filter criteria These will be used as additional filter for the mailbox query.

Returns

null|list<int>

Definition at line 156 of file MailFolderSearch.php.

References ILIAS\Mail\Folder\MailFolderSearch\$filtered_ids.

Referenced by ILIAS\Mail\Folder\MailFolderSearch\getCount(), ILIAS\Mail\Folder\MailFolderSearch\getMaiIds(), ILIAS\Mail\Folder\MailFolderSearch\getPagedRecords(), ILIAS\Mail\Folder\MailFolderSearch\getRecords(), and ILIAS\Mail\Folder\MailFolderSearch\getUnread().

                                     : ?array
    {
        if ($this->filtered_ids === null &&
            $this->lucene_result !== null &&
            $this->lucene_searcher !== null) {
            $this->lucene_searcher->search($this->folder->getUserId(), $this->folder->getFolderId());
            $this->filtered_ids = $this->lucene_result->getIds();
        }

        return $this->filtered_ids;
    }

Here is the caller graph for this function:

getMaiIds()

ILIAS\Mail\Folder\MailFolderSearch::getMaiIds

(

)

Get the ids of all filtered mails.

Returns

int[]

Definition at line 114 of file MailFolderSearch.php.

References ILIAS\Mail\Folder\MailFolderSearch\getFilteredIds().

                               : array
    {
        return $this->mailbox_query
            ->withFilteredIds($this->getFilteredIds())
            ->queryMailIds();
    }

Here is the call graph for this function:

getPagedRecords()

ILIAS\Mail\Folder\MailFolderSearch::getPagedRecords	(	int	$limit,
		int	$offset,
		?MailBoxOrderColumn	$order_column,
		?string	$order_direction
	)

Get record objects of filtered and paged mails.

Returns

MailRecordData[]

Definition at line 136 of file MailFolderSearch.php.

References ILIAS\Mail\Folder\MailFolderSearch\getFilteredIds().

     : array {
        return $this->mailbox_query
            ->withFilteredIds($this->getFilteredIds())
            ->withLimit($limit)
            ->withOffset($offset)
            ->withOrderColumn($order_column)
            ->withOrderDirection($order_direction)
            ->query(true);
    }

Here is the call graph for this function:

getRecords()

ILIAS\Mail\Folder\MailFolderSearch::getRecords

(

)

Get record objects of all filtered mails.

Returns

MailRecordData[]

Definition at line 125 of file MailFolderSearch.php.

References ILIAS\Mail\Folder\MailFolderSearch\getFilteredIds().

                                : array
    {
        return $this->mailbox_query
            ->withFilteredIds($this->getFilteredIds())
            ->query(true);
    }

Here is the call graph for this function:

getUnread()

ILIAS\Mail\Folder\MailFolderSearch::getUnread

(

)

Get a cached count of unread mails for the filter criteria.

Definition at line 101 of file MailFolderSearch.php.

References ILIAS\Mail\Folder\MailFolderSearch\$unread, and ILIAS\Mail\Folder\MailFolderSearch\getFilteredIds().

                               : int
    {
        if ($this->unread === null) {
            $this->unread = $this->mailbox_query->withFilteredIds($this->getFilteredIds())->countUnread();
        }

        return $this->unread;
    }

Here is the call graph for this function:

Field Documentation

$count

int ILIAS\Mail\Folder\MailFolderSearch::$count = null

private

Definition at line 42 of file MailFolderSearch.php.

Referenced by ILIAS\Mail\Folder\MailFolderSearch\getCount().

$filtered_ids

array ILIAS\Mail\Folder\MailFolderSearch::$filtered_ids = null

private

Definition at line 41 of file MailFolderSearch.php.

Referenced by ILIAS\Mail\Folder\MailFolderSearch\getFilteredIds().

$lucene_result

ilMailSearchResult ILIAS\Mail\Folder\MailFolderSearch::$lucene_result = null

private

Definition at line 39 of file MailFolderSearch.php.

$lucene_searcher

ilMailLuceneSearcher ILIAS\Mail\Folder\MailFolderSearch::$lucene_searcher = null

private

Definition at line 38 of file MailFolderSearch.php.

$mailbox_query

MailBoxQuery ILIAS\Mail\Folder\MailFolderSearch::$mailbox_query

private

Definition at line 37 of file MailFolderSearch.php.

$unread

int ILIAS\Mail\Folder\MailFolderSearch::$unread = null

private

Definition at line 43 of file MailFolderSearch.php.

Referenced by ILIAS\Mail\Folder\MailFolderSearch\getUnread().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Mail/classes/Folder/MailFolderSearch.php