php-parser/doc
Nikita Popov b9996315a6 Add more extensive docs for node visitors
Also document NodeFinder.
2018-02-28 21:00:42 +01:00
..
component Add more extensive docs for node visitors 2018-02-28 21:00:42 +01:00
0_Introduction.markdown Proofreading the docs - very minor changes! 2018-02-28 18:15:02 +01:00
2_Usage_of_basic_components.markdown Proofreading the docs - very minor changes! 2018-02-28 18:15:02 +01:00
README.md Add more extensive docs for node visitors 2018-02-28 21:00:42 +01:00

Table of Contents

Guide

  1. Introduction
  2. Usage of basic components

Component documentation

  • Walking the AST
    • Node visitors
    • Modifying the AST from a visitor
    • Short-circuiting traversals
    • Interleaved visitors
    • Simple node finding API
    • Parent and sibling references
  • Name resolution
    • Name resolver options
    • Name resolution context
  • Pretty printing
    • Converting AST back to PHP code
    • Customizing formatting
    • Formatting-preserving code transformations
  • AST builders
    • Fluent builders for AST nodes
  • Lexer
    • Lexer options
    • Token and file positions for nodes
    • Custom attributes
  • Error handling
    • Column information for errors
    • Error recovery (parsing of syntactically incorrect code)
  • Constant expression evaluation
    • Evaluating constant/property/etc initializers
    • Handling errors and unsupported expressions
  • JSON representation
    • JSON encoding and decoding of ASTs
  • Performance
    • Disabling XDebug
    • Reusing objects
    • Garbage collection impact
  • Frequently asked questions
    • Parent and sibling references