PHP Class Pantheon\Terminus\Models\SiteUserMembership

Inheritance: extends TerminusModel, implements League\Container\ContainerAwareInterface, use trait League\Container\ContainerAwareTrait
Datei anzeigen Open project: pantheon-systems/terminus

Public Properties

Property Type Description
$site Site
$user User

Protected Properties

Property Type Description
$user_data stdClass

Public Methods

Method Description
__construct ( object $attributes = null, array $options = [] ) : SiteUserMembership Object constructor
delete ( ) : Workflow Remove membership, either org or user
getSite ( ) : Site
getUser ( ) : User Get the user for this membership
setRole ( string $role ) : Workflow Changes the role of the given member

Method Details

__construct() public method

Object constructor
public __construct ( object $attributes = null, array $options = [] ) : SiteUserMembership
$attributes object Attributes of this model
$options array Options with which to configure this model
return SiteUserMembership

delete() public method

Remove membership, either org or user
public delete ( ) : Workflow
return Workflow

getSite() public method

public getSite ( ) : Site
return Site

getUser() public method

Get the user for this membership
public getUser ( ) : User
return User

setRole() public method

Changes the role of the given member
public setRole ( string $role ) : Workflow
$role string Desired role for this member
return Workflow

Property Details

$site public_oe property

public Site,Pantheon\Terminus\Models $site
return Site

$user public_oe property

public User,Pantheon\Terminus\Models $user
return User

$user_data protected_oe property

protected stdClass $user_data
return stdClass