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

  • CApiTenantsCommandCreator
  • CApiTenantsCommandCreatorMySQL
  • CApiTenantsCommandCreatorPostgreSQL
  • CApiTenantsDbStorage
  • CApiTenantsNodbStorage
  • CApiTenantsStorage

Class CApiTenantsDbStorage

AApiManagerStorage
Extended by CApiTenantsStorage
Extended by CApiTenantsDbStorage
Package: Tenants\Storages
Located at tenants/storages/db/storage.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Parameters

$oManager
$oManager

Overrides

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

Parameters

$sOrderBy

Returns

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

Parameters

$iPage
$iTenantsPerPage
$sOrderBy
Default value is 'login'.
$bOrderType
Default value is true.
$sSearchDesc
Default value is empty string.

Returns

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

Parameters

$sSearchDesc
Default value is empty string.

Returns

integer|false
public integer
# getTenantAllocatedSize( integer $iTenantId )

Parameters

$iTenantId

Returns

integer
public CTenant
# getTenantById( mixed $mTenantId, boolean $bIdIsMd5 = false )

Parameters

$mTenantId
$bIdIsMd5
Default value is false.

Returns

CTenant
public integer
# getTenantIdByLogin( string $sTenantLogin, string $sTenantPassword = null )

Parameters

$sTenantLogin
$sTenantPassword
Default value is null.

Returns

integer
public integer
# getTenantIdByDomainId( integer $iDomainId )

Parameters

$iDomainId

Returns

integer
public string
# getTenantLoginById( integer $iIdTenant )

Parameters

$iIdTenant

Returns

string
public array
# getTenantsIdsByChannelId( integer $iChannelId )

Parameters

$iChannelId

Returns

array
public array
# getSubscriptionUserUsage( integer $iTenantId, integer|null $iExceptUserId = null )

Parameters

$iTenantId
$iExceptUserId
Default value is null.

Returns

array
public boolean
# isTenantExists( CTenant $oTenant )

Parameters

$oTenant

Returns

boolean
public array
# getTenantDomains( integer $iTenantId )

Parameters

$iTenantId

Returns

array
public boolean
# createTenant( CTenant & $oTenant )

Parameters

$oTenant

Returns

boolean
public boolean
# updateTenant( CTenant $oTenant )

Parameters

$oTenant

Returns

boolean
public boolean
# allocateFileUsage( CTenant $oTenant, integer $iAllocatedSizeInBytes )

Parameters

$oTenant
$iAllocatedSizeInBytes

Returns

boolean
public boolean
# deleteTenant( integer $iTenantId )

Parameters

$iTenantId

Returns

boolean
public boolean
# deleteTenants( array $aTenantIds )

Parameters

$aTenantIds

Returns

boolean
public boolean
# deleteTenantSubscriptions( integer $iTenantId )

Parameters

$iTenantId

Returns

boolean
public boolean
# updateTenantMainCapa( integer $iTenantId, $sCapa )

Parameters

$iTenantId
$sCapa

Returns

boolean
public array|false
# getSocials( integer $iIdTenant )

Parameters

$iIdTenant

Returns

array|false
public array|false
# getSocialById( integer $iIdSocial )

Parameters

$iIdSocial

Returns

array|false
public array|false
# getSocialByName( integer $iIdTenant, string $sSocialName )

Parameters

$iIdTenant
$sSocialName

Returns

array|false
public boolean
# isSocialExists( CTenantSocials $oSocial )

Parameters

$oSocial

Returns

boolean
public boolean
# createSocial( CTenantSocials & $oSocial )

Parameters

$oSocial

Returns

boolean
public boolean
# deleteSocial( integer $iIdSocial )

Parameters

$iIdSocial

Returns

boolean
public boolean
# deleteSocialsByTenantId( integer $iTenanatId )

Parameters

$iTenanatId

Returns

boolean
public boolean
# updateSocial( CTenantSocials $oSocial )

Parameters

$oSocial

Returns

boolean

Properties summary

protected CDbStorage $oConnection

$oConnection

$oConnection

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