Line

/ LJCPHPCodeDoc / LJCTextBuilderLib / LJCTextBuilder / Line

Parameters

$text - The add text.

$addIndent - Indicates if the element can be indented.

$allowNewLine - Indicates if a new line can be added.

Returns

The potentially indented and wrapped new text value.

Syntax

PHP
public function Line(?string $text = null, bool $addIndent = true , bool $allowNewLine = true): string

Appends a potentially indented text line to the builder.

Remarks

Line() is an "Append" method. It creates the text with GetText() and adds a new line after the text. The text is then added to the builder.
Line() works the same as Text() except it appends a new line.

Example

PHP
$tb = new LJCTextBuilder(); $tb->Text("This is an appended line."); $tb->AddIndent(); // Example Method: // Starts the text with a newline if the builder already has text, param // allowNewLine = true and builder text does not end with a newline. // The text begins with the current indent string if param // addIndent = true. // Ends the text with a newline. // Defaults: addIndent = true, allowNewLine = true. $tb->Line(); $tb->Text("This is an indented line."); $result = $tb->ToString(); // result: // This is an appended line. // // This is an indented line.

PHP

 $tb = new LJCTextBuilder();
 
 $tb->Text("This is an appended line.");
 $tb->AddIndent();
 
 // Example Method:
 // Starts the text with a newline if the builder already has text, param
 // allowNewLine = true and builder text does not end with a newline.
 // The text begins with the current indent string if param
 // addIndent = true.
 // Ends the text with a newline.
 // Defaults: addIndent = true, allowNewLine = true.
 $tb->Line();
 
 $tb->Text("This is an indented line.");
 $result = $tb->ToString();
 
 // result:
 // This is an appended line.
 //
 //   This is an indented line.