| [ Index ] |
|
Code source de IMP H3 (4.1.5) |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 688 lignes (22 kb) |
| Inclus ou requis: | 9 fois |
| Référencé: | 0 fois |
| Nécessite: | 4 fichiers lib/IMAP/Sort.php lib/IMAP/Tree.php lib/IMAP/Search.php lib/Folder.php |
IMP_Search:: (26 méthodes):
IMP_Search()
sessionSetup()
runSearch()
createSearchQuery()
deleteSearchQuery()
retrieveUIQuery()
getLabel()
_getVFolderList()
_saveVFolderList()
addVFolder()
createVTrashFolder()
isVTrashFolder()
createVINBOXFolder()
isVINBOXFolder()
isEditableVFolder()
listQueries()
getSearchFolders()
editURL()
deleteURL()
isSearchMbox()
isVFolder()
searchMboxID()
_strip()
createSearchID()
searchFields()
_updateIMPTree()
Classe: IMP_Search - X-Ref
The IMP_Search:: class contains all code related to mailbox searching| IMP_Search($params = array() X-Ref |
| Constructor. param: array $params Available parameters: |
| sessionSetup() X-Ref |
| Set up IMP_Search variables for the current session. |
| runSearch(&$ob, $id = null) X-Ref |
| Run a search. param: IMAP_Search_Query &$ob An optional search query to add (via param: string $id The search query id to use (by default, return: array The sorted list. |
| createSearchQuery($query, $folders, $search, $label, $id = null) X-Ref |
| Creates the IMAP search query in the IMP session. param: IMAP_Search_Query $query The search query object. param: array $folders The list of folders to search. param: array $search The search array used to build the param: string $label The label to use for the search param: string $id The query id to use (or else one is return: string Returns the search query id. |
| deleteSearchQuery($id = null) X-Ref |
| Deletes an IMAP search query. param: string $id The search query id to use (by default, will use return: string Returns the search query id. |
| retrieveUIQuery($id = null) X-Ref |
| Retrieves the previously stored search UI information. param: string $id The search query id to use (by default, will use return: array The array necessary to rebuild the search UI page. |
| getLabel($id = null) X-Ref |
| Generates the label to use for search results. param: string $id The search query id to use (by default, will use return: string The search results label. |
| _getVFolderList() X-Ref |
| Obtains the list of virtual folders for the current user. return: array The list of virtual folders. |
| _saveVFolderList($vfolder) X-Ref |
| Saves the list of virtual folders for the current user. param: array The virtual folder list. |
| addVFolder($query, $folders, $search, $label, $id = null) X-Ref |
| Add a virtual folder for the current user. param: IMAP_Search_Query $query The search query object. param: array $folders The list of folders to search. param: array $search The search array used to build the param: string $label The label to use for the search param: string $id The virtual folder id. return: string The virtual folder ID. |
| createVTrashFolder() X-Ref |
| Add a virtual trash folder for the current user. |
| isVTrashFolder($id = null) X-Ref |
| Determines whether a virtual folder ID is the Virtual Trash Folder. param: string $id The search query id to use (by default, will use return: boolean True if the virutal folder ID is the Virtual Trash |
| createVINBOXFolder() X-Ref |
| Add a virtual INBOX folder for the current user. |
| isVINBOXFolder($id = null) X-Ref |
| Determines whether a virtual folder ID is the Virtual INBOX Folder. param: string $id The search query id to use (by default, will use return: boolean True if the virutal folder ID is the Virtual INBOX |
| isEditableVFolder($id = null) X-Ref |
| Is the current active folder an editable Virtual Folder? param: string $id The search query id to use (by default, will use return: boolean True if the current folder is both a virtual folder |
| listQueries($vfolder = false) X-Ref |
| Return a list of IDs and query labels, sorted by the label. param: boolean $vfolder If true, only return Virtual Folders? return: array An array with the folder IDs as the key and the labels |
| getSearchFolders($id = null) X-Ref |
| Get the list of searchable folders for the given search query. param: string $id The search query id to use (by default, will use return: array The list of searchable folders. |
| editURL($id = null) X-Ref |
| Returns a link to edit a given search query. param: string $id The search query id to use (by default, will use |
| deleteURL($id = null) X-Ref |
| Returns a link to delete a given search query. param: string $id The search query id to use (by default, will use return: string The URL to allow deletion of the search query. |
| isSearchMbox($id = null) X-Ref |
| Is the given mailbox a search mailbox? param: string $id The search query id to use (by default, will use return: boolean Whether the given mailbox name is a search mailbox. |
| isVFolder($id = null) X-Ref |
| Is the given mailbox a virtual folder? param: string $id The search query id to use (by default, will use return: boolean Whether the given mailbox name is a virtual folder. |
| searchMboxID() X-Ref |
| Get the ID for the search mailbox, if we are currently in a search mailbox. return: mixed The search ID if in a mailbox, else false. |
| _strip($id) X-Ref |
| Strip the identifying label from a mailbox ID. param: string $id The mailbox query ID. return: string The virtual folder ID, with any IMP specific identifying |
| createSearchID($id) X-Ref |
| Create the canonical search ID for a given search query. param: string $id The mailbox query ID. return: string The canonical search query ID. |
| searchFields() X-Ref |
| Return the base search fields. return: array The base search fields. |
| _updateIMPTree($action, $id, $label = null) X-Ref |
| Update IMAP_Tree object. param: string $action Either 'delete' or 'add'. param: string $id The query ID to update. param: string $label If $action = 'add', the label to use for the |
| Généré le : Thu Nov 29 12:30:07 2007 | par Balluche grâce à PHPXref 0.7 |
|
|