WarrantRequest
in package
Warrant Request Data Structure
Encapsulates warrant application data for a member to hold a specific position or role within an organizational entity.
Tags
Table of Contents
Properties
- $entityId : int
- $entityType : string
- $expires_on : DateTime|null
- $member_id : int
- $member_role_id : int|null
- $name : string
- $requester_id : int
- $start_on : DateTime|null
Methods
- __construct() : mixed
- Create a new warrant request.
Properties
$entityId
public
int
$entityId
Entity primary key ID
$entityType
public
string
$entityType
Entity type (e.g., 'Branches', 'Activities', 'Direct Grant')
$expires_on
public
DateTime|null
$expires_on
Optional custom end date (null = use period default)
$member_id
public
int
$member_id
ID of member who will receive the warrant
$member_role_id
public
int|null
$member_role_id
Optional specific role within the entity
$name
public
string
$name
Human-readable warrant title
$requester_id
public
int
$requester_id
ID of member requesting this warrant
$start_on
public
DateTime|null
$start_on
Optional custom start date (null = use period default)
Methods
__construct()
Create a new warrant request.
public
__construct(string $name, string $entity_type, int $entity_id, int $requester_id, int $member_id[, DateTime|null $start_on = null ][, DateTime|null $expires_on = null ][, int|null $member_role_id = null ]) : mixed
Parameters
- $name : string
-
Warrant title
- $entity_type : string
-
Entity type
- $entity_id : int
-
Entity ID
- $requester_id : int
-
Requester member ID
- $member_id : int
-
Recipient member ID
- $start_on : DateTime|null = null
-
Optional start date
- $expires_on : DateTime|null = null
-
Optional end date
- $member_role_id : int|null = null
-
Optional role within entity