enums

Documentation

Index

• type AstInheritType
• type ClassLikeType
  • func (t ClassLikeType) ToString() string
• type CodeclimateLevelEnum
• type CollectorType
  • func NewCollectorTypeFromString(collectorType string) (CollectorType, error)
• type ConfigurationCodeclimate
  • func NewConfigurationCodeclimateFromArray(array map[SeverityType]interface{}) *ConfigurationCodeclimate
  • func (c *ConfigurationCodeclimate) GetSeverity(key SeverityType) *string
• type DependencyType
• type EmitterType
  • func NewEmitterTypeFromString(input string) (EmitterType, error)
• type FormatterType
• type OutputFormatterType
  • func NewOutputFormatterTypeFromString(input string) (OutputFormatterType, error)
• type RuleTypeEnum
• type SeverityType
• type TokenType
  • func NewTokenType(s string) (TokenType, error)
  • func NewTokenTypeTryFromEmitterType(emitterType EmitterType) *TokenType

Types

type AstInheritType

type AstInheritType string

const (
	AstInheritTypeExtends    AstInheritType = "Extends"
	AstInheritTypeImplements AstInheritType = "Implements"
	AstInheritTypeUses       AstInheritType = "Uses"
)

type ClassLikeType

type ClassLikeType string

const (
	TypeClasslike ClassLikeType = "classLike"
	TypeClass     ClassLikeType = "class"
	TypeInterface ClassLikeType = "interface"
	TypeTrait     ClassLikeType = "trait"
)

func (ClassLikeType) ToString

func (t ClassLikeType) ToString() string

type CodeclimateLevelEnum

type CodeclimateLevelEnum string

const (
	CodeclimateLevelEnumInfo     CodeclimateLevelEnum = "info"
	CodeclimateLevelEnumMinor    CodeclimateLevelEnum = "minor"
	CodeclimateLevelEnumMajor    CodeclimateLevelEnum = "major"
	CodeclimateLevelEnumCritical CodeclimateLevelEnum = "critical"
	CodeclimateLevelEnumBlocker  CodeclimateLevelEnum = "blocker"
)

type CollectorType

type CollectorType string

const (
	CollectorTypeTypeAttribute      CollectorType = "attribute"
	CollectorTypeTypeBool           CollectorType = "bool"
	CollectorTypeTypeClass          CollectorType = "struct"
	CollectorTypeTypeClasslike      CollectorType = "structLike"
	CollectorTypeTypeClassNameRegex CollectorType = "structNameRegex"
	CollectorTypeTypeTagValueRegex  CollectorType = "tagValueRegex"
	CollectorTypeTypeDirectory      CollectorType = "directory"
	CollectorTypeTypeExtends        CollectorType = "extends"
	CollectorTypeTypeFunctionName   CollectorType = "functionName"
	CollectorTypeTypeGlob           CollectorType = "glob"
	CollectorTypeTypeImplements     CollectorType = "implements"
	CollectorTypeTypeInheritance    CollectorType = "inheritanceLevel"
	CollectorTypeTypeInherits       CollectorType = "inherits"
	CollectorTypeTypeInterface      CollectorType = "interface"
	CollectorTypeTypeLayer          CollectorType = "layer_contract"
	CollectorTypeTypeMethod         CollectorType = "method"
	CollectorTypeTypeGlobal         CollectorType = "global"
	CollectorTypeTypeTrait          CollectorType = "trait"
	CollectorTypeTypeUses           CollectorType = "uses"
	CollectorTypeTypePhpInternal    CollectorType = "php_internal"
	CollectorTypeTypeComposer       CollectorType = "composer"
)

func NewCollectorTypeFromString

func NewCollectorTypeFromString(collectorType string) (CollectorType, error)

type ConfigurationCodeclimate

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

func NewConfigurationCodeclimateFromArray

func NewConfigurationCodeclimateFromArray(array map[SeverityType]interface{}) *ConfigurationCodeclimate

func (*ConfigurationCodeclimate) GetSeverity

func (c *ConfigurationCodeclimate) GetSeverity(key SeverityType) *string

type DependencyType

type DependencyType string

DependencyType - Specifies the type of AST dependency_contract. You can use this information to enrich the displayed output to the user in your output formatter.

const (
	DependencyTypeUse                      DependencyType = "use"
	DependencyTypeInherit                  DependencyType = "inherit"
	DependencyTypeReturnType               DependencyType = "returntype"
	DependencyTypeParameter                DependencyType = "parameter"
	DependencyTypeNew                      DependencyType = "new"
	DependencyTypeStaticProperty           DependencyType = "static_property"
	DependencyTypeStaticMethod             DependencyType = "static_method"
	DependencyTypeInstanceof               DependencyType = "instanceof"
	DependencyTypeCatch                    DependencyType = "catch"
	DependencyTypeVariable                 DependencyType = "variable"
	DependencyTypeThrow                    DependencyType = "throw"
	DependencyTypeConst                    DependencyType = "const"
	DependencyTypeAnonymousClassExtends    DependencyType = "anonymous_class_extends"
	DependencyTypeAnonymousClassImplements DependencyType = "anonymous_class_implements"
	DependencyTypeAnonymousClassTrait      DependencyType = "anonymous_class_trait"
	DependencyTypeAttribute                DependencyType = "attribute"
	DependencyTypeSuperGlobalVariable      DependencyType = "superglobal_variable"
	DependencyTypeUnresolvedFunctionCall   DependencyType = "unresolved_function_call"
)

type EmitterType

type EmitterType string

const (
	EmitterTypeClassToken               EmitterType = "class"
	EmitterTypeClassSuperGlobalToken    EmitterType = "class_superglobal"
	EmitterTypeFileToken                EmitterType = "file_supportive"
	EmitterTypeFunctionToken            EmitterType = "function"
	EmitterTypeFunctionCall             EmitterType = "function_call"
	EmitterTypeFunctionSuperGlobalToken EmitterType = "function_superglobal"
	EmitterTypeUseToken                 EmitterType = "use"
)

func NewEmitterTypeFromString

func NewEmitterTypeFromString(input string) (EmitterType, error)

type FormatterType

type FormatterType string

const (
	FormatterTypeCodeclimateConfig FormatterType = "codecli_mate_config"
	FormatterTypeGraphvizConfig    FormatterType = "graphviz_config"
	FormatterTypeMermaidJsConfig   FormatterType = "mermaid_js_config"
)

type OutputFormatterType

type OutputFormatterType string

const (
	GithubActions OutputFormatterType = "github-actions"
	Table         OutputFormatterType = "table"
	Baseline      OutputFormatterType = "baseline"
)

func NewOutputFormatterTypeFromString

func NewOutputFormatterTypeFromString(input string) (OutputFormatterType, error)

type RuleTypeEnum

type RuleTypeEnum string

const (
	TypeViolation        RuleTypeEnum = "violation"
	TypeSkippedViolation RuleTypeEnum = "skipped_violation"
	TypeUncovered        RuleTypeEnum = "uncovered"
	TypeAllowed          RuleTypeEnum = "allowed"
)

type SeverityType

type SeverityType string

const (
	SeverityTypeFailure   SeverityType = "failure"
	SeverityTypeSkipped   SeverityType = "skipped"
	SeverityTypeUncovered SeverityType = "uncovered"
)

type TokenType

type TokenType string

const (
	TokenTypeClassLike TokenType = "class-like"
	TokenTypeFunction  TokenType = "function"
	TokenTypeFile      TokenType = "file_supportive"
)

func NewTokenType

func NewTokenType(s string) (TokenType, error)

func NewTokenTypeTryFromEmitterType

func NewTokenTypeTryFromEmitterType(emitterType EmitterType) *TokenType