PHP 클래스 Horde_Kolab_Storage_Driver_Base, horde

Copyright 2009-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
상속: implements Horde_Kolab_Storage_Driver
파일 보기 프로젝트 열기: horde/horde 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$_namespace Horde_Kolab_Storage_Folder_Namespace Memory cache for the namespace of this driver.
$charset string Charset used by this driver.

공개 메소드들

메소드 설명
__construct ( Horde_Kolab_Storage_Factory $factory, array $params = [] ) Constructor.
fetchBodypart ( string $mailbox, array $uid, array $id ) : resource Retrieves a bodypart for the given message ID and mime part ID.
fetchComplete ( string $folder, array $uid ) : array Retrieves a complete message.
fetchHeaders ( string $folder, array $uid ) : Horde_Mime_Headers Retrieves the message headers.
fetchStructure ( string $mailbox, array $uids ) : Horde_Mime_Part Retrieves the messages for the given message ids.
getAuth ( ) : string Return the id of the user currently authenticated.
getBackend ( ) : mixed Returns the actual backend driver.
getId ( ) : string Return the unique connection id.
getModifiable ( string $folder, string $obid, array $object ) : Horde_Kolab_Storage_Driver_Modifiable Return a modifiable message object.
getNamespace ( ) : Horde_Kolab_Storage_Folder_Namespace Retrieve the namespace information for this connection.
getParam ( string $key, mixed $default = null ) : mixed Return a parameter setting for this connection.
getParameters ( ) : array Return the connection parameters.
getParams ( ) : array Return all parameter settings for this connection.
getStamp ( string $folder ) : Horde_Kolab_Storage_Folder_Stamp Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data.
getStampFromToken ( string $folder, string $token, array $ids ) : Horde_Kolab_Storage_Folder_Stamp Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data. This method, as opposed to self::getStamp(), uses the IMAP client's token to calculate the changes.
hasCatenateSupport ( ) : boolean Checks if the backend supports CATENATE.
setBackend ( mixed $backend ) : null Set the backend driver.
setParam ( string $key, mixed $value ) : null Set a parameter setting for this connection.

보호된 메소드들

메소드 설명
_getAnnotateMoreEntry ( string $name ) : array Split a name for the METADATA extension into the correct syntax for the older ANNOTATEMORE version.
decodeList ( array $list ) : array Decode a list of IMAP path names from the driver charset to UTF-8.
decodeListKeys ( array $list ) : array Decode the keys of a list of IMAP path names from the driver charset to UTF-8.
decodePath ( string $path ) : string Decode IMAP path names from the driver charset to UTF-8.
encodePath ( string $path ) : string Encode IMAP path names from UTF-8 to the driver charset.
getFactory ( ) : Horde_Kolab_Storage_Factory Return the factory.

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( Horde_Kolab_Storage_Factory $factory, array $params = [] )
$factory Horde_Kolab_Storage_Factory A factory for helper objects.
$params array Connection parameters.

_getAnnotateMoreEntry() 보호된 메소드

Split a name for the METADATA extension into the correct syntax for the older ANNOTATEMORE version.
protected _getAnnotateMoreEntry ( string $name ) : array
$name string A name for a metadata entry.
리턴 array A list of two elements: The entry name and the value type.

decodeList() 보호된 메소드

Decode a list of IMAP path names from the driver charset to UTF-8.
protected decodeList ( array $list ) : array
$list array The the driver charset encoded path names.
리턴 array The path names in UTF-8.

decodeListKeys() 보호된 메소드

Decode the keys of a list of IMAP path names from the driver charset to UTF-8.
protected decodeListKeys ( array $list ) : array
$list array The list with the driver charset encoded path names as keys.
리턴 array The list with path names in UTF-8 as keys.

decodePath() 보호된 메소드

Decode IMAP path names from the driver charset to UTF-8.
protected decodePath ( string $path ) : string
$path string The the driver charset encoded path name.
리턴 string The path name in UTF-8.

encodePath() 보호된 메소드

Encode IMAP path names from UTF-8 to the driver charset.
protected encodePath ( string $path ) : string
$path string The UTF-8 encoded path name.
리턴 string The path name in the driver charset.

fetchBodypart() 공개 메소드

Retrieves a bodypart for the given message ID and mime part ID.
public fetchBodypart ( string $mailbox, array $uid, array $id ) : resource
$mailbox string The mailbox to fetch the messages from.
$uid array The message UID.
$id array The mime part ID.
리턴 resource The transfer-decoded body part data, as a stream resource presented as 8bit data.

fetchComplete() 공개 메소드

Retrieves a complete message.
public fetchComplete ( string $folder, array $uid ) : array
$folder string The folder to fetch the messages from.
$uid array The message UID.
리턴 array The message encapsuled as an array that contains a Horde_Mime_Headers and a Horde_Mime_Part object.

fetchHeaders() 공개 메소드

Retrieves the message headers.
public fetchHeaders ( string $folder, array $uid ) : Horde_Mime_Headers
$folder string The folder to fetch the message from.
$uid array The message UID.
리턴 Horde_Mime_Headers The message headers.

fetchStructure() 공개 메소드

Retrieves the messages for the given message ids.
public fetchStructure ( string $mailbox, array $uids ) : Horde_Mime_Part
$mailbox string The mailbox to fetch the messages from.
$uids array The message UIDs.
리턴 Horde_Mime_Part The message structure parsed into a Horde_Mime_Part instance.

getAuth() 공개 메소드

Return the id of the user currently authenticated.
public getAuth ( ) : string
리턴 string The id of the user that opened the IMAP connection.

getBackend() 공개 메소드

If there is no driver set the driver should be constructed within this method.
public getBackend ( ) : mixed
리턴 mixed The backend driver.

getFactory() 보호된 메소드

Return the factory.
protected getFactory ( ) : Horde_Kolab_Storage_Factory
리턴 Horde_Kolab_Storage_Factory The factory.

getId() 공개 메소드

Return the unique connection id.
public getId ( ) : string
리턴 string The connection id.

getModifiable() 공개 메소드

Return a modifiable message object.
public getModifiable ( string $folder, string $obid, array $object ) : Horde_Kolab_Storage_Driver_Modifiable
$folder string The folder to access.
$obid string The backend ID of the object to retrieve from the folder.
$object array The object data.
리턴 Horde_Kolab_Storage_Driver_Modifiable The modifiable message object.

getNamespace() 공개 메소드

Retrieve the namespace information for this connection.
public getNamespace ( ) : Horde_Kolab_Storage_Folder_Namespace
리턴 Horde_Kolab_Storage_Folder_Namespace The initialized namespace handler.

getParam() 공개 메소드

Return a parameter setting for this connection.
public getParam ( string $key, mixed $default = null ) : mixed
$key string The parameter key.
$default mixed An optional default value.
리턴 mixed The parameter value.

getParameters() 공개 메소드

Return the connection parameters.
public getParameters ( ) : array
리턴 array The connection parameters.

getParams() 공개 메소드

Return all parameter settings for this connection.
public getParams ( ) : array
리턴 array The parameters.

getStamp() 공개 메소드

Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data.
public getStamp ( string $folder ) : Horde_Kolab_Storage_Folder_Stamp
$folder string Return the stamp for this folder.
리턴 Horde_Kolab_Storage_Folder_Stamp A stamp indicating the current folder status.

getStampFromToken() 공개 메소드

Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data. This method, as opposed to self::getStamp(), uses the IMAP client's token to calculate the changes.
public getStampFromToken ( string $folder, string $token, array $ids ) : Horde_Kolab_Storage_Folder_Stamp
$folder string Return the stamp for this folder.
$token string A sync token provided by the IMAP server.
$ids array An array of UIDs that we know about.
리턴 Horde_Kolab_Storage_Folder_Stamp A stamp indicating the current folder status.

hasCatenateSupport() 공개 메소드

Checks if the backend supports CATENATE.
public hasCatenateSupport ( ) : boolean
리턴 boolean True if the backend supports CATENATE.

setBackend() 공개 메소드

Set the backend driver.
public setBackend ( mixed $backend ) : null
$backend mixed The driver that should be used.
리턴 null

setParam() 공개 메소드

Set a parameter setting for this connection.
public setParam ( string $key, mixed $value ) : null
$key string The parameter key.
$value mixed The parameter value.
리턴 null

프로퍼티 상세

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

Memory cache for the namespace of this driver.
protected Horde_Kolab_Storage_Folder_Namespace $_namespace
리턴 Horde_Kolab_Storage_Folder_Namespace

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

Charset used by this driver.
protected string $charset
리턴 string