Support

Represents the optional "support" section of a composer.json file.

This value object provides structured access to support-related metadata such as support email, issue tracker, forum, wiki, IRC, source code, documentation, RSS feed, chat channel, and security disclosure policy.

All properties of this class are immutable after instantiation. Consumers MAY safely treat instances of this class as readonly value objects. Since the "support" section is optional in composer.json, each field MAY contain an empty string when the corresponding value is not defined.

Implementations SHALL preserve the exact values provided at construction time. URL-based properties SHOULD contain fully qualified URLs whenever available. The IRC property SHOULD follow the format "irc://server/channel" when provided.

---

• Full name: \FastForward\DevTools\Composer\Json\Schema\Support
• This class is marked as final and can't be subclassed
• This class implements: \FastForward\DevTools\Composer\Json\Schema\SupportInterface
• This class is a Final class

Methods

__construct

Constructs a new ComposerJsonSupport instance.

public __construct(string $email = '', string $issues = '', string $forum = '', string $wiki = '', string $irc = '', string $source = '', string $docs = '', string $rss = '', string $chat = '', string $security = ''): mixed

Each argument represents an optional support entry from the composer.json "support" section. Callers MAY omit any argument, in which case the value SHALL default to an empty string.

Parameters:

Parameter	Type	Description
$email	string	The support email address. SHOULD be a valid email address.
$issues	string	The URL to the issue tracker. SHOULD be a fully qualified URL.
$forum	string	The URL to the support forum. SHOULD be a fully qualified URL.
$wiki	string	The URL to the project wiki. SHOULD be a fully qualified URL.
$irc	string	The IRC support channel. SHOULD follow the format "irc://server/channel".
$source	string	The URL to browse or download the project source code.
SHOULD be a fully qualified URL.
$docs	string	The URL to the project documentation. SHOULD be a fully qualified URL.
$rss	string	The URL to the RSS feed. SHOULD be a fully qualified URL.
$chat	string	The URL to the chat channel. SHOULD be a fully qualified URL.
$security	string	The URL to the vulnerability disclosure policy.
SHOULD be a fully qualified URL.

---

getEmail

Retrieves the support email address.

public getEmail(): string

This method MUST return the support email value exactly as stored by the instance.

Return Value:

the support email address

---

getIssues

Retrieves the issue tracker URL.

public getIssues(): string

This method MUST return the issue tracker value exactly as stored by the instance.

Return Value:

the issue tracker URL

---

getForum

Retrieves the forum URL.

public getForum(): string

This method MUST return the forum value exactly as stored by the instance.

Return Value:

the forum URL

---

getWiki

Retrieves the wiki URL.

public getWiki(): string

This method MUST return the wiki value exactly as stored by the instance.

Return Value:

the wiki URL

---

getIrc

Retrieves the IRC support channel.

public getIrc(): string

This method MUST return the IRC value exactly as stored by the instance.

Return Value:

the IRC support channel

---

getSource

Retrieves the source code URL.

public getSource(): string

This method MUST return the source URL value exactly as stored by the instance.

Return Value:

the source code URL

---

getDocs

Retrieves the documentation URL.

public getDocs(): string

This method MUST return the documentation URL value exactly as stored by the instance.

Return Value:

the documentation URL

---

getRss

Retrieves the RSS feed URL.

public getRss(): string

This method MUST return the RSS feed URL value exactly as stored by the instance.

Return Value:

the RSS feed URL

---

getChat

Retrieves the chat channel URL.

public getChat(): string

This method MUST return the chat channel URL value exactly as stored by the instance.

Return Value:

the chat channel URL

---

getSecurity

Retrieves the vulnerability disclosure policy URL.

public getSecurity(): string

This method MUST return the security policy URL value exactly as stored by the instance.

Return Value:

the vulnerability disclosure policy URL

---