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

  • CApiContactsmainCarddavStorage
  • CApiContactsmainCommandCreatorMySQL
  • CApiContactsmainCommandCreatorPostgreSQL
  • CApiContactsmainDbStorage
  • CApiContactsmainLdapStorage
  • CApiContactsmainNodbStorage
  • CApiContactsmainSabredavStorage

Class CApiContactsmainCommandCreatorMySQL

api_CommandCreator
Extended by CApiContactsmainCommandCreator
Extended by CApiContactsmainCommandCreatorMySQL

Direct known subclasses

CApiContactsmainCommandCreatorPostgreSQL

Package: Contacts\Storages
Located at contactsmain/storages/db/command_creator.php

Methods summary

protected string
# getContactByWhere( integer|null $iUserId, string $sWhere, boolean $bIgnoreHideInGab = false, integer $iSharedTenantId = null, boolean $bIgnoreAutoCreate = false )

Parameters

$iUserId
$sWhere
$bIgnoreHideInGab
= false
$iSharedTenantId
= null
$bIgnoreAutoCreate
= false

Returns

string

Overrides

CApiContactsmainCommandCreator::getContactByWhere
protected string
# getGroupByWhere( string $sWhere )

Parameters

$sWhere

Returns

string

Overrides

CApiContactsmainCommandCreator::getGroupByWhere
public boolean
# GetContactItemsWithoutOrder( integer $iUserId, integer $iOffset, integer $iRequestLimit )

Parameters

$iUserId
$iOffset
$iRequestLimit

Returns

boolean
| array
public string
# GetAllContactsNamesWithPhones( integer $iUserId, integer $iSharedTenantId = 0, boolean $bAddGlobal = true )

Parameters

$iUserId
$iSharedTenantId
= 0
$bAddGlobal
= true

Returns

string
public string
# GetSuggestContactItems( integer $iUserId, string $sSearch, integer $iRequestLimit, boolean $bPhoneOnly = false, integer $iSharedTenantId = null, boolean $bAll = false )

Parameters

$iUserId
$sSearch
$iRequestLimit
$bPhoneOnly
= false
$iSharedTenantId
= null
$bAll
= false

Returns

string
public string
# GetSuggestGroupItems( integer $iUserId, string $sSearch, integer $iRequestLimit )

Parameters

$iUserId
$sSearch
$iRequestLimit

Returns

string
public string
# GetContactItems( integer $iUserId, integer $iSortField, integer $iSortOrder, integer $iOffset, integer $iRequestLimit, string $sSearch, string $sFirstCharacter, integer $iGroupId, integer $iSharedTenantId = null, boolean $bAll = false )

Parameters

$iUserId
$iSortField
$iSortOrder
$iOffset
$iRequestLimit
$sSearch
$sFirstCharacter
$iGroupId
$iSharedTenantId
= null
$bAll
= false

Returns

string
public string
# GetGroupItems( integer $iUserId, integer $iSortField, integer $iSortOrder, integer $iOffset, integer $iRequestLimit, string $sSearch, string $sFirstCharacter, integer $iContactId )

Parameters

$iUserId
$iSortField
$iSortOrder
$iOffset
$iRequestLimit
$sSearch
$sFirstCharacter
$iContactId

Returns

string
public string
# GetContactItemsCount( integer $iUserId, string $sSearch, integer $sFirstCharacter, integer $iGroupId, boolean $iSharedTenantId = null, $bAll = false )

Parameters

$iUserId
$sSearch
$sFirstCharacter
$iGroupId
$iGroupId
$iSharedTenantId = null
$iSharedTenantId
$bAll = false
$bAll

Returns

string
public string
# GetGroupItemsCount( integer $iUserId, string $sSearch, string $sFirstCharacter )

Parameters

$iUserId
$sSearch
$sFirstCharacter

Returns

string
public string
# ConvertedContactLocalId( CAccount $oAccount, mixed $mContactId, integer $iContactType )

Parameters

$oAccount
$mContactId
$iContactType

Returns

string
public string
# ConvertedContactLocalIdCollection( CAccount $oAccount, integer $iContactType )

Parameters

$oAccount
$iContactType

Returns

string
public string
# ContactIdsLinkedToGroups( array $aContactsIds )

Parameters

$aContactsIds

Returns

string
public boolean
# FlushContacts( )

Returns

boolean
public string
# AddContactsToGroup( CGroup $oGroup, array $aContactIds )

Parameters

$oGroup
$aContactIds

Returns

string
public string
# RemoveContactsFromGroup( CGroup $oGroup, array $aContactIds )

Parameters

$oGroup
$aContactIds

Returns

string
public string
# GetGlobalContactById( integer $iUserId, integer $mContactId )

Parameters

$iUserId
$mContactId

Returns

string
public boolean
# GetGroupEvents( integer $iGroupId )

Parameters

$iGroupId

Returns

boolean
public boolean
# GetGroupEvent( string $sCalendarId, string $sEventId )

Parameters

$sCalendarId
$sEventId

Returns

boolean
public string
# AddEventToGroup( integer $iGroupId, string $sCalendarId, string $sEventId )

Parameters

$iGroupId
$sCalendarId
$sEventId

Returns

string
public string
# RemoveEventFromGroup( integer $iGroupId, string $sCalendarId, string $sEventId )

Parameters

$iGroupId
$sCalendarId
$sEventId

Returns

string
public string
# RemoveEventFromAllGroups( string $sCalendarId, string $sEventId )

Parameters

$sCalendarId
$sEventId

Returns

string

Methods inherited from CApiContactsmainCommandCreator

ClearContactsIdsByExceptGroupsIds(), ClearContactsIdsByGroupsIds(), ClearGroupsIdsByContactsIds(), ClearGroupsIdsByExceptContactsIds(), CreateAutoCreateContact(), CreateContact(), CreateGroup(), DeleteAllContacts(), DeleteAllGroups(), DeleteAllGroupsContacts(), DeleteAutoCreateContacts(), DeleteContacts(), DeleteGroups(), DeleteUserGlobalContact(), DeleteUserGlobalSubContact(), GetContactByEmail(), GetContactById(), GetContactByStrId(), GetContactByTypeId(), GetContactGroupsIds(), GetExistingEmails(), GetGroupById(), GetGroupByName(), GetGroupByStrId(), GetSharedContactIds(), UpdateContact(), UpdateContactFrequencyByEmails(), UpdateContactUserId(), UpdateGroup(), UpdateGroupIdsInContact(), clearGroupContactsExceptIds(), clearGroupContactsIds(), resetContactFrequency(), sharedItemsSqlHelper()

AfterLogic API Documentation API documentation generated by ApiGen