API Documentation
Back to top  

AutoUpdaterSettings

Class AutoUpdaterSettings

package

Default

Methods

AutoUpdaterSettings constructor.

__construct(\AutoUpdaterCurlClient $curl, \CI_DB_query_builder $db)

Arguments

$curl

\AutoUpdaterCurlClient

$db

\CI_DB_query_builder

Returns the directory path for the backups to be created.

backupsDirectory() : string

Response

string

Creates a test file for the permission check.

createTestFile(string $path, integer $chmod)

Arguments

$path

string

$chmod

integer

Return the data processing accepting flag.

dataProcessingAccepted() : boolean

Response

boolean

True, if an admin accepted the data processing, otherwise false.

Determines the needed file permissions for writing operations.

determineCorrectFilePermission() : integer

Response

integer

Determines the url of the feedback server.

determineFeedbackServerUrl() : integer

Response

integer

Determines the url of the update server.

determineUpdateServerUrl() : integer

Response

integer

Returns the url of the update server.

feedbackServerUrl() : string

Response

string

Returns a configuration value for a given configuration key.

getGmConf(string $key) : mixed

Arguments

$key

string

Response

mixed

Checks the accessibility of a file by using curl.

isAccessible(string $url) : boolean

Arguments

$url

string

URL to the file.

Response

boolean

True, if the file is accessible by curl, otherwise false.

Returns the correct chmod value for normal directory permission.

normalDirectoryPermissionValue() : integer

Response

integer

Returns the correct chmod value for normal file permission.

normalFilePermissionValue() : integer

Response

integer

Returns the base directory path of the shop.

shopBaseDirectory() : string

Response

string

Returns the directory path for the updates to be downloaded before moved into the shop.

updatesDirectory() : string

Response

string

Returns the url of the update server.

updateServerUrl() : string

Response

string

Returns the correct chmod value for writing permission.

writingPermissionValue() : integer

Response

integer

Properties

curl

curl : \AutoUpdaterCurlClient
var

Type(s)

\AutoUpdaterCurlClient

db

db : \CI_DB_query_builder
var

Type(s)

\CI_DB_query_builder

dataProcessingAccepted

dataProcessingAccepted : boolean
var

Type(s)

boolean

shopBaseDirectory

shopBaseDirectory : string
var

Type(s)

string

backupsDirectory

backupsDirectory : string
var

Type(s)

string

updatesDirectory

updatesDirectory : string
var

Type(s)

string

updateServerUrl

updateServerUrl : string
var

Type(s)

string

feedbackServerUrl

feedbackServerUrl : string
var

Type(s)

string

writingPermissionValue

writingPermissionValue : integer
var

Type(s)

integer