Elgg  Version 3.0
Public Member Functions | List of all members
Elgg\Database\Seeds\Seed Class Reference

Abstract seed. More...

Inheritance diagram for Elgg\Database\Seeds\Seed:
Elgg\Database\Seeds\Seedable Elgg\Database\Seeds\Groups Elgg\Database\Seeds\Users

Public Member Functions

 __construct ($limit=null)
 Seed constructor. More...
 
 seed ()
 Populate database. More...
 
 unseed ()
 Removed seeded rows from database. More...
 
- Public Member Functions inherited from Elgg\Database\Seeds\Seedable
 createUser (array $attributes=[], array $metadata=[])
 Create a new fake user. More...
 
 createGroup (array $attributes=[], array $metadata=[])
 Create a new fake group. More...
 
 createObject (array $attributes=[], array $metadata=[])
 Create a new fake object. More...
 
 createSite (array $attributes=[], array $metadata=[])
 Create a new fake site. More...
 

Detailed Description

Abstract seed.

Plugins should extend this class to create their own seeders, add use 'seeds','database' plugin hook to add their seed to the sequence.

Definition at line 13 of file Seed.php.

Constructor & Destructor Documentation

Elgg\Database\Seeds\Seed::__construct (   $limit = null)

Seed constructor.

Parameters
int$limitNumber of item to seed

Definition at line 23 of file Seed.php.

Member Function Documentation

Elgg\Database\Seeds\Seed::seed ( )
abstract

Populate database.

Returns
mixed
Elgg\Database\Seeds\Seed::unseed ( )
abstract

Removed seeded rows from database.

Returns
mixed

The documentation for this class was generated from the following file: