CoreAdmin
in package
CoreAdmin class. Interface to PMA.core for administrative operations. Does NOT apply to PMA.start / PMA.core.lite
Table of Contents
- addLocalRootDirectory() : mixed
- addS3RootDirectory() : mixed
- addSimpleForm() : mixed
- Create a new form; return Form ID
- addUser() : mixed
- Define a new user in PMA.core Returns true if user creation is successful; false if not.
- adminConnect() : mixed
- Attempt to connect to PMA.core instance; success results in a SessionID only success if the user has administrative status
- adminDisconnect() : mixed
- Attempt to disconnect from PMA.core instance; True if valid admSessionID was indeed disconnected
- denyAccessToRootDirectory() : mixed
- getCurrentInstance() : mixed
- getCurrentPmaCoreInstance() : mixed
- getInstances() : mixed
- getLicenseInfo() : mixed
- getPmaCoreInstances() : mixed
- getReversedRootDirectories() : mixed
- grantAccessToRootDirectory() : mixed
- reverseRootDirectory() : mixed
- lookup the reverse path of a root-directory
- reverseUid() : mixed
- lookup the reverse path of a UID for a specific slide
- UserExists() : mixed
Methods
addLocalRootDirectory()
public
static addLocalRootDirectory(mixed $AdmSessionID, mixed $alias, mixed $localpath[, mixed $description = "Root dir created through lib_php" ], mixed $instanceID[, mixed $isPublic = False ][, mixed $isOffline = False ]) : mixed
Parameters
- $AdmSessionID : mixed
- $alias : mixed
- $localpath : mixed
- $description : mixed = "Root dir created through lib_php"
- $instanceID : mixed
- $isPublic : mixed = False
- $isOffline : mixed = False
Return values
mixed —addS3RootDirectory()
public
static addS3RootDirectory(mixed $AdmSessionID, mixed $s3accessKey, mixed $s3secretKey, mixed $alias, mixed $s3path, mixed $instanceID[, mixed $description = "Root dir created through lib_php" ][, mixed $isPublic = False ][, mixed $isOffline = False ]) : mixed
Parameters
- $AdmSessionID : mixed
- $s3accessKey : mixed
- $s3secretKey : mixed
- $alias : mixed
- $s3path : mixed
- $instanceID : mixed
- $description : mixed = "Root dir created through lib_php"
- $isPublic : mixed = False
- $isOffline : mixed = False
Return values
mixed —addSimpleForm()
Create a new form; return Form ID
public
static addSimpleForm(mixed $name[, mixed $description = "" ][, mixed $fields = null ][, mixed $sessionID = null ]) : mixed
Parameters
- $name : mixed
- $description : mixed = ""
- $fields : mixed = null
- $sessionID : mixed = null
Return values
mixed —addUser()
Define a new user in PMA.core Returns true if user creation is successful; false if not.
public
static addUser(mixed $AdmSessionID, mixed $login, mixed $firstName, mixed $lastName, mixed $email, mixed $password[, mixed $canAnnotate = false ][, mixed $isAdmin = false ][, mixed $isSuspended = false ]) : mixed
Parameters
- $AdmSessionID : mixed
- $login : mixed
- $firstName : mixed
- $lastName : mixed
- $email : mixed
- $password : mixed
- $canAnnotate : mixed = false
- $isAdmin : mixed = false
- $isSuspended : mixed = false
Return values
mixed —adminConnect()
Attempt to connect to PMA.core instance; success results in a SessionID only success if the user has administrative status
public
static adminConnect(mixed $pmacoreURL, mixed $pmacoreAdmUsername, mixed $pmacoreAdmPassword) : mixed
Parameters
- $pmacoreURL : mixed
- $pmacoreAdmUsername : mixed
- $pmacoreAdmPassword : mixed
Return values
mixed —adminDisconnect()
Attempt to disconnect from PMA.core instance; True if valid admSessionID was indeed disconnected
public
static adminDisconnect(mixed $admSessionID) : mixed
Parameters
- $admSessionID : mixed
Return values
mixed —denyAccessToRootDirectory()
public
static denyAccessToRootDirectory(mixed $AdmSessionID, mixed $pmacoreUsername, mixed $alias) : mixed
Parameters
- $AdmSessionID : mixed
- $pmacoreUsername : mixed
- $alias : mixed
Return values
mixed —getCurrentInstance()
public
static getCurrentInstance(mixed $admSessionID) : mixed
Parameters
- $admSessionID : mixed
Return values
mixed —getCurrentPmaCoreInstance()
public
getCurrentPmaCoreInstance(mixed $AdmSessionID) : mixed
Parameters
- $AdmSessionID : mixed
Return values
mixed —getInstances()
public
static getInstances(mixed $admSessionID) : mixed
Parameters
- $admSessionID : mixed
Return values
mixed —getLicenseInfo()
public
static getLicenseInfo(mixed $admSessionID) : mixed
Parameters
- $admSessionID : mixed
Return values
mixed —getPmaCoreInstances()
public
getPmaCoreInstances(mixed $AdmSessionID) : mixed
Parameters
- $AdmSessionID : mixed
Return values
mixed —getReversedRootDirectories()
public
static getReversedRootDirectories(mixed $admSessionID) : mixed
Parameters
- $admSessionID : mixed
Return values
mixed —grantAccessToRootDirectory()
public
static grantAccessToRootDirectory(mixed $AdmSessionID, mixed $pmacoreUsername, mixed $alias) : mixed
Parameters
- $AdmSessionID : mixed
- $pmacoreUsername : mixed
- $alias : mixed
Return values
mixed —reverseRootDirectory()
lookup the reverse path of a root-directory
public
static reverseRootDirectory(mixed $admSessionID, mixed $alias) : mixed
Parameters
- $admSessionID : mixed
- $alias : mixed
Return values
mixed —reverseUid()
lookup the reverse path of a UID for a specific slide
public
static reverseUid(mixed $admSessionID, mixed $slideRefUid) : mixed
Parameters
- $admSessionID : mixed
- $slideRefUid : mixed
Return values
mixed —UserExists()
public
static UserExists(mixed $AdmSessionID, mixed $login) : mixed
Parameters
- $AdmSessionID : mixed
- $login : mixed