Principals
extends IteratorIterator
in package
Collection of PointOfContact objects from the stellar.toml file.
Provides an iterable collection for managing multiple principal entries from the [[PRINCIPALS]] section of the stellar.toml file.
Table of Contents
Methods
- __construct() : mixed
- add() : void
- Adds a PointOfContact to the collection.
- count() : int
- Returns the number of principals in the collection.
- current() : PointOfContact
- Returns the current PointOfContact in the iteration.
- toArray() : array<string|int, PointOfContact>
Methods
__construct()
public
__construct(PointOfContact ...$pointsOfContact) : mixed
Parameters
- $pointsOfContact : PointOfContact
add()
Adds a PointOfContact to the collection.
public
add(PointOfContact $pointOfContact) : void
Parameters
- $pointOfContact : PointOfContact
-
The point of contact to add
count()
Returns the number of principals in the collection.
public
count() : int
Return values
int —The count of principals
current()
Returns the current PointOfContact in the iteration.
public
current() : PointOfContact
Return values
PointOfContact —The current point of contact object
toArray()
public
toArray() : array<string|int, PointOfContact>