PHP Class ElggUpgrade, Elgg

These are listed in admin/upgrades and allow for ajax upgrades.
Inheritance: extends ElggObject
显示文件 Open project: elgg/elgg Class Usage Examples

Public Properties

Property Type Description
$_callable_egefps callable Do not use.

Public Methods

Method 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 method

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

__set() public method

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
return void

getBatch() public method

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

getCompletedTime() public method

Gets the time when the upgrade completed.
public getCompletedTime ( ) : string
return string

initializeAttributes() public method

Set subtype to upgrade
public initializeAttributes ( ) : null
return null

isCompleted() public method

Has this upgrade completed?
public isCompleted ( ) : boolean
return boolean

save() public method

Require an upgrade page.
public save ( ) : mixed
return mixed

setClass() public method

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

setCompleted() public method

Mark this upgrade as completed
public setCompleted ( ) : boolean
return boolean

setCompletedTime() public method

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

setID() public method

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

Property Details

$_callable_egefps public_oe property

Do not use.
public callable $_callable_egefps
return callable