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

  • CApiTenantsManager

Class CApiTenantsManager

CApiTenantsManager class summary

AApiManagerWithStorage
Extended by CApiTenantsManager
Package: Tenants
Located at tenants/manager.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager, $sForcedStorage = '' )

Creates a new instance of the object.

Creates a new instance of the object.

Parameters

$oManager
$oManager
$sForcedStorage
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
# getDefaultGlobalTenant( )

Returns

CTenant
public CTenant|null
# getTenantById( mixed $mTenantId, boolean $bIdIsHash = false )

Parameters

$mTenantId
$bIdIsHash
Default value is false.

Returns

CTenant|null
public CTenant
# getTenantByHash( string $sTenantHash )

Parameters

$sTenantHash

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, boolean $bUseCache = false )

Parameters

$iIdTenant
$bUseCache
Default value is false.

Returns

string
public boolean
# isTenantExists( CTenant $oTenant )

Parameters

$oTenant

Returns

boolean
public array|boolean
# getTenantDomains( integer $iTenantId )

Parameters

$iTenantId

Returns

array|boolean
public boolean
# createTenant( CTenant & $oTenant )

Parameters

$oTenant

Returns

boolean
public boolean
# updateTenant( CTenant $oTenant )

Parameters

$oTenant

Returns

boolean

Throws

CApiManagerException(Errs::TenantsManager_QuotaLimitExided)
1707
CApiManagerException(Errs::TenantsManager_TenantUpdateFailed)
1703

$oException
public false
# updateTenantMainCapa( integer $iTenantID )

Parameters

$iTenantID

Returns

false
public boolean
# allocateFileUsage( CTenant $oTenant, integer $iNewAllocatedSizeInBytes )

Parameters

$oTenant
$iNewAllocatedSizeInBytes

Returns

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

Parameters

$iTenantID
$iExceptUserId
Default value is null.

Returns

array|boolean
public array
# getTenantsIdsByChannelId( integer $iChannelId )

Parameters

$iChannelId

Returns

array
public boolean
# deleteTenantsByChannelId( integer $iChannelId )

Parameters

$iChannelId

Returns

boolean
public boolean
# deleteTenant( CTenant $oTenant )

Parameters

$oTenant

Returns

boolean

Throws


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

Parameters

$iIdTenant

Returns

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

Parameters

$iIdSocial

Returns

CTenantSocials|null
public CTenantSocials|null
# getSocialByName( integer $iIdTenant, string $sSocialName )

Parameters

$iIdTenant
$sSocialName

Returns

CTenantSocials|null
public boolean
# isSocialExists( CTenantSocials $oSocial )

Parameters

$oSocial

Returns

boolean
public boolean
# createSocial( CTenantSocials $oSocial )

Parameters

$oSocial

Returns

boolean
public boolean
# deleteSocial( CTenantSocials $oSocial )

Parameters

$oSocial

Returns

boolean
public boolean
# deleteSocialsByTenantId( integer $iTenanatId )

Parameters

$iTenanatId

Returns

boolean
public boolean
# updateSocial( CTenantSocials $oSocial )

Parameters

$oSocial

Returns

boolean

Properties summary

public static array $aTenantNameCache
# array()
AfterLogic API Documentation API documentation generated by ApiGen