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

  • CApiDbCommandCreator
  • CApiDbCommandCreatorMySQL
  • CApiDbCommandCreatorPostgreSQL
  • CApiDbDbStorage
  • CApiDbNodbStorage
  • CApiDbStorage

Class CApiDbDbStorage

AApiManagerStorage
Extended by CApiDbStorage
Extended by CApiDbDbStorage
Package: Db\Storages
Located at db/storages/db/storage.php

Methods summary

public
# __construct( CApiGlobalManager & $oManager )

Parameters

$oManager
$oManager

Overrides

CApiDbStorage::__construct
public boolean
# testConnection( )

Returns

boolean

Overrides

CApiDbStorage::testConnection
public boolean
# createDatabase( )

Returns

boolean

Throws

CApiBaseException(Errs::Db_ExceptionError)
3001

Overrides

CApiDbStorage::createDatabase
public boolean
# syncTables( mixed $fVerboseCallback, boolean $bDropFields = false, boolean $bDropIndex = false )

Parameters

$fVerboseCallback
$bDropFields
Default value is false.
$bDropIndex
Default value is false.

Returns

boolean

Overrides

CApiDbStorage::syncTables
protected boolean
# syncTable( CDbTable $oTable, mixed $fVerboseCallback, boolean $bDropFields = false, boolean $bDropIndex = false )

Parameters

$oTable
$fVerboseCallback
$bDropFields
Default value is false.
$bDropIndex
Default value is false.

Returns

boolean
public boolean
# isAUsersTableExists( )

Returns

boolean

Overrides

CApiDbStorage::isAUsersTableExists
public boolean
# createTables( )

Returns

boolean

Overrides

CApiDbStorage::createTables
public string
# getSqlSchemaAsString( boolean $bAddDropTable = false )

Parameters

$bAddDropTable
Default value is false.

Returns

string

Overrides

CApiDbStorage::getSqlSchemaAsString
public array
# getSqlSchemaAsArray( boolean $bAddDropTable = false )

Parameters

$bAddDropTable
Default value is false.

Returns

array

Overrides

CApiDbStorage::getSqlSchemaAsArray
public array
# getSqlFunctionsAsArray( boolean $bAddDropFunction = false )

Parameters

$bAddDropFunction
Default value is false.

Returns

array

Overrides

CApiDbStorage::getSqlFunctionsAsArray

Properties summary

protected CDbStorage $oConnection

$oConnection

$oConnection

#
protected CApiDomainsCommandCreator $oCommandCreator
#
protected IDbHelper $oHelper
#
AfterLogic API Documentation API documentation generated by ApiGen