• 홈
  • IMP_Search

PHP 클래스 IMP_Search, horde

저자: Michael Slusarz ([email protected])
상속: implements ArrayAccess, implements IteratorAggregate, implements Serializable
파일 보기 프로젝트 열기: horde/horde

공개 프로퍼티들

프로퍼티 타입 설명
$changed boolean Has the object data changed?

보호된 프로퍼티들

프로퍼티 타입 설명
$_search array Each subarray contains: Keys: mailbox IDs. Values: IMP_Search_Query objects.

공개 메소드들

메소드 설명
__construct ( ) Constructor.
applyFilter ( string $id, array $mboxes, string $mid = null ) : IMP_Search_Query Converts a filter to a search query and stores it in the local session.
createQuery ( array $criteria, array $opts = [] ) : IMP_Search_Query Creates the IMAP search query.
createSearchId ( string $id ) : string Create the canonical search ID for a given search query.
editUrl ( string $id ) : Horde_Url Returns a link to edit a given search query.
getIterator ( )
init ( ) Initialize session search data.
isFilter ( string $id, boolean $editable = false ) Is a mailbox a filter query?
isQuery ( string $id, boolean $editable = false ) : boolean Is a mailbox a search query?
isSearchMbox ( string $id ) : boolean Is the given mailbox a search mailbox?
isSystemQuery ( string $id ) : boolean Is a mailbox a system (built-in) search query?
isVFolder ( string $id, boolean $editable = false ) : boolean Is a mailbox a virtual folder?
isVTrash ( string $id ) : boolean Determines whether a mailbox ID is the Virtual Trash Folder.
isVinbox ( string $id ) : boolean Determines whether a mailbox ID is the Virtual INBOX Folder.
offsetExists ( $offset ) * ArrayAccess methods.
offsetGet ( $offset )
offsetSet ( string $offset, IMP_Search_Query $value ) Alter the current IMAP search query.
offsetUnset ( string $offset ) Deletes an IMAP search query.
serialize ( ) : string Serialize.
setFilters ( array $filters ) Saves the list of filters for the current user.
setVFolders ( array $vfolders ) Saves the list of virtual folders for the current user.
unserialize ( string $data ) Unserialize.

보호된 메소드들

메소드 설명
_getFilters ( ) Loads the list of filters for the current user.
_getVFolders ( ) Loads the list of virtual folders for the current user.
_strip ( string $id ) : string Strip the identifying label from a mailbox ID.

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( )

_getFilters() 보호된 메소드

Loads the list of filters for the current user.
protected _getFilters ( )

_getVFolders() 보호된 메소드

Loads the list of virtual folders for the current user.
protected _getVFolders ( )

_strip() 보호된 메소드

Strip the identifying label from a mailbox ID.
protected _strip ( string $id ) : string
$id string The mailbox query ID.
리턴 string The virtual folder ID, with any IMP specific identifying information stripped off.

applyFilter() 공개 메소드

Converts a filter to a search query and stores it in the local session.
public applyFilter ( string $id, array $mboxes, string $mid = null ) : IMP_Search_Query
$id string The mailbox ID of the filter.
$mboxes array The list of mailboxes to apply the filter on.
$mid string Use as the mailbox ID.
리턴 IMP_Search_Query The created query object.

createQuery() 공개 메소드

Creates the IMAP search query.
public createQuery ( array $criteria, array $opts = [] ) : IMP_Search_Query
$criteria array The search criteria array.
$opts array Additional options: - id: (string) Use as the mailbox ID. - label: (string) The label to use for the search results. - mboxes: (array) The list of mailboxes to directly search. If this contains the IMP_Search_Query::ALLSEARCH constant, all mailboxes will be searched. - subfolders: (array) The list of mailboxes to do subfolder searches on. - type: (integer) Query type.
리턴 IMP_Search_Query Returns the query object.

createSearchId() 공개 메소드

Create the canonical search ID for a given search query.
public createSearchId ( string $id ) : string
$id string The mailbox query ID.
리턴 string The canonical search query ID.

editUrl() 공개 메소드

Returns a link to edit a given search query.
public editUrl ( string $id ) : Horde_Url
$id string The search query id.
리턴 Horde_Url The URL to the search page.

getIterator() 공개 메소드

public getIterator ( )

init() 공개 메소드

Initialize session search data.
public init ( )

isFilter() 공개 메소드

Is a mailbox a filter query?
public isFilter ( string $id, boolean $editable = false )
$id string The mailbox ID.
$editable boolean Is this an editable (i.e. not built-in) filter query?

isQuery() 공개 메소드

Is a mailbox a search query?
public isQuery ( string $id, boolean $editable = false ) : boolean
$id string The mailbox ID.
$editable boolean Is this an editable (i.e. not built-in) search query?
리턴 boolean True if a search query.

isSearchMbox() 공개 메소드

Is the given mailbox a search mailbox?
public isSearchMbox ( string $id ) : boolean
$id string The mailbox name.
리턴 boolean Whether the given mailbox name is a search mailbox.

isSystemQuery() 공개 메소드

Is a mailbox a system (built-in) search query?
public isSystemQuery ( string $id ) : boolean
$id string The mailbox ID.
리턴 boolean True if a system search query.

isVFolder() 공개 메소드

Is a mailbox a virtual folder?
public isVFolder ( string $id, boolean $editable = false ) : boolean
$id string The mailbox ID.
$editable boolean Is this an editable (i.e. not built-in) virtual folder?
리턴 boolean Whether the mailbox ID is a virtual folder.

isVTrash() 공개 메소드

Determines whether a mailbox ID is the Virtual Trash Folder.
public isVTrash ( string $id ) : boolean
$id string The mailbox id.
리턴 boolean True if the ID is the Virtual Trash folder.

isVinbox() 공개 메소드

Determines whether a mailbox ID is the Virtual INBOX Folder.
public isVinbox ( string $id ) : boolean
$id string The mailbox id.
리턴 boolean True if the ID is the Virtual INBOX folder.

offsetExists() 공개 메소드

* ArrayAccess methods.
public offsetExists ( $offset )

offsetGet() 공개 메소드

public offsetGet ( $offset )

offsetSet() 공개 메소드

Alter the current IMAP search query.
public offsetSet ( string $offset, IMP_Search_Query $value )
$offset string The search query id.
$value IMP_Search_Query The query object.

offsetUnset() 공개 메소드

Deletes an IMAP search query.
public offsetUnset ( string $offset )
$offset string The search query id.

serialize() 공개 메소드

Serialize.
public serialize ( ) : string
리턴 string Serialized representation of this object.

setFilters() 공개 메소드

Saves the list of filters for the current user.
public setFilters ( array $filters )
$filters array The filter list.

setVFolders() 공개 메소드

Saves the list of virtual folders for the current user.
public setVFolders ( array $vfolders )
$vfolders array The virtual folder list.

unserialize() 공개 메소드

Unserialize.
public unserialize ( string $data )
$data string Serialized data.

프로퍼티 상세

$_search 보호되어 있는 프로퍼티

Each subarray contains: Keys: mailbox IDs. Values: IMP_Search_Query objects.
protected array $_search
리턴 array

$changed 공개적으로 프로퍼티

Has the object data changed?
public bool $changed
리턴 boolean