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

  • CApiChannelsCommandCreator
  • CApiChannelsCommandCreatorMySQL
  • CApiChannelsCommandCreatorPostgreSQL
  • CApiChannelsDbStorage
  • CApiChannelsNodbStorage
  • CApiChannelsStorage

Class CApiChannelsDbStorage

AApiManagerStorage
Extended by CApiChannelsStorage
Extended by CApiChannelsDbStorage
Package: Channels\Storages
Located at channels/storages/db/storage.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Parameters

$oManager
$oManager

Overrides

CApiChannelsStorage::__construct
protected string
# _dbOrderBy( string $sOrderBy )

Parameters

$sOrderBy

Returns

string
public array|false
# getChannelList( integer $iPage, integer $iChannelsPerPage, string $sOrderBy = 'Login', boolean $bOrderType = true, string $sSearchDesc = '' )

Parameters

$iPage
$iChannelsPerPage
$sOrderBy
Default value is login
$bOrderType
Default value is true
$sSearchDesc
Default value is empty string

Returns

array|false
[Id => [Login, Description]]
public integer
# getChannelCount( string $sSearchDesc = '' )

Parameters

$sSearchDesc
Default value is empty string

Returns

integer
| false
public CChannel|null
# getChannelById( integer $iChannelId )

Parameters

$iChannelId

Returns

CChannel|null
public integer
# getChannelIdByLogin( string $sChannelLogin )

Parameters

$sChannelLogin

Returns

integer
public boolean
# channelExists( CChannel $oChannel )

Parameters

$oChannel

Returns

boolean
public boolean
# createChannel( CChannel & $oChannel )

Parameters

$oChannel

Returns

boolean
public boolean
# updateChannel( CChannel $oChannel )

Parameters

$oChannel

Returns

boolean
public boolean
# deleteChannel( integer $iChannelId )

Parameters

$iChannelId

Returns

boolean
public boolean
# deleteChannels( array $aChannelsIds )

Parameters

$aChannelsIds

Returns

boolean

Properties summary

protected CDbStorage $oConnection

$oConnection

$oConnection

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