Article
in package
uses
FormatsForDisplay
Represents a single news article with headline, content, and publication data.
Table of Contents
Properties
- $content : string
- $headline : string
- $publication_date : Carbon
- $source : string
- $symbol : string
Methods
- __construct() : mixed
- Constructs a new Article instance.
- __toString() : string
- Returns a string representation of the article.
- formatChange() : string
- Format a change value with sign and currency (e.g., "+$1.25" or "-$0.50").
- formatCurrency() : string
- Format a float as currency (e.g., "$150.25").
- formatDate() : string
- Format a Carbon date without time (e.g., "Jan 24, 2026").
- formatDateTime() : string
- Format a Carbon date with time (e.g., "Jan 24, 2026 3:45 PM").
- formatGreek() : string
- Format a Greek value (4 decimal places, e.g., "0.4520").
- formatNumber() : string
- Format a number with commas (e.g., "15,234").
- formatPercent() : string
- Format a percentage with sign (e.g., "+3.25%" or "-1.50%").
- formatPercentRaw() : string
- Format a percentage that is already in percent form (e.g., "32.50%").
- formatVolume() : string
- Format volume with K/M/B suffixes (e.g., "54.9M", "12.3K").
Properties
$content
public
string
$content
$headline
public
string
$headline
$publication_date
public
Carbon
$publication_date
$source
public
string
$source
$symbol
public
string
$symbol
Methods
__construct()
Constructs a new Article instance.
public
__construct(string $symbol, string $headline, string $content, string $source, Carbon $publication_date) : mixed
Parameters
- $symbol : string
-
The ticker symbol this article relates to.
- $headline : string
-
The headline of the news article.
- $content : string
-
The content of the article, if available.
- $source : string
-
The source URL where the news appeared.
- $publication_date : Carbon
-
The date the news was published on the source website.
__toString()
Returns a string representation of the article.
public
__toString() : string
Return values
string —Human-readable article data.
formatChange()
Format a change value with sign and currency (e.g., "+$1.25" or "-$0.50").
protected
formatChange(float|null $value) : string
Parameters
- $value : float|null
-
The change value to format.
Return values
string —Formatted change string or "N/A" if null.
formatCurrency()
Format a float as currency (e.g., "$150.25").
protected
formatCurrency(float|null $value) : string
Parameters
- $value : float|null
-
The value to format.
Return values
string —Formatted currency string or "N/A" if null.
formatDate()
Format a Carbon date without time (e.g., "Jan 24, 2026").
protected
formatDate(Carbon|null $date) : string
Parameters
- $date : Carbon|null
-
The date to format.
Return values
string —Formatted date string or "N/A" if null.
formatDateTime()
Format a Carbon date with time (e.g., "Jan 24, 2026 3:45 PM").
protected
formatDateTime(Carbon|null $date) : string
Parameters
- $date : Carbon|null
-
The date to format.
Return values
string —Formatted date string or "N/A" if null.
formatGreek()
Format a Greek value (4 decimal places, e.g., "0.4520").
protected
formatGreek(float|null $value) : string
Parameters
- $value : float|null
-
The Greek value to format.
Return values
string —Formatted Greek string or "N/A" if null.
formatNumber()
Format a number with commas (e.g., "15,234").
protected
formatNumber(int|null $value) : string
Parameters
- $value : int|null
-
The number to format.
Return values
string —Formatted number string or "N/A" if null.
formatPercent()
Format a percentage with sign (e.g., "+3.25%" or "-1.50%").
protected
formatPercent(float|null $value) : string
Assumes input is a decimal (0.30 = 30%).
Parameters
- $value : float|null
-
The decimal value to format as percentage.
Return values
string —Formatted percentage string or "N/A" if null.
formatPercentRaw()
Format a percentage that is already in percent form (e.g., "32.50%").
protected
formatPercentRaw(float|null $value) : string
Use this for values like implied volatility that are already percentages.
Parameters
- $value : float|null
-
The percentage value to format.
Return values
string —Formatted percentage string or "N/A" if null.
formatVolume()
Format volume with K/M/B suffixes (e.g., "54.9M", "12.3K").
protected
formatVolume(int|null $value) : string
Parameters
- $value : int|null
-
The volume to format.
Return values
string —Formatted volume string or "N/A" if null.