PHP Class Prose\BaseCleanup

Author: Michael Heap ([email protected])
Inheritance: extends Prose
Show file Open project: datasift/storyplayer

Protected Properties

Property Type Description
$key string key The key of the table we're working with
$table BaseObject The actual table that we're working with

Public Methods

Method Description
__construct ( StoryTeller $st, array $args = [] ) : parent::__construct __construct
shutdown ( ) : void shutdown
startup ( ) : void startup

Protected Methods

Method Description
getTable ( )
removeTablesIfEmpty ( ) : void removeTableIfEmpty

Method Details

__construct() public method

__construct
public __construct ( StoryTeller $st, array $args = [] ) : parent::__construct
$st DataSift\Storyplayer\PlayerLib\StoryTeller The StoryTeller object
$args array Any arguments to be used in this Prose module
return parent::__construct

getTable() protected method

protected getTable ( )

removeTablesIfEmpty() protected method

Remove an entry in the runtime config if it is empty
protected removeTablesIfEmpty ( ) : void
return void

shutdown() abstract public method

The function to run after stories are run
abstract public shutdown ( ) : void
return void

startup() abstract public method

The function to run before stories are run
abstract public startup ( ) : void
return void

Property Details

$key protected property

key The key of the table we're working with
protected string $key
return string

$table protected property

The actual table that we're working with
protected BaseObject $table
return BaseObject