ShareRecipient
in package
Read onlyYes
FinalYes
Tags
Attributes
- #[Consumable]
- $since: '35.0.0'
Table of Contents
Properties
- $class : IShareRecipientType>
- $initiator : ShareUser|null
- $instance : non-empty-string|null
- $secret : non-empty-string|null
- $value : non-empty-string
Methods
- __construct() : mixed
- format() : SharingRecipient
- formatMultiple() : array<int, SharingRecipient>
Properties
$class
public
IShareRecipientType>
$class
$initiator
public
ShareUser|null
$initiator
= null
$instance
public
non-empty-string|null
$instance
$secret
public
non-empty-string|null
$secret
= null
$value
public
non-empty-string
$value
Methods
__construct()
public
__construct(string $class, string $value, string|null $instance[, string|null $secret = null ][, ShareUser|null $initiator = null ]) : mixed
Parameters
- $class : string
- $value : string
- $instance : string|null
- $secret : string|null = null
- $initiator : ShareUser|null = null
Tags
format()
public
format(ISharingRegistry $registry, IFactory $l10nFactory, IURLGenerator $urlGenerator, IUserManager $userManager, bool $isUnique) : SharingRecipient
Parameters
- $registry : ISharingRegistry
- $l10nFactory : IFactory
- $urlGenerator : IURLGenerator
- $userManager : IUserManager
- $isUnique : bool
Tags
Return values
SharingRecipientformatMultiple()
public
static formatMultiple(ISharingRegistry $registry, IFactory $l10nFactory, IURLGenerator $urlGenerator, IUserManager $userManager, array<int, self> $recipients) : array<int, SharingRecipient>
Parameters
- $registry : ISharingRegistry
- $l10nFactory : IFactory
- $urlGenerator : IURLGenerator
- $userManager : IUserManager
- $recipients : array<int, self>