RicdDataSnapshot
in package
FinalYes
Immutable snapshot of data returned from the RICD source.
Table of Contents
Properties
- $description : string|null
- $endDate : DateTimeImmutable|null
- $organizationName : string|null
- $projectStatus : string|null
- $projectType : string|null
- $refreshedAt : DateTimeImmutable|null
- $researchAreas : array<string|int, string>
- $ricdId : string
- $selectedAt : DateTimeImmutable
- $startDate : DateTimeImmutable|null
- $subjectAreas : array<string|int, string>
- $title : string
- $url : string|null
- $year : string|null
Methods
- __construct() : mixed
- RicdDataSnapshot constructor.
- description() : string|null
- Description.
- endDate() : DateTimeImmutable|null
- End date.
- organizationName() : string|null
- Organization name.
- projectStatus() : string|null
- Project status.
- projectType() : string|null
- Project type.
- refreshedAt() : DateTimeImmutable|null
- When the record was refreshed.
- researchAreas() : array<string|int, string>
- Research areas.
- ricdId() : string
- RICD identifier.
- selectedAt() : DateTimeImmutable
- When the record was selected.
- startDate() : DateTimeImmutable|null
- Start date.
- subjectAreas() : array<string|int, string>
- Subject areas.
- title() : string
- Title.
- url() : string|null
- External URL.
- withRefreshedAt() : self
- Return a clone with updated refreshedAt timestamp.
- year() : string|null
- Year information.
Properties
$description
private
string|null
$description
$endDate
private
DateTimeImmutable|null
$endDate
$organizationName
private
string|null
$organizationName
$projectStatus
private
string|null
$projectStatus
$projectType
private
string|null
$projectType
$refreshedAt
private
DateTimeImmutable|null
$refreshedAt
$researchAreas
private
array<string|int, string>
$researchAreas
$ricdId
private
string
$ricdId
$selectedAt
private
DateTimeImmutable
$selectedAt
$startDate
private
DateTimeImmutable|null
$startDate
$subjectAreas
private
array<string|int, string>
$subjectAreas
$title
private
string
$title
$url
private
string|null
$url
$year
private
string|null
$year
Methods
__construct()
RicdDataSnapshot constructor.
public
__construct(string $ricdId, string $title[, string|null $description = null ][, string|null $organizationName = null ][, DateTimeImmutable|null $startDate = null ][, DateTimeImmutable|null $endDate = null ][, string|null $url = null ][, DateTimeImmutable|null $selectedAt = null ][, DateTimeImmutable|null $refreshedAt = null ][, string|null $projectType = null ][, string|null $projectStatus = null ][, array<string|int, string> $researchAreas = [] ][, array<string|int, string> $subjectAreas = [] ][, string|null $year = null ]) : mixed
Parameters
- $ricdId : string
- $title : string
- $description : string|null = null
- $organizationName : string|null = null
- $startDate : DateTimeImmutable|null = null
- $endDate : DateTimeImmutable|null = null
- $url : string|null = null
- $selectedAt : DateTimeImmutable|null = null
- $refreshedAt : DateTimeImmutable|null = null
- $projectType : string|null = null
- $projectStatus : string|null = null
- $researchAreas : array<string|int, string> = []
- $subjectAreas : array<string|int, string> = []
- $year : string|null = null
description()
Description.
public
description() : string|null
Return values
string|nullendDate()
End date.
public
endDate() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullorganizationName()
Organization name.
public
organizationName() : string|null
Return values
string|nullprojectStatus()
Project status.
public
projectStatus() : string|null
Return values
string|nullprojectType()
Project type.
public
projectType() : string|null
Return values
string|nullrefreshedAt()
When the record was refreshed.
public
refreshedAt() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullresearchAreas()
Research areas.
public
researchAreas() : array<string|int, string>
Return values
array<string|int, string>ricdId()
RICD identifier.
public
ricdId() : string
Return values
stringselectedAt()
When the record was selected.
public
selectedAt() : DateTimeImmutable
Return values
DateTimeImmutablestartDate()
Start date.
public
startDate() : DateTimeImmutable|null
Return values
DateTimeImmutable|nullsubjectAreas()
Subject areas.
public
subjectAreas() : array<string|int, string>
Return values
array<string|int, string>title()
Title.
public
title() : string
Return values
stringurl()
External URL.
public
url() : string|null
Return values
string|nullwithRefreshedAt()
Return a clone with updated refreshedAt timestamp.
public
withRefreshedAt(DateTimeImmutable $refreshedAt) : self
Parameters
- $refreshedAt : DateTimeImmutable
Return values
selfyear()
Year information.
public
year() : string|null