Overview

Namespaces

  • malkusch
    • bav
  • PHP

Classes

  • Agency
  • AutomaticUpdatePlan
  • BAV
  • Configuration
  • ConfigurationRegistry
  • DataBackendContainer
  • DefaultConfiguration
  • DoctrineBackendContainer
  • FileDataBackendContainer
  • LogUpdatePlan
  • PDODataBackendContainer
  • UpdatePlan
  • Overview
  • Namespace
  • Class
  • Tree

Class Configuration

Configuration

Direct known subclasses

malkusch\bav\DefaultConfiguration
Namespace: malkusch\bav
License: GPL
Author: Markus Malkusch <markus@malkusch.de>
See: malkusch\bav\ConfigurationRegistry
Link: Donations
Api
Located at Configuration.php
Methods summary
public
# setUpdatePlan( malkusch\bav\UpdatePlan $updatePlan = null )

Sets the update plan.

Sets the update plan.

Set to null if you don't want to use an update plan.

public malkusch\bav\UpdatePlan|null
# getUpdatePlan( )

Gets the update plan.

Gets the update plan.

Returns

malkusch\bav\UpdatePlan|null
public
# setAutomaticInstallation( boolean $automaticInstallation )

Turns automatic installation on or off.

Turns automatic installation on or off.

If automatic installation is activated malkusch\bav\DataBackendContainer will check if it is installed and if not install the backend.

Parameters

$automaticInstallation
boolean
$automaticInstallation Set true to turn installation on

See

DataBackend::install()
public boolean
# isAutomaticInstallation( )

Returns true if automatic installation is activated.

Returns true if automatic installation is activated.

Returns

boolean
public
# setDataBackendContainer( malkusch\bav\DataBackendContainer $backendContainer )

Sets the data malkusch\bav\DataBackendContainer.

Sets the data malkusch\bav\DataBackendContainer.

public malkusch\bav\DataBackendContainer
# getDataBackendContainer( )

Returns the malkusch\bav\DataBackendContainer.

Returns the malkusch\bav\DataBackendContainer.

Returns

malkusch\bav\DataBackendContainer
public
# setEncoding( malkusch\bav\Encoding $encoding )

Sets the encoding.

Sets the encoding.

public Encoding
# getEncoding( )

Returns the encoding.

Returns the encoding.

Returns

Encoding
public
# setTempDirectory( string $tempDirectory )

Sets the temporary directory.

Sets the temporary directory.

If you set a temporary directory BAV will use this for temporary files. This option is optional. If it is not set the system's path will be used.

The temporary directory is used for the installation and update process.

Parameters

$tempDirectory
string
$tempDirectory
public string
# getTempDirectory( )

Returns the optional configured temporary directory.

Returns the optional configured temporary directory.

Returns

string
API documentation generated by ApiGen 2.8.0