Webylon 3.1 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
  • Download
Version: current
  • 3.2
  • 3.1

Packages

  • auth
  • Booking
  • cart
    • shipping
    • steppedcheckout
  • Catalog
  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • newsletter
    • publishers
    • reports
    • security
    • tasks
  • Dashboard
  • DataObjectManager
  • event
  • faq
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • googlesitemaps
  • guestbook
  • installer
  • newsletter
  • None
  • photo
    • gallery
  • PHP
  • polls
  • recaptcha
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets
  • seo
    • open
      • graph
  • sfDateTimePlugin
  • spamprotection
  • stealth
    • captha
  • subsites
  • userform
    • pagetypes
  • userforms
  • webylon
  • widgets

Classes

  • BuildTask
  • CliDebugView
  • ConvertFrom26Task
  • Debug
  • DebugView
  • DeleteUnusedCustomerFilesTask
  • DevelopmentAdmin
  • FillLinkTrackingTask
  • FillOldLogDataTask
  • FindBadLinksTask
  • MigrationTask
  • MySQLDatabaseConfigurationHelper
  • PhotoGalleryMigrationTask
  • SapphireREPL
  • SS_Backtrace
  • SS_Cli
  • SS_Log
  • SS_LogEmailWriter
  • SS_LogErrorEmailFormatter
  • SS_LogErrorFileFormatter
  • SS_LogFileWriter
  • SS_ZendLog
  • TaskRunner

Class MySQLDatabaseConfigurationHelper

This is a helper class for the SS installer.

It does all the specific checking for MySQLDatabase to ensure that the configuration is setup correctly.

MySQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper
Package: sapphire\dev
Located at sapphire/dev/install/MySQLDatabaseConfigurationHelper.php

Methods summary

public boolean
# requireDatabaseFunctions( array $databaseConfig )

Ensure that the database function for connectivity is available. If it is, we assume the PHP module for this database has been setup correctly.

Ensure that the database function for connectivity is available. If it is, we assume the PHP module for this database has been setup correctly.

Parameters

$databaseConfig
array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc

Returns

boolean
boolean

Implementation of

DatabaseConfigurationHelper::requireDatabaseFunctions()
public array
# requireDatabaseServer( array $databaseConfig )

Ensure that the database server exists.

Ensure that the database server exists.

Parameters

$databaseConfig
array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc

Returns

array
Result - e.g. array('success' => true, 'error' => 'details of error')

Implementation of

DatabaseConfigurationHelper::requireDatabaseServer()
public array
# requireDatabaseConnection( array $databaseConfig )

Ensure a database connection is possible using credentials provided.

Ensure a database connection is possible using credentials provided.

Parameters

$databaseConfig
array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc

Returns

array
Result - e.g. array('success' => true, 'error' => 'details of error')

Implementation of

DatabaseConfigurationHelper::requireDatabaseConnection()
public array
# requireDatabaseOrCreatePermissions( array $databaseConfig )

Ensure that the database connection is able to use an existing database, or be able to create one if it doesn't exist.

Ensure that the database connection is able to use an existing database, or be able to create one if it doesn't exist.

Parameters

$databaseConfig
array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc

Returns

array
Result - e.g. array('success' => true, 'alreadyExists' => 'true')

Implementation of

DatabaseConfigurationHelper::requireDatabaseOrCreatePermissions()

Magic methods summary

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -
Webylon 3.1 API Docs API documentation generated by ApiGen 2.8.0