utils

Documentation

Index

• func BinaryOpString(n ir.Node) string
• func FindPHPFiles(root string) ([]string, error)
• func FindVarNode(n ir.Node) ir.Node
• func InCoalesceOrIsset(path irutil.NodePath) bool
• func InVendor(path string) bool
• func IsCapitalized(s string) bool
• func IsPHPKeyword(word string) bool
• func IsQuote(r rune) bool
• func IsSpecialClassName(n ir.Node) bool
• func NameNodeEquals(n ir.Node, s string) bool
• func NameNodeToString(n ir.Node) string
• func VarToString(v ir.Node) string
• type CommentParser
  • func NewCommentParser(comment string, line int) *CommentParser
  • func (c *CommentParser) ParseExpectation() (wants []string, err error)

Functions

func BinaryOpString

func BinaryOpString(n ir.Node) string

func FindPHPFiles

func FindPHPFiles(root string) ([]string, error)

FindPHPFiles traverses the file system starting with the passed folder and finding all files with a .php extension.

func FindVarNode

func FindVarNode(n ir.Node) ir.Node

FindVarNode returns expression variable node root. If expression doesn't start from a variable, returns nil.

func InCoalesceOrIsset

func InCoalesceOrIsset(path irutil.NodePath) bool

func InVendor

func InVendor(path string) bool

func IsCapitalized

func IsCapitalized(s string) bool

IsCapitalized reports whether s starts with an upper case letter.

func IsPHPKeyword

func IsPHPKeyword(word string) bool

func IsQuote

func IsQuote(r rune) bool

func IsSpecialClassName

func IsSpecialClassName(n ir.Node) bool

IsSpecialClassName checks if the passed node is a special class name.

func NameNodeEquals

func NameNodeEquals(n ir.Node, s string) bool

NameNodeEquals checks whether n node name value is identical to s.

func NameNodeToString

func NameNodeToString(n ir.Node) string

NameNodeToString converts nodes of *name.Name, and *node.Identifier to string. This function is a helper function to aid printing function names, not for actual code analysis.

func VarToString

func VarToString(v ir.Node) string

Types

type CommentParser

type CommentParser struct {
	// contains filtered or unexported fields
}

func NewCommentParser

func NewCommentParser(comment string, line int) *CommentParser

func (*CommentParser) ParseExpectation

func (c *CommentParser) ParseExpectation() (wants []string, err error)

ParseExpectation parses a string describing expected errors like

want `error description 1` [and` error description 2` and `error 3` ...]