PHP Класс Pantheon\Terminus\Models\Site

Наследование: extends TerminusModel, implements Robo\Contract\ConfigAwareInterface, implements League\Container\ContainerAwareInterface, use trait Robo\Common\ConfigAwareTrait, use trait League\Container\ContainerAwareTrait
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$branches Pantheon\Terminus\Collections\Branches
$environments Pantheon\Terminus\Collections\Environments
$new_relic NewRelic
$org_memberships Pantheon\Terminus\Collections\SiteOrganizationMemberships
$redis Redis
$solr Solr
$user_memberships Pantheon\Terminus\Collections\SiteUserMemberships
$workflows Pantheon\Terminus\Collections\Workflows

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

Свойство Тип Описание
$upstream_data stdClass
$url The URL at which to fetch this model's information

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

Метод Описание
__construct ( $attributes = null, array $options = [] )
addPaymentMethod ( string $payment_method_id ) : Workflow Add a payment method to the given site
completeMigration ( ) : Workflow Completes a site migration in progress
converge ( ) : Workflow Converges all bindings on a site
dashboardUrl ( ) : string Provides Pantheon Dashboard URL for this site
delete ( ) : Workflow Deletes the site represented by this object
deployProduct ( string $upstream_id ) : Workflow Creates a new site for migration
fetch ( array $options = [] ) : Site Fetches this object from Pantheon
getBranches ( ) : Branches
getEnvironments ( ) : Environments
getFeature ( string $feature ) : mixed | null Returns a specific site feature value
getName ( ) : mixed Get the human-readable name of the site
getNewRelic ( ) : NewRelic
getOrganizationMemberships ( ) : SiteOrganizationMemberships
getOrganizations ( ) : SiteOrganizationMembership[] Returns all organization members of this site
getRedis ( ) : Redis
getSolr ( ) : Solr
getUpstream ( ) : Upstream
getUserMemberships ( ) : SiteUserMemberships
getWorkflows ( ) : Workflows
removePaymentMethod ( ) : Workflow Remove this site's payment method
serialize ( ) : array Formats the Site object into an associative array for output
setOwner ( User $user_id ) : Workflow Sets the site owner to the indicated team member
updateServiceLevel ( string $service_level ) : Workflow Update service level

Защищенные методы

Метод Описание
parseAttributes ( object $data ) : object Modify response data between fetch and assignment

Приватные методы

Метод Описание
setUpstream ( object $attributes ) Ensures the proper creation of an Upstream object

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

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

public __construct ( $attributes = null, array $options = [] )
$options array

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

Add a payment method to the given site
public addPaymentMethod ( string $payment_method_id ) : Workflow
$payment_method_id string UUID of new payment method
Результат Workflow

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

Completes a site migration in progress
public completeMigration ( ) : Workflow
Результат Workflow

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

Converges all bindings on a site
public converge ( ) : Workflow
Результат Workflow

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

Provides Pantheon Dashboard URL for this site
public dashboardUrl ( ) : string
Результат string

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

Deletes the site represented by this object
public delete ( ) : Workflow
Результат Workflow

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

Creates a new site for migration
public deployProduct ( string $upstream_id ) : Workflow
$upstream_id string The UUID for the product to deploy.
Результат Workflow

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

Fetches this object from Pantheon
public fetch ( array $options = [] ) : Site
$options array params to pass to url request
Результат Site

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

public getBranches ( ) : Branches
Результат Pantheon\Terminus\Collections\Branches

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

public getEnvironments ( ) : Environments
Результат Pantheon\Terminus\Collections\Environments

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

Returns a specific site feature value
public getFeature ( string $feature ) : mixed | null
$feature string Feature to check
Результат mixed | null Feature value, or null if not found

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

Get the human-readable name of the site
public getName ( ) : mixed
Результат mixed

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

public getNewRelic ( ) : NewRelic
Результат NewRelic

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

public getOrganizationMemberships ( ) : SiteOrganizationMemberships
Результат Pantheon\Terminus\Collections\SiteOrganizationMemberships

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

Returns all organization members of this site
public getOrganizations ( ) : SiteOrganizationMembership[]
Результат SiteOrganizationMembership[]

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

public getRedis ( ) : Redis
Результат Redis

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

public getSolr ( ) : Solr
Результат Solr

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

public getUpstream ( ) : Upstream
Результат Upstream

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

public getUserMemberships ( ) : SiteUserMemberships
Результат Pantheon\Terminus\Collections\SiteUserMemberships

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

public getWorkflows ( ) : Workflows
Результат Pantheon\Terminus\Collections\Workflows

parseAttributes() защищенный Метод

Modify response data between fetch and assignment
protected parseAttributes ( object $data ) : object
$data object attributes received from API response
Результат object $data

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

Remove this site's payment method
public removePaymentMethod ( ) : Workflow
Результат Workflow

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

Formats the Site object into an associative array for output
public serialize ( ) : array
Результат array Associative array of data for output

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

Sets the site owner to the indicated team member
public setOwner ( User $user_id ) : Workflow
$user_id User UUID of new owner of site
Результат Workflow

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

Update service level
public updateServiceLevel ( string $service_level ) : Workflow
$service_level string Level to set service on site to
Результат Workflow

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

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

public Branches,Pantheon\Terminus\Collections $branches
Результат Pantheon\Terminus\Collections\Branches

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

public Environments,Pantheon\Terminus\Collections $environments
Результат Pantheon\Terminus\Collections\Environments

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

public NewRelic,Pantheon\Terminus\Models $new_relic
Результат NewRelic

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

public SiteOrganizationMemberships,Pantheon\Terminus\Collections $org_memberships
Результат Pantheon\Terminus\Collections\SiteOrganizationMemberships

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

public Redis,Pantheon\Terminus\Models $redis
Результат Redis

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

public Solr,Pantheon\Terminus\Models $solr
Результат Solr

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

protected stdClass $upstream_data
Результат stdClass

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

The URL at which to fetch this model's information
protected $url

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

public SiteUserMemberships,Pantheon\Terminus\Collections $user_memberships
Результат Pantheon\Terminus\Collections\SiteUserMemberships

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

public Workflows,Pantheon\Terminus\Collections $workflows
Результат Pantheon\Terminus\Collections\Workflows