Class CApiUsersStorage

AApiManagerStorage

CApiUsersStorage

Direct known subclasses

CApiUsersDbStorage, CApiUsersNodbStorage

Package: Users\Storages
Internal
Located at users/storages/default.php

Methods summary

`public`	# `__construct( CApiGlobalManager $sStorageName, CApiGlobalManager & $oManager )` Parameters `$sStorageName` $oManager `$oManager`
`public CAccount`	# `getAccountByEmail( string $sEmail )` Parameters `$sEmail` Returns `CAccount`
`public CAccount`	# `getAccountById( integer $iAccountId, boolean $bIdIsMd5 = false )` Parameters `$iAccountId` `$bIdIsMd5` Returns `CAccount`
`public CUser`	# `getUserById( integer $iUserId )` Parameters `$iUserId` Returns `CUser`
`public integer`	# `getDefaultAccountDomainId( integer $iUserId )` Parameters `$iUserId` Returns integer
`public integer`	# `getDefaultAccountId( integer $iUserId )` Parameters `$iUserId` Returns integer
`public integer`	# `getAccountUsedSpace( string $sEmail )` Parameters `$sEmail` Returns integer
`public array\|boolean`	# `getAccountIdentities( integer $IdAccount )` Parameters `$IdAccount` Returns array\|boolean
`public CIdentity`	# `getIdentity( integer $iIdentityId )` Parameters `$iIdentityId` Returns `CIdentity` \| bool
`public boolean`	# `createIdentity( CIdentity & $oIdentity )` Parameters `$oIdentity` $oIdentity Returns boolean
`public boolean`	# `deleteIdentity( integer $iIdentityId )` Parameters `$iIdentityId` Returns boolean
`public boolean`	# `updateIdentity( CIdentity $oIdentity )` Parameters `$oIdentity` Returns boolean
`public boolean`	# `createAccount( CAccount & $oAccount )` Parameters `$oAccount` $oAccount Returns boolean
`public boolean`	# `enableAccounts( array $aAccountsIds, boolean $bIsEnabled )` Parameters `$aAccountsIds` `$bIsEnabled` Returns boolean
`public boolean`	# `updateAccount( CAccount $oAccount )` Parameters `$oAccount` Returns boolean
`public boolean`	# `updateAccountLastLoginAndCount( integer $iUserId )` Parameters `$iUserId` Returns boolean
`public boolean`	# `accountExists( CAccount $oAccount )` Parameters `$oAccount` Returns boolean
`public boolean`	# `deleteAccount( array $iAccountsId )` Parameters `$iAccountsId` Returns boolean
`public array`	# `getAccountIdList( integer $iUserId )` Parameters `$iUserId` Returns array \| false
`public array`	# `getUserAccounts( integer $iUserId )` Parameters `$iUserId` Returns array \| false array(int IdAccount => array(bool isDefaultAccount, string email, string friendlyName, string signature, int isSignatureHtml, int isSignatureAdded))
`public array`	# `getUserList( integer $iDomainId, integer $iPage, integer $iUsersPerPage, string $sOrderBy = 'name', boolean $bAscOrderType = true, string $sSearchDesc = '' )` Parameters `$iDomainId` `$iPage` `$iUsersPerPage` `$sOrderBy` = 'email' `$bAscOrderType` = true `$sSearchDesc` = '' Returns array \| false [IdAccount => [IsMailingList, Email, FriendlyName, IsDisabled, IdUser, StorageQuota, LastLogin]]
`public array`	# `getDefaultAccountIdList( integer $iDomainId, integer $iPage, integer $iUsersPerPage )` Parameters `$iDomainId` `$iPage` `$iUsersPerPage` Returns array \| false
`public array`	# `getDefaultAccountList( )` Returns array \| false
`public integer`	# `getUsersCountForDomain( integer $iDomainId, string $sSearchDesc = '' )` Parameters `$iDomainId` `$sSearchDesc` = '' Returns integer \| false
`public integer`	# `getUsersCountForTenant( integer $iTenantId )` Parameters `$iTenantId` Returns integer \| false
`public integer`	# `getTotalUsersCount( )` Returns integer
`public boolean`	# `createCalUser( CCalUser & $oCalUser )` Parameters `$oCalUser` $oCalUser Returns boolean
`public CCalUser`	# `getCalUser( integer $iUserId )` Parameters `$iUserId` Returns `CCalUser`
`public boolean`	# `deleteCalUser( integer $iUserId )` Parameters `$iUserId` Returns boolean
`public boolean`	# `updateCalUser( CCalUser $oCalUser )` Parameters `$oCalUser` Returns boolean

Packages

Classes

Class CApiUsersStorage

Direct known subclasses

Methods summary

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns