Elgg  Version master
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Elgg\Database\Seeds\Groups Class Reference

Seed users. More...

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

Public Member Functions

 seed ()
 {Populate database.
Returns
mixed
} More...
 
 unseed ()
 {Removed seeded rows from database.
Returns
mixed
} More...
 
- Public Member Functions inherited from Elgg\Database\Seeds\Seed
 __construct (array $options=[])
 Seed constructor. More...
 
 getCount ()
 Get the count of the seeded entities. More...
 
 advance (int $step=1)
 Advance progressbar. More...
 
- Public Member Functions inherited from Elgg\Database\Seeds\Seedable
 createUser (array $properties=[])
 Create a new fake user. More...
 
 createGroup (array $properties=[])
 Create a new fake group. More...
 
 createObject (array $properties=[])
 Create a new fake object. More...
 
 createSite (array $properties=[])
 Create a new fake site. More...
 

Static Public Member Functions

static getType ()
 Get the (un)seeding type of this handler.
Returns
string
More...
 
- Static Public Member Functions inherited from Elgg\Database\Seeds\Seed
static register (\Elgg\Event $event)
 Register this class for seeding. More...
 
static getDefaultLimit ()
 Get the default number of content to seed. More...
 

Protected Member Functions

 getCountOptions ()
 Get options for elgg_count_entities()
Returns
array
See also
self::getCount()
More...
 

Additional Inherited Members

- Protected Attributes inherited from Elgg\Database\Seeds\Seed
int $limit
 
bool $create = false
 
int $seeded_counter = 0
 

Detailed Description

Seed users.

Definition at line 12 of file Groups.php.

Member Function Documentation

◆ getCountOptions()

Elgg\Database\Seeds\Groups::getCountOptions ( )
protected

Get options for elgg_count_entities()

Returns
array
See also
self::getCount()

Reimplemented from Elgg\Database\Seeds\Seed.

Definition at line 142 of file Groups.php.

◆ getType()

static Elgg\Database\Seeds\Groups::getType ( )
static

Get the (un)seeding type of this handler.

Returns
string

Reimplemented from Elgg\Database\Seeds\Seed.

Definition at line 135 of file Groups.php.

◆ seed()

Elgg\Database\Seeds\Groups::seed ( )

{Populate database.

Returns
mixed
}

Reimplemented from Elgg\Database\Seeds\Seed.

Definition at line 17 of file Groups.php.

◆ unseed()

Elgg\Database\Seeds\Groups::unseed ( )

{Removed seeded rows from database.

Returns
mixed
}

Reimplemented from Elgg\Database\Seeds\Seed.

Definition at line 108 of file Groups.php.


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