SupportInterface

Defines the contract for representing the "support" section of a composer.json file.

The support section contains optional metadata intended to help users, contributors, and integrators obtain assistance, report issues, review documentation, access source code, and follow project communication channels.

Implementations of this interface MUST provide string-based accessors for each supported support entry defined by Composer metadata conventions. Since the "support" section is optional, implementations MAY return an empty string when a given support entry is not defined. Implementations SHOULD return normalized and human-usable values whenever possible.

URL-based values SHOULD be fully qualified. The IRC value SHOULD follow the format "irc://server/channel" when provided. The email value SHOULD represent a valid support email address when available.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this interface are to be interpreted as described in RFC 2119.

---

• Full name: \FastForward\DevTools\Composer\Json\Schema\SupportInterface

Methods

getEmail

Retrieves the support email address.

public getEmail(): string

This method MUST return the email address intended for support requests. Implementations MAY return an empty string when no support email is defined. Implementations SHOULD return a syntactically valid email address.

Return Value:

the support email address

---

getIssues

Retrieves the URL to the issue tracker.

public getIssues(): string

This method MUST return the URL used to report bugs, request features, or otherwise track issues related to the project. Implementations MAY return an empty string when no issue tracker is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the issue tracker URL

---

getForum

Retrieves the URL to the support forum.

public getForum(): string

This method MUST return the URL of the forum intended for community support or project-related discussions. Implementations MAY return an empty string when no forum is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the forum URL

---

getWiki

Retrieves the URL to the project wiki.

public getWiki(): string

This method MUST return the URL of the wiki that provides project knowledge, guides, or collaborative documentation. Implementations MAY return an empty string when no wiki is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the wiki URL

---

getIrc

Retrieves the IRC channel for support.

public getIrc(): string

This method MUST return the IRC endpoint intended for project support. Implementations MAY return an empty string when no IRC channel is defined. Implementations SHOULD return the value in the format "irc://server/channel".

Return Value:

the IRC support channel

---

getSource

Retrieves the URL to browse or download the project source code.

public getSource(): string

This method MUST return the source URL associated with the project. Implementations MAY return an empty string when no source URL is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the source code URL

---

getDocs

Retrieves the URL to the project documentation.

public getDocs(): string

This method MUST return the URL that points to official documentation or usage guides for the project. Implementations MAY return an empty string when no documentation URL is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the documentation URL

---

getRss

Retrieves the URL to the RSS feed.

public getRss(): string

This method MUST return the RSS feed URL when the project provides syndicated updates. Implementations MAY return an empty string when no RSS feed is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the RSS feed URL

---

getChat

Retrieves the URL to the chat channel.

public getChat(): string

This method MUST return the URL for the project's chat-based support or communication channel. Implementations MAY return an empty string when no chat channel is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the chat channel URL

---

getSecurity

Retrieves the URL to the vulnerability disclosure policy.

public getSecurity(): string

This method MUST return the URL that describes how security vulnerabilities SHALL be reported to the project maintainers. Implementations MAY return an empty string when no security policy is defined. Implementations SHOULD return a fully qualified URL.

Return Value:

the vulnerability disclosure policy URL

---