Struct Formatter 

pub struct Formatter<'a> { /* private fields */ }

Formatter for PHP code.

The Formatter is the main entry point for formatting PHP code. It allows for:

• Building an AST representation of the code
• Converting that AST into a document model
• Printing the document as a formatted string

Implementations

impl<'a> Formatter<'a>

pub fn new( interner: &'a ThreadedInterner, php_version: PHPVersion, settings: FormatSettings, ) -> Self

Creates a new Formatter instance.

Arguments

• interner - The interner to use for string interning.
• php_version - The PHP version to target when formatting.
• settings - The settings to use for formatting.

Returns

A new Formatter instance configured with the given parameters.

pub fn format_code( &self, name: &'a str, code: &'a str, ) -> Result<String, ParseError>

Formats PHP code provided as a string.

This method parses the provided code string into an AST and then formats it. It’s a convenient way to format code snippets without manually creating a Source object.

Arguments

• name - A name for the code snippet (used for error reporting).
• code - The PHP code to format as a string.

Returns

A Result containing either the formatted code as a string or a ParseError if the code couldn’t be parsed.

pub fn format_source(&self, source: &'a Source) -> Result<String, ParseError>

Formats PHP code from a Source object.

This method parses the provided Source into an AST and then formats it. This is useful when you already have a Source object but not a parsed AST.

Arguments

• source - The Source object containing the PHP code to format.

Returns

A Result containing either the formatted code as a string or a ParseError if the code couldn’t be parsed.

pub fn format(&self, source: &'a Source, program: &'a Program) -> String

Formats a PHP program.

This is a convenience method that combines build and print into a single operation.

Arguments

• source - The source to use for the program.
• program - A Program struct representing the AST of the program to format.

Returns

The formatted program as a string.

pub fn build(&self, source: &'a Source, program: &'a Program) -> Document<'a>

Builds a document model from a program AST.

This method converts the AST into a document model that represents the logical structure of the formatted code.

Arguments

• source - The source to use for the program.
• program - A Program struct representing the AST of the program to build.

Returns

A Document representing the structured format of the program.

pub fn print( &self, document: Document<'a>, capacity_hint: Option<usize>, ) -> String

Prints a document model as a formatted string.

This method takes a document model and renders it as formatted text according to the formatter settings.

Arguments

• document - The document model to print.
• capacity_hint - An optional hint for pre-allocating the output buffer size. When available (e.g., from source code), this improves performance.

Returns

The formatted document as a string.

Trait Implementations

impl<'a> Debug for Formatter<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.