PHP Класс Pantheon\Terminus\Collections\OrganizationSiteMemberships

Наследование: extends TerminusCollection
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$organization Pantheon\Terminus\Models\Organization

Защищенные свойства (Protected)

Свойство Тип Описание
$collected_class string
$paged boolean

Открытые методы

Метод Описание
__construct ( array $options = [] ) : OrganizationSiteMemberships Instantiates the collection
create ( Site $site ) : Workflow Adds a site to this organization
get ( string $id ) : OrganizationSiteMembership Retrieves the model with site of the given UUID or name
getOrganization ( ) : Organization
getSite ( string $site_id ) : Site Retrieves the matching site from model members
siteIsMember ( Site $site ) : boolean Determines whether a site is a member of this collection

Описание методов

__construct() публичный Метод

Instantiates the collection
public __construct ( array $options = [] ) : OrganizationSiteMemberships
$options array To be set
Результат OrganizationSiteMemberships

create() публичный Метод

Adds a site to this organization
public create ( Site $site ) : Workflow
$site Site Site object of site to add to this organization
Результат Workflow

get() публичный Метод

Retrieves the model with site of the given UUID or name
public get ( string $id ) : OrganizationSiteMembership
$id string UUID or name of desired site membership instance
Результат OrganizationSiteMembership

getOrganization() публичный Метод

public getOrganization ( ) : Organization
Результат Pantheon\Terminus\Models\Organization

getSite() публичный Метод

Retrieves the matching site from model members
public getSite ( string $site_id ) : Site
$site_id string ID or name of desired site
Результат Site $membership->site

siteIsMember() публичный Метод

Determines whether a site is a member of this collection
public siteIsMember ( Site $site ) : boolean
$site Site Site to determine membership of
Результат boolean

Описание свойств

$collected_class защищенное свойство

protected string $collected_class
Результат string

$organization публичное свойство

public Organization,Pantheon\Terminus\Models $organization
Результат Pantheon\Terminus\Models\Organization

$paged защищенное свойство

protected bool $paged
Результат boolean