PHP Class Pantheon\Terminus\Collections\OrganizationUserMemberships

Inheritance: extends TerminusCollection

Show file Open project: pantheon-systems/terminus Class Usage Examples

Public Properties

Property	Type	Description
$organization	Organization

Protected Properties

Property	Type	Description
$collected_class	string
$paged	boolean

Public Methods

Method	Description
__construct ( array $options = [] )	Instantiates the collection, sets param members as properties
create ( string $uuid, string $role ) : Workflow	Adds a user to this organization
get ( string $id ) : OrganizationUserMembership	Retrieves models by either user ID, email address, or full name
getOrganization ( ) : Organization

Method Details

__construct() public method

Instantiates the collection, sets param members as properties

public __construct ( array $options = [] )
$options	array	To be set to $this->key

create() public method

Adds a user to this organization

public create ( string $uuid, string $role ) : Workflow
$uuid	string	UUID of user user to add to this organization
$role	string	Role to assign to the new member
return	Workflow	$workflow

get() public method

Retrieves models by either user ID, email address, or full name

public get ( string $id ) : OrganizationUserMembership
$id	string	Either a user ID, email address, or full name
return	OrganizationUserMembership

getOrganization() public method

public getOrganization ( ) : Organization
return	Organization

Property Details

$collected_class protected property

protected string $collected_class
return	string

$organization public property

public Organization $organization
return	Organization

$paged protected property

protected bool $paged
return	boolean