AfterLogic API Documentation
  • Package
  • Class

Packages

  • Calendar
    • Classes
    • Storages
  • Capability
  • Channels
    • Classes
    • Storages
  • Collaboration
  • Contacts
    • Helpers
    • Storages
  • Dav
  • Db
    • Classes
    • Enum
    • Storages
  • Domains
    • Classes
    • Storages
  • Fetchers
    • Classes
    • Storages
  • Filecache
    • Storages
  • Filestorage
    • Classes
    • Storages
  • GContacts
    • Storages
  • Helpdesk
    • Classes
    • Enum
    • Storages
  • Integrator
  • IOS
  • Logger
  • Mail
    • Classes
    • Enum
    • Storages
  • Mailsuite
    • Classes
    • Storages
  • Min
    • Storages
  • Sieve
    • Classes
    • Enum
  • Social
    • Classes
    • Storages
  • Subscription
    • Classes
  • Subscriptions
    • Storages
  • Tenants
    • Classes
    • Storages
  • Twofactorauth
    • Classes
    • Storages
  • Users
    • Classes
    • Enum
    • Storages
  • Voice
  • WebMail
    • Storages

Classes

  • CApiHelpdeskCommandCreator
  • CApiHelpdeskCommandCreatorMySQL
  • CApiHelpdeskCommandCreatorPostgreSQL
  • CApiHelpdeskDbStorage
  • CApiHelpdeskStorage

Class CApiHelpdeskDbStorage

AApiManagerStorage
Extended by CApiHelpdeskStorage
Extended by CApiHelpdeskDbStorage
Package: Helpdesk\Storages
Internal
Located at helpdesk/storages/db/storage.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Parameters

$oManager
$oManager

Overrides

CApiHelpdeskStorage::__construct
protected CHelpdeskUser|false
# _getUserBySql( string $sSql )

Parameters

$sSql

Returns

CHelpdeskUser|false
public boolean
# createUser( CHelpdeskUser & $oHelpdeskUser )

Parameters

$oHelpdeskUser

Returns

boolean
public CHelpdeskUser|false
# getUserById( integer $iIdTenant, integer $iHelpdeskUserId )

Parameters

$iIdTenant
$iHelpdeskUserId

Returns

CHelpdeskUser|false
public CHelpdeskUser|false
# getUserByIdWithoutTenantID( integer $iHelpdeskUserId )

Parameters

$iHelpdeskUserId

Returns

CHelpdeskUser|false
public CHelpdeskUser|null|false
# getUserByEmail( integer $iIdTenant, string $sEmail )

Parameters

$iIdTenant
$sEmail

Returns

CHelpdeskUser|null|false
public CHelpdeskUser|null|false
# getUserByNotificationEmail( integer $iIdTenant, string $sEmail )

Parameters

$iIdTenant
$sEmail

Returns

CHelpdeskUser|null|false
public
# getUserBySocialId( $iIdTenant, $sSocialId )
public CHelpdeskUser|false
# getUserByActivateHash( integer $iIdTenant, string $sActivateHash )

Parameters

$iIdTenant
$sActivateHash

Returns

CHelpdeskUser|false
public array
# getAgentsEmailsForNotification( integer $iIdTenant, array $aExcludeEmails = array() )

Parameters

$iIdTenant
$aExcludeEmails
Default value is empty array.

Returns

array
public integer|boolean
# getNextHelpdeskIdForMonitoring( integer $iLimitAddInMin = 5 )

Parameters

$iLimitAddInMin
Default value is 5.

Returns

integer|boolean
public integer
# getHelpdeskMailboxLastUid( integer $iIdTenant, string $sEmail )

Parameters

$iIdTenant
$sEmail

Returns

integer
public boolean
# setHelpdeskMailboxLastUid( integer $iIdTenant, string $sEmail, integer $iLastUid )

Parameters

$iIdTenant
$sEmail
$iLastUid

Returns

boolean
public boolean
# updateHelpdeskFetcherTimer( integer $iIdTenant )

Parameters

$iIdTenant

Returns

boolean
public boolean
# isUserExists( CHelpdeskUser $oHelpdeskUser )

Parameters

$oHelpdeskUser

Returns

boolean
public array|boolean
# userInformation( CHelpdeskUser $oHelpdeskUser, array $aIdList )

Parameters

$oHelpdeskUser
$aIdList

Returns

array|boolean
public boolean
# updateUser( CHelpdeskUser $oHelpdeskUser )

Parameters

$oHelpdeskUser

Returns

boolean
public boolean
# setUserAsBlocked( integer $iIdTenant, integer $iIdHelpdeskUser )

Parameters

$iIdTenant
$iIdHelpdeskUser

Returns

boolean
public boolean
# deleteUser( integer $iIdTenant, integer $iIdHelpdeskUser )

Parameters

$iIdTenant
$iIdHelpdeskUser

Returns

boolean
public boolean
# deletePosts( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread, array $aPostIds )

Parameters

$oHelpdeskUser
$oThread
$aPostIds

Returns

boolean
public boolean
# clearUnregistredUsers( )

Returns

boolean
public boolean
# addAttachments( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread, CHelpdeskPost $oHelpdeskPost, array $aAttachments )

Parameters

$oHelpdeskUser
$oHelpdeskThread
$oHelpdeskPost
$aAttachments

Returns

boolean
public boolean
# verifyThreadIdsBelongToUser( CHelpdeskUser $oHelpdeskUser, array $aThreadIds )

Parameters

$oHelpdeskUser
$aThreadIds

Returns

boolean
public boolean
# verifyPostIdsBelongToUser( CHelpdeskUser $oHelpdeskUser, array $aPostIds )

Parameters

$oHelpdeskUser
$aPostIds

Returns

boolean
public boolean
# archiveThreads( CHelpdeskUser $oHelpdeskUser, array $aThreadIds, boolean $bSetArchive = true )

Parameters

$oHelpdeskUser
$aThreadIds
$bSetArchive
Default value is true.

Returns

boolean
public boolean
# archiveOutdatedThreads( )

Returns

boolean
public boolean
# notificateOutdatedThreadID( integer & $iIdOwner )

Parameters

$iIdOwner

Returns

boolean
public CHelpdeskThread|false
# getThreadById( CHelpdeskUser $oHelpdeskUser, integer $iIdThread )

Parameters

$oHelpdeskUser
$iIdThread

Returns

CHelpdeskThread|false
public integer
# getThreadIdByHash( integer $iTenantID, string $sHash )

Parameters

$iTenantID
$sHash

Returns

integer
public boolean
# createThread( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread & $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

boolean
public boolean
# updateThread( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

boolean
public integer
# getThreadsCount( CHelpdeskUser $oHelpdeskUser, integer $iFilter = EHelpdeskThreadFilterType::All, string $sSearch = '', integer $iSearchOwner = 0 )

Parameters

$oHelpdeskUser
$iFilter
Default value is 0 EHelpdeskThreadFilterType::All.
$sSearch
Default value is empty string.
$iSearchOwner
Default value is 0.

Returns

integer
public integer
# getThreadsPendingCount( integer $iTenantId )

Parameters

$iTenantId
Default value is 0.

Returns

integer
public array|boolean
# getThreads( CHelpdeskUser $oHelpdeskUser, integer $iOffset = 0, integer $iLimit = 20, integer $iFilter = EHelpdeskThreadFilterType::All, string $sSearch = '', integer $iSearchOwner = 0 )

Parameters

$oHelpdeskUser
$iOffset
Default value is 0.
$iLimit
Default value is 20.
$iFilter
Default value is 0 EHelpdeskThreadFilterType::All.
$sSearch
Default value is empty string.
$iSearchOwner
Default value is 0.

Returns

array|boolean
public integer
# getPostsCount( CHelpdeskUser $oHelpdeskUser, CHelpdeskPost $oThread )

Parameters

$oHelpdeskUser
$oThread

Returns

integer
public integer
# getExtPostsCount( CHelpdeskUser $oHelpdeskUser, CHelpdeskPost $oThread )

Parameters

$oHelpdeskUser
$oThread

Returns

integer
public array|boolean
# getThreadsLastPostIds( CHelpdeskUser $oHelpdeskUser, array $aThreadIds )

Parameters

$oHelpdeskUser
$aThreadIds

Returns

array|boolean
public array|boolean
# getAttachments( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

array|boolean
public array|boolean
# getPosts( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oThread, integer $iStartFromId = 0, integer $iLimit = 20 )

Parameters

$oHelpdeskUser
$oThread
$iStartFromId
Default value is 0.
$iLimit
Default value is 20.

Returns

array|boolean
public boolean
# createPost( CHelpdeskUser $oHelpdeskUser, CHelpdeskPost & $oPost )

Parameters

$oHelpdeskUser
$oPost

Returns

boolean
public array|boolean
# getOnline( CHelpdeskUser $oHelpdeskUser, $iThreadID )

Parameters

$oHelpdeskUser
$iThreadID
$iThreadID

Returns

array|boolean
public boolean
# clearAllOnline( integer $iTimeoutInMin = 15 )

Parameters

$iTimeoutInMin
Default value is 15.

Returns

boolean
public boolean
# setOnline( CHelpdeskUser $oHelpdeskUser, integer $iThreadID )

Parameters

$oHelpdeskUser
$iThreadID

Returns

boolean
public boolean
# setThreadSeen( CHelpdeskUser $oHelpdeskUser, CHelpdeskThread $oHelpdeskThread )

Parameters

$oHelpdeskUser
$oHelpdeskThread

Returns

boolean

Properties summary

protected CDbStorage $oConnection

$oConnection

$oConnection

#
protected CApiHelpdeskCommandCreatorMySQL $oCommandCreator
#
AfterLogic API Documentation API documentation generated by ApiGen