PHP Class ElggUpgrade, Elgg

These are listed in admin/upgrades and allow for ajax upgrades.
Inheritance: extends ElggObject
Afficher le fichier Open project: elgg/elgg Class Usage Examples

Méthodes publiques

Свойство Type Description
$_callable_egefps callable Do not use.

Méthodes publiques

Méthode Description
__get ( string $name ) : mixed Get an attribute or private setting value
__set ( string $name, mixed $value ) : void Set a value as private setting or attribute.
getBatch ( ) : Elgg\Upgrade\Batch | false Return instance of the class that processes the data
getCompletedTime ( ) : string Gets the time when the upgrade completed.
initializeAttributes ( ) : null Set subtype to upgrade
isCompleted ( ) : boolean Has this upgrade completed?
save ( ) : mixed Require an upgrade page.
setClass ( string $class ) : void Sets a class for the upgrade
setCompleted ( ) : boolean Mark this upgrade as completed
setCompletedTime ( integer $time = null ) : boolean Sets the timestamp for when the upgrade completed.
setID ( string $id ) : void Sets an unique id for the upgrade

Method Details

__get() public méthode

Get an attribute or private setting value
public __get ( string $name ) : mixed
$name string Name of the attribute or private setting
Résultat mixed

__set() public méthode

Attributes include title and description.
public __set ( string $name, mixed $value ) : void
$name string Name of the attribute or private_setting
$value mixed Value to be set
Résultat void

getBatch() public méthode

Return instance of the class that processes the data
public getBatch ( ) : Elgg\Upgrade\Batch | false
Résultat Elgg\Upgrade\Batch | false

getCompletedTime() public méthode

Gets the time when the upgrade completed.
public getCompletedTime ( ) : string
Résultat string

initializeAttributes() public méthode

Set subtype to upgrade
public initializeAttributes ( ) : null
Résultat null

isCompleted() public méthode

Has this upgrade completed?
public isCompleted ( ) : boolean
Résultat boolean

save() public méthode

Require an upgrade page.
public save ( ) : mixed
Résultat mixed

setClass() public méthode

Sets a class for the upgrade
public setClass ( string $class ) : void
$class string Fully qualified class name
Résultat void

setCompleted() public méthode

Mark this upgrade as completed
public setCompleted ( ) : boolean
Résultat boolean

setCompletedTime() public méthode

Sets the timestamp for when the upgrade completed.
public setCompletedTime ( integer $time = null ) : boolean
$time integer Timestamp when upgrade finished. Defaults to now.
Résultat boolean

setID() public méthode

Sets an unique id for the upgrade
public setID ( string $id ) : void
$id string Upgrade id in format :
Résultat void

Property Details

$_callable_egefps public_oe property

Do not use.
public callable $_callable_egefps
Résultat callable