CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.6 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.6
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
      • Debug
      • Middleware
      • Renderer
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class TextFormatter

A Debugger formatter for generating unstyled plain text output.

Provides backwards compatible output with the historical output of Debugger::exportVar()

Namespace: Cake\Error\Debug

Method Summary

  • dump() public

    Convert a tree of NodeInterface objects into a plain text string.

  • export() protected

    Convert a tree of NodeInterface objects into a plain text string.

  • exportArray() protected

    Export an array type object

  • exportObject() protected

    Handles object to string conversion.

  • formatWrapper() public

    Output a dump wrapper with location context.

Method Detail

dump() ¶ public

dump(Cake\Error\Debug\NodeInterface $node): string

Convert a tree of NodeInterface objects into a plain text string.

Parameters
Cake\Error\Debug\NodeInterface $node

The node tree to dump.

Returns
string

export() ¶ protected

export(Cake\Error\Debug\NodeInterface $var, int $indent): string

Convert a tree of NodeInterface objects into a plain text string.

Parameters
Cake\Error\Debug\NodeInterface $var

The node tree to dump.

int $indent

The current indentation level.

Returns
string

exportArray() ¶ protected

exportArray(Cake\Error\Debug\ArrayNode $var, int $indent): string

Export an array type object

Parameters
Cake\Error\Debug\ArrayNode $var

The array to export.

int $indent

The current indentation level.

Returns
string

exportObject() ¶ protected

exportObject(Cake\Error\Debug\ClassNode|Cake\Error\Debug\ReferenceNode $var, int $indent): string

Handles object to string conversion.

Parameters
Cake\Error\Debug\ClassNode|Cake\Error\Debug\ReferenceNode $var

Object to convert.

int $indent

Current indentation level.

Returns
string
See Also
\Cake\Error\Debugger::exportVar()

formatWrapper() ¶ public

formatWrapper(string $contents, array $location): string

Output a dump wrapper with location context.

Parameters
string $contents
array $location
Returns
string
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs