throws

Documentation

Index

• type Throws
  • func NewResolver(root rooter, node ast.Vertex) *Throws
  • func NewResolverFromIndex(n *index.INode) *Throws
  • func (t *Throws) Throws() []*fqn.FQN
• type Violation
  • func Diagnose(root rooter) (results []*Violation)
  • func (v *Violation) Code() string
  • func (v *Violation) Line() int
  • func (v *Violation) Message() string

Types

type Throws

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

func NewResolver

func NewResolver(root rooter, node ast.Vertex) *Throws

func NewResolverFromIndex

func NewResolverFromIndex(n *index.INode) *Throws

func (*Throws) Throws

func (t *Throws) Throws() []*fqn.FQN

type Violation

type Violation struct {
	// Either a function or class method statement.
	Node   ast.Vertex
	Throws []*fqn.FQN
	// contains filtered or unexported fields
}

func Diagnose

func Diagnose(root rooter) (results []*Violation)

Diagnose finds all the functions or methods in the given file that throw exceptions that are not added to the PHPDoc with an @throws tag or caught in that method.

func (*Violation) Code

func (v *Violation) Code() string

func (*Violation) Line

func (v *Violation) Line() int

func (*Violation) Message

func (v *Violation) Message() string