Application
Interfaces, Classes, Traits and Enums
- FunctionOrMethodName
- IArgumentable
- ExceptionInterface
- Base exception marker interface for the instantiator component
- InstantiatorInterface
- Instantiator provides utility methods to build objects without invoking their constructors
- Parsable
- The Parsable interface describes classes that can be parsed from their binary DER representation.
- Filter
- Filter to apply to a property while copying an object
- Matcher
- TypeFilter
- Builder
- ErrorHandler
- FunctionLike
- Node
- NodeTraverserInterface
- NodeVisitor
- Parser
- Exception
- Requirement
- VersionConstraint
- Exception
- Element
- Interface for Api Elements
- File
- Interface for files processed by the ProjectFactory
- Project
- Interface for project. Since the definition of a project can be different per factory this interface will be small.
- ProjectFactory
- Interface for project factories. A project factory shall convert a set of files into an object implementing the Project interface.
- Tag
- TagFactory
- StaticMethod
- Formatter
- Reference
- Interface for references in {@see \phpDocumentor\Reflection\DocBlock\Tags\See}
- DocBlockFactoryInterface
- PseudoType
- Type
- TokenInterface
- Argument token interface.
- ClassPatchInterface
- Class patch interface.
- DoubleInterface
- Core double interface.
- ReflectionInterface
- Reflection interface.
- DoublerException
- Core Prophecy exception interface.
- Exception
- Core Prophecy exception interface.
- PredictionException
- Core Prophecy exception interface.
- ProphecyException
- Core Prophecy exception interface.
- PredictionInterface
- Prediction interface.
- PromiseInterface
- Promise interface.
- ProphecyInterface
- Core Prophecy interface.
- ProphecySubjectInterface
- Controllable doubles interface.
- RevealerInterface
- Prophecies revealer interface.
- Exception
- Exception
- Exception
- Exception
- InvocationStubber
- MockObject
- ParametersRule
- Stub
- Test
- TestListener
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterIncompleteTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterLastTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterRiskyTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterSkippedTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterSuccessfulTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterTestErrorHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterTestFailureHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- AfterTestWarningHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- BeforeFirstTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- BeforeTestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- Hook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- TestHook
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- TestSuiteLoader
- ResultPrinter
- This interface, as well as the associated mechanism for extending PHPUnit, will be removed in PHPUnit 10. There is no alternative available in this version of PHPUnit.
- ClientboundPacket
- Packet
- PacketHandlerInterface
- This class is an automatically generated stub. Do not edit it manually.
- ServerboundPacket
- MetadataProperty
- PlayerBlockAction
- This is used for PlayerAuthInput packet when the flags include PERFORM_BLOCK_ACTIONS
- ClassLoader
- DynamicClassLoader
- AttachableLogger
- BufferedLogger
- Logger
- LogLevel
- BlockInventory
- Container
- Nameable
- Fallable
- CommandExecutor
- CommandMap
- CommandSender
- CraftingRecipe
- Ageable
- Animation
- Represents an animation such as an arm swing, or other visual effect done by entities.
- Consumable
- Interface implemented by objects that can be consumed by mobs.
- Explosive
- FoodSource
- Interface implemented by objects that can be consumed by players, giving them food and saturation.
- ProjectileSource
- Cancellable
- This interface is implemented by an Event subclass if and only if it can be cancelled.
- Listener
- Classes implementing this interface can be registered to receive called Events.
- Form
- Form implementations must implement this interface to be able to utilize the Player form-sending mechanism.
- Inventory
- InventoryHolder
- InventoryListener
- Classes implementing this interface can be injected into inventories to receive notifications when content changes occur.
- TemporaryInventory
- ConsumableItem
- Interface implemented by objects that can be consumed by mobs.
- FoodSourceItem
- Interface implemented by objects that can be consumed by mobs.
- Releasable
- Interface implemented by objects that can be used.
- AdvancedNetworkInterface
- Advanced network interfaces have some additional capabilities, such as being able to ban addresses and process raw packets.
- Compressor
- SkinAdapter
- Used to convert new skin data to the skin entity or old skin entity to skin data.
- PacketBroadcaster
- PacketSender
- NetworkInterface
- Network interfaces are transport layers which can be used to transmit packets between the server and clients.
- RawPacketHandler
- Permissible
- IPlayer
- Plugin
- It is recommended to use PluginBase for the actual plugin
- PluginLoader
- Handles different types of plugins
- PluginOwned
- This interface may be implemented by objects which are owned by plugins, to allow them to be identified as such.
- ResourceProvider
- ResourcePack
- ChunkListener
- This interface allows you to listen for events occurring on or in specific chunks. This will receive events for any chunks which it is registered to listen to.
- ChunkLoader
- If you want to keep chunks loaded, implement this interface and register it into World.
- ChunkManager
- WorldData
- WorldProvider
- WritableWorldProvider
- Populator
- Particle
- Sound
- TickingChunkLoader
- TickingChunkLoader includes all of the same functionality as ChunkLoader (it can be used in the same way).
- TestInterface
- MessageIdentifiers
- ProtocolAcceptor
- ServerEventListener
- ServerEventSource
- ServerInterface
- InterThreadChannelReader
- InterThreadChannelWriter
- ArrayInterface
- `ArrayInterface` provides traversable array functionality to data types.
- CollectionInterface
- A collection represents a group of objects, known as its elements.
- DoubleEndedQueueInterface
- A linear collection that supports element insertion and removal at both ends.
- MapInterface
- An object that maps keys to values.
- TypedMapInterface
- A `TypedMapInterface` represents a map of elements where key and value are typed.
- QueueInterface
- A queue is a collection in which the entities in the collection are kept in order.
- UuidBuilderInterface
- A UUID builder builds instances of UuidInterface
- CodecInterface
- A codec encodes and decodes a UUID according to defined rules
- NumberConverterInterface
- A number converter converts UUIDs from hexadecimal characters into representations of integers and vice versa
- TimeConverterInterface
- A time converter converts timestamps into representations that may be used in UUIDs
- DeprecatedUuidInterface
- This interface encapsulates deprecated methods for ramsey/uuid; this interface and its methods will be removed in ramsey/uuid 5.0.0.
- UuidExceptionInterface
- FieldsInterface
- UUIDs are comprised of unsigned integers, the bytes of which are separated into fields and arranged in a particular layout defined by the specification for the variant
- DceSecurityGeneratorInterface
- A DCE Security generator generates strings of binary data based on a local domain, local identifier, node ID, clock sequence, and the current time
- NameGeneratorInterface
- A name generator generates strings of binary data created by hashing together a namespace with a name, according to a hashing algorithm
- RandomGeneratorInterface
- A random generator generates strings of random binary data
- TimeGeneratorInterface
- A time generator generates strings of binary data based on a node ID, clock sequence, and the current time
- CalculatorInterface
- A calculator performs arithmetic operations on numbers
- DceSecurityProviderInterface
- A DCE provider provides access to local domain identifiers for version 2, DCE Security, UUIDs
- NodeProviderInterface
- A node provider retrieves or generates a node ID
- TimeProviderInterface
- A time provider retrieves the current time
- FieldsInterface
- RFC 4122 defines fields for a specific variant of UUID
- UuidInterface
- Also known as a Leach-Salz variant UUID, an RFC 4122 variant UUID is a universally unique identifier defined by RFC 4122
- NumberInterface
- NumberInterface ensures consistency in numeric values returned by ramsey/uuid
- TypeInterface
- TypeInterface ensures consistency in typed values returned by ramsey/uuid
- UuidFactoryInterface
- UuidFactoryInterface defines common functionality all `UuidFactory` instances must implement
- UuidInterface
- A UUID is a universally unique identifier adhering to an agreed-upon representation format and standard for generation
- ValidatorInterface
- A validator validates a string as a proper UUID
- Exception
- Exception
- Exception
- Exception
- Exception
- LongestCommonSubsequenceCalculator
- DiffOutputBuilderInterface
- Defines how an output builder should take a generated diff array and return a string representation of that diff.
- Exception
- Exception
- Exception
- Exception
- Exception
- Exception
- BooleanParseable
- The `Parseable` interface is used when defining custom parsing of a field.
- FloatParseable
- The `Parseable` interface is used when defining custom parsing of a field.
- IntParseable
- The `Parseable` interface is used when defining custom parsing of a field.
- ObjectParseable
- The `Parseable` interface is used when defining custom parsing of a field.
- Parseable
- The `Parseable` interface is used when defining custom parsing of a field.
- StringParseable
- The `Parseable` interface is used when defining custom parsing of a field.
- Context
- SimpleType
- Type
- ArginfoType
- ArgInfo
- FunctionName
- MethodName
- ReturnInfo
- FuncInfo
- ClassInfo
- FileInfo
- DocCommentTag
- RuntestsValgrind
- BroadcastTask
- ExampleListener
- MainClass
- Main
- PlayerReceiveMessageEvent
- Context
- Comment
- JSON comment and trailing comma stripper.
- CommentTest
- BigDecimal
- Immutable, arbitrary-precision signed decimal numbers.
- BigInteger
- An arbitrary-size integer.
- BigNumber
- Common interface for arbitrary-precision rational numbers.
- BigRational
- An arbitrarily large rational number.
- DivisionByZeroException
- Exception thrown when a division by zero occurs.
- IntegerOverflowException
- Exception thrown when an integer overflow occurs.
- MathException
- Base class for all math exceptions.
- NegativeNumberException
- Exception thrown when attempting to perform an unsupported operation, such as a square root, on a negative number.
- NumberFormatException
- Exception thrown when attempting to create a number from a string with an invalid format.
- RoundingNecessaryException
- Exception thrown when a number cannot be represented at the requested scale without rounding.
- RoundingMode
- Specifies a rounding behavior for numerical operations capable of discarding precision.
- ComposerAutoloaderInitf5c30eae39144cb65ebc6b143eb36a61
- ComposerStaticInitf5c30eae39144cb65ebc6b143eb36a61
- ClassLoader
- ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
- InstalledVersions
- This class is copied in every Composer installed project and available to all
- BaseArgument
- BlockPositionArgument
- BooleanArgument
- FloatArgument
- IntegerArgument
- RawStringArgument
- StringEnumArgument
- TextArgument
- Vector3Argument
- BaseCommand
- BaseSubCommand
- BaseConstraint
- ConsoleRequiredConstraint
- InGameRequiredConstraint
- ArgumentOrderException
- CommandoException
- HookAlreadyRegistered
- InvalidErrorCode
- PacketHooker
- SoftEnumStore
- InvalidArgumentException
- Exception for invalid arguments provided to the instantiator
- UnexpectedValueException
- Exception for given parameters causing invalid/unexpected state on instantiation
- Instantiator
- AbstractString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- AbstractTime
- Class ASNObject is the base class for all concrete ASN.1 objects.
- ASNObject
- Class ASNObject is the base class for all concrete ASN.1 objects.
- Base128
- A base-128 decoder.
- AttributeTypeAndValue
- Class ASNObject is the base class for all concrete ASN.1 objects.
- RDNString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- RelativeDistinguishedName
- Class ASNObject is the base class for all concrete ASN.1 objects.
- Construct
- Class ASNObject is the base class for all concrete ASN.1 objects.
- NotImplementedException
- ParserException
- ExplicitlyTaggedObject
- Class ExplicitlyTaggedObject decorate an inner object with an additional tag that gives information about its context specific meaning.
- Identifier
- The Identifier encodes the ASN.1 tag (class and number) of the type of a data value.
- OID
- TemplateParser
- BitString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- BMPString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- Boolean
- Class ASNObject is the base class for all concrete ASN.1 objects.
- CharacterString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- Enumerated
- Class ASNObject is the base class for all concrete ASN.1 objects.
- GeneralizedTime
- This ASN.1 universal type contains date and time information according to ISO 8601.
- GeneralString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- GraphicString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- IA5String
- The International Alphabet No.5 (IA5) references the encoding of the ASCII characters.
- Integer
- Class ASNObject is the base class for all concrete ASN.1 objects.
- NullObject
- Class ASNObject is the base class for all concrete ASN.1 objects.
- NumericString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- ObjectDescriptor
- Class ASNObject is the base class for all concrete ASN.1 objects.
- ObjectIdentifier
- Class ASNObject is the base class for all concrete ASN.1 objects.
- OctetString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- PrintableString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- RelativeObjectIdentifier
- Class ASNObject is the base class for all concrete ASN.1 objects.
- Sequence
- Class ASNObject is the base class for all concrete ASN.1 objects.
- Set
- Class ASNObject is the base class for all concrete ASN.1 objects.
- T61String
- Class ASNObject is the base class for all concrete ASN.1 objects.
- UniversalString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- UTCTime
- This ASN.1 universal type contains the calendar date and time.
- UTF8String
- Class ASNObject is the base class for all concrete ASN.1 objects.
- VisibleString
- Class ASNObject is the base class for all concrete ASN.1 objects.
- UnknownConstructedObject
- Class ASNObject is the base class for all concrete ASN.1 objects.
- UnknownObject
- Class ASNObject is the base class for all concrete ASN.1 objects.
- AlgorithmIdentifier
- Class ASNObject is the base class for all concrete ASN.1 objects.
- CertificateExtensions
- Class ASNObject is the base class for all concrete ASN.1 objects.
- CertificateSubject
- Class ASNObject is the base class for all concrete ASN.1 objects.
- Attributes
- Class ASNObject is the base class for all concrete ASN.1 objects.
- CSR
- Class ASNObject is the base class for all concrete ASN.1 objects.
- PrivateKey
- Class ASNObject is the base class for all concrete ASN.1 objects.
- PublicKey
- Class ASNObject is the base class for all concrete ASN.1 objects.
- DNSName
- Class ASNObject is the base class for all concrete ASN.1 objects.
- IPAddress
- Class ASNObject is the base class for all concrete ASN.1 objects.
- SubjectAlternativeNames
- See section 8.3.2.1 of ITU-T X.509.
- DeepCopy
- CloneException
- PropertyException
- DoctrineCollectionFilter
- DoctrineEmptyCollectionFilter
- DoctrineProxyFilter
- KeepFilter
- ReplaceFilter
- SetNullFilter
- DoctrineProxyMatcher
- PropertyMatcher
- PropertyNameMatcher
- PropertyTypeMatcher
- Matches a property by its type.
- ReflectionHelper
- DateIntervalFilter
- ReplaceFilter
- ShallowCopyFilter
- ArrayObjectFilter
- In PHP 7.4 the storage of an ArrayObject isn't returned as ReflectionProperty. So we deep copy its array copy.
- SplDoublyLinkedList
- SplDoublyLinkedListFilter
- TypeMatcher
- Class_
- ClassConst
- Declaration
- Enum_
- EnumCase
- Function_
- FunctionLike
- Interface_
- Method
- Namespace_
- Param
- Property
- Trait_
- TraitUse
- TraitUseAdaptation
- Use_
- BuilderFactory
- Doc
- Comment
- ConstExprEvaluationException
- ConstExprEvaluator
- Evaluates constant expressions.
- Error
- Collecting
- Error handler that collects all errors into an array.
- Throwing
- Error handler that handles all errors by throwing them.
- JsonDecoder
- Emulative
- AttributeEmulator
- CoaleseEqualTokenEmulator
- EnumTokenEmulator
- ExplicitOctalEmulator
- FlexibleDocStringEmulator
- FnTokenEmulator
- KeywordEmulator
- MatchTokenEmulator
- NullsafeTokenEmulator
- NumericLiteralSeparatorEmulator
- ReadonlyTokenEmulator
- ReverseEmulator
- Reverses emulation direction of the inner emulator.
- Lexer
- NameContext
- Arg
- Attribute
- AttributeGroup
- ComplexType
- This is a base class for complex types, including nullable types and union types.
- Const_
- Array_
- ArrayDimFetch
- ArrayItem
- ArrowFunction
- Assign
- BitwiseAnd
- BitwiseOr
- BitwiseXor
- Coalesce
- Concat
- Div
- Minus
- Mod
- Mul
- Plus
- Pow
- ShiftLeft
- ShiftRight
- AssignOp
- AssignRef
- BitwiseAnd
- BitwiseOr
- BitwiseXor
- BooleanAnd
- BooleanOr
- Coalesce
- Concat
- Div
- Equal
- Greater
- GreaterOrEqual
- Identical
- LogicalAnd
- LogicalOr
- LogicalXor
- Minus
- Mod
- Mul
- NotEqual
- NotIdentical
- Plus
- Pow
- ShiftLeft
- ShiftRight
- Smaller
- SmallerOrEqual
- Spaceship
- BinaryOp
- BitwiseNot
- BooleanNot
- CallLike
- Array_
- Bool_
- Double
- Int_
- Object_
- String_
- Unset_
- Cast
- ClassConstFetch
- Clone_
- Closure
- ClosureUse
- ConstFetch
- Empty_
- Error
- Error node used during parsing with error recovery.
- ErrorSuppress
- Eval_
- Exit_
- FuncCall
- Include_
- Instanceof_
- Isset_
- List_
- Match_
- MethodCall
- New_
- NullsafeMethodCall
- NullsafePropertyFetch
- PostDec
- PostInc
- PreDec
- PreInc
- Print_
- PropertyFetch
- ShellExec
- StaticCall
- StaticPropertyFetch
- Ternary
- Throw_
- UnaryMinus
- UnaryPlus
- Variable
- Yield_
- YieldFrom
- Expr
- Identifier
- Represents a non-namespaced name. Namespaced names are represented using Name nodes.
- IntersectionType
- This is a base class for complex types, including nullable types and union types.
- MatchArm
- FullyQualified
- Relative
- Name
- NullableType
- This is a base class for complex types, including nullable types and union types.
- Param
- DNumber
- Encapsed
- EncapsedStringPart
- LNumber
- Class_
- Dir
- File
- Function_
- Line
- Method
- Namespace_
- Trait_
- MagicConst
- String_
- Scalar
- Break_
- Case_
- Catch_
- Class_
- ClassConst
- ClassLike
- ClassMethod
- Const_
- Continue_
- Declare_
- DeclareDeclare
- Do_
- Echo_
- Else_
- ElseIf_
- Enum_
- EnumCase
- Expression
- Represents statements of type "expr;"
- Finally_
- For_
- Foreach_
- Function_
- Global_
- Goto_
- GroupUse
- HaltCompiler
- If_
- InlineHTML
- Interface_
- Label
- Namespace_
- Nop
- Nop/empty statement (;).
- Property
- PropertyProperty
- Return_
- Static_
- StaticVar
- Switch_
- Throw_
- Trait_
- TraitUse
- Alias
- Precedence
- TraitUseAdaptation
- TryCatch
- Unset_
- Use_
- UseUse
- While_
- Stmt
- UnionType
- This is a base class for complex types, including nullable types and union types.
- VariadicPlaceholder
- Represents the "..." in "foo(...)" of the first-class callable syntax.
- VarLikeIdentifier
- Represents a name that is written in source code with a leading dollar, but is not a proper variable. The leading dollar is not stored as part of the name.
- NodeAbstract
- NodeDumper
- NodeFinder
- NodeTraverser
- CloningVisitor
- Visitor cloning all nodes and linking to the original nodes using an attribute.
- FindingVisitor
- This visitor can be used to find and collect all nodes satisfying some criterion determined by a filter callback.
- FirstFindingVisitor
- This visitor can be used to find the first node satisfying some criterion determined by a filter callback.
- NameResolver
- NodeConnectingVisitor
- Visitor that connects a child node to its parent node as well as its sibling nodes.
- ParentConnectingVisitor
- Visitor that connects a child node to its parent node.
- NodeVisitorAbstract
- Multiple
- Php5
- Php7
- Tokens
- ParserAbstract
- ParserFactory
- Standard
- PrettyPrinterAbstract
- ElementCollectionException
- InvalidApplicationNameException
- InvalidEmailException
- InvalidUrlException
- ManifestDocumentException
- ManifestDocumentLoadingException
- ManifestDocumentMapperException
- ManifestElementException
- ManifestLoaderException
- ManifestDocumentMapper
- ManifestLoader
- ManifestSerializer
- Application
- ApplicationName
- Author
- AuthorCollection
- AuthorCollectionIterator
- BundledComponent
- BundledComponentCollection
- BundledComponentCollectionIterator
- CopyrightInformation
- Extension
- Library
- License
- Manifest
- PhpExtensionRequirement
- PhpVersionRequirement
- RequirementCollection
- RequirementCollectionIterator
- Type
- Url
- AuthorElement
- AuthorElementCollection
- BundlesElement
- ComponentElement
- ComponentElementCollection
- ContainsElement
- CopyrightElement
- ElementCollection
- ExtElement
- ExtElementCollection
- ExtensionElement
- LicenseElement
- ManifestDocument
- ManifestElement
- PhpElement
- RequiresElement
- BuildMetaData
- AbstractVersionConstraint
- AndVersionConstraintGroup
- AnyVersionConstraint
- ExactVersionConstraint
- GreaterThanOrEqualToVersionConstraint
- OrVersionConstraintGroup
- SpecificMajorAndMinorVersionConstraint
- SpecificMajorVersionConstraint
- InvalidPreReleaseSuffixException
- InvalidVersionException
- NoBuildMetaDataException
- NoPreReleaseSuffixException
- UnsupportedVersionConstraintException
- PreReleaseSuffix
- Version
- VersionConstraintParser
- VersionConstraintValue
- VersionNumber
- Fqsen
- Value Object for Fqsen.
- Location
- The location where an element occurs within a file.
- Description
- Object representing to description for a DocBlock.
- DescriptionFactory
- Creates a new Description object given a body of text.
- ExampleFinder
- Class used to find an example file's location based on a given ExampleDescriptor.
- Serializer
- Converts a DocBlock back from an object to a complete DocComment including Asterisks.
- StandardTagFactory
- Creates a Tag object given the contents of a tag.
- Author
- Reflection class for an {@}author tag in a Docblock.
- BaseTag
- Parses a tag definition for a DocBlock.
- Covers
- Reflection class for a @covers tag in a Docblock.
- Deprecated
- Reflection class for a {@}deprecated tag in a Docblock.
- Example
- Reflection class for a {@}example tag in a Docblock.
- AlignFormatter
- PassthroughFormatter
- Generic
- Parses a tag definition for a DocBlock.
- InvalidTag
- This class represents an exception during the tag creation
- Link
- Reflection class for a {@}link tag in a Docblock.
- Method
- Reflection class for an {@}method in a Docblock.
- Param
- Reflection class for the {@}param tag in a Docblock.
- Property
- Reflection class for a {@}property tag in a Docblock.
- PropertyRead
- Reflection class for a {@}property-read tag in a Docblock.
- PropertyWrite
- Reflection class for a {@}property-write tag in a Docblock.
- Fqsen
- Fqsen reference used by {@see \phpDocumentor\Reflection\DocBlock\Tags\See}
- Url
- Url reference used by {@see \phpDocumentor\Reflection\DocBlock\Tags\See}
- Return_
- Reflection class for a {@}return tag in a Docblock.
- See
- Reflection class for an {@}see tag in a Docblock.
- Since
- Reflection class for a {@}since tag in a Docblock.
- Source
- Reflection class for a {@}source tag in a Docblock.
- TagWithType
- Parses a tag definition for a DocBlock.
- Throws
- Reflection class for a {@}throws tag in a Docblock.
- Uses
- Reflection class for a {@}uses tag in a Docblock.
- Var_
- Reflection class for a {@}var tag in a Docblock.
- Version
- Reflection class for a {@}version tag in a Docblock.
- DocBlock
- DocBlockFactory
- PcreException
- Utils
- FqsenResolver
- Resolver for Fqsen using Context information
- CallableString
- Value Object representing the type 'string'.
- False_
- Value Object representing the PseudoType 'False', which is a Boolean type.
- HtmlEscapedString
- Value Object representing the type 'string'.
- IntegerRange
- Value Object representing the type 'int'.
- List_
- Value Object representing the type 'list'.
- LiteralString
- Value Object representing the type 'string'.
- LowercaseString
- Value Object representing the type 'string'.
- NegativeInteger
- Value Object representing the type 'int'.
- NonEmptyLowercaseString
- Value Object representing the type 'string'.
- NonEmptyString
- Value Object representing the type 'string'.
- Numeric_
- Value Object representing the 'numeric' pseudo-type, which is either a numeric-string, integer or float.
- NumericString
- Value Object representing the type 'string'.
- PositiveInteger
- Value Object representing the type 'int'.
- TraitString
- Value Object representing the type 'string'.
- True_
- Value Object representing the PseudoType 'False', which is a Boolean type.
- TypeResolver
- AbstractList
- Represents a list of values. This is an abstract class for Array_ and Collection.
- AggregatedType
- Base class for aggregated types like Compound and Intersection
- Array_
- Represents an array type as described in the PSR-5, the PHPDoc Standard.
- ArrayKey
- Value Object representing a array-key Type.
- Boolean
- Value Object representing a Boolean type.
- Callable_
- Value Object representing a Callable type.
- ClassString
- Value Object representing the type 'string'.
- Collection
- Represents a collection type as described in the PSR-5, the PHPDoc Standard.
- Compound
- Value Object representing a Compound Type.
- Context
- Provides information about the Context in which the DocBlock occurs that receives this context.
- ContextFactory
- Convenience class to create a Context for DocBlocks when not using the Reflection Component of phpDocumentor.
- Expression
- Represents an expression type as described in the PSR-5, the PHPDoc Standard.
- Float_
- Value Object representing a Float.
- Integer
- Value object representing Integer type
- InterfaceString
- Value Object representing the type 'string'.
- Intersection
- Value Object representing a Compound Type.
- Iterable_
- Value Object representing iterable type
- Mixed_
- Value Object representing an unknown, or mixed, type.
- Never_
- Value Object representing the return-type 'never'.
- Null_
- Value Object representing a null value or type.
- Nullable
- Value Object representing a nullable type. The real type is wrapped.
- Object_
- Value Object representing an object.
- Parent_
- Value Object representing the 'parent' type.
- Resource_
- Value Object representing the 'resource' Type.
- Scalar
- Value Object representing the 'scalar' pseudo-type, which is either a string, integer, float or boolean.
- Self_
- Value Object representing the 'self' type.
- Static_
- Value Object representing the 'static' type.
- String_
- Value Object representing the type 'string'.
- This
- Value Object representing the '$this' pseudo-type.
- Void_
- Value Object representing the return-type 'void'.
- ArgumentsWildcard
- Arguments wildcarding.
- AnyValuesToken
- Any values token.
- AnyValueToken
- Any single value token.
- ApproximateValueToken
- Approximate value token
- ArrayCountToken
- Array elements count token.
- ArrayEntryToken
- Array entry token.
- ArrayEveryEntryToken
- Array every entry token.
- CallbackToken
- Callback-verified token.
- ExactValueToken
- Exact value token.
- IdenticalValueToken
- Identical value token.
- InArrayToken
- Check if values is in array
- LogicalAndToken
- Logical AND token.
- LogicalNotToken
- Logical NOT token.
- NotInArrayToken
- Check if values is not in array
- ObjectStateToken
- Object state-checker token.
- StringContainsToken
- String contains token.
- TypeToken
- Value type token.
- Argument
- Argument tokens shortcuts.
- Call
- Call object.
- CallCenter
- Calls receiver & manager.
- ClosureComparator
- Closure comparator.
- Factory
- Prophecy comparator factory.
- ProphecyComparator
- Compares objects for equality.
- CachedDoubler
- Cached class doubler.
- DisableConstructorPatch
- Disable constructor.
- HhvmExceptionPatch
- Exception patch for HHVM to remove the stubs from special methods
- KeywordPatch
- Remove method functionality from the double which will clash with php keywords.
- MagicCallPatch
- Discover Magical API using "@method" PHPDoc format.
- ProphecySubjectPatch
- Add Prophecy functionality to the double.
- ReflectionClassNewInstancePatch
- ReflectionClass::newInstance patch.
- SplFileInfoPatch
- SplFileInfo patch.
- ThrowablePatch
- TraversablePatch
- Traversable interface patch.
- Doubler
- Cached class doubler.
- ClassCodeGenerator
- Class code creator.
- ClassCreator
- Class creator.
- ClassMirror
- Class mirror.
- ArgumentNode
- Argument node.
- ArgumentTypeNode
- ClassNode
- Class node.
- MethodNode
- Method node.
- ReturnTypeNode
- TypeNodeAbstract
- TypeHintReference
- Tells whether a keyword refers to a class or to a built-in type for the current version of php
- LazyDouble
- Lazy double.
- NameGenerator
- Name generator.
- UnexpectedCallException
- ClassCreatorException
- ClassMirrorException
- ClassNotFoundException
- DoubleException
- InterfaceNotFoundException
- MethodNotExtendableException
- MethodNotFoundException
- ReturnByReferenceException
- InvalidArgumentException
- AggregateException
- FailedPredictionException
- Basic failed prediction exception.
- NoCallsException
- UnexpectedCallsCountException
- UnexpectedCallsException
- MethodProphecyException
- ObjectProphecyException
- CallbackPrediction
- Callback prediction.
- CallPrediction
- Call prediction.
- CallTimesPrediction
- Prediction interface.
- NoCallsPrediction
- No calls prediction.
- CallbackPromise
- Callback promise.
- ReturnArgumentPromise
- Return argument promise.
- ReturnPromise
- Return promise.
- ThrowPromise
- Throw promise.
- MethodProphecy
- Method prophecy.
- ObjectProphecy
- Object prophecy.
- Revealer
- Basic prophecies revealer.
- Prophet
- Prophet creates prophecies.
- ExportUtil
- This class is a modification from sebastianbergmann/exporter
- StringUtil
- String utility.
- Plugin
- PharAutoloader
- BooleanInBooleanAndRule
- BooleanInBooleanNotRule
- BooleanInBooleanOrRule
- BooleanInElseIfConditionRule
- BooleanInIfConditionRule
- BooleanInTernaryOperatorRule
- BooleanRuleHelper
- UselessCastRule
- RequireParentConstructCallRule
- DisallowedBacktickRule
- DisallowedEmptyRule
- DisallowedImplicitArrayCreationRule
- DisallowedShortTernaryRule
- OverwriteVariablesWithForeachRule
- OverwriteVariablesWithForLoopInitRule
- ClosureUsesThisRule
- WrongCaseOfInheritedMethodRule
- OperandInArithmeticIncrementOrDecrementRule
- OperandInArithmeticPostDecrementRule
- OperandInArithmeticPostIncrementRule
- OperandInArithmeticPreDecrementRule
- OperandInArithmeticPreIncrementRule
- OperandsInArithmeticAdditionRule
- OperandsInArithmeticDivisionRule
- OperandsInArithmeticExponentiationRule
- OperandsInArithmeticModuloRule
- OperandsInArithmeticMultiplicationRule
- OperandsInArithmeticSubtractionRule
- OperatorRuleHelper
- DynamicCallOnStaticMethodsCallableRule
- DynamicCallOnStaticMethodsRule
- StrictFunctionCallsRule
- MatchingTypeInSwitchCaseConditionRule
- VariableMethodCallableRule
- VariableMethodCallRule
- VariablePropertyFetchRule
- VariableStaticMethodCallableRule
- VariableStaticMethodCallRule
- VariableStaticPropertyFetchRule
- VariableVariablesRule
- CodeCoverage
- Provides collection functionality for PHP code coverage information.
- Selector
- BranchAndPathCoverageNotSupportedException
- DeadCodeDetectionNotSupportedException
- DirectoryCouldNotBeCreatedException
- InvalidArgumentException
- NoCodeCoverageDriverAvailableException
- NoCodeCoverageDriverWithPathCoverageSupportAvailableException
- ParserException
- PathExistsButIsNotDirectoryException
- PcovNotAvailableException
- PhpdbgNotAvailableException
- ReflectionException
- ReportAlreadyFinalizedException
- StaticAnalysisCacheNotConfiguredException
- TestIdMissingException
- UnintentionallyCoveredCodeException
- WriteOperationFailedException
- WrongXdebugVersionException
- Xdebug2NotEnabledException
- Xdebug3NotEnabledException
- XdebugNotAvailableException
- XmlException
- Filter
- Clover
- Cobertura
- Crap4j
- Facade
- PHP
- Text
- Facade
- CacheWarmer
- Version
- Facade
- Factory
- Iterator
- ProcessControlExtensionNotLoadedException
- TimeoutException
- Invoker
- InvalidArgumentException
- RuntimeException
- Template
- Duration
- NoActiveTimerException
- TimeSinceStartOfRequestNotAvailableException
- ResourceUsageFormatter
- Timer
- Assert
- IsFalse
- IsTrue
- Callback
- Count
- GreaterThan
- IsEmpty
- LessThan
- SameSize
- Constraint
- IsEqual
- IsEqualCanonicalizing
- IsEqualIgnoringCase
- IsEqualWithDelta
- Exception
- ExceptionCode
- ExceptionMessage
- ExceptionMessageRegularExpression
- DirectoryExists
- FileExists
- IsReadable
- IsWritable
- IsAnything
- IsIdentical
- JsonMatches
- JsonMatchesErrorMessageProvider
- IsFinite
- IsInfinite
- IsNan
- ClassHasAttribute
- ClassHasStaticAttribute
- ObjectEquals
- ObjectHasAttribute
- BinaryOperator
- LogicalAnd
- LogicalNot
- LogicalOr
- LogicalXor
- Operator
- UnaryOperator
- IsJson
- RegularExpression
- StringContains
- StringEndsWith
- StringMatchesFormatDescription
- StringStartsWith
- ArrayHasKey
- TraversableContains
- TraversableContainsEqual
- TraversableContainsIdentical
- TraversableContainsOnly
- IsInstanceOf
- IsNull
- IsType
- InvocationMocker
- MockBuilder
- TestCase
- Version
- Command
- Blacklist
- ExcludeList
- ActorEventPacket
- ActorPickRequestPacket
- AddActorPacket
- AddBehaviorTreePacket
- AddEntityPacket
- AddItemActorPacket
- AddPaintingPacket
- AddPlayerPacket
- AddVolumeEntityPacket
- AdventureSettingsPacket
- AnimateEntityPacket
- AnimatePacket
- AnvilDamagePacket
- AutomationClientConnectPacket
- AvailableActorIdentifiersPacket
- AvailableCommandsPacket
- BiomeDefinitionListPacket
- BlockActorDataPacket
- BlockEventPacket
- BlockPickRequestPacket
- BookEditPacket
- BossEventPacket
- CameraPacket
- CameraShakePacket
- ChangeDimensionPacket
- ChunkRadiusUpdatedPacket
- ClientboundDebugRendererPacket
- ClientboundMapItemDataPacket
- ClientCacheBlobStatusPacket
- ClientCacheMissResponsePacket
- ClientCacheStatusPacket
- ClientToServerHandshakePacket
- CodeBuilderPacket
- CommandBlockUpdatePacket
- CommandOutputPacket
- CommandRequestPacket
- CompletedUsingItemPacket
- ContainerClosePacket
- ContainerOpenPacket
- ContainerSetDataPacket
- CorrectPlayerMovePredictionPacket
- CraftingDataPacket
- CraftingEventPacket
- CreatePhotoPacket
- CreativeContentPacket
- DataPacket
- DebugInfoPacket
- DisconnectPacket
- EducationSettingsPacket
- EduUriResourcePacket
- EmoteListPacket
- EmotePacket
- EventPacket
- FilterTextPacket
- GameRulesChangedPacket
- GuiDataPickItemPacket
- HurtArmorPacket
- InteractPacket
- InventoryContentPacket
- InventorySlotPacket
- InventoryTransactionPacket
- This packet effectively crams multiple packets into one.
- ItemComponentPacket
- ItemFrameDropItemPacket
- ItemStackRequestPacket
- ItemStackResponsePacket
- LabTablePacket
- LecternUpdatePacket
- LevelChunkPacket
- LevelEventGenericPacket
- LevelEventPacket
- LevelSoundEventPacket
- LevelSoundEventPacketV1
- Useless leftover from a 1.8 refactor, does nothing
- LevelSoundEventPacketV2
- Useless leftover from a 1.9 refactor, does nothing
- LoginPacket
- MapCreateLockedCopyPacket
- MapInfoRequestPacket
- MobArmorEquipmentPacket
- MobEffectPacket
- MobEquipmentPacket
- ModalFormRequestPacket
- ModalFormResponsePacket
- MotionPredictionHintsPacket
- MoveActorAbsolutePacket
- MoveActorDeltaPacket
- MovePlayerPacket
- MultiplayerSettingsPacket
- NetworkChunkPublisherUpdatePacket
- NetworkSettingsPacket
- NetworkStackLatencyPacket
- NpcDialoguePacket
- NpcRequestPacket
- OnScreenTextureAnimationPacket
- PacketDecodeException
- PacketPool
- PacketViolationWarningPacket
- PassengerJumpPacket
- PhotoInfoRequestPacket
- TODO: this one has no handlers, so I have no idea which direction it should be sent It doesn't appear to be used at all right now... this is just here to keep the scraper happy
- PhotoTransferPacket
- PlayerActionPacket
- PlayerArmorDamagePacket
- PlayerAuthInputPacket
- PlayerEnchantOptionsPacket
- PlayerFogPacket
- PlayerHotbarPacket
- PlayerInputPacket
- PlayerListPacket
- PlayerSkinPacket
- PlaySoundPacket
- PlayStatusPacket
- PositionTrackingDBClientRequestPacket
- PositionTrackingDBServerBroadcastPacket
- ProtocolInfo
- Version numbers and packet IDs for the current Minecraft PE protocol
- PurchaseReceiptPacket
- RemoveActorPacket
- RemoveEntityPacket
- RemoveObjectivePacket
- RemoveVolumeEntityPacket
- RequestChunkRadiusPacket
- ResourcePackChunkDataPacket
- ResourcePackChunkRequestPacket
- ResourcePackClientResponsePacket
- ResourcePackDataInfoPacket
- ResourcePacksInfoPacket
- ResourcePackStackPacket
- RespawnPacket
- ScriptCustomEventPacket
- ItemTypeDictionary
- NetworkNbtSerializer
- Base Named Binary Tag encoder/decoder
- PacketBatch
- PacketSerializer
- PacketSerializerContext
- Contains information for a packet serializer specific to a given game session needed for packet encoding and decoding, such as a dictionary of item runtime IDs to their internal string IDs.
- ServerSettingsRequestPacket
- ServerSettingsResponsePacket
- ServerToClientHandshakePacket
- SetActorDataPacket
- SetActorLinkPacket
- SetActorMotionPacket
- SetCommandsEnabledPacket
- SetDefaultGameTypePacket
- SetDifficultyPacket
- SetDisplayObjectivePacket
- SetHealthPacket
- SetLastHurtByPacket
- SetLocalPlayerAsInitializedPacket
- SetPlayerGameTypePacket
- SetScoreboardIdentityPacket
- SetScorePacket
- SetSpawnPositionPacket
- SetTimePacket
- SettingsCommandPacket
- SetTitlePacket
- ShowCreditsPacket
- ShowProfilePacket
- ShowStoreOfferPacket
- SimpleEventPacket
- SimulationTypePacket
- SpawnExperienceOrbPacket
- SpawnParticleEffectPacket
- StartGamePacket
- StopSoundPacket
- StructureBlockUpdatePacket
- StructureTemplateDataRequestPacket
- StructureTemplateDataResponsePacket
- SubChunkPacket
- SubChunkRequestPacket
- SubClientLoginPacket
- SyncActorPropertyPacket
- TakeItemActorPacket
- TextPacket
- TickSyncPacket
- TransferPacket
- ActorEvent
- BlockPaletteEntry
- BlockPosition
- BoolGameRule
- BossBarColor
- CacheableNbt
- ChunkCacheBlob
- CommandData
- CommandEnum
- CommandEnumConstraint
- CommandOriginData
- CommandOutputMessage
- CommandParameter
- DeviceOS
- DimensionIds
- EducationEditionOffer
- EducationSettingsAgentCapabilities
- EducationSettingsExternalLinkSettings
- EducationUriResource
- Enchant
- EnchantOption
- Attribute
- BlockPosMetadataProperty
- ByteMetadataProperty
- CompoundTagMetadataProperty
- EntityIds
- This file is directly generated from the entity definitions provided by the client. The entities listed in this file are expected to always have the same IDs.
- EntityLink
- EntityMetadataCollection
- EntityMetadataFlags
- EntityMetadataProperties
- EntityMetadataTypes
- FloatMetadataProperty
- IntMetadataProperty
- LongMetadataProperty
- PlayerMetadataFlags
- ShortMetadataProperty
- StringMetadataProperty
- Vec3MetadataProperty
- Experiments
- FloatGameRule
- GameMode
- GameRule
- GameRuleType
- GeneratorType
- InputMode
- IntGameRule
- ContainerIds
- CreativeContentEntry
- InventoryTransactionChangedSlotsHack
- ItemStack
- ItemStackWrapper
- MismatchTransactionData
- NetworkInventoryAction
- NormalTransactionData
- ReleaseItemTransactionData
- BeaconPaymentStackRequestAction
- Completes a transaction involving a beacon consuming input to produce effects.
- CraftingConsumeInputStackRequestAction
- Sends some (or all) items from the source slot to the magic place where crafting ingredients turn into result items.
- CraftingMarkSecondaryResultStackRequestAction
- I have no clear idea what this does. It seems to be the client hinting to the server "hey, put a secondary output in X crafting grid slot". This is used for things like buckets.
- CraftRecipeAutoStackRequestAction
- Tells that the current transaction crafted the specified recipe, using the recipe book. This is effectively the same as the regular crafting result action.
- CraftRecipeOptionalStackRequestAction
- Renames an item in an anvil, or map on a cartography table.
- CraftRecipeStackRequestAction
- Tells that the current transaction crafted the specified recipe.
- CreativeCreateStackRequestAction
- Creates an item by copying it from the creative inventory. This is treated as a crafting action by vanilla.
- DeprecatedCraftingNonImplementedStackRequestAction
- Tells that the current transaction involves crafting an item in a way that isn't supported by the current system.
- DeprecatedCraftingResultsStackRequestAction
- Not clear what this is needed for, but it is very clearly marked as deprecated, so hopefully it'll go away before I have to write a proper description for it.
- DestroyStackRequestAction
- Sends some (or all) items from the source slot to /dev/null. This happens when the player clicks items into the creative inventory menu in creative mode.
- DropStackRequestAction
- Drops some (or all) items from the source slot into the world as an item entity.
- ItemStackRequest
- ItemStackRequestAction
- ItemStackRequestActionType
- ItemStackRequestSlotInfo
- LabTableCombineStackRequestAction
- Not clear what the point of this is. It's sent when the player uses a lab table, but it's not clear why this action is needed.
- MineBlockStackRequestAction
- PlaceStackRequestAction
- Puts some (or all) of the items from the source slot into the destination slot.
- SwapStackRequestAction
- Swaps two stacks. These don't have to be in the same inventory. This action does not modify the stacks themselves.
- TakeStackRequestAction
- Takes some (or all) of the items from the source slot into the destination slot (usually the cursor?).
- ItemStackResponse
- ItemStackResponseContainerInfo
- ItemStackResponseSlotInfo
- TransactionData
- UIInventorySlotOffset
- UseItemOnEntityTransactionData
- UseItemTransactionData
- WindowTypes
- ItemComponentPacketEntry
- ItemInteractionData
- ItemTypeEntry
- LevelEvent
- LevelSettings
- LevelSoundEvent
- AuthenticationData
- Model class for LoginPacket JSON data for JsonMapper
- ClientData
- Model class for LoginPacket JSON data for JsonMapper
- ClientDataAnimationFrame
- Model class for LoginPacket JSON data for JsonMapper
- ClientDataPersonaPieceTintColor
- Model class for LoginPacket JSON data for JsonMapper
- ClientDataPersonaSkinPiece
- Model class for LoginPacket JSON data for JsonMapper
- ClientDataToSkinDataHelper
- JwtBodyRfc7519
- Model class for JsonMapper which describes the RFC7519 standard fields in a JWT. Any of these fields might not be provided.
- JwtChain
- Model class for LoginPacket JSON data for JsonMapper
- JwtChainLinkBody
- Model for JsonMapper exposing the data in the login JWT chain links.
- JwtHeader
- MapDecoration
- MapImage
- MapTrackedObject
- MultiplayerGameVisibility
- ParticleIds
- PlayerAction
- PlayerAuthInputFlags
- These flags are used in PlayerAuthInputPacket's inputFlags field.
- PlayerBlockActionStopBreak
- PlayerBlockActionWithBlockInfo
- This is used for PlayerAuthInput packet when the flags include PERFORM_BLOCK_ACTIONS
- PlayerListEntry
- PlayerMovementSettings
- PlayerMovementType
- PlayerPermissions
- PlayMode
- Enum used by PlayerAuthInputPacket. Most of these names don't make any sense, but that isn't surprising.
- CraftingRecipeBlockName
- FurnaceRecipe
- FurnaceRecipeBlockName
- MaterialReducerRecipe
- MaterialReducerRecipeOutput
- MultiRecipe
- PotionContainerChangeRecipe
- PotionTypeRecipe
- RecipeIngredient
- RecipeWithTypeId
- ShapedRecipe
- ShapelessRecipe
- BehaviorPackInfoEntry
- ResourcePackInfoEntry
- ResourcePackStackEntry
- ResourcePackType
- ScoreboardIdentityPacketEntry
- ScorePacketEntry
- PersonaPieceTintColor
- PersonaSkinPiece
- SkinAnimation
- SkinData
- SkinImage
- SpawnSettings
- StructureEditorData
- StructureSettings
- SubChunkPacketHeightMapInfo
- SubChunkPacketHeightMapType
- SubChunkRequestResult
- UIProfile
- UpdateSubChunkBlocksPacketEntry
- UpdateAttributesPacket
- UpdateBlockPacket
- UpdateBlockSyncedPacket
- UpdateEquipPacket
- UpdatePlayerGameTypePacket
- UpdateSoftEnumPacket
- UpdateSubChunkBlocksPacket
- UpdateTradePacket
- DataPacketTest
- LoginPacketTest
- ProtocolInfoTest
- PacketBatchTest
- TestPacket
- Binary
- BinaryDataException
- BinaryStream
- Limits
- BinaryTest
- BuiltInTypes
- CallbackType
- InvalidCallbackException
- MatchTester
- ParameterType
- ReturnType
- Type
- ClassImplementingInvoke
- ClassImplementingIteratorAggregate
- ClassImplementingNothing
- ClassImplementingToString
- MatchTesterTest
- BasePhp71Test
- TypeTest
- BaseClassLoader
- BaseClassLoaderTest
- GlobalFallbackClass
- NamespacedFallbackClass
- NestedNamespacedFallbackClass
- NestedNamespacePsr4Class
- TopNamespacePsr4Class
- Color
- ErrorRecord
- ErrorToExceptionHandler
- ErrorTypeToStringMap
- GlobalLogger
- Global accessor for logger
- PrefixedLogger
- SimpleLogger
- AttachableThreadedLogger
- ThreadedLogger
- ThreadedLoggerAttachment
- Axis
- AxisAlignedBB
- Facing
- Math
- Matrix
- RayTraceResult
- Class representing a ray trace collision with an AxisAlignedBB
- Vector2
- Vector3
- VectorMath
- VoxelRayTrace
- FacingTest
- Vector3Test
- BaseNbtSerializer
- Base Named Binary Tag encoder/decoder
- BigEndianNbtSerializer
- Base Named Binary Tag encoder/decoder
- InvalidTagValueException
- JsonNbtParser
- LittleEndianNbtSerializer
- Base Named Binary Tag encoder/decoder
- NBT
- NbtDataException
- NbtException
- NoSuchTagException
- ReaderTracker
- ByteArrayTag
- ByteTag
- CompoundTag
- DoubleTag
- FloatTag
- ImmutableTag
- IntArrayTag
- IntTag
- ListTag
- LongTag
- ShortTag
- StringTag
- Tag
- TreeRoot
- This class wraps around the root Tag for NBT files to avoid losing the name information.
- UnexpectedTagTypeException
- CreateTagTest
- JsonNbtParserTest
- NbtSerializerTest
- ByteArrayTagTest
- ByteTagTest
- CompoundTagTest
- DoubleTagTest
- FloatTagTest
- IntArrayTagTest
- IntTagTest
- ListTagTest
- LongTagTest
- ShortTagTest
- StringTagTest
- ActivatorRail
- Simple non-curvable rail.
- Air
- Air block
- Anvil
- Bamboo
- BambooSapling
- Barrel
- BaseBanner
- BaseCoral
- BaseRail
- BaseSign
- Beacon
- Bed
- Bedrock
- Beetroot
- Bell
- Block
- BlockBreakInfo
- BlockFactory
- Manages deserializing block types from their legacy blockIDs and metadata.
- BlockIdentifier
- BlockIdentifierFlattened
- BlockLegacyIdHelper
- BlockLegacyIds
- BlockLegacyMetadata
- Constants for legacy metadata for various blocks.
- BlockToolType
- Types of tools that can be used to break blocks Blocks may allow multiple tool types by combining these bitflags
- BlueIce
- BoneBlock
- Bookshelf
- BrewingStand
- BrownMushroom
- BrownMushroomBlock
- Button
- Cactus
- Cake
- Carpet
- Carrot
- CarvedPumpkin
- ChemicalHeat
- ChemistryTable
- Chest
- Clay
- Coal
- CoalOre
- Cobweb
- CocoaBlock
- Concrete
- ConcretePowder
- Coral
- CoralBlock
- CraftingTable
- Crops
- DaylightSensor
- DeadBush
- DetectorRail
- Simple non-curvable rail.
- DiamondOre
- Dirt
- Door
- DoublePlant
- DoubleTallGrass
- DragonEgg
- DriedKelp
- DyedShulkerBox
- Element
- EmeraldOre
- EnchantingTable
- EnderChest
- EndPortalFrame
- EndRod
- Farmland
- Fence
- FenceGate
- Fire
- FletchingTable
- FloorBanner
- FloorCoralFan
- FloorSign
- Flowable
- Flower
- FlowerPot
- FrostedIce
- Furnace
- Glass
- GlassPane
- GlazedTerracotta
- GlowingObsidian
- Glowstone
- Grass
- GrassPath
- Gravel
- HardenedClay
- HardenedGlass
- HardenedGlassPane
- HayBale
- Hopper
- Ice
- InfestedStone
- AnvilInventory
- This class provides a complete implementation of a regular inventory.
- BarrelInventory
- This class provides a complete implementation of a regular inventory.
- BrewingStandInventory
- This class provides a complete implementation of a regular inventory.
- ChestInventory
- This class provides a complete implementation of a regular inventory.
- CraftingTableInventory
- This class provides a complete implementation of a regular inventory.
- DoubleChestInventory
- This class provides everything needed to implement an inventory, minus the underlying storage system.
- EnchantInventory
- This class provides a complete implementation of a regular inventory.
- EnderChestInventory
- EnderChestInventory is not a real inventory; it's just a gateway to the player's ender inventory.
- FurnaceInventory
- This class provides a complete implementation of a regular inventory.
- HopperInventory
- This class provides a complete implementation of a regular inventory.
- LoomInventory
- This class provides a complete implementation of a regular inventory.
- ShulkerBoxInventory
- This class provides a complete implementation of a regular inventory.
- ItemFrame
- Jukebox
- Ladder
- Lantern
- LapisOre
- Lava
- Leaves
- Lever
- Liquid
- LitPumpkin
- Log
- Loom
- Magma
- Melon
- MelonStem
- MonsterSpawner
- MushroomStem
- Mycelium
- NetherPortal
- NetherQuartzOre
- Netherrack
- NetherReactor
- NetherWartPlant
- Note
- Opaque
- PackedIce
- Planks
- Podzol
- Potato
- PoweredRail
- Simple non-curvable rail.
- PressurePlate
- PumpkinStem
- Rail
- RedMushroom
- RedMushroomBlock
- Redstone
- RedstoneComparator
- RedstoneLamp
- RedstoneOre
- RedstoneRepeater
- RedstoneTorch
- RedstoneWire
- Reserved6
- Sand
- Sapling
- SeaLantern
- SeaPickle
- ShulkerBox
- SimplePressurePlate
- Skull
- Slab
- Slime
- Snow
- SnowLayer
- SoulSand
- Sponge
- StainedGlass
- StainedGlassPane
- StainedHardenedClay
- StainedHardenedGlass
- StainedHardenedGlassPane
- Stair
- Stem
- StoneButton
- StonePressurePlate
- StraightOnlyRail
- Simple non-curvable rail.
- Sugarcane
- SweetBerryBush
- TallGrass
- Thin
- Banner
- Barrel
- Beacon
- Bed
- Bell
- BlastFurnace
- BrewingStand
- Chest
- Comparator
- DaylightSensor
- EnchantTable
- EnderChest
- FlowerPot
- Furnace
- Hopper
- ItemFrame
- Jukebox
- MonsterSpawner
- NormalFurnace
- Note
- ShulkerBox
- Sign
- Skull
- Smoker
- Spawnable
- Tile
- TileFactory
- TNT
- Torch
- Transparent
- Trapdoor
- TrappedChest
- Tripwire
- TripwireHook
- UnderwaterTorch
- UnknownBlock
- BannerPatternLayer
- Contains information about a pattern layer on a banner.
- BannerPatternType
- This doc-block is generated automatically, do not modify it manually.
- BellAttachmentType
- This doc-block is generated automatically, do not modify it manually.
- BlockDataSerializer
- BrewingStandSlot
- This doc-block is generated automatically, do not modify it manually.
- CoralType
- This doc-block is generated automatically, do not modify it manually.
- DyeColor
- This doc-block is generated automatically, do not modify it manually.
- InvalidBlockStateException
- LeverFacing
- This doc-block is generated automatically, do not modify it manually.
- MinimumCostFlowCalculator
- Calculates the path(s) of least resistance for liquid flow.
- MushroomBlockType
- This doc-block is generated automatically, do not modify it manually.
- RailConnectionInfo
- RecordType
- This doc-block is generated automatically, do not modify it manually.
- SignText
- SkullType
- This doc-block is generated automatically, do not modify it manually.
- SlabType
- This doc-block is generated automatically, do not modify it manually.
- StairShape
- This doc-block is generated automatically, do not modify it manually.
- TreeType
- This doc-block is generated automatically, do not modify it manually.
- VanillaBlocks
- This doc-block is generated automatically, do not modify it manually.
- Vine
- Wall
- WallBanner
- WallCoralFan
- WallSign
- Water
- WaterLily
- WeightedPressurePlate
- WeightedPressurePlateHeavy
- WeightedPressurePlateLight
- Wheat
- Wood
- WoodenButton
- WoodenDoor
- WoodenFence
- WoodenPressurePlate
- WoodenSlab
- WoodenStairs
- WoodenTrapdoor
- Wool
- Command
- BanCommand
- BanIpCommand
- BanListCommand
- ClearCommand
- DefaultGamemodeCommand
- DeopCommand
- DifficultyCommand
- DumpMemoryCommand
- EffectCommand
- EnchantCommand
- GamemodeCommand
- GarbageCollectorCommand
- GiveCommand
- HelpCommand
- KickCommand
- KillCommand
- ListCommand
- MeCommand
- OpCommand
- PardonCommand
- PardonIpCommand
- ParticleCommand
- PluginsCommand
- SaveCommand
- SaveOffCommand
- SaveOnCommand
- SayCommand
- SeedCommand
- SetWorldSpawnCommand
- SpawnpointCommand
- StatusCommand
- StopCommand
- TeleportCommand
- TellCommand
- TimeCommand
- TimingsCommand
- TitleCommand
- TransferServerCommand
- VanillaCommand
- VersionCommand
- WhitelistCommand
- FormattedCommandAlias
- PluginCommand
- SimpleCommandMap
- CommandException
- InvalidCommandSyntaxException
- ConsoleCommandSender
- ConsoleReader
- ConsoleReaderThread
- Specialized Thread class aimed at PocketMine-MP-related usages. It handles setting up autoloading and error handling.
- CraftingGrid
- This class provides a complete implementation of a regular inventory.
- CraftingManager
- CraftingManagerFromDataHelper
- FurnaceRecipe
- FurnaceRecipeManager
- FurnaceType
- This doc-block is generated automatically, do not modify it manually.
- ShapedRecipe
- ShapelessRecipe
- CrashDump
- CrashDumpData
- CrashDumpDataGeneral
- CrashDumpDataPluginEntry
- CrashDumpRenderer
- BannerPatternTypeIdMap
- BiomeIds
- CoralTypeIdMap
- DyeColorIdMap
- EffectIdMap
- EffectIds
- EnchantmentIdMap
- Handles translation of internal enchantment types to and from Minecraft: Bedrock IDs.
- EnchantmentIds
- EntityLegacyIds
- LegacyBiomeIdToStringIdMap
- LegacyBlockIdToStringIdMap
- LegacyEntityIdToStringIdMap
- LegacyItemIdToStringIdMap
- LegacyToStringBidirectionalIdMap
- MushroomBlockTypeIdMap
- PotionTypeIdMap
- PotionTypeIds
- GameModeIdMap
- SavedDataLoadingException
- ArmSwingAnimation
- ArrowShakeAnimation
- ConsumingItemAnimation
- CriticalHitAnimation
- DeathAnimation
- HurtAnimation
- RespawnAnimation
- SquidInkCloudAnimation
- TotemUseAnimation
- Attribute
- AttributeFactory
- AttributeMap
- AbsorptionEffect
- Effect
- EffectInstance
- EffectManager
- HealthBoostEffect
- HungerEffect
- InstantDamageEffect
- InstantEffect
- InstantHealthEffect
- InvisibilityEffect
- LevitationEffect
- PoisonEffect
- RegenerationEffect
- SaturationEffect
- SlownessEffect
- SpeedEffect
- StringToEffectParser
- Handles parsing effect types from strings. This is used to interpret names in the /effect command.
- VanillaEffects
- This doc-block is generated automatically, do not modify it manually.
- WitherEffect
- Entity
- EntityDataHelper
- EntityFactory
- This class manages the creation of entities loaded from disk.
- EntitySizeInfo
- ExperienceManager
- Human
- HungerManager
- InvalidSkinException
- Living
- Location
- ExperienceOrb
- FallingBlock
- ItemEntity
- Painting
- PaintingMotive
- PrimedTNT
- Arrow
- Egg
- EnderPearl
- ExperienceBottle
- Projectile
- Snowball
- SplashPotion
- Throwable
- Skin
- Squid
- ExperienceUtils
- Villager
- WaterAnimal
- Zombie
- BlockBreakEvent
- Called when a player destroys a block somewhere in the world.
- BlockBurnEvent
- Called when a block is burned away by fire.
- BlockEvent
- BlockFormEvent
- Called when a new block forms, usually as the result of some action.
- BlockGrowEvent
- Called when plants or crops grow.
- BlockItemPickupEvent
- Called when a block picks up an item, arrow, etc.
- BlockPlaceEvent
- Called when a player places a block
- BlockSpreadEvent
- Called when a block spreads to another block, such as grass spreading to nearby dirt blocks.
- BlockTeleportEvent
- BlockUpdateEvent
- Called when a block tries to be updated due to a neighbor change
- LeavesDecayEvent
- Called when leaves decay due to not being attached to wood.
- SignChangeEvent
- Called when a sign's text is changed by a player.
- StructureGrowEvent
- Called when structures such as Saplings or Bamboo grow.
- EntityBlockChangeEvent
- Called when an Entity, excluding players, changes a block directly
- EntityCombustByBlockEvent
- EntityCombustByEntityEvent
- EntityCombustEvent
- EntityDamageByBlockEvent
- Called when an entity takes damage from a block.
- EntityDamageByChildEntityEvent
- Called when an entity takes damage from an entity sourced from another entity, for example being hit by a snowball thrown by a Player.
- EntityDamageByEntityEvent
- Called when an entity takes damage from another entity.
- EntityDamageEvent
- Called when an entity takes damage.
- EntityDeathEvent
- EntityDespawnEvent
- Called when a entity is despawned
- EntityEffectAddEvent
- Called when an effect is added to an Entity.
- EntityEffectEvent
- EntityEffectRemoveEvent
- Called when an effect is removed from an entity.
- EntityEvent
- EntityExplodeEvent
- Called when a entity explodes
- EntityItemPickupEvent
- Called when an entity picks up an item, arrow, etc.
- EntityMotionEvent
- EntityRegainHealthEvent
- EntityShootBowEvent
- EntitySpawnEvent
- Called when a entity is spawned
- EntityTeleportEvent
- EntityTrampleFarmlandEvent
- ExplosionPrimeEvent
- Called when a entity decides to explode
- ItemDespawnEvent
- ItemSpawnEvent
- ProjectileHitBlockEvent
- ProjectileHitEntityEvent
- ProjectileHitEvent
- ProjectileLaunchEvent
- Event
- EventPriority
- List of event priorities
- HandlerList
- HandlerListManager
- CraftItemEvent
- FurnaceBurnEvent
- Called when a furnace is about to consume a new fuel item.
- FurnaceSmeltEvent
- InventoryCloseEvent
- InventoryEvent
- InventoryOpenEvent
- InventoryTransactionEvent
- Called when there is a transaction between two Inventory objects.
- ListenerMethodTags
- Provides constants for all the PhpDoc tags supported for Listener methods.
- PlayerBedEnterEvent
- PlayerBedLeaveEvent
- PlayerBlockPickEvent
- Called when a player middle-clicks on a block to get an item in creative mode.
- PlayerBucketEmptyEvent
- PlayerBucketEvent
- PlayerBucketFillEvent
- PlayerChangeSkinEvent
- Called when a player changes their skin in-game.
- PlayerChatEvent
- Called when a player chats something
- PlayerCommandPreprocessEvent
- Called when a player runs a command or chats, early in the process
- PlayerCreationEvent
- Allows the creation of players overriding the base Player class
- PlayerDataSaveEvent
- Called when a player's data is about to be saved to disk.
- PlayerDeathEvent
- PlayerDisplayNameChangeEvent
- PlayerDropItemEvent
- Called when a player tries to drop an item from its hotbar
- PlayerDuplicateLoginEvent
- Called when a player connects with a username or UUID that is already used by another player on the server.
- PlayerEditBookEvent
- PlayerEmoteEvent
- Called when a player uses an emote.
- PlayerEntityInteractEvent
- Called when a player interacts with an entity (e.g. shearing a sheep, naming a mob using a nametag).
- PlayerEvent
- PlayerExhaustEvent
- PlayerExperienceChangeEvent
- Called when a player gains or loses XP levels and/or progress.
- PlayerGameModeChangeEvent
- Called when a player has its gamemode changed
- PlayerInteractEvent
- Called when a player interacts or touches a block (including air?)
- PlayerItemConsumeEvent
- Called when a player eats something
- PlayerItemHeldEvent
- PlayerItemUseEvent
- Called when a player uses its held item, for example when throwing a projectile.
- PlayerJoinEvent
- Called when the player spawns in the world after logging in, when they first see the terrain.
- PlayerJumpEvent
- Called when a player jumps
- PlayerKickEvent
- Called when a player leaves the server
- PlayerLoginEvent
- Called after the player has successfully authenticated, before it spawns. The player is on the loading screen when this is called.
- PlayerMoveEvent
- PlayerPreLoginEvent
- Called when a player connects to the server, prior to authentication taking place.
- PlayerQuitEvent
- Called when a player leaves the server
- PlayerRespawnEvent
- Called when a player is respawned
- PlayerToggleFlightEvent
- PlayerToggleSneakEvent
- PlayerToggleSprintEvent
- PlayerTransferEvent
- PluginDisableEvent
- PluginEnableEvent
- PluginEvent
- RegisteredListener
- CommandEvent
- Called when any CommandSender runs a command, early in the process
- DataPacketReceiveEvent
- DataPacketSendEvent
- Called when packets are sent to network sessions.
- LowMemoryEvent
- Called when the server is in a low-memory state as defined by the properties Plugins should free caches or other non-essential data.
- NetworkInterfaceEvent
- NetworkInterfaceRegisterEvent
- Called when a network interface is registered into the network, for example the RakLib interface.
- NetworkInterfaceUnregisterEvent
- Called when a network interface is unregistered
- QueryRegenerateEvent
- ServerEvent
- UpdateNotifyEvent
- Called when the AutoUpdater receives notification of an available PocketMine-MP update.
- ChunkEvent
- Chunk-related events
- ChunkLoadEvent
- Called when a Chunk is loaded
- ChunkPopulateEvent
- Called when a Chunk is populated (after receiving it on the main thread)
- ChunkUnloadEvent
- Called when a Chunk is unloaded
- SpawnChangeEvent
- An event that is called when a world spawn changes.
- WorldEvent
- WorldInitEvent
- Called when a World is initializing
- WorldLoadEvent
- Called when a World is loaded
- WorldSaveEvent
- Called when a World is saved
- WorldUnloadEvent
- Called when a World is unloaded
- FormValidationException
- ArmorInventory
- This class provides a complete implementation of a regular inventory.
- BaseInventory
- This class provides everything needed to implement an inventory, minus the underlying storage system.
- CallbackInventoryListener
- CreativeInventory
- DelegateInventory
- An inventory which is backed by another inventory, and acts as a proxy to that inventory.
- PlayerCraftingInventory
- This class provides a complete implementation of a regular inventory.
- PlayerCursorInventory
- This class provides a complete implementation of a regular inventory.
- PlayerEnderInventory
- This class provides a complete implementation of a regular inventory.
- PlayerInventory
- This class provides a complete implementation of a regular inventory.
- PlayerOffHandInventory
- This class provides a complete implementation of a regular inventory.
- SimpleInventory
- This class provides a complete implementation of a regular inventory.
- CreateItemAction
- This action is used by creative players to balance transactions involving the creative inventory menu.
- DestroyItemAction
- This action type shows up when a creative player puts an item into the creative inventory menu to destroy it.
- DropItemAction
- Represents an action involving dropping an item into the world.
- InventoryAction
- Represents an action involving a change that applies in some way to an inventory or other item-source.
- SlotChangeAction
- Represents an action causing a change in an inventory slot.
- CraftingTransaction
- This transaction type is specialized for crafting validation. It shares most of the same semantics of the base inventory transaction type, but the requirement for validity is slightly different.
- InventoryTransaction
- This is the basic type for an inventory transaction. This is used for moving items between inventories, dropping items and more. It allows transactions with multiple inputs and outputs.
- TransactionBuilderInventory
- This class facilitates generating SlotChangeActions to build an inventory transaction.
- TransactionCancelledException
- Thrown when an inventory transaction is valid, but can't proceed due to other factors (e.g. a plugin intervened).
- TransactionException
- Thrown when a transaction fails to execute for any reason.
- TransactionValidationException
- Thrown when a transaction cannot proceed due to preconditions not being met (e.g. transaction doesn't balance).
- Apple
- Armor
- ArmorTypeInfo
- Arrow
- Axe
- BakedPotato
- Bamboo
- Banner
- Bed
- Beetroot
- BeetrootSeeds
- BeetrootSoup
- BlazeRod
- Boat
- Book
- Bow
- Bowl
- Bread
- Bucket
- Carrot
- ChorusFruit
- Clock
- Clownfish
- Coal
- CocoaBeans
- Compass
- CookedChicken
- CookedFish
- CookedMutton
- CookedPorkchop
- CookedRabbit
- CookedSalmon
- Cookie
- DriedKelp
- Durable
- Dye
- Egg
- Enchantment
- Manages enchantment type data.
- EnchantmentInstance
- Container for enchantment data applied to items.
- FireAspectEnchantment
- Classes extending this class can be applied to weapons and activate when used by a mob to attack another mob in melee combat.
- ItemFlags
- KnockbackEnchantment
- Classes extending this class can be applied to weapons and activate when used by a mob to attack another mob in melee combat.
- MeleeWeaponEnchantment
- Classes extending this class can be applied to weapons and activate when used by a mob to attack another mob in melee combat.
- ProtectionEnchantment
- Manages enchantment type data.
- Rarity
- SharpnessEnchantment
- Classes extending this class can be applied to weapons and activate when used by a mob to attack another mob in melee combat.
- StringToEnchantmentParser
- Handles parsing enchantments from strings. This is used to interpret names in the /enchant command.
- VanillaEnchantments
- This doc-block is generated automatically, do not modify it manually.
- EnderPearl
- ExperienceBottle
- Fertilizer
- FishingRod
- FlintSteel
- Food
- GlassBottle
- GoldenApple
- GoldenAppleEnchanted
- GoldenCarrot
- Hoe
- Item
- ItemBlock
- Class used for Items that can be Blocks
- ItemBlockWallOrFloor
- ItemFactory
- Manages deserializing item types from their legacy ID/metadata.
- ItemIdentifier
- ItemIds
- ItemUseResult
- This doc-block is generated automatically, do not modify it manually.
- LegacyStringToItemParser
- LegacyStringToItemParserException
- LiquidBucket
- Melon
- MelonSeeds
- MilkBucket
- Minecart
- MushroomStew
- PaintingItem
- Pickaxe
- PoisonousPotato
- Potato
- Potion
- PotionType
- This doc-block is generated automatically, do not modify it manually.
- ProjectileItem
- Pufferfish
- PumpkinPie
- PumpkinSeeds
- RabbitStew
- RawBeef
- RawChicken
- RawFish
- RawMutton
- RawPorkchop
- RawRabbit
- RawSalmon
- Record
- Redstone
- RottenFlesh
- Shears
- Shovel
- Skull
- Snowball
- SpawnEgg
- SpiderEye
- SplashPotion
- Steak
- Stick
- StringItem
- StringToItemParser
- Handles parsing items from strings. This is used to interpret names from the /give command (and others).
- SweetBerries
- Sword
- TieredTool
- Tool
- ToolTier
- This doc-block is generated automatically, do not modify it manually.
- Totem
- VanillaItems
- This doc-block is generated automatically, do not modify it manually.
- WheatSeeds
- WritableBook
- WritableBookBase
- WritableBookPage
- WrittenBook
- KnownTranslationFactory
- This class contains factory methods for all the translations known to PocketMine-MP as per the used version of pmmp/Language.
- KnownTranslationKeys
- This class contains constants for all the translations known to PocketMine-MP as per the used version of pmmp/Language.
- Language
- LanguageNotFoundException
- Translatable
- MemoryManager
- BandwidthStatsTracker
- BidirectionalBandwidthStatsTracker
- ProcessLoginTask
- Class used to run async tasks in other threads.
- VerifyLoginException
- ChunkCache
- This class is used by the current MCPE protocol system to store cached chunk packets for fast resending.
- CraftingDataCache
- StaticPacketCache
- ChunkRequestTask
- Class used to run async tasks in other threads.
- CompressBatchPromise
- CompressBatchTask
- Class used to run async tasks in other threads.
- DecompressionException
- ZlibCompressor
- GlobalItemTypeDictionary
- ItemTranslator
- This class handles translation between network item ID+metadata to PocketMine-MP internal ID+metadata and vice versa.
- LegacySkinAdapter
- R12ToCurrentBlockMapEntry
- SkinAdapterSingleton
- Accessor for SkinAdapter
- TypeConversionException
- Thrown by TypeConverter if a problem occurred during converting of network types to PM core types (e.g. invalid item ID, invalid NBT, etc).
- TypeConverter
- DecryptionException
- EncryptionContext
- EncryptionUtils
- PrepareEncryptionTask
- Class used to run async tasks in other threads.
- DeathPacketHandler
- Handlers are attached to sessions to handle packets received from their associated clients. A handler is mutable and may be removed/replaced at any time.
- HandshakePacketHandler
- Handler responsible for awaiting client response from crypto handshake.
- InGamePacketHandler
- This handler handles packets related to general gameplay.
- LoginPacketHandler
- Handles the initial login phase of the session. This handler is used as the initial state.
- PacketHandler
- Handlers are attached to sessions to handle packets received from their associated clients. A handler is mutable and may be removed/replaced at any time.
- PreSpawnPacketHandler
- Handler used for the pre-spawn phase of the session.
- ResourcePacksPacketHandler
- Handler used for the resource packs sequence phase of the session. This handler takes care of downloading resource packs to the client.
- SpawnResponsePacketHandler
- Handlers are attached to sessions to handle packets received from their associated clients. A handler is mutable and may be removed/replaced at any time.
- InventoryManager
- JwtException
- JwtUtils
- NetworkSession
- PthreadsChannelReader
- PthreadsChannelWriter
- RakLibInterface
- RakLibPacketSender
- RakLibServer
- Specialized Thread class aimed at PocketMine-MP-related usages. It handles setting up autoloading and error handling.
- RakLibThreadCrashInfo
- SnoozeAwarePthreadsChannelWriter
- ChunkSerializer
- StandardPacketBroadcaster
- Network
- NetworkInterfaceStartException
- Thrown when a network interface fails to start for some reason.
- NetworkSessionManager
- PacketHandlingException
- Thrown when an error occurs during packet handling - for example, a message contained invalid options, packet shorter than expected, unknown packet, etc.
- DedicatedQueryNetworkInterface
- This is a supplementary network interface to maintain Query functionality when the RakLibInterface is not registered.
- QueryHandler
- QueryInfo
- UPnP
- UPnPException
- UPnPNetworkInterface
- BanEntry
- BanList
- DefaultPermissionNames
- DefaultPermissions
- PermissibleBase
- Permission
- Represents a permission
- PermissionAttachment
- PermissionAttachmentInfo
- PermissionManager
- PermissionParser
- PermissionParserException
- Thrown by PermissionParser when it encounters data that it doesn't like.
- ChunkSelector
- GameMode
- This doc-block is generated automatically, do not modify it manually.
- OfflinePlayer
- Player
- Main class that handles networking, recovery, and packet sending to the server part
- PlayerChunkLoader
- PlayerInfo
- Encapsulates data needed to create a player.
- SurvivalBlockBreakHandler
- UsedChunkStatus
- This doc-block is generated automatically, do not modify it manually.
- XboxLivePlayerInfo
- Encapsulates player info specific to players who are authenticated with XBOX Live.
- ApiVersion
- DiskResourceProvider
- Provides resources from the given plugin directory on disk. The path may be prefixed with a specific access protocol to enable special types of access.
- PharPluginLoader
- Handles different types of plugins
- PluginBase
- PluginDescription
- PluginDescriptionCommandEntry
- PluginDescriptionParseException
- Thrown when invalid things are found in a PluginDescription during loading
- PluginEnableOrder
- This doc-block is generated automatically, do not modify it manually.
- PluginException
- PluginGraylist
- PluginLoadabilityChecker
- PluginLoadTriage
- PluginLogger
- PluginManager
- Manages all the plugins
- ScriptPluginLoader
- Simple script loader, not for plugin development For an example see https://gist.github.com/shoghicp/516105d470cf7d140757
- Promise
- PromiseResolver
- Manifest
- Model for JsonMapper to represent resource pack manifest.json contents.
- ManifestDependencyEntry
- ManifestHeader
- ManifestMetadata
- ManifestModuleEntry
- ResourcePackException
- ResourcePackManager
- ZippedResourcePack
- AsyncPool
- Manages general-purpose worker threads used for processing asynchronous tasks, and the tasks submitted to those workers.
- AsyncTask
- Class used to run async tasks in other threads.
- AsyncWorker
- Specialized Worker class for PocketMine-MP-related use cases. It handles setting up autoloading and error handling.
- BulkCurlTask
- Executes a consecutive list of cURL operations.
- BulkCurlTaskOperation
- CancelTaskException
- This exception can be thrown from Task::onRun() to cancel the execution of the task.
- ClosureTask
- Task implementation which allows closures to be called by a scheduler.
- DumpWorkerMemoryTask
- Task used to dump memory from AsyncWorkers
- GarbageCollectionTask
- Class used to run async tasks in other threads.
- Task
- TaskHandler
- TaskScheduler
- Server
- The class that manages everything
- ServerConfigGroup
- SendUsageTask
- Class used to run async tasks in other threads.
- Thread
- Specialized Thread class aimed at PocketMine-MP-related usages. It handles setting up autoloading and error handling.
- ThreadException
- ThreadManager
- Worker
- Specialized Worker class for PocketMine-MP-related use cases. It handles setting up autoloading and error handling.
- Timings
- TimingsHandler
- TimingsRecord
- Represents a record collected by a timings handler.
- UpdateChecker
- UpdateCheckTask
- Class used to run async tasks in other threads.
- UpdateInfo
- Model class for JsonMapper to represent the information returned from the updater API.
- AssumptionFailedError
- This exception should be thrown in places where something is assumed to be true, but the type system does not provide a guarantee. This makes static analysers happy and makes sure that the server will crash properly if any assumption does not hold.
- Config
- Config Class for simple config manipulation of multiple formats.
- Filesystem
- Git
- Internet
- InternetException
- InternetRequestResult
- MainLogger
- MainLoggerThread
- ObjectSet
- Process
- Random
- XorShift128Engine Random Number Noise, used for fast seeded values Most of the code in this class was adapted from the XorShift128Engine in the php-random library.
- ReversePriorityQueue
- ServerException
- ServerKiller
- Specialized Thread class aimed at PocketMine-MP-related usages. It handles setting up autoloading and error handling.
- SignalHandler
- StringToTParser
- Handles parsing any Minecraft thing from strings. This can be used, for example, to implement a user-friendly item parser to be used by the /give command (and others).
- Terminal
- TextFormat
- Class used to handle Minecraft chat format, and convert it to other formats like HTML
- Timezone
- Utils
- Big collection of functions
- VersionString
- Manages PocketMine-MP version strings, and compares them
- VersionInfo
- SetupWizard
- Biome
- BiomeRegistry
- DesertBiome
- ForestBiome
- GrassyBiome
- HellBiome
- IcePlainsBiome
- MountainsBiome
- OceanBiome
- PlainBiome
- RiverBiome
- SandyBiome
- SmallMountainsBiome
- SnowyBiome
- SwampBiome
- TaigaBiome
- UnknownBiome
- Polyfill class for biomes that are unknown to PocketMine-MP
- BlockTransaction
- ChunkLockId
- Represents a unique lock ID for use with World chunk locking.
- Explosion
- BiomeArray
- Chunk
- ChunkException
- HeightArray
- BaseWorldProvider
- ChunkData
- ChunkUtils
- BaseNbtWorldData
- BedrockWorldData
- JavaWorldData
- CorruptedChunkException
- CorruptedWorldException
- UnsupportedWorldFormatException
- FastChunkSerializer
- This class provides a serializer used for transmitting chunks between threads.
- FormatConverter
- LevelDB
- ReadOnlyWorldProviderManagerEntry
- Anvil
- CorruptedRegionException
- McRegion
- PMAnvil
- This format is exactly the same as the PC Anvil format, with the only difference being that the stored data order is XZY instead of YZX for more performance loading and saving worlds.
- RegionException
- RegionGarbageMap
- RegionLoader
- RegionLocationTableEntry
- RegionWorldProvider
- WritableRegionWorldProvider
- This class implements the stuff needed for general region-based world providers to support saving.
- WorldProviderManager
- WorldProviderManagerEntry
- WritableWorldProviderManagerEntry
- SubChunk
- BiomeSelector
- Flat
- Gaussian
- Generator
- GeneratorManager
- GeneratorManagerEntry
- GeneratorRegisterTask
- Class used to run async tasks in other threads.
- GeneratorUnregisterTask
- Class used to run async tasks in other threads.
- Nether
- InvalidGeneratorOptionsException
- Noise
- Simplex
- Generates simplex-based noise.
- Normal
- BirchTree
- JungleTree
- OakTree
- Ore
- OreType
- SpruceTree
- TallGrass
- Tree
- TreeFactory
- PopulationTask
- Class used to run async tasks in other threads.
- GroundCover
- Ore
- TallGrass
- Tree
- ThreadLocalGeneratorContext
- Manages thread-local caches for generators and the things needed to support them
- BlockLightUpdate
- LightPopulationTask
- Class used to run async tasks in other threads.
- LightPropagationContext
- LightUpdate
- SkyLightUpdate
- AngryVillagerParticle
- BlockBreakParticle
- BlockForceFieldParticle
- BlockPunchParticle
- This particle appears when a player is attacking a block face in survival mode attempting to break it.
- BubbleParticle
- CriticalParticle
- DragonEggTeleportParticle
- DustParticle
- EnchantmentTableParticle
- EnchantParticle
- EndermanTeleportParticle
- EntityFlameParticle
- ExplodeParticle
- FlameParticle
- FloatingTextParticle
- HappyVillagerParticle
- HeartParticle
- HugeExplodeParticle
- HugeExplodeSeedParticle
- InkParticle
- InstantEnchantParticle
- ItemBreakParticle
- LavaDripParticle
- LavaParticle
- MobSpawnParticle
- PortalParticle
- PotionSplashParticle
- RainSplashParticle
- RedstoneParticle
- SmokeParticle
- SnowballPoofParticle
- SplashParticle
- SporeParticle
- TerrainParticle
- WaterDripParticle
- WaterParticle
- Position
- SimpleChunkManager
- AnvilBreakSound
- AnvilFallSound
- AnvilUseSound
- ArrowHitSound
- BarrelCloseSound
- BarrelOpenSound
- BellRingSound
- BlazeShootSound
- BlockBreakSound
- BlockPlaceSound
- BlockPunchSound
- Played when a player attacks a block in survival, attempting to break it.
- BowShootSound
- BucketEmptyLavaSound
- BucketEmptyWaterSound
- BucketFillLavaSound
- BucketFillWaterSound
- ChestCloseSound
- ChestOpenSound
- ClickSound
- DoorBumpSound
- DoorCrashSound
- DoorSound
- EnderChestCloseSound
- EnderChestOpenSound
- EndermanTeleportSound
- EntityAttackNoDamageSound
- Played when a player attacks a mob, but fails to deal damage (e.g. cancelled or attack cooldown).
- EntityAttackSound
- Played when a player attacks a mob, dealing damage.
- EntityLandSound
- Played when an entity hits the ground after falling a distance that doesn't cause damage, e.g. due to jumping.
- EntityLongFallSound
- Played when an entity hits ground after falling a long distance (damage).
- EntityShortFallSound
- Played when an entity hits the ground after falling a short distance.
- ExplodeSound
- FireExtinguishSound
- FizzSound
- FlintSteelSound
- GhastShootSound
- GhastSound
- IgniteSound
- ItemBreakSound
- LaunchSound
- NoteInstrument
- This doc-block is generated automatically, do not modify it manually.
- NoteSound
- PaintingPlaceSound
- PopSound
- PotionSplashSound
- RecordSound
- RecordStopSound
- RedstonePowerOffSound
- RedstonePowerOnSound
- ShulkerBoxCloseSound
- ShulkerBoxOpenSound
- ThrowSound
- TotemUseSound
- XpCollectSound
- XpLevelUpSound
- SubChunkExplorer
- SubChunkExplorerStatus
- World
- WorldCreationOptions
- Represents user-customizable settings for world creation
- WorldException
- WorldManager
- WorldTimings
- DisallowEnumComparisonRule
- UnsafeForeachArrayOfStringRule
- BlockTest
- BrewingStandTest
- MyCustomBlock
- OutOfBoundsBlock
- StrangeNewBlock
- SignTextTest
- CoralTypeIdMapTest
- DyeColorIdMapTest
- EffectIdMapTest
- EnchantmentIdMapTest
- HandlerListManagerTest
- TestAbstractAllowHandleEvent
- TestAbstractEvent
- TestConcreteEvent
- TestConcreteExtendsAbstractEvent
- TestConcreteExtendsAllowHandleEvent
- TestConcreteExtendsConcreteEvent
- BaseInventoryTest
- BannerTest
- ItemFactoryTest
- ItemTest
- LegacyStringToItemParserTest
- StupidJsonDecodeTest
- ApiVersionTest
- AsyncPoolTest
- LeakTestAsyncTask
- Class used to run async tasks in other threads.
- PublishProgressRaceAsyncTask
- Class used to run async tasks in other threads.
- TaskSchedulerTest
- CloningRegistryTraitTest
- ConfigTest
- EnumTraitTest
- TestAbstractClass
- TestInstantiableClass
- TestSubclassOfInstantiableClass
- TestCloningRegistry
- This doc-block is generated automatically, do not modify it manually.
- TestEnum
- This doc-block is generated automatically, do not modify it manually.
- ChunkTest
- RegionLoaderTest
- RegionLocationTableEntryTest
- SubChunkTest
- Main
- Test
- TestFailedException
- ReceiveReliabilityLayer
- ReliableCacheEntry
- SendReliabilityLayer
- Socket
- SocketException
- ACK
- AcknowledgePacket
- AdvertiseSystem
- ConnectedPacket
- Represents a packet which is sent inside an EncapsulatedPacket.
- ConnectedPing
- Represents a packet which is sent inside an EncapsulatedPacket.
- ConnectedPong
- Represents a packet which is sent inside an EncapsulatedPacket.
- ConnectionRequest
- Represents a packet which is sent inside an EncapsulatedPacket.
- ConnectionRequestAccepted
- Represents a packet which is sent inside an EncapsulatedPacket.
- Datagram
- DisconnectionNotification
- Represents a packet which is sent inside an EncapsulatedPacket.
- EncapsulatedPacket
- IncompatibleProtocolVersion
- NACK
- NewIncomingConnection
- Represents a packet which is sent inside an EncapsulatedPacket.
- OfflineMessage
- OpenConnectionReply1
- OpenConnectionReply2
- OpenConnectionRequest1
- OpenConnectionRequest2
- Packet
- PacketReliability
- PacketSerializer
- SplitPacketInfo
- UnconnectedPing
- UnconnectedPingOpenConnections
- UnconnectedPong
- RakLib
- Server
- Session
- SimpleProtocolAcceptor
- UnconnectedMessageHandler
- ExceptionTraceCleaner
- InternetAddress
- RakLibToUserThreadMessageReceiver
- RakLibToUserThreadMessageSender
- UserToRakLibThreadMessageReceiver
- UserToRakLibThreadMessageSender
- SleeperHandler
- Manages a Threaded sleeper which can be waited on for notifications. Calls callbacks for attached notifiers when notifications are received from the notifiers.
- SleeperNotifier
- Notifiers are Threaded objects which can be attached to threaded sleepers in order to wake them up.
- AbstractArray
- This class provides a basic implementation of `ArrayInterface`, to minimize the effort required to implement this interface.
- AbstractCollection
- This class provides a basic implementation of `CollectionInterface`, to minimize the effort required to implement this interface
- AbstractSet
- This class contains the basic implementation of a collection that does not allow duplicated values (a set), to minimize the effort required to implement this specific type of collection.
- Collection
- A collection represents a group of objects.
- DoubleEndedQueue
- This class provides a basic implementation of `DoubleEndedQueueInterface`, to minimize the effort required to implement this interface.
- CollectionMismatchException
- Thrown when attempting to operate on collections of differing types.
- InvalidArgumentException
- Thrown to indicate an argument is not of the expected type.
- InvalidSortOrderException
- Thrown when attempting to use a sort order that is not recognized.
- NoSuchElementException
- Thrown when attempting to access an element that does not exist.
- OutOfBoundsException
- Thrown when attempting to access an element out of the range of the collection.
- UnsupportedOperationException
- Thrown to indicate that the requested operation is not supported.
- ValueExtractionException
- Thrown when attempting to extract a value for a method or property that does not exist.
- GenericArray
- `GenericArray` represents a standard array object.
- AbstractMap
- This class provides a basic implementation of `MapInterface`, to minimize the effort required to implement this interface.
- AbstractTypedMap
- This class provides a basic implementation of `TypedMapInterface`, to minimize the effort required to implement this interface.
- AssociativeArrayMap
- `AssociativeArrayMap` represents a standard associative array object.
- NamedParameterMap
- `NamedParameterMap` represents a mapping of values to a set of named keys that may optionally be typed
- Queue
- This class provides a basic implementation of `QueueInterface`, to minimize the effort required to implement this interface.
- Set
- A set is a collection that contains no duplicate elements.
- BinaryUtils
- Provides binary math utilities
- BuilderCollection
- A collection of UuidBuilderInterface objects
- DefaultUuidBuilder
- UuidBuilder builds instances of RFC 4122 UUIDs
- DegradedUuidBuilder
- FallbackBuilder
- FallbackBuilder builds a UUID by stepping through a list of UUID builders until a UUID can be constructed without exceptions
- GuidStringCodec
- GuidStringCodec encodes and decodes globally unique identifiers (GUID)
- OrderedTimeCodec
- OrderedTimeCodec encodes and decodes a UUID, optimizing the byte order for more efficient storage
- StringCodec
- StringCodec encodes and decodes RFC 4122 UUIDs
- TimestampFirstCombCodec
- TimestampFirstCombCodec encodes and decodes COMBs, with the timestamp as the first 48 bits
- TimestampLastCombCodec
- TimestampLastCombCodec encodes and decodes COMBs, with the timestamp as the last 48 bits
- BigNumberConverter
- Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberConverter is deprecated in favor of GenericNumberConverter
- DegradedNumberConverter
- Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberConverter is deprecated in favor of GenericNumberConverter
- GenericNumberConverter
- GenericNumberConverter uses the provided calculator to convert decimal numbers to and from hexadecimal values
- BigNumberTimeConverter
- Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberTimeConverter is deprecated in favor of GenericTimeConverter
- DegradedTimeConverter
- Previously used to integrate moontoast/math as a bignum arithmetic library, BigNumberTimeConverter is deprecated in favor of GenericTimeConverter
- GenericTimeConverter
- GenericTimeConverter uses the provided calculator to calculate and convert time values
- PhpTimeConverter
- PhpTimeConverter uses built-in PHP functions and standard math operations available to the PHP programming language to provide facilities for converting parts of time into representations that may be used in UUIDs
- DegradedUuid
- Uuid provides constants and static methods for working with and generating UUIDs
- BuilderNotFoundException
- Thrown to indicate that no suitable builder could be found
- DateTimeException
- Thrown to indicate that the PHP DateTime extension encountered an exception/error
- DceSecurityException
- Thrown to indicate an exception occurred while dealing with DCE Security (version 2) UUIDs
- InvalidArgumentException
- Thrown to indicate that the argument received is not valid
- InvalidBytesException
- Thrown to indicate that the bytes being operated on are invalid in some way
- InvalidUuidStringException
- Thrown to indicate that the string received is not a valid UUID
- NameException
- Thrown to indicate that an error occurred while attempting to hash a namespace and name
- NodeException
- Thrown to indicate that attempting to fetch or create a node ID encountered an error
- RandomSourceException
- Thrown to indicate that the source of random data encountered an error
- TimeSourceException
- Thrown to indicate that the source of time encountered an error
- UnableToBuildUuidException
- Thrown to indicate a builder is unable to build a UUID
- UnsupportedOperationException
- Thrown to indicate that the requested operation is not supported
- FeatureSet
- FeatureSet detects and exposes available features in the current environment
- CombGenerator
- CombGenerator generates COMBs (combined UUID/timestamp)
- DceSecurityGenerator
- DceSecurityGenerator generates strings of binary data based on a local domain, local identifier, node ID, clock sequence, and the current time
- DefaultNameGenerator
- DefaultNameGenerator generates strings of binary data based on a namespace, name, and hashing algorithm
- DefaultTimeGenerator
- DefaultTimeGenerator generates strings of binary data based on a node ID, clock sequence, and the current time
- NameGeneratorFactory
- NameGeneratorFactory retrieves a default name generator, based on the environment
- PeclUuidNameGenerator
- PeclUuidNameGenerator generates strings of binary data from a namespace and a name, using ext-uuid
- PeclUuidRandomGenerator
- PeclUuidRandomGenerator generates strings of random binary data using ext-uuid
- PeclUuidTimeGenerator
- PeclUuidTimeGenerator generates strings of binary data for time-base UUIDs, using ext-uuid
- RandomBytesGenerator
- RandomBytesGenerator generates strings of random binary data using the built-in `random_bytes()` PHP function
- RandomGeneratorFactory
- RandomGeneratorFactory retrieves a default random generator, based on the environment
- RandomLibAdapter
- RandomLibAdapter generates strings of random binary data using the paragonie/random-lib library
- TimeGeneratorFactory
- TimeGeneratorFactory retrieves a default time generator, based on the environment
- Fields
- GUIDs are comprised of a set of named fields, according to RFC 4122
- Guid
- Guid represents a UUID with "native" (little-endian) byte order
- GuidBuilder
- GuidBuilder builds instances of Guid
- BrickMathCalculator
- A calculator using the brick/math library for arbitrary-precision arithmetic
- RoundingMode
- Specifies a rounding behavior for numerical operations capable of discarding precision.
- Fields
- Nonstandard UUID fields do not conform to the RFC 4122 standard
- Uuid
- Nonstandard\Uuid is a UUID that doesn't conform to RFC 4122
- UuidBuilder
- Nonstandard\UuidBuilder builds instances of Nonstandard\Uuid
- UuidV6
- Ordered-time, or version 6, UUIDs include timestamp, clock sequence, and node values that are combined into a 128-bit unsigned integer
- SystemDceSecurityProvider
- SystemDceSecurityProvider retrieves the user or group identifiers from the system
- FallbackNodeProvider
- FallbackNodeProvider retrieves the system node ID by stepping through a list of providers until a node ID can be obtained
- NodeProviderCollection
- A collection of NodeProviderInterface objects
- RandomNodeProvider
- RandomNodeProvider generates a random node ID
- StaticNodeProvider
- StaticNodeProvider provides a static node value with the multicast bit set
- SystemNodeProvider
- SystemNodeProvider retrieves the system node ID, if possible
- FixedTimeProvider
- FixedTimeProvider uses an known time to provide the time
- SystemTimeProvider
- SystemTimeProvider retrieves the current time using built-in PHP functions
- Fields
- RFC 4122 variant UUIDs are comprised of a set of named fields
- NilUuid
- The nil UUID is special form of UUID that is specified to have all 128 bits set to zero
- UuidBuilder
- UuidBuilder builds instances of RFC 4122 UUIDs
- UuidV1
- Time-based, or version 1, UUIDs include timestamp, clock sequence, and node values that are combined into a 128-bit unsigned integer
- UuidV2
- DCE Security version, or version 2, UUIDs include local domain identifier, local ID for the specified domain, and node values that are combined into a 128-bit unsigned integer
- UuidV3
- Version 3 UUIDs are named-based, using combination of a namespace and name that are hashed into a 128-bit unsigned integer using MD5
- UuidV4
- Random, or version 4, UUIDs are randomly or pseudo-randomly generated 128-bit integers
- UuidV5
- Version 5 UUIDs are named-based, using combination of a namespace and name that are hashed into a 128-bit unsigned integer using SHA1
- Validator
- Rfc4122\Validator validates strings as UUIDs of the RFC 4122 variant
- Decimal
- A value object representing a decimal
- Hexadecimal
- A value object representing a hexadecimal number
- Integer
- A value object representing an integer
- Time
- A value object representing a timestamp
- Uuid
- Uuid provides constants and static methods for working with and generating UUIDs
- UuidFactory
- GenericValidator
- GenericValidator validates strings as UUIDs of any variant
- AmbiguousOptionException
- OptionDoesNotAllowArgumentException
- RequiredOptionArgumentMissingException
- UnknownOptionException
- Parser
- ClassMethodUnit
- ClassUnit
- CodeUnit
- CodeUnitCollection
- CodeUnitCollectionIterator
- InvalidCodeUnitException
- NoTraitException
- ReflectionException
- FunctionUnit
- InterfaceMethodUnit
- InterfaceUnit
- Mapper
- TraitMethodUnit
- TraitUnit
- Wizard
- ArrayComparator
- Compares arrays for equality.
- Comparator
- Abstract base class for comparators which compare values for equality.
- ComparisonFailure
- Thrown when an assertion for string equality failed.
- DateTimeComparator
- Compares DateTimeInterface instances for equality.
- DOMNodeComparator
- Compares DOMNode instances for equality.
- DoubleComparator
- Compares doubles for equality.
- ExceptionComparator
- Compares Exception instances for equality.
- RuntimeException
- Factory
- Factory for comparators which compare values for equality.
- MockObjectComparator
- Compares PHPUnit\Framework\MockObject\MockObject instances for equality.
- NumericComparator
- Compares numerical values for equality.
- ObjectComparator
- Compares objects for equality.
- ResourceComparator
- Compares resources for equality.
- ScalarComparator
- Compares scalar or NULL values for equality.
- SplObjectStorageComparator
- Compares \SplObjectStorage instances for equality.
- TypeComparator
- Compares values for type equality.
- Calculator
- Complexity
- ComplexityCollection
- ComplexityCollectionIterator
- RuntimeException
- ComplexityCalculatingVisitor
- CyclomaticComplexityCalculatingVisitor
- Chunk
- Diff
- Differ
- ConfigurationException
- InvalidArgumentException
- Line
- MemoryEfficientLongestCommonSubsequenceCalculator
- AbstractChunkOutputBuilder
- DiffOnlyOutputBuilder
- Builds a diff string representation in a loose unified diff format listing only changes lines. Does not include line numbers.
- StrictUnifiedDiffOutputBuilder
- Strict Unified diff output builder.
- UnifiedDiffOutputBuilder
- Builds a diff string representation in unified diff format in chunks.
- Parser
- Unified diff parser.
- TimeEfficientLongestCommonSubsequenceCalculator
- Console
- OperatingSystem
- Runtime
- Utility class for HHVM/PHP environment handling.
- Exporter
- A nifty utility for visualizing PHP variables.
- CodeExporter
- Exports parts of a Snapshot as PHP code.
- RuntimeException
- ExcludeList
- Restorer
- Restorer of snapshots of global state.
- Snapshot
- A snapshot of global state.
- Counter
- IllogicalValuesException
- NegativeValueException
- RuntimeException
- LineCountingVisitor
- LinesOfCode
- Enumerator
- Traverses array structures and object graphs to enumerate all referenced objects.
- InvalidArgumentException
- InvalidArgumentException
- ObjectReflector
- Context
- A context containing previously processed arrays and objects when recursively processing a value.
- InvalidArgumentException
- ResourceOperations
- RuntimeException
- ReflectionMapper
- CallableType
- FalseType
- GenericObjectType
- IntersectionType
- IterableType
- MixedType
- NeverType
- NullType
- ObjectType
- SimpleType
- StaticType
- Type
- UnionType
- UnknownType
- VoidType
- TypeName
- Version
- AwaitChild
- AwaitException
- Channel
- A channel allows coroutines to communicate by sending and polling values in an FIFO stream.
- GeneratorUtil
- InterruptException
- The default exception to throw into an async iterator when `Traverser::interrupt()` is called.
- PromiseState
- Traverser
- An adapter to convert an async function into an async iterator.
- UnawaitedCallbackException
- AwaitTest
- ChannelTest
- DummyException
- LoadingTest
- MutexTest
- TraverseTest
- DisposableSpec
- DisposeException
- Thrown when a Disposable is disposed when awaiting on it.
- EventQueueEntry
- PromiseRejectedException
- FileNotFoundException
- An exception that will be thrown when a file is not found.
- GeneralMarshalException
- MarshalException
- UnmarshalException
- EmbeddedUser
- FileTest
- MarshalTest
- Options
- OptionsParser
- UnionUser
- UnmarshalTest
- User
- ReturnTypeWillChange
- Exception
- NamespaceUri
- NamespaceUriException
- Token
- TokenCollection
- TokenCollectionException
- Tokenizer
- XMLSerializer
- Assert
- Efficient assertions to validate the input/output of your methods.
- InvalidArgumentException
- Path
- Contains utility methods for handling path strings.
- Url
- Contains utility methods for handling URL strings.
- PathTest
- UrlTest
- ArgumentableTrait
- TestListenerDefaultImplementation
- PacketHandlerDefaultImplTrait
- This trait provides default implementations for all packet handlers, so that you don't have to manually write handlers for every single packet even if you don't care about them.
- IntegerishMetadataProperty
- GetTypeIdFromConstTrait
- DisappearStackRequestActionTrait
- TakeOrPlaceStackRequestActionTrait
- IntegerishTagTrait
- This trait implements common parts of tags containing integer values.
- NoDynamicFieldsTrait
- AnimatedBlockInventoryTrait
- BlockInventoryTrait
- ContainerTrait
- This trait implements most methods in the {@link Container} interface. It should only be used by Tiles.
- NameableTrait
- This trait implements most methods in the {@link Nameable} interface. It should only be used by Tiles.
- AnalogRedstoneSignalEmitterTrait
- AnyFacingTrait
- ColoredTrait
- ColorInMetadataTrait
- FacesOppositePlacingPlayerTrait
- FallableTrait
- This trait handles falling behaviour for blocks that need them.
- HorizontalFacingTrait
- NormalHorizontalFacingInMetadataTrait
- PillarRotationInMetadataTrait
- PillarRotationTrait
- PoweredByRedstoneTrait
- RailPoweredByRedstoneTrait
- SignLikeRotationTrait
- CancellableTrait
- This trait provides a basic boolean-setter-style implementation for `Cancellable` to reduce boilerplate.
- ItemEnchantmentHandlingTrait
- This trait encapsulates all enchantment handling needed for itemstacks.
- PermissibleDelegateTrait
- PluginOwnedTrait
- CommonThreadPartsTrait
- CloningRegistryTrait
- DestructorCallbackTrait
- This trait provides destructor callback functionality to objects which use it. This enables a weakmap-like system to function without actually having weak maps.
- EnumTrait
- NotCloneable
- NotSerializable
- RegistryTrait
- SingletonTrait
- ChunkListenerNoOpTrait
- This trait implements no-op default methods for chunk listeners.
- TestTrait
- TypeTrait
- Provides functionality to check values for specific types.
- ValueExtractorTrait
- Provides functionality to extract the value of a property or method from an object.
- ValueToStringTrait
- Provides functionality to express a value as string
- DeprecatedUuidMethodsTrait
- This trait encapsulates deprecated methods for ramsey/uuid; this trait and its methods will be removed in ramsey/uuid 5.0.0.
- SerializableFieldsTrait
- Provides common serialization functionality to fields
- NilTrait
- Provides common functionality for nil UUIDs
- VariantTrait
- Provides common functionality for handling the variant, as defined by RFC 4122
- VersionTrait
- Provides common functionality for handling the version, as defined by RFC 4122
- MarshalTrait
- This is the main trait used for marshaling/demarshaling data.
- Mixin
- This trait provides nurllOr*, all* and allNullOr* variants of assertion base methods.
Table of Contents
- ACCEPTED_OPTS = ["current" => "Version to insert and tag", "next" => "Version to put in the file after tagging", "channel" => "Release channel to post this build into"]
- ARGS = '\\((?<args>[^()]*+(?:\\((?&args)\\)[^()]*+)*+)\\)'
- INIT_DIR = getcwd()
- IS_WINDOWS = substr(PHP_OS, 0, 3) == "WIN"
- LEVELDB_ZLIB_RAW_COMPRESSION = 4
- LIB = '(?(DEFINE) (?<singleQuotedString>\'[^\\\\\']*+(?:\\\\.[^\\\\\']*+)*+\') (?<doubleQuotedString>"[^\\\\"]*+(?:\\\\.[^\\\\"]*+)*+") (?<string>(?&singleQuotedString)|(?&doubleQuotedString)) (?<comment>/\\*[^*]*+(?:\\*(?!/)[^*]*+)*+\\*/) (?<code>\\{[^\'"/{}]*+(?:(?:(?&string)|(?&comment)|(?&code)|/)[^\'"/{}]*+)*+}) )'
- MIN_PHP_VERSION = "8.0.0"
- MYSQLI_REFRESH_REPLICA = 64
- PARAMS = '\\[(?<params>[^[\\]]*+(?:\\[(?¶ms)\\][^[\\]]*+)*+)\\]'
- PHP_QA_EMAIL = 'qa-reports@lists.php.net'
- QA_REPORTS_PAGE = 'http://qa.php.net/reports'
- QA_SUBMISSION_PAGE = 'http://qa.php.net/buildtest-process.php'
- SHARED_HEADER = <<<'HEADER' <?php /* * * ____ _ _ __ __ _ __ __ ____ * | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) | * | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/ * |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_| * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * @author PocketMine Team * @link http://www.pocketmine.net/ * * */ declare(strict_types=1); namespace pocketmine\lang; HEADER
- SUPPORTED_EXTENSIONS = ["mcr", "mca", "mcapm"]
- T_NAME_FULLY_QUALIFIED = 'T_NAME_FULLY_QUALIFIED'
- T_NAME_QUALIFIED = 'T_NAME_QUALIFIED'
- TEST_PHP_SRCDIR = getcwd()
- TESTED_PHP_VERSION = `{$php} -n -r "echo PHP_VERSION;"`
- TRAVIS_CI = (bool) getenv('TRAVIS')
- VERSIONS = ["8.0"]
- processDirectory() : array<string|int, FileInfo>
- processStubFile() : FileInfo|null
- computeStubHash() : string
- extractStubHash() : string|null
- parseDocComment() : array<string|int, DocCommentTag>
- parseFunctionLike() : FuncInfo
- handlePreprocessorConditions() : string|null
- getFileDocComment() : Doc|null
- handleStatements() : mixed
- parseStubFile() : FileInfo
- funcInfoToCode() : string
- findEquivalentFuncInfo() : FuncInfo|null
- generateCodeWithConditions() : string
- generateArgInfoCode() : string
- generateFunctionEntries() : string
- generateMethodSynopses() : array<string, string>
- replaceMethodSynopses() : array<string, string>
- installPhpParser() : mixed
- initPhpParser() : mixed
- show_usage() : void
- main() : void
- One function to rule them all, one function to find them, one function to bring them all and in the darkness bind them.
- hrtime() : array<string|int, mixed>|float|int
- verify_config() : void
- write_information() : void
- save_or_mail_results() : void
- find_files() : void
- test_name() : string
- test_sort() : int
- mail_qa_team() : bool
- save_text() : void
- error_report() : void
- system_with_timeout() : false|string
- run_all_tests() : void
- run_all_tests_parallel() : void
- The heart of parallel testing.
- send_message() : void
- kill_children() : void
- run_worker() : void
- show_file_block() : void
- run_test() : string
- comp_line() : bool|int
- count_array_diff() : int
- generate_array_diff() : array<string|int, mixed>
- generate_diff() : string
- error() : void
- settings2array() : void
- settings2params() : string
- compute_summary() : void
- get_summary() : string
- show_start() : void
- show_end() : void
- show_summary() : void
- show_redirect_start() : void
- show_redirect_ends() : void
- show_test() : void
- clear_show_test() : void
- parse_conflicts() : array<string|int, mixed>
- show_result() : void
- junit_init() : void
- junit_save_xml() : void
- junit_get_suite_xml() : string
- junit_enabled() : bool
- junit_mark_test_as() : void
- junit_suite_record() : void
- junit_get_timer() : float
- junit_start_timer() : void
- junit_get_suitename_for() : string
- junit_path_to_classname() : string
- junit_init_suite() : void
- junit_finish_timer() : void
- junit_merge_results() : void
- init_output_buffers() : void
- check_proc_open_function_exists() : void
- init_steps() : Generator
- crash_protector_test() : Generator
- composerRequiref5c30eae39144cb65ebc6b143eb36a61() : void
- includeFile() : void
- Scope isolated include.
- deep_copy() : mixed
- Deep copies the given value.
- preprocessGrammar() : mixed
- resolveNodes() : mixed
- resolveMacros() : mixed
- assertArgs() : mixed
- resolveStackAccess() : mixed
- removeTrailingWhitespace() : mixed
- regex() : mixed
- magicSplit() : mixed
- ensureDirExists() : mixed
- execCmd() : mixed
- assertArrayHasKey() : void
- Asserts that an array has a specified key.
- assertArrayNotHasKey() : void
- Asserts that an array does not have a specified key.
- assertContains() : void
- Asserts that a haystack contains a needle.
- assertContainsEquals() : void
- assertNotContains() : void
- Asserts that a haystack does not contain a needle.
- assertNotContainsEquals() : void
- assertContainsOnly() : void
- Asserts that a haystack contains only values of a given type.
- assertContainsOnlyInstancesOf() : void
- Asserts that a haystack contains only instances of a given class name.
- assertNotContainsOnly() : void
- Asserts that a haystack does not contain only values of a given type.
- assertCount() : void
- Asserts the number of elements of an array, Countable or Traversable.
- assertNotCount() : void
- Asserts the number of elements of an array, Countable or Traversable.
- assertEquals() : void
- Asserts that two variables are equal.
- assertEqualsCanonicalizing() : void
- Asserts that two variables are equal (canonicalizing).
- assertEqualsIgnoringCase() : void
- Asserts that two variables are equal (ignoring case).
- assertEqualsWithDelta() : void
- Asserts that two variables are equal (with delta).
- assertNotEquals() : void
- Asserts that two variables are not equal.
- assertNotEqualsCanonicalizing() : void
- Asserts that two variables are not equal (canonicalizing).
- assertNotEqualsIgnoringCase() : void
- Asserts that two variables are not equal (ignoring case).
- assertNotEqualsWithDelta() : void
- Asserts that two variables are not equal (with delta).
- assertObjectEquals() : void
- assertEmpty() : void
- Asserts that a variable is empty.
- assertNotEmpty() : void
- Asserts that a variable is not empty.
- assertGreaterThan() : void
- Asserts that a value is greater than another value.
- assertGreaterThanOrEqual() : void
- Asserts that a value is greater than or equal to another value.
- assertLessThan() : void
- Asserts that a value is smaller than another value.
- assertLessThanOrEqual() : void
- Asserts that a value is smaller than or equal to another value.
- assertFileEquals() : void
- Asserts that the contents of one file is equal to the contents of another file.
- assertFileEqualsCanonicalizing() : void
- Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
- assertFileEqualsIgnoringCase() : void
- Asserts that the contents of one file is equal to the contents of another file (ignoring case).
- assertFileNotEquals() : void
- Asserts that the contents of one file is not equal to the contents of another file.
- assertFileNotEqualsCanonicalizing() : void
- Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
- assertFileNotEqualsIgnoringCase() : void
- Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
- assertStringEqualsFile() : void
- Asserts that the contents of a string is equal to the contents of a file.
- assertStringEqualsFileCanonicalizing() : void
- Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
- assertStringEqualsFileIgnoringCase() : void
- Asserts that the contents of a string is equal to the contents of a file (ignoring case).
- assertStringNotEqualsFile() : void
- Asserts that the contents of a string is not equal to the contents of a file.
- assertStringNotEqualsFileCanonicalizing() : void
- Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
- assertStringNotEqualsFileIgnoringCase() : void
- Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
- assertIsReadable() : void
- Asserts that a file/dir is readable.
- assertIsNotReadable() : void
- Asserts that a file/dir exists and is not readable.
- assertNotIsReadable() : void
- Asserts that a file/dir exists and is not readable.
- assertIsWritable() : void
- Asserts that a file/dir exists and is writable.
- assertIsNotWritable() : void
- Asserts that a file/dir exists and is not writable.
- assertNotIsWritable() : void
- Asserts that a file/dir exists and is not writable.
- assertDirectoryExists() : void
- Asserts that a directory exists.
- assertDirectoryDoesNotExist() : void
- Asserts that a directory does not exist.
- assertDirectoryNotExists() : void
- Asserts that a directory does not exist.
- assertDirectoryIsReadable() : void
- Asserts that a directory exists and is readable.
- assertDirectoryIsNotReadable() : void
- Asserts that a directory exists and is not readable.
- assertDirectoryNotIsReadable() : void
- Asserts that a directory exists and is not readable.
- assertDirectoryIsWritable() : void
- Asserts that a directory exists and is writable.
- assertDirectoryIsNotWritable() : void
- Asserts that a directory exists and is not writable.
- assertDirectoryNotIsWritable() : void
- Asserts that a directory exists and is not writable.
- assertFileExists() : void
- Asserts that a file exists.
- assertFileDoesNotExist() : void
- Asserts that a file does not exist.
- assertFileNotExists() : void
- Asserts that a file does not exist.
- assertFileIsReadable() : void
- Asserts that a file exists and is readable.
- assertFileIsNotReadable() : void
- Asserts that a file exists and is not readable.
- assertFileNotIsReadable() : void
- Asserts that a file exists and is not readable.
- assertFileIsWritable() : void
- Asserts that a file exists and is writable.
- assertFileIsNotWritable() : void
- Asserts that a file exists and is not writable.
- assertFileNotIsWritable() : void
- Asserts that a file exists and is not writable.
- assertTrue() : void
- Asserts that a condition is true.
- assertNotTrue() : void
- Asserts that a condition is not true.
- assertFalse() : void
- Asserts that a condition is false.
- assertNotFalse() : void
- Asserts that a condition is not false.
- assertNull() : void
- Asserts that a variable is null.
- assertNotNull() : void
- Asserts that a variable is not null.
- assertFinite() : void
- Asserts that a variable is finite.
- assertInfinite() : void
- Asserts that a variable is infinite.
- assertNan() : void
- Asserts that a variable is nan.
- assertClassHasAttribute() : void
- Asserts that a class has a specified attribute.
- assertClassNotHasAttribute() : void
- Asserts that a class does not have a specified attribute.
- assertClassHasStaticAttribute() : void
- Asserts that a class has a specified static attribute.
- assertClassNotHasStaticAttribute() : void
- Asserts that a class does not have a specified static attribute.
- assertObjectHasAttribute() : void
- Asserts that an object has a specified attribute.
- assertObjectNotHasAttribute() : void
- Asserts that an object does not have a specified attribute.
- assertSame() : void
- Asserts that two variables have the same type and value.
- assertNotSame() : void
- Asserts that two variables do not have the same type and value.
- assertInstanceOf() : void
- Asserts that a variable is of a given type.
- assertNotInstanceOf() : void
- Asserts that a variable is not of a given type.
- assertIsArray() : void
- Asserts that a variable is of type array.
- assertIsBool() : void
- Asserts that a variable is of type bool.
- assertIsFloat() : void
- Asserts that a variable is of type float.
- assertIsInt() : void
- Asserts that a variable is of type int.
- assertIsNumeric() : void
- Asserts that a variable is of type numeric.
- assertIsObject() : void
- Asserts that a variable is of type object.
- assertIsResource() : void
- Asserts that a variable is of type resource.
- assertIsClosedResource() : void
- Asserts that a variable is of type resource and is closed.
- assertIsString() : void
- Asserts that a variable is of type string.
- assertIsScalar() : void
- Asserts that a variable is of type scalar.
- assertIsCallable() : void
- Asserts that a variable is of type callable.
- assertIsIterable() : void
- Asserts that a variable is of type iterable.
- assertIsNotArray() : void
- Asserts that a variable is not of type array.
- assertIsNotBool() : void
- Asserts that a variable is not of type bool.
- assertIsNotFloat() : void
- Asserts that a variable is not of type float.
- assertIsNotInt() : void
- Asserts that a variable is not of type int.
- assertIsNotNumeric() : void
- Asserts that a variable is not of type numeric.
- assertIsNotObject() : void
- Asserts that a variable is not of type object.
- assertIsNotResource() : void
- Asserts that a variable is not of type resource.
- assertIsNotClosedResource() : void
- Asserts that a variable is not of type resource.
- assertIsNotString() : void
- Asserts that a variable is not of type string.
- assertIsNotScalar() : void
- Asserts that a variable is not of type scalar.
- assertIsNotCallable() : void
- Asserts that a variable is not of type callable.
- assertIsNotIterable() : void
- Asserts that a variable is not of type iterable.
- assertMatchesRegularExpression() : void
- Asserts that a string matches a given regular expression.
- assertRegExp() : void
- Asserts that a string matches a given regular expression.
- assertDoesNotMatchRegularExpression() : void
- Asserts that a string does not match a given regular expression.
- assertNotRegExp() : void
- Asserts that a string does not match a given regular expression.
- assertSameSize() : void
- Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
- assertNotSameSize() : void
- Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
- assertStringMatchesFormat() : void
- Asserts that a string matches a given format string.
- assertStringNotMatchesFormat() : void
- Asserts that a string does not match a given format string.
- assertStringMatchesFormatFile() : void
- Asserts that a string matches a given format file.
- assertStringNotMatchesFormatFile() : void
- Asserts that a string does not match a given format string.
- assertStringStartsWith() : void
- Asserts that a string starts with a given prefix.
- assertStringStartsNotWith() : void
- Asserts that a string starts not with a given prefix.
- assertStringContainsString() : void
- assertStringContainsStringIgnoringCase() : void
- assertStringNotContainsString() : void
- assertStringNotContainsStringIgnoringCase() : void
- assertStringEndsWith() : void
- Asserts that a string ends with a given suffix.
- assertStringEndsNotWith() : void
- Asserts that a string ends not with a given suffix.
- assertXmlFileEqualsXmlFile() : void
- Asserts that two XML files are equal.
- assertXmlFileNotEqualsXmlFile() : void
- Asserts that two XML files are not equal.
- assertXmlStringEqualsXmlFile() : void
- Asserts that two XML documents are equal.
- assertXmlStringNotEqualsXmlFile() : void
- Asserts that two XML documents are not equal.
- assertXmlStringEqualsXmlString() : void
- Asserts that two XML documents are equal.
- assertXmlStringNotEqualsXmlString() : void
- Asserts that two XML documents are not equal.
- assertEqualXMLStructure() : void
- Asserts that a hierarchy of DOMElements matches.
- assertThat() : void
- Evaluates a PHPUnit\Framework\Constraint matcher object.
- assertJson() : void
- Asserts that a string is a valid JSON string.
- assertJsonStringEqualsJsonString() : void
- Asserts that two given JSON encoded objects or arrays are equal.
- assertJsonStringNotEqualsJsonString() : void
- Asserts that two given JSON encoded objects or arrays are not equal.
- assertJsonStringEqualsJsonFile() : void
- Asserts that the generated JSON encoded object and the content of the given file are equal.
- assertJsonStringNotEqualsJsonFile() : void
- Asserts that the generated JSON encoded object and the content of the given file are not equal.
- assertJsonFileEqualsJsonFile() : void
- Asserts that two JSON files are equal.
- assertJsonFileNotEqualsJsonFile() : void
- Asserts that two JSON files are not equal.
- logicalAnd() : LogicalAnd
- logicalOr() : LogicalOr
- logicalNot() : LogicalNot
- logicalXor() : LogicalXor
- anything() : IsAnything
- isTrue() : IsTrue
- callback() : Callback
- isFalse() : IsFalse
- isJson() : IsJson
- isNull() : IsNull
- isFinite() : IsFinite
- isInfinite() : IsInfinite
- isNan() : IsNan
- containsEqual() : TraversableContainsEqual
- containsIdentical() : TraversableContainsIdentical
- containsOnly() : TraversableContainsOnly
- containsOnlyInstancesOf() : TraversableContainsOnly
- arrayHasKey() : ArrayHasKey
- equalTo() : IsEqual
- equalToCanonicalizing() : IsEqualCanonicalizing
- equalToIgnoringCase() : IsEqualIgnoringCase
- equalToWithDelta() : IsEqualWithDelta
- isEmpty() : IsEmpty
- isWritable() : IsWritable
- isReadable() : IsReadable
- directoryExists() : DirectoryExists
- fileExists() : FileExists
- greaterThan() : GreaterThan
- greaterThanOrEqual() : LogicalOr
- classHasAttribute() : ClassHasAttribute
- classHasStaticAttribute() : ClassHasStaticAttribute
- objectHasAttribute() : ObjectHasAttribute
- identicalTo() : IsIdentical
- isInstanceOf() : IsInstanceOf
- isType() : IsType
- lessThan() : LessThan
- lessThanOrEqual() : LogicalOr
- matchesRegularExpression() : RegularExpression
- matches() : StringMatchesFormatDescription
- stringStartsWith() : StringStartsWith
- stringContains() : StringContains
- stringEndsWith() : StringEndsWith
- countOf() : Count
- objectEquals() : ObjectEquals
- any() : AnyInvokedCount
- Returns a matcher that matches when the method is executed zero or more times.
- never() : InvokedCount
- Returns a matcher that matches when the method is never executed.
- atLeast() : InvokedAtLeastCount
- Returns a matcher that matches when the method is executed at least N times.
- atLeastOnce() : InvokedAtLeastOnce
- Returns a matcher that matches when the method is executed at least once.
- once() : InvokedCount
- Returns a matcher that matches when the method is executed exactly once.
- exactly() : InvokedCount
- Returns a matcher that matches when the method is executed exactly $count times.
- atMost() : InvokedAtMostCount
- Returns a matcher that matches when the method is executed at most N times.
- at() : InvokedAtIndex
- Returns a matcher that matches when the method is executed at the given index.
- returnValue() : ReturnStub
- returnValueMap() : ReturnValueMap
- returnArgument() : ReturnArgument
- returnCallback() : ReturnCallback
- returnSelf() : ReturnSelf
- Returns the current object.
- throwException() : Exception
- onConsecutiveCalls() : ConsecutiveCalls
- generateCreateFunction() : array<string|int, mixed>
- verify_translations() : bool
- parse_language_file() : array<string|int, mixed>|null
- constantify() : string
- functionify() : string
- generate_known_translation_keys() : void
- generate_known_translation_factory() : void
- generateMethodAnnotations() : string
- replaceVersion() : void
- main() : void
- preg_quote_array() : array<string|int, string>
- buildPhar() : Generator|array<string|int, string>
- main() : void
- critical_error() : void
- check_platform_dependencies() : array<string|int, string>
- emit_performance_warnings() : void
- set_ini_entries() : void
- server() : void
- libdeflate_deflate_compress() : string
- find_regions_recursive() : void
- main() : int
- markdownify() : string
- newImage() : GdImage
- render() : void
- v1() : non-empty-string
- Returns a version 1 (time-based) UUID from a host ID, sequence number, and the current time
- v2() : non-empty-string
- Returns a version 2 (DCE Security) UUID from a local domain, local identifier, host ID, clock sequence, and the current time
- v3() : non-empty-string
- Returns a version 3 (name-based) UUID based on the MD5 hash of a namespace ID and a name
- v4() : non-empty-string
- Returns a version 4 (random) UUID
- v5() : non-empty-string
- Returns a version 5 (name-based) UUID based on the SHA-1 hash of a namespace ID and a name
- v6() : non-empty-string
- Returns a version 6 (ordered-time) UUID from a host ID, sequence number, and the current time
- array_is_list() : bool
- enum_exists() : bool
Constants
ACCEPTED_OPTS
public
mixed
ACCEPTED_OPTS
= ["current" => "Version to insert and tag", "next" => "Version to put in the file after tagging", "channel" => "Release channel to post this build into"]
ARGS
public
mixed
ARGS
= '\\((?<args>[^()]*+(?:\\((?&args)\\)[^()]*+)*+)\\)'
INIT_DIR
public
mixed
INIT_DIR
= getcwd()
IS_WINDOWS
public
mixed
IS_WINDOWS
= substr(PHP_OS, 0, 3) == "WIN"
LEVELDB_ZLIB_RAW_COMPRESSION
public
mixed
LEVELDB_ZLIB_RAW_COMPRESSION
= 4
LIB
public
mixed
LIB
= '(?(DEFINE)
(?<singleQuotedString>\'[^\\\\\']*+(?:\\\\.[^\\\\\']*+)*+\')
(?<doubleQuotedString>"[^\\\\"]*+(?:\\\\.[^\\\\"]*+)*+")
(?<string>(?&singleQuotedString)|(?&doubleQuotedString))
(?<comment>/\\*[^*]*+(?:\\*(?!/)[^*]*+)*+\\*/)
(?<code>\\{[^\'"/{}]*+(?:(?:(?&string)|(?&comment)|(?&code)|/)[^\'"/{}]*+)*+})
)'
MIN_PHP_VERSION
public
mixed
MIN_PHP_VERSION
= "8.0.0"
MYSQLI_REFRESH_REPLICA
public
mixed
MYSQLI_REFRESH_REPLICA
= 64
PARAMS
public
mixed
PARAMS
= '\\[(?<params>[^[\\]]*+(?:\\[(?¶ms)\\][^[\\]]*+)*+)\\]'
PHP_QA_EMAIL
public
mixed
PHP_QA_EMAIL
= 'qa-reports@lists.php.net'
QA_REPORTS_PAGE
public
mixed
QA_REPORTS_PAGE
= 'http://qa.php.net/reports'
QA_SUBMISSION_PAGE
public
mixed
QA_SUBMISSION_PAGE
= 'http://qa.php.net/buildtest-process.php'
SHARED_HEADER
public
mixed
SHARED_HEADER
= <<<'HEADER'
<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\lang;
HEADER
SUPPORTED_EXTENSIONS
public
mixed
SUPPORTED_EXTENSIONS
= ["mcr", "mca", "mcapm"]
T_NAME_FULLY_QUALIFIED
public
mixed
T_NAME_FULLY_QUALIFIED
= 'T_NAME_FULLY_QUALIFIED'
T_NAME_QUALIFIED
public
mixed
T_NAME_QUALIFIED
= 'T_NAME_QUALIFIED'
TEST_PHP_SRCDIR
public
mixed
TEST_PHP_SRCDIR
= getcwd()
TESTED_PHP_VERSION
public
mixed
TESTED_PHP_VERSION
= `{$php} -n -r "echo PHP_VERSION;"`
TRAVIS_CI
public
mixed
TRAVIS_CI
= (bool) getenv('TRAVIS')
VERSIONS
public
mixed
VERSIONS
= ["8.0"]
Functions
processDirectory()
processDirectory(string $dir, Context $context) : array<string|int, FileInfo>
Parameters
- $dir : string
- $context : Context
Return values
array<string|int, FileInfo> —processStubFile()
processStubFile(string $stubFile, Context $context) : FileInfo|null
Parameters
- $stubFile : string
- $context : Context
Return values
FileInfo|null —computeStubHash()
computeStubHash(string $stubCode) : string
Parameters
- $stubCode : string
Return values
string —extractStubHash()
extractStubHash(string $arginfoFile) : string|null
Parameters
- $arginfoFile : string
Return values
string|null —parseDocComment()
parseDocComment(Doc $comment) : array<string|int, DocCommentTag>
Parameters
- $comment : Doc
Return values
array<string|int, DocCommentTag> —parseFunctionLike()
parseFunctionLike(PrettyPrinterAbstract $prettyPrinter, FunctionOrMethodName $name, int $classFlags, int $flags, FunctionLike $func, string|null $cond) : FuncInfo
Parameters
- $prettyPrinter : PrettyPrinterAbstract
- $name : FunctionOrMethodName
- $classFlags : int
- $flags : int
- $func : FunctionLike
- $cond : string|null
Return values
FuncInfo —handlePreprocessorConditions()
handlePreprocessorConditions(array<string|int, mixed> &$conds, Stmt $stmt) : string|null
Parameters
- $conds : array<string|int, mixed>
- $stmt : Stmt
Return values
string|null —getFileDocComment()
getFileDocComment(array<string|int, mixed> $stmts) : Doc|null
Parameters
- $stmts : array<string|int, mixed>
Return values
Doc|null —handleStatements()
handleStatements(FileInfo $fileInfo, array<string|int, mixed> $stmts, PrettyPrinterAbstract $prettyPrinter) : mixed
Parameters
- $fileInfo : FileInfo
- $stmts : array<string|int, mixed>
- $prettyPrinter : PrettyPrinterAbstract
Return values
mixed —parseStubFile()
parseStubFile(string $code) : FileInfo
Parameters
- $code : string
Return values
FileInfo —funcInfoToCode()
funcInfoToCode(FuncInfo $funcInfo) : string
Parameters
- $funcInfo : FuncInfo
Return values
string —findEquivalentFuncInfo()
findEquivalentFuncInfo(array<string|int, FuncInfo> $generatedFuncInfos, FuncInfo $funcInfo) : FuncInfo|null
Parameters
Return values
FuncInfo|null —generateCodeWithConditions()
generateCodeWithConditions(iteratable<string|int, FuncInfo> $funcInfos, string $separator, Closure $codeGenerator) : string
Parameters
- $funcInfos : iteratable<string|int, FuncInfo>
- $separator : string
- $codeGenerator : Closure
Return values
string —generateArgInfoCode()
generateArgInfoCode(FileInfo $fileInfo, string $stubHash) : string
Parameters
- $fileInfo : FileInfo
- $stubHash : string
Return values
string —generateFunctionEntries()
generateFunctionEntries(Name|null $className, array<string|int, FuncInfo> $funcInfos) : string
Parameters
Return values
string —generateMethodSynopses()
generateMethodSynopses(array<string|int, FuncInfo> $funcMap, array<string|int, FuncInfo> $aliasMap) : array<string, string>
Parameters
Return values
array<string, string> —replaceMethodSynopses()
replaceMethodSynopses(string $targetDirectory, array<string|int, FuncInfo> $funcMap, array<string|int, FuncInfo> $aliasMap) : array<string, string>
Parameters
- $targetDirectory : string
- $funcMap : array<string|int, FuncInfo>
- $aliasMap : array<string|int, FuncInfo>
Return values
array<string, string> —installPhpParser()
installPhpParser(string $version, string $phpParserDir) : mixed
Parameters
- $version : string
- $phpParserDir : string
Return values
mixed —initPhpParser()
initPhpParser() : mixed
Return values
mixed —show_usage()
show_usage() : void
Return values
void —main()
One function to rule them all, one function to find them, one function to bring them all and in the darkness bind them.
main() : void
This is the entry point and exit point überfunction. It contains all the code that was previously found at the top level. It could and should be refactored to be smaller and more manageable.
Return values
void —hrtime()
hrtime([bool $as_num = false ]) : array<string|int, mixed>|float|int
Parameters
- $as_num : bool = false
Return values
array<string|int, mixed>|float|int —verify_config()
verify_config() : void
Return values
void —write_information()
write_information() : void
Return values
void —save_or_mail_results()
save_or_mail_results() : void
Return values
void —find_files()
find_files(string $dir[, bool $is_ext_dir = false ][, bool $ignore = false ]) : void
Parameters
- $dir : string
- $is_ext_dir : bool = false
- $ignore : bool = false
Return values
void —test_name()
test_name(array<string|int, mixed>|string $name) : string
Parameters
- $name : array<string|int, mixed>|string
Return values
string —test_sort()
test_sort(array<string|int, mixed>|string $a, array<string|int, mixed>|string $b) : int
Parameters
- $a : array<string|int, mixed>|string
- $b : array<string|int, mixed>|string
Return values
int —mail_qa_team()
mail_qa_team(string $data[, bool $status = false ]) : bool
Parameters
- $data : string
- $status : bool = false
Return values
bool —save_text()
save_text(string $filename, string $text[, string|null $filename_copy = null ]) : void
Parameters
- $filename : string
- $text : string
- $filename_copy : string|null = null
Return values
void —error_report()
error_report(string $testname, string $logname, string $tested) : void
Parameters
- $testname : string
- $logname : string
- $tested : string
Return values
void —system_with_timeout()
system_with_timeout(string $commandline[, array<string|int, mixed>|null $env = null ][, string|null $stdin = null ][, bool $captureStdIn = true ][, bool $captureStdOut = true ][, bool $captureStdErr = true ]) : false|string
Parameters
- $commandline : string
- $env : array<string|int, mixed>|null = null
- $stdin : string|null = null
- $captureStdIn : bool = true
- $captureStdOut : bool = true
- $captureStdErr : bool = true
Return values
false|string —run_all_tests()
run_all_tests(array<string|int, mixed> $test_files, array<string|int, mixed> $env[, string|array<string|int, mixed>|null $redir_tested = null ]) : void
Parameters
- $test_files : array<string|int, mixed>
- $env : array<string|int, mixed>
- $redir_tested : string|array<string|int, mixed>|null = null
Return values
void —run_all_tests_parallel()
The heart of parallel testing.
run_all_tests_parallel(array<string|int, mixed> $test_files, array<string|int, mixed> $env, string|array<string|int, mixed>|null $redir_tested) : void
Parameters
- $test_files : array<string|int, mixed>
- $env : array<string|int, mixed>
- $redir_tested : string|array<string|int, mixed>|null
Return values
void —send_message()
send_message(mixed $stream, array<string|int, mixed> $message) : void
Parameters
- $stream : mixed
- $message : array<string|int, mixed>
Return values
void —kill_children()
kill_children(array<string|int, mixed> $children) : void
Parameters
- $children : array<string|int, mixed>
Return values
void —run_worker()
run_worker() : void
Return values
void —show_file_block()
show_file_block(string $file, string $block[, string|null $section = null ]) : void
Parameters
- $file : string
- $block : string
- $section : string|null = null
Return values
void —run_test()
run_test(string $php, string|array<string|int, mixed> $file, array<string|int, mixed> $env) : string
Parameters
- $php : string
- $file : string|array<string|int, mixed>
- $env : array<string|int, mixed>
Return values
string —comp_line()
comp_line(string $l1, string $l2, bool $is_reg) : bool|int
Parameters
- $l1 : string
- $l2 : string
- $is_reg : bool
Return values
bool|int —count_array_diff()
count_array_diff(array<string|int, mixed> $ar1, array<string|int, mixed> $ar2, bool $is_reg, array<string|int, mixed> $w, int $idx1, int $idx2, int $cnt1, int $cnt2, int $steps) : int
Parameters
- $ar1 : array<string|int, mixed>
- $ar2 : array<string|int, mixed>
- $is_reg : bool
- $w : array<string|int, mixed>
- $idx1 : int
- $idx2 : int
- $cnt1 : int
- $cnt2 : int
- $steps : int
Return values
int —generate_array_diff()
generate_array_diff(array<string|int, mixed> $ar1, array<string|int, mixed> $ar2, bool $is_reg, array<string|int, mixed> $w) : array<string|int, mixed>
Parameters
- $ar1 : array<string|int, mixed>
- $ar2 : array<string|int, mixed>
- $is_reg : bool
- $w : array<string|int, mixed>
Return values
array<string|int, mixed> —generate_diff()
generate_diff(string $wanted, string|null $wanted_re, string $output) : string
Parameters
- $wanted : string
- $wanted_re : string|null
- $output : string
Return values
string —error()
error(string $message) : void
Parameters
- $message : string
Return values
void —settings2array()
settings2array(array<string|int, mixed> $settings, mixed &$ini_settings) : void
Parameters
- $settings : array<string|int, mixed>
- $ini_settings : mixed
Return values
void —settings2params()
settings2params(array<string|int, mixed> $ini_settings) : string
Parameters
- $ini_settings : array<string|int, mixed>
Return values
string —compute_summary()
compute_summary() : void
Return values
void —get_summary()
get_summary(bool $show_ext_summary) : string
Parameters
- $show_ext_summary : bool
Return values
string —show_start()
show_start(mixed $start_time) : void
Parameters
- $start_time : mixed
Return values
void —show_end()
show_end(mixed $end_time) : void
Parameters
- $end_time : mixed
Return values
void —show_summary()
show_summary() : void
Return values
void —show_redirect_start()
show_redirect_start(string $tests, string $tested, string $tested_file) : void
Parameters
- $tests : string
- $tested : string
- $tested_file : string
Return values
void —show_redirect_ends()
show_redirect_ends(string $tests, string $tested, string $tested_file) : void
Parameters
- $tests : string
- $tested : string
- $tested_file : string
Return values
void —show_test()
show_test(int $test_idx, string $shortname) : void
Parameters
- $test_idx : int
- $shortname : string
Return values
void —clear_show_test()
clear_show_test() : void
Return values
void —parse_conflicts()
parse_conflicts(string $text) : array<string|int, mixed>
Parameters
- $text : string
Return values
array<string|int, mixed> —show_result()
show_result(string $result, string $tested, string $tested_file[, string $extra = '' ][, array<string|int, mixed>|null $temp_filenames = null ]) : void
Parameters
- $result : string
- $tested : string
- $tested_file : string
- $extra : string = ''
- $temp_filenames : array<string|int, mixed>|null = null
Return values
void —junit_init()
junit_init() : void
Return values
void —junit_save_xml()
junit_save_xml() : void
Return values
void —junit_get_suite_xml()
junit_get_suite_xml([string $suite_name = '' ]) : string
Parameters
- $suite_name : string = ''
Return values
string —junit_enabled()
junit_enabled() : bool
Return values
bool —junit_mark_test_as()
junit_mark_test_as(array<string|int, mixed>|string $type, string $file_name, string $test_name[, float|null $time = null ][, string $message = '' ][, string $details = '' ]) : void
Parameters
- $type : array<string|int, mixed>|string
- $file_name : string
- $test_name : string
- $time : float|null = null
- $message : string = ''
- $details : string = ''
Return values
void —junit_suite_record()
junit_suite_record(string $suite, string $param[, float $value = 1 ]) : void
Parameters
- $suite : string
- $param : string
- $value : float = 1
Return values
void —junit_get_timer()
junit_get_timer(string $file_name) : float
Parameters
- $file_name : string
Return values
float —junit_start_timer()
junit_start_timer(string $file_name) : void
Parameters
- $file_name : string
Return values
void —junit_get_suitename_for()
junit_get_suitename_for(string $file_name) : string
Parameters
- $file_name : string
Return values
string —junit_path_to_classname()
junit_path_to_classname(string $file_name) : string
Parameters
- $file_name : string
Return values
string —junit_init_suite()
junit_init_suite(string $suite_name) : void
Parameters
- $suite_name : string
Return values
void —junit_finish_timer()
junit_finish_timer(string $file_name) : void
Parameters
- $file_name : string
Return values
void —junit_merge_results()
junit_merge_results(array<string|int, mixed> $junit) : void
Parameters
- $junit : array<string|int, mixed>
Return values
void —init_output_buffers()
init_output_buffers() : void
Return values
void —check_proc_open_function_exists()
check_proc_open_function_exists() : void
Return values
void —init_steps()
init_steps(Context $context) : Generator
Parameters
- $context : Context
Return values
Generator —crash_protector_test()
crash_protector_test(Context $context, string $adminName) : Generator
Parameters
- $context : Context
- $adminName : string
Return values
Generator —composerRequiref5c30eae39144cb65ebc6b143eb36a61()
composerRequiref5c30eae39144cb65ebc6b143eb36a61(string $fileIdentifier, string $file) : void
Parameters
- $fileIdentifier : string
- $file : string
Return values
void —includeFile()
Scope isolated include.
includeFile(string $file) : void
Prevents access to $this/self from included files.
Parameters
- $file : string
Tags
Return values
void —deep_copy()
Deep copies the given value.
deep_copy(mixed $value[, bool $useCloneMethod = false ]) : mixed
Parameters
- $value : mixed
- $useCloneMethod : bool = false
Return values
mixed —preprocessGrammar()
preprocessGrammar(mixed $code) : mixed
Parameters
- $code : mixed
Return values
mixed —resolveNodes()
resolveNodes(mixed $code) : mixed
Parameters
- $code : mixed
Return values
mixed —resolveMacros()
resolveMacros(mixed $code) : mixed
Parameters
- $code : mixed
Return values
mixed —assertArgs()
assertArgs(mixed $num, mixed $args, mixed $name) : mixed
Parameters
- $num : mixed
- $args : mixed
- $name : mixed
Return values
mixed —resolveStackAccess()
resolveStackAccess(mixed $code) : mixed
Parameters
- $code : mixed
Return values
mixed —removeTrailingWhitespace()
removeTrailingWhitespace(mixed $code) : mixed
Parameters
- $code : mixed
Return values
mixed —regex()
regex(mixed $regex) : mixed
Parameters
- $regex : mixed
Return values
mixed —magicSplit()
magicSplit(mixed $regex, mixed $string) : mixed
Parameters
- $regex : mixed
- $string : mixed
Return values
mixed —ensureDirExists()
ensureDirExists(mixed $dir) : mixed
Parameters
- $dir : mixed
Return values
mixed —execCmd()
execCmd(mixed $cmd) : mixed
Parameters
- $cmd : mixed
Return values
mixed —assertArrayHasKey()
Asserts that an array has a specified key.
assertArrayHasKey(int|string $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
- $key : int|string
- $array : array<string|int, mixed>|ArrayAccess
- $message : string = ''
Tags
Return values
void —assertArrayNotHasKey()
Asserts that an array does not have a specified key.
assertArrayNotHasKey(int|string $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
- $key : int|string
- $array : array<string|int, mixed>|ArrayAccess
- $message : string = ''
Tags
Return values
void —assertContains()
Asserts that a haystack contains a needle.
assertContains(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iteratable<string|int, mixed>
- $message : string = ''
Tags
Return values
void —assertContainsEquals()
assertContainsEquals(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iteratable<string|int, mixed>
- $message : string = ''
Return values
void —assertNotContains()
Asserts that a haystack does not contain a needle.
assertNotContains(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iteratable<string|int, mixed>
- $message : string = ''
Tags
Return values
void —assertNotContainsEquals()
assertNotContainsEquals(mixed $needle, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iteratable<string|int, mixed>
- $message : string = ''
Return values
void —assertContainsOnly()
Asserts that a haystack contains only values of a given type.
assertContainsOnly(string $type, iteratable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
- $type : string
- $haystack : iteratable<string|int, mixed>
- $isNativeType : bool|null = null
- $message : string = ''
Tags
Return values
void —assertContainsOnlyInstancesOf()
Asserts that a haystack contains only instances of a given class name.
assertContainsOnlyInstancesOf(string $className, iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $className : string
- $haystack : iteratable<string|int, mixed>
- $message : string = ''
Tags
Return values
void —assertNotContainsOnly()
Asserts that a haystack does not contain only values of a given type.
assertNotContainsOnly(string $type, iteratable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
- $type : string
- $haystack : iteratable<string|int, mixed>
- $isNativeType : bool|null = null
- $message : string = ''
Tags
Return values
void —assertCount()
Asserts the number of elements of an array, Countable or Traversable.
assertCount(int $expectedCount, Countable|iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $expectedCount : int
- $haystack : Countable|iteratable<string|int, mixed>
- $message : string = ''
Tags
Return values
void —assertNotCount()
Asserts the number of elements of an array, Countable or Traversable.
assertNotCount(int $expectedCount, Countable|iteratable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $expectedCount : int
- $haystack : Countable|iteratable<string|int, mixed>
- $message : string = ''
Tags
Return values
void —assertEquals()
Asserts that two variables are equal.
assertEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertEqualsCanonicalizing()
Asserts that two variables are equal (canonicalizing).
assertEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertEqualsIgnoringCase()
Asserts that two variables are equal (ignoring case).
assertEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertEqualsWithDelta()
Asserts that two variables are equal (with delta).
assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $delta : float
- $message : string = ''
Tags
Return values
void —assertNotEquals()
Asserts that two variables are not equal.
assertNotEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNotEqualsCanonicalizing()
Asserts that two variables are not equal (canonicalizing).
assertNotEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNotEqualsIgnoringCase()
Asserts that two variables are not equal (ignoring case).
assertNotEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNotEqualsWithDelta()
Asserts that two variables are not equal (with delta).
assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $delta : float
- $message : string = ''
Tags
Return values
void —assertObjectEquals()
assertObjectEquals(object $expected, object $actual[, string $method = 'equals' ][, string $message = '' ]) : void
Parameters
- $expected : object
- $actual : object
- $method : string = 'equals'
- $message : string = ''
Tags
Return values
void —assertEmpty()
Asserts that a variable is empty.
assertEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNotEmpty()
Asserts that a variable is not empty.
assertNotEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertGreaterThan()
Asserts that a value is greater than another value.
assertGreaterThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertGreaterThanOrEqual()
Asserts that a value is greater than or equal to another value.
assertGreaterThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertLessThan()
Asserts that a value is smaller than another value.
assertLessThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertLessThanOrEqual()
Asserts that a value is smaller than or equal to another value.
assertLessThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertFileEquals()
Asserts that the contents of one file is equal to the contents of another file.
assertFileEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
Return values
void —assertFileEqualsCanonicalizing()
Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
assertFileEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
Return values
void —assertFileEqualsIgnoringCase()
Asserts that the contents of one file is equal to the contents of another file (ignoring case).
assertFileEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
Return values
void —assertFileNotEquals()
Asserts that the contents of one file is not equal to the contents of another file.
assertFileNotEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
Return values
void —assertFileNotEqualsCanonicalizing()
Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
assertFileNotEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
Return values
void —assertFileNotEqualsIgnoringCase()
Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
assertFileNotEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
Return values
void —assertStringEqualsFile()
Asserts that the contents of a string is equal to the contents of a file.
assertStringEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
Return values
void —assertStringEqualsFileCanonicalizing()
Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
Return values
void —assertStringEqualsFileIgnoringCase()
Asserts that the contents of a string is equal to the contents of a file (ignoring case).
assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
Return values
void —assertStringNotEqualsFile()
Asserts that the contents of a string is not equal to the contents of a file.
assertStringNotEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
Return values
void —assertStringNotEqualsFileCanonicalizing()
Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
Return values
void —assertStringNotEqualsFileIgnoringCase()
Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
Return values
void —assertIsReadable()
Asserts that a file/dir is readable.
assertIsReadable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertIsNotReadable()
Asserts that a file/dir exists and is not readable.
assertIsNotReadable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertNotIsReadable()
Asserts that a file/dir exists and is not readable.
assertNotIsReadable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertIsWritable()
Asserts that a file/dir exists and is writable.
assertIsWritable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertIsNotWritable()
Asserts that a file/dir exists and is not writable.
assertIsNotWritable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertNotIsWritable()
Asserts that a file/dir exists and is not writable.
assertNotIsWritable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertDirectoryExists()
Asserts that a directory exists.
assertDirectoryExists(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryDoesNotExist()
Asserts that a directory does not exist.
assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryNotExists()
Asserts that a directory does not exist.
assertDirectoryNotExists(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryIsReadable()
Asserts that a directory exists and is readable.
assertDirectoryIsReadable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryIsNotReadable()
Asserts that a directory exists and is not readable.
assertDirectoryIsNotReadable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryNotIsReadable()
Asserts that a directory exists and is not readable.
assertDirectoryNotIsReadable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryIsWritable()
Asserts that a directory exists and is writable.
assertDirectoryIsWritable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryIsNotWritable()
Asserts that a directory exists and is not writable.
assertDirectoryIsNotWritable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertDirectoryNotIsWritable()
Asserts that a directory exists and is not writable.
assertDirectoryNotIsWritable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
Return values
void —assertFileExists()
Asserts that a file exists.
assertFileExists(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertFileDoesNotExist()
Asserts that a file does not exist.
assertFileDoesNotExist(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertFileNotExists()
Asserts that a file does not exist.
assertFileNotExists(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
Return values
void —assertFileIsReadable()
Asserts that a file exists and is readable.
assertFileIsReadable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
Return values
void —assertFileIsNotReadable()
Asserts that a file exists and is not readable.
assertFileIsNotReadable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
Return values
void —assertFileNotIsReadable()
Asserts that a file exists and is not readable.
assertFileNotIsReadable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
Return values
void —assertFileIsWritable()
Asserts that a file exists and is writable.
assertFileIsWritable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
Return values
void —assertFileIsNotWritable()
Asserts that a file exists and is not writable.
assertFileIsNotWritable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
Return values
void —assertFileNotIsWritable()
Asserts that a file exists and is not writable.
assertFileNotIsWritable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
Return values
void —assertTrue()
Asserts that a condition is true.
assertTrue(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
Return values
void —assertNotTrue()
Asserts that a condition is not true.
assertNotTrue(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
Return values
void —assertFalse()
Asserts that a condition is false.
assertFalse(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
Return values
void —assertNotFalse()
Asserts that a condition is not false.
assertNotFalse(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
Return values
void —assertNull()
Asserts that a variable is null.
assertNull(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNotNull()
Asserts that a variable is not null.
assertNotNull(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertFinite()
Asserts that a variable is finite.
assertFinite(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertInfinite()
Asserts that a variable is infinite.
assertInfinite(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNan()
Asserts that a variable is nan.
assertNan(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertClassHasAttribute()
Asserts that a class has a specified attribute.
assertClassHasAttribute(string $attributeName, string $className[, string $message = '' ]) : void
Parameters
- $attributeName : string
- $className : string
- $message : string = ''
Tags
Return values
void —assertClassNotHasAttribute()
Asserts that a class does not have a specified attribute.
assertClassNotHasAttribute(string $attributeName, string $className[, string $message = '' ]) : void
Parameters
- $attributeName : string
- $className : string
- $message : string = ''
Tags
Return values
void —assertClassHasStaticAttribute()
Asserts that a class has a specified static attribute.
assertClassHasStaticAttribute(string $attributeName, string $className[, string $message = '' ]) : void
Parameters
- $attributeName : string
- $className : string
- $message : string = ''
Tags
Return values
void —assertClassNotHasStaticAttribute()
Asserts that a class does not have a specified static attribute.
assertClassNotHasStaticAttribute(string $attributeName, string $className[, string $message = '' ]) : void
Parameters
- $attributeName : string
- $className : string
- $message : string = ''
Tags
Return values
void —assertObjectHasAttribute()
Asserts that an object has a specified attribute.
assertObjectHasAttribute(string $attributeName, object $object[, string $message = '' ]) : void
Parameters
- $attributeName : string
- $object : object
- $message : string = ''
Tags
Return values
void —assertObjectNotHasAttribute()
Asserts that an object does not have a specified attribute.
assertObjectNotHasAttribute(string $attributeName, object $object[, string $message = '' ]) : void
Parameters
- $attributeName : string
- $object : object
- $message : string = ''
Tags
Return values
void —assertSame()
Asserts that two variables have the same type and value.
assertSame(mixed $expected, mixed $actual[, string $message = '' ]) : void
Used on objects, it asserts that two variables reference the same object.
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNotSame()
Asserts that two variables do not have the same type and value.
assertNotSame(mixed $expected, mixed $actual[, string $message = '' ]) : void
Used on objects, it asserts that two variables do not reference the same object.
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertInstanceOf()
Asserts that a variable is of a given type.
assertInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertNotInstanceOf()
Asserts that a variable is not of a given type.
assertNotInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsArray()
Asserts that a variable is of type array.
assertIsArray(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsBool()
Asserts that a variable is of type bool.
assertIsBool(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsFloat()
Asserts that a variable is of type float.
assertIsFloat(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsInt()
Asserts that a variable is of type int.
assertIsInt(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNumeric()
Asserts that a variable is of type numeric.
assertIsNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsObject()
Asserts that a variable is of type object.
assertIsObject(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsResource()
Asserts that a variable is of type resource.
assertIsResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsClosedResource()
Asserts that a variable is of type resource and is closed.
assertIsClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsString()
Asserts that a variable is of type string.
assertIsString(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsScalar()
Asserts that a variable is of type scalar.
assertIsScalar(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsCallable()
Asserts that a variable is of type callable.
assertIsCallable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsIterable()
Asserts that a variable is of type iterable.
assertIsIterable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotArray()
Asserts that a variable is not of type array.
assertIsNotArray(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotBool()
Asserts that a variable is not of type bool.
assertIsNotBool(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotFloat()
Asserts that a variable is not of type float.
assertIsNotFloat(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotInt()
Asserts that a variable is not of type int.
assertIsNotInt(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotNumeric()
Asserts that a variable is not of type numeric.
assertIsNotNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotObject()
Asserts that a variable is not of type object.
assertIsNotObject(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotResource()
Asserts that a variable is not of type resource.
assertIsNotResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotClosedResource()
Asserts that a variable is not of type resource.
assertIsNotClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotString()
Asserts that a variable is not of type string.
assertIsNotString(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotScalar()
Asserts that a variable is not of type scalar.
assertIsNotScalar(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotCallable()
Asserts that a variable is not of type callable.
assertIsNotCallable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertIsNotIterable()
Asserts that a variable is not of type iterable.
assertIsNotIterable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
Return values
void —assertMatchesRegularExpression()
Asserts that a string matches a given regular expression.
assertMatchesRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
- $pattern : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertRegExp()
Asserts that a string matches a given regular expression.
assertRegExp(string $pattern, string $string[, string $message = '' ]) : void
Parameters
- $pattern : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertDoesNotMatchRegularExpression()
Asserts that a string does not match a given regular expression.
assertDoesNotMatchRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
- $pattern : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertNotRegExp()
Asserts that a string does not match a given regular expression.
assertNotRegExp(string $pattern, string $string[, string $message = '' ]) : void
Parameters
- $pattern : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertSameSize()
Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
assertSameSize(Countable|iteratable<string|int, mixed> $expected, Countable|iteratable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
- $expected : Countable|iteratable<string|int, mixed>
- $actual : Countable|iteratable<string|int, mixed>
- $message : string = ''
Tags
Return values
void —assertNotSameSize()
Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
assertNotSameSize(Countable|iteratable<string|int, mixed> $expected, Countable|iteratable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
- $expected : Countable|iteratable<string|int, mixed>
- $actual : Countable|iteratable<string|int, mixed>
- $message : string = ''
Tags
Return values
void —assertStringMatchesFormat()
Asserts that a string matches a given format string.
assertStringMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
- $format : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertStringNotMatchesFormat()
Asserts that a string does not match a given format string.
assertStringNotMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
- $format : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertStringMatchesFormatFile()
Asserts that a string matches a given format file.
assertStringMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
- $formatFile : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertStringNotMatchesFormatFile()
Asserts that a string does not match a given format string.
assertStringNotMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
- $formatFile : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertStringStartsWith()
Asserts that a string starts with a given prefix.
assertStringStartsWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
- $prefix : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertStringStartsNotWith()
Asserts that a string starts not with a given prefix.
assertStringStartsNotWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
- $prefix : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertStringContainsString()
assertStringContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
Return values
void —assertStringContainsStringIgnoringCase()
assertStringContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
Return values
void —assertStringNotContainsString()
assertStringNotContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
Return values
void —assertStringNotContainsStringIgnoringCase()
assertStringNotContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
Return values
void —assertStringEndsWith()
Asserts that a string ends with a given suffix.
assertStringEndsWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
- $suffix : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertStringEndsNotWith()
Asserts that a string ends not with a given suffix.
assertStringEndsNotWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
- $suffix : string
- $string : string
- $message : string = ''
Tags
Return values
void —assertXmlFileEqualsXmlFile()
Asserts that two XML files are equal.
assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
Return values
void —assertXmlFileNotEqualsXmlFile()
Asserts that two XML files are not equal.
assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
Return values
void —assertXmlStringEqualsXmlFile()
Asserts that two XML documents are equal.
assertXmlStringEqualsXmlFile(string $expectedFile, DOMDocument|string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualXml : DOMDocument|string
- $message : string = ''
Tags
Return values
void —assertXmlStringNotEqualsXmlFile()
Asserts that two XML documents are not equal.
assertXmlStringNotEqualsXmlFile(string $expectedFile, DOMDocument|string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualXml : DOMDocument|string
- $message : string = ''
Tags
Return values
void —assertXmlStringEqualsXmlString()
Asserts that two XML documents are equal.
assertXmlStringEqualsXmlString(DOMDocument|string $expectedXml, DOMDocument|string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedXml : DOMDocument|string
- $actualXml : DOMDocument|string
- $message : string = ''
Tags
Return values
void —assertXmlStringNotEqualsXmlString()
Asserts that two XML documents are not equal.
assertXmlStringNotEqualsXmlString(DOMDocument|string $expectedXml, DOMDocument|string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedXml : DOMDocument|string
- $actualXml : DOMDocument|string
- $message : string = ''
Tags
Return values
void —assertEqualXMLStructure()
Asserts that a hierarchy of DOMElements matches.
assertEqualXMLStructure(DOMElement $expectedElement, DOMElement $actualElement[, bool $checkAttributes = false ][, string $message = '' ]) : void
Parameters
- $expectedElement : DOMElement
- $actualElement : DOMElement
- $checkAttributes : bool = false
- $message : string = ''
Tags
Return values
void —assertThat()
Evaluates a PHPUnit\Framework\Constraint matcher object.
assertThat(mixed $value, Constraint $constraint[, string $message = '' ]) : void
Parameters
- $value : mixed
- $constraint : Constraint
- $message : string = ''
Tags
Return values
void —assertJson()
Asserts that a string is a valid JSON string.
assertJson(string $actualJson[, string $message = '' ]) : void
Parameters
- $actualJson : string
- $message : string = ''
Tags
Return values
void —assertJsonStringEqualsJsonString()
Asserts that two given JSON encoded objects or arrays are equal.
assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedJson : string
- $actualJson : string
- $message : string = ''
Tags
Return values
void —assertJsonStringNotEqualsJsonString()
Asserts that two given JSON encoded objects or arrays are not equal.
assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedJson : string
- $actualJson : string
- $message : string = ''
Tags
Return values
void —assertJsonStringEqualsJsonFile()
Asserts that the generated JSON encoded object and the content of the given file are equal.
assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualJson : string
- $message : string = ''
Tags
Return values
void —assertJsonStringNotEqualsJsonFile()
Asserts that the generated JSON encoded object and the content of the given file are not equal.
assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualJson : string
- $message : string = ''
Tags
Return values
void —assertJsonFileEqualsJsonFile()
Asserts that two JSON files are equal.
assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
Return values
void —assertJsonFileNotEqualsJsonFile()
Asserts that two JSON files are not equal.
assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
Return values
void —logicalAnd()
logicalAnd() : LogicalAnd
Return values
LogicalAnd —logicalOr()
logicalOr() : LogicalOr
Return values
LogicalOr —logicalNot()
logicalNot(Constraint $constraint) : LogicalNot
Parameters
- $constraint : Constraint
Return values
LogicalNot —logicalXor()
logicalXor() : LogicalXor
Return values
LogicalXor —anything()
anything() : IsAnything
Return values
IsAnything —isTrue()
isTrue() : IsTrue
Return values
IsTrue —callback()
callback(callable $callback) : Callback
Parameters
- $callback : callable
Return values
Callback —isFalse()
isFalse() : IsFalse
Return values
IsFalse —isJson()
isJson() : IsJson
Return values
IsJson —isNull()
isNull() : IsNull
Return values
IsNull —isFinite()
isFinite() : IsFinite
Return values
IsFinite —isInfinite()
isInfinite() : IsInfinite
Return values
IsInfinite —isNan()
isNan() : IsNan
Return values
IsNan —containsEqual()
containsEqual(mixed $value) : TraversableContainsEqual
Parameters
- $value : mixed
Return values
TraversableContainsEqual —containsIdentical()
containsIdentical(mixed $value) : TraversableContainsIdentical
Parameters
- $value : mixed
Return values
TraversableContainsIdentical —containsOnly()
containsOnly(string $type) : TraversableContainsOnly
Parameters
- $type : string
Return values
TraversableContainsOnly —containsOnlyInstancesOf()
containsOnlyInstancesOf(string $className) : TraversableContainsOnly
Parameters
- $className : string
Return values
TraversableContainsOnly —arrayHasKey()
arrayHasKey(mixed $key) : ArrayHasKey
Parameters
- $key : mixed
Return values
ArrayHasKey —equalTo()
equalTo(mixed $value) : IsEqual
Parameters
- $value : mixed
Return values
IsEqual —equalToCanonicalizing()
equalToCanonicalizing(mixed $value) : IsEqualCanonicalizing
Parameters
- $value : mixed
Return values
IsEqualCanonicalizing —equalToIgnoringCase()
equalToIgnoringCase(mixed $value) : IsEqualIgnoringCase
Parameters
- $value : mixed
Return values
IsEqualIgnoringCase —equalToWithDelta()
equalToWithDelta(mixed $value, float $delta) : IsEqualWithDelta
Parameters
- $value : mixed
- $delta : float
Return values
IsEqualWithDelta —isEmpty()
isEmpty() : IsEmpty
Return values
IsEmpty —isWritable()
isWritable() : IsWritable
Return values
IsWritable —isReadable()
isReadable() : IsReadable
Return values
IsReadable —directoryExists()
directoryExists() : DirectoryExists
Return values
DirectoryExists —fileExists()
fileExists() : FileExists
Return values
FileExists —greaterThan()
greaterThan(mixed $value) : GreaterThan
Parameters
- $value : mixed
Return values
GreaterThan —greaterThanOrEqual()
greaterThanOrEqual(mixed $value) : LogicalOr
Parameters
- $value : mixed
Return values
LogicalOr —classHasAttribute()
classHasAttribute(string $attributeName) : ClassHasAttribute
Parameters
- $attributeName : string
Return values
ClassHasAttribute —classHasStaticAttribute()
classHasStaticAttribute(string $attributeName) : ClassHasStaticAttribute
Parameters
- $attributeName : string
Return values
ClassHasStaticAttribute —objectHasAttribute()
objectHasAttribute(mixed $attributeName) : ObjectHasAttribute
Parameters
- $attributeName : mixed
Return values
ObjectHasAttribute —identicalTo()
identicalTo(mixed $value) : IsIdentical
Parameters
- $value : mixed
Return values
IsIdentical —isInstanceOf()
isInstanceOf(string $className) : IsInstanceOf
Parameters
- $className : string
Return values
IsInstanceOf —isType()
isType(string $type) : IsType
Parameters
- $type : string
Return values
IsType —lessThan()
lessThan(mixed $value) : LessThan
Parameters
- $value : mixed
Return values
LessThan —lessThanOrEqual()
lessThanOrEqual(mixed $value) : LogicalOr
Parameters
- $value : mixed
Return values
LogicalOr —matchesRegularExpression()
matchesRegularExpression(string $pattern) : RegularExpression
Parameters
- $pattern : string
Return values
RegularExpression —matches()
matches(string $string) : StringMatchesFormatDescription
Parameters
- $string : string
Return values
StringMatchesFormatDescription —stringStartsWith()
stringStartsWith(mixed $prefix) : StringStartsWith
Parameters
- $prefix : mixed
Return values
StringStartsWith —stringContains()
stringContains(string $string[, bool $case = true ]) : StringContains
Parameters
- $string : string
- $case : bool = true
Return values
StringContains —stringEndsWith()
stringEndsWith(string $suffix) : StringEndsWith
Parameters
- $suffix : string
Return values
StringEndsWith —countOf()
countOf(int $count) : Count
Parameters
- $count : int
Return values
Count —objectEquals()
objectEquals(object $object[, string $method = 'equals' ]) : ObjectEquals
Parameters
- $object : object
- $method : string = 'equals'
Return values
ObjectEquals —any()
Returns a matcher that matches when the method is executed zero or more times.
any() : AnyInvokedCount
Return values
AnyInvokedCount —never()
Returns a matcher that matches when the method is never executed.
never() : InvokedCount
Return values
InvokedCount —atLeast()
Returns a matcher that matches when the method is executed at least N times.
atLeast(int $requiredInvocations) : InvokedAtLeastCount
Parameters
- $requiredInvocations : int
Return values
InvokedAtLeastCount —atLeastOnce()
Returns a matcher that matches when the method is executed at least once.
atLeastOnce() : InvokedAtLeastOnce
Return values
InvokedAtLeastOnce —once()
Returns a matcher that matches when the method is executed exactly once.
once() : InvokedCount
Return values
InvokedCount —exactly()
Returns a matcher that matches when the method is executed exactly $count times.
exactly(int $count) : InvokedCount
Parameters
- $count : int
Return values
InvokedCount —atMost()
Returns a matcher that matches when the method is executed at most N times.
atMost(int $allowedInvocations) : InvokedAtMostCount
Parameters
- $allowedInvocations : int
Return values
InvokedAtMostCount —at()
Returns a matcher that matches when the method is executed at the given index.
at(int $index) : InvokedAtIndex
Parameters
- $index : int
Return values
InvokedAtIndex —returnValue()
returnValue(mixed $value) : ReturnStub
Parameters
- $value : mixed
Return values
ReturnStub —returnValueMap()
returnValueMap(array<string|int, mixed> $valueMap) : ReturnValueMap
Parameters
- $valueMap : array<string|int, mixed>
Return values
ReturnValueMap —returnArgument()
returnArgument(int $argumentIndex) : ReturnArgument
Parameters
- $argumentIndex : int
Return values
ReturnArgument —returnCallback()
returnCallback(mixed $callback) : ReturnCallback
Parameters
- $callback : mixed
Return values
ReturnCallback —returnSelf()
Returns the current object.
returnSelf() : ReturnSelf
This method is useful when mocking a fluent interface.
Return values
ReturnSelf —throwException()
throwException(Throwable $exception) : Exception
Parameters
- $exception : Throwable
Return values
Exception —onConsecutiveCalls()
onConsecutiveCalls() : ConsecutiveCalls
Return values
ConsecutiveCalls —generateCreateFunction()
generateCreateFunction(ReflectionClass $reflect, int $indentLevel, int $modifiers) : array<string|int, mixed>
Parameters
- $reflect : ReflectionClass
- $indentLevel : int
- $modifiers : int
Return values
array<string|int, mixed> —verify_translations()
verify_translations(array<string|int, string> $baseLanguageDef, string $altLanguageName, array<string|int, string> $altLanguageDef) : bool
Parameters
- $baseLanguageDef : array<string|int, string>
- $altLanguageName : string
- $altLanguageDef : array<string|int, string>
Tags
Return values
bool —true if everything is OK, false otherwise
parse_language_file()
parse_language_file(string $path, string $code) : array<string|int, mixed>|null
Parameters
- $path : string
- $code : string
Return values
array<string|int, mixed>|null —constantify()
constantify(string $permissionName) : string
Parameters
- $permissionName : string
Return values
string —functionify()
functionify(string $permissionName) : string
Parameters
- $permissionName : string
Return values
string —generate_known_translation_keys()
generate_known_translation_keys(array<string|int, string> $languageDefinitions) : void
Parameters
- $languageDefinitions : array<string|int, string>
Tags
Return values
void —generate_known_translation_factory()
generate_known_translation_factory(array<string|int, string> $languageDefinitions) : void
Parameters
- $languageDefinitions : array<string|int, string>
Tags
Return values
void —generateMethodAnnotations()
generateMethodAnnotations(string $namespaceName, array<string|int, object> $members) : string
Parameters
- $namespaceName : string
- $members : array<string|int, object>
Return values
string —replaceVersion()
replaceVersion(string $versionInfoPath, string $newVersion, bool $isDev, string $channel) : void
Parameters
- $versionInfoPath : string
- $newVersion : string
- $isDev : bool
- $channel : string
Return values
void —main()
main() : void
Return values
void —preg_quote_array()
preg_quote_array(array<string|int, string> $strings, string $delim) : array<string|int, string>
Parameters
- $strings : array<string|int, string>
- $delim : string
Return values
array<string|int, string> —buildPhar()
buildPhar(string $pharPath, string $basePath, array<string|int, string> $includedPaths, array<string|int, mixed> $metadata, string $stub[, int $signatureAlgo = Phar::SHA1 ][, int|null $compression = null ]) : Generator|array<string|int, string>
Parameters
- $pharPath : string
- $basePath : string
- $includedPaths : array<string|int, string>
- $metadata : array<string|int, mixed>
- $stub : string
- $signatureAlgo : int = Phar::SHA1
- $compression : int|null = null
Tags
Return values
Generator|array<string|int, string> —main()
main() : void
Return values
void —critical_error()
critical_error(string $message) : void
Parameters
- $message : string
Return values
void —check_platform_dependencies()
check_platform_dependencies() : array<string|int, string>
Return values
array<string|int, string> —emit_performance_warnings()
emit_performance_warnings(Logger $logger) : void
Parameters
- $logger : Logger
Return values
void —set_ini_entries()
set_ini_entries() : void
Return values
void —server()
server() : void
Return values
void —libdeflate_deflate_compress()
libdeflate_deflate_compress(string $data[, int $level = 6 ]) : string
Parameters
- $data : string
- $level : int = 6
Return values
string —find_regions_recursive()
find_regions_recursive(string $dir, array<string|int, int> &$files) : void
Parameters
- $dir : string
- $files : array<string|int, int>
Tags
Return values
void —main()
main(array<string|int, string> $argv) : int
Parameters
- $argv : array<string|int, string>
Return values
int —markdownify()
markdownify(string $name) : string
Parameters
- $name : string
Return values
string —newImage()
newImage(int $scale, int $radius) : GdImage
Parameters
- $scale : int
- $radius : int
Return values
GdImage —render()
render(int $radius, int $baseX, int $baseZ, int $chunksPerStep, int $scale, GdImage $image, int $chunkColor, int $offsetX, int $offsetZ, string $outputFolder) : void
Parameters
- $radius : int
- $baseX : int
- $baseZ : int
- $chunksPerStep : int
- $scale : int
- $image : GdImage
- $chunkColor : int
- $offsetX : int
- $offsetZ : int
- $outputFolder : string
Return values
void —v1()
Returns a version 1 (time-based) UUID from a host ID, sequence number, and the current time
v1([Hexadecimal|int|string|null $node = null ][, int $clockSeq = null ]) : non-empty-string
Parameters
- $node : Hexadecimal|int|string|null = null
-
A 48-bit number representing the hardware address; this number may be represented as an integer or a hexadecimal string
- $clockSeq : int = null
-
A 14-bit number used to help avoid duplicates that could arise when the clock is set backwards in time or if the node ID changes
Return values
non-empty-string —Version 1 UUID as a string
v2()
Returns a version 2 (DCE Security) UUID from a local domain, local identifier, host ID, clock sequence, and the current time
v2(int $localDomain[, Integer|null $localIdentifier = null ][, Hexadecimal|null $node = null ][, int|null $clockSeq = null ]) : non-empty-string
Parameters
- $localDomain : int
-
The local domain to use when generating bytes, according to DCE Security
- $localIdentifier : Integer|null = null
-
The local identifier for the given domain; this may be a UID or GID on POSIX systems, if the local domain is person or group, or it may be a site-defined identifier if the local domain is org
- $node : Hexadecimal|null = null
-
A 48-bit number representing the hardware address
- $clockSeq : int|null = null
-
A 14-bit number used to help avoid duplicates that could arise when the clock is set backwards in time or if the node ID changes
Return values
non-empty-string —Version 2 UUID as a string
v3()
Returns a version 3 (name-based) UUID based on the MD5 hash of a namespace ID and a name
v3(string|UuidInterface $ns, string $name) : non-empty-string
Parameters
- $ns : string|UuidInterface
-
The namespace (must be a valid UUID)
- $name : string
Tags
Return values
non-empty-string —Version 3 UUID as a string
v4()
Returns a version 4 (random) UUID
v4() : non-empty-string
Return values
non-empty-string —Version 4 UUID as a string
v5()
Returns a version 5 (name-based) UUID based on the SHA-1 hash of a namespace ID and a name
v5(string|UuidInterface $ns, string $name) : non-empty-string
Parameters
- $ns : string|UuidInterface
-
The namespace (must be a valid UUID)
- $name : string
Tags
Return values
non-empty-string —Version 5 UUID as a string
v6()
Returns a version 6 (ordered-time) UUID from a host ID, sequence number, and the current time
v6([Hexadecimal|null $node = null ][, int $clockSeq = null ]) : non-empty-string
Parameters
- $node : Hexadecimal|null = null
-
A 48-bit number representing the hardware address
- $clockSeq : int = null
-
A 14-bit number used to help avoid duplicates that could arise when the clock is set backwards in time or if the node ID changes
Return values
non-empty-string —Version 6 UUID as a string
array_is_list()
array_is_list(array<string|int, mixed> $array) : bool
Parameters
- $array : array<string|int, mixed>
Return values
bool —enum_exists()
enum_exists(string $enum[, bool $autoload = true ]) : bool
Parameters
- $enum : string
- $autoload : bool = true