PHP Class Pantheon\Terminus\Collections\SiteOrganizationMemberships

Inheritance: extends SiteOwnedCollection
Show file Open project: pantheon-systems/terminus

Protected Properties

Property Type Description
$collected_class string
$paged boolean
$url string

Public Methods

Method Description
create ( string $name, string $role ) : Workflow Adds this org as a member to the site
findByName ( string $name ) : SiteOrganizationMembership | null Returns UUID of organization with given name
get ( string $id ) : OrganizationSiteMembership Retrieves the model with organization of the given UUID or name
getUUID ( string $name ) : SiteOrganizationMembership | null Returns UUID of organization with given name

Method Details

create() public method

Adds this org as a member to the site
public create ( string $name, string $role ) : Workflow
$name string Name of site to add org to
$role string Role for supporting organization to take
return Pantheon\Terminus\Models\Workflow

findByName() public method

Returns UUID of organization with given name
public findByName ( string $name ) : SiteOrganizationMembership | null
$name string A name to search for
return Pantheon\Terminus\Models\SiteOrganizationMembership | null

get() public method

Retrieves the model with organization of the given UUID or name
public get ( string $id ) : OrganizationSiteMembership
$id string UUID or name of desired site membership instance
return Pantheon\Terminus\Models\OrganizationSiteMembership

getUUID() public method

Returns UUID of organization with given name
public getUUID ( string $name ) : SiteOrganizationMembership | null
$name string A name to search for
return Pantheon\Terminus\Models\SiteOrganizationMembership | null

Property Details

$collected_class protected property

protected string $collected_class
return string

$paged protected property

protected bool $paged
return boolean

$url protected property

protected string $url
return string