FormattedRecipeDisplayController

FormattedRecipeDisplayController Class

this is the server side controller for the Formatted Recipe Display component. It has one method that delivers a class, and it's matching test class to the UI for display. The component is reponsible for formatting and syntax highlighting

Group Shared Code

See ApexClassUtilities

Methods

getRecipeCode(recipeName)

SUPPRESSWARNINGS AURAENABLED

AuraEnabled, and cached read-only method for grabbing the body of a given Apex Class

Note: this method contains a false-positive PMD violation. Normally, we'd want to check for FLS/CRUD here, but for ApexClass a system level object that Admins and users cannot really change we're ok.

Signature

public static ClassData getRecipeCode(String recipeName)

Parameters

Name	Type	Description
recipeName	String	Name of the Class to return

Return Type

ClassData

Example

System.debug(FormattedRecipeDisplayController.getRecipeCode('FormattedRecipeDisplayController'));

Classes

ClassData Class

Data transfer object for marshalling information form this class to the LWC that consumes it

Fields

name

AURAENABLED

Signature

public name

Type

String

---

apiVersion

AURAENABLED

Signature

public apiVersion

Type

Decimal

---

body

AURAENABLED

Signature

public body

Type

String

---

lengthWithoutComments

AURAENABLED

Signature

public lengthWithoutComments

Type

Integer

---

groupName

AURAENABLED

Signature

public groupName

Type

String

Constructors

ClassData(klass)

constructor for ClassData that accepts an ApexClass object

Signature

public ClassData(ApexClass klass)

Parameters

Name	Type	Description
klass	ApexClass	An ApexClass object to build this object from.