shipcloud PHP Client

Application

Interfaces, Classes and Traits

ExceptionInterface: Base exception marker interface for the instantiator component
InstantiatorInterface: Instantiator provides utility methods to build objects without invoking their constructors
FormatterInterface: Interface for formatters
ActivationStrategyInterface: Interface for activation strategies for the FingersCrossedHandler.
FormattableHandlerInterface: Interface to describe loggers that have a formatter
HandlerInterface: Interface that all Monolog Handlers must implement
ProcessableHandlerInterface: Interface to describe loggers that have processors
ProcessorInterface: An optional interface to allow labelling Monolog processors.
ResettableInterface: Handler or Processor implementing this interface will be reset when Logger::reset() is called.
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
AfterIncompleteTestHook
AfterLastTestHook
AfterRiskyTestHook
AfterSkippedTestHook
AfterSuccessfulTestHook
AfterTestErrorHook
AfterTestFailureHook
AfterTestHook
AfterTestWarningHook
BeforeFirstTestHook
BeforeTestHook
Hook
TestHook
TestSuiteLoader
ResultPrinter
LoggerAwareInterface: Describes a logger-aware instance.
LoggerInterface: Describes a logger instance.
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
ApiExample
ApiClientTest
AdditionalServiceTest
AddressTest
CustomsDeclarationItemTest
CustomsDeclarationTest
DropOffPointTest
LabelTest
LabelVoucherTest
PackageTest
PickupTest
PropertiesTest
ShipmentTest
TrackerTest
ComposerAutoloaderInitbad2687492e23cbe8723d3e5c914a517
ComposerStaticInitbad2687492e23cbe8723d3e5c914a517
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
InvalidArgumentException: Exception for invalid arguments provided to the instantiator
UnexpectedValueException: Exception for given parameters causing invalid/unexpected state on instantiation
Instantiator
ErrorHandler: Monolog error handler
ChromePHPFormatter: Formats a log message according to the ChromePHP array format
ElasticaFormatter: Format a log message into an Elastica Document
FlowdockFormatter: formats the record to be used in the FlowdockHandler
FluentdFormatter: Class FluentdFormatter
GelfMessageFormatter: Serializes a log message to GELF
HtmlFormatter: Formats incoming records into an HTML table
JsonFormatter: Encodes whatever record data is passed to it as json
LineFormatter: Formats incoming records into a one-line string
LogglyFormatter: Encodes message information into JSON in a format compatible with Loggly.
LogstashFormatter: Serializes a log message to Logstash Event Format
MongoDBFormatter: Formats a record for use with the MongoDBHandler.
NormalizerFormatter: Normalizes incoming records to remove objects/resources so it's easier to dump to various targets
ScalarFormatter: Formats data into an associative array of scalar values.
WildfireFormatter: Serializes a log message according to Wildfire's header requirements
AbstractHandler: Base Handler class providing the Handler structure
AbstractProcessingHandler: Base Handler class providing the Handler structure
AbstractSyslogHandler: Common syslog functionality
AmqpHandler: Base Handler class providing the Handler structure
BrowserConsoleHandler: Handler sending logs to browser's javascript console with no browser extension required
BufferHandler: Buffers all records until closing the handler and then pass them as batch.
ChromePHPHandler: Handler sending logs to the ChromePHP extension (http://www.chromephp.com/)
CouchDBHandler: CouchDB handler
CubeHandler: Logs to Cube.
Util
DeduplicationHandler: Simple handler wrapper that deduplicates log records across multiple requests
DoctrineCouchDBHandler: CouchDB handler for Doctrine CouchDB ODM
DynamoDbHandler: Amazon DynamoDB handler (http://aws.amazon.com/dynamodb/)
ElasticSearchHandler: Elastic Search handler
ErrorLogHandler: Stores to PHP error_log() handler.
FilterHandler: Simple handler wrapper that filters records based on a list of levels
ChannelLevelActivationStrategy: Channel and Error level based monolog activation strategy. Allows to trigger activation based on level per channel. e.g. trigger activation on level 'ERROR' by default, except for records of the 'sql' channel; those should trigger activation on level 'WARN'.
ErrorLevelActivationStrategy: Error level based activation strategy.
FingersCrossedHandler: Buffers all records until a certain level is reached
FirePHPHandler: Simple FirePHP Handler (http://www.firephp.org/), which uses the Wildfire protocol.
FleepHookHandler: Sends logs to Fleep.io using Webhook integrations
FlowdockHandler: Sends notifications through the Flowdock push API
GelfHandler: Handler to send messages to a Graylog2 (http://www.graylog2.org) server
GroupHandler: Forwards records to multiple handlers
HandlerWrapper: This simple wrapper class can be used to extend handlers functionality.
HipChatHandler: Sends notifications through the hipchat api to a hipchat room
IFTTTHandler: IFTTTHandler uses cURL to trigger IFTTT Maker actions
InsightOpsHandler: Inspired on LogEntriesHandler.
LogEntriesHandler: Stores to any socket - uses fsockopen() or pfsockopen().
LogglyHandler: Sends errors to Loggly.
MailHandler: Base class for all mail handlers
MandrillHandler: MandrillHandler uses cURL to send the emails to the Mandrill API
MissingExtensionException: Exception can be thrown if an extension for an handler is missing
MongoDBHandler: Logs to a MongoDB database.
NativeMailerHandler: NativeMailerHandler uses the mail() function to send the emails
NewRelicHandler: Class to record a log on a NewRelic application.
NullHandler: Blackhole
PHPConsoleHandler: Monolog handler for Google Chrome extension "PHP Console"
PsrHandler: Proxies log messages to an existing PSR-3 compliant logger.
PushoverHandler: Sends notifications through the pushover api to mobile phones
RavenHandler: Handler to send messages to a Sentry (https://github.com/getsentry/sentry) server using sentry-php (https://github.com/getsentry/sentry-php)
RedisHandler: Logs to a Redis key using rpush
RollbarHandler: Sends errors to Rollbar
RotatingFileHandler: Stores logs to files that are rotated every day and a limited number of files are kept.
SamplingHandler: Sampling handler
SlackRecord: Slack record utility helping to log to Slack webhooks or API.
SlackbotHandler: Sends notifications through Slack's Slackbot
SlackHandler: Sends notifications through Slack API
SlackWebhookHandler: Sends notifications through Slack Webhooks
SocketHandler: Stores to any socket - uses fsockopen() or pfsockopen().
StreamHandler: Stores to any stream resource
SwiftMailerHandler: SwiftMailerHandler uses Swift_Mailer to send the emails
SyslogHandler: Logs to syslog service.
UdpSocket
SyslogUdpHandler: A Handler for logging to a remote syslogd server.
TestHandler: Used for testing purposes.
WhatFailureGroupHandler: Forwards records to multiple handlers suppressing failures of each handler and continuing through to give every handler a chance to succeed.
ZendMonitorHandler: Handler sending logs to Zend Monitor
Logger: Monolog log channel
GitProcessor: Injects Git branch and Git commit SHA in all records
IntrospectionProcessor: Injects line/file:class/function where the log message came from
MemoryPeakUsageProcessor: Injects memory_get_peak_usage in all records
MemoryProcessor: Some methods that are common for all memory processors
MemoryUsageProcessor: Injects memory_get_usage in all records
MercurialProcessor: Injects Hg branch and Hg revision number in all records
ProcessIdProcessor: Adds value of getmypid into records
PsrLogMessageProcessor: Processes a record's message according to PSR-3 rules
TagProcessor: Adds a tags array into record
UidProcessor: Adds a unique identifier into records
WebProcessor: Injects url/method and remote IP of the current web request in all records
Registry: Monolog log registry
SignalHandler: Monolog POSIX signal handler
Utils
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
Email
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
AbstractVersionConstraint
AndVersionConstraintGroup
AnyVersionConstraint
ExactVersionConstraint
GreaterThanOrEqualToVersionConstraint
OrVersionConstraintGroup
SpecificMajorAndMinorVersionConstraint
SpecificMajorVersionConstraint
InvalidPreReleaseSuffixException
InvalidVersionException
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.
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
AbstractLogger: This is a simple Logger implementation that other Loggers can inherit from.
InvalidArgumentException
LogLevel: Describes log levels.
NullLogger: This Logger can be used to avoid conditional log calls.
LoggerInterfaceTest: Provides a base test class for ensuring compliance with the LoggerInterface.
TestLogger: Used for testing purposes.
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
CallableType
LogicException
RuntimeException
FalseType
GenericObjectType
IterableType
MixedType
NullType
ObjectType
ReflectionMapper
SimpleType
StaticType
Type
TypeName
UnionType
UnknownType
VoidType
Version
Exception
NamespaceUri
NamespaceUriException
Token
TokenCollection
TokenCollectionException
Tokenizer
XMLSerializer
Assert: Efficient assertions to validate the input/output of your methods.
InvalidArgumentException
FormattableHandlerTrait: Helper trait for implementing FormattableInterface
ProcessableHandlerTrait: Helper trait for implementing ProcessableInterface
TestListenerDefaultImplementation
LoggerAwareTrait: Basic Implementation of LoggerAwareInterface.
LoggerTrait: This is a simple Logger trait that classes unable to extend AbstractLogger (because they extend another class, etc) can include.
Mixin: This trait aids static analysis tooling in introspecting assertion magic methods.

ARGS = '$(?<args>[^()]*+(?:\((?&args)$[^()]*+)*+)\)'
LIB = '(?(DEFINE) (?<singleQuotedString>'[^\\']*+(?:\\.[^\\']*+)*+') (?<doubleQuotedString>"[^\\"]*+(?:\\.[^\\"]*+)*+") (?<string>(?&singleQuotedString)|(?&doubleQuotedString)) (?<comment>/\*[^*]*+(?:\*(?!/)[^*]*+)*+\*/) (?<code>\{[^'"/{}]*+(?:(?:(?&string)|(?&comment)|(?&code)|/)[^'"/{}]*+)*+}) )'
PARAMS = '\[(?<params>[^[\]]*+(?:\[(?&params)\][^[\]]*+)*+)\]'
T_NAME_FULLY_QUALIFIED = 'T_NAME_FULLY_QUALIFIED'
T_NAME_QUALIFIED = 'T_NAME_QUALIFIED'
generate_variables() : mixed
generate_getter_and_setter() : mixed
generate_to_array() : mixed
composerRequirebad2687492e23cbe8723d3e5c914a517() : mixed
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
ctype_alnum() : mixed
ctype_alpha() : mixed
ctype_cntrl() : mixed
ctype_digit() : mixed
ctype_graph() : mixed
ctype_lower() : mixed
ctype_print() : mixed
ctype_punct() : mixed
ctype_space() : mixed
ctype_upper() : mixed
ctype_xdigit() : mixed
ctype_alnum() : bool
ctype_alpha() : bool
ctype_cntrl() : bool
ctype_digit() : bool
ctype_graph() : bool
ctype_lower() : bool
ctype_print() : bool
ctype_punct() : bool
ctype_space() : bool
ctype_upper() : bool
ctype_xdigit() : bool

ARGS


    public
    mixed
    ARGS
    = '\((?<args>[^()]*+(?:\((?&args)\)[^()]*+)*+)\)'

LIB


    public
    mixed
    LIB
    = '(?(DEFINE)
    (?<singleQuotedString>'[^\\']*+(?:\\.[^\\']*+)*+')
    (?<doubleQuotedString>"[^\\"]*+(?:\\.[^\\"]*+)*+")
    (?<string>(?&singleQuotedString)|(?&doubleQuotedString))
    (?<comment>/\*[^*]*+(?:\*(?!/)[^*]*+)*+\*/)
    (?<code>\{[^'"/{}]*+(?:(?:(?&string)|(?&comment)|(?&code)|/)[^'"/{}]*+)*+})
)'

PARAMS


    public
    mixed
    PARAMS
    = '\[(?<params>[^[\]]*+(?:\[(?&params)\][^[\]]*+)*+)\]'

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'

generate_variables()


    
                generate_variables(mixed $arr) : mixed

Parameters

$arr : mixed

Return values

mixed —

generate_getter_and_setter()


    
                generate_getter_and_setter(mixed $arr) : mixed

Parameters

$arr : mixed

Return values

mixed —

generate_to_array()


    
                generate_to_array(mixed $arr) : mixed

Parameters

$arr : mixed

Return values

mixed —

composerRequirebad2687492e23cbe8723d3e5c914a517()


    
                composerRequirebad2687492e23cbe8723d3e5c914a517(mixed $fileIdentifier, mixed $file) : mixed

Parameters

$fileIdentifier : mixed
$file : mixed

Return values

mixed —

includeFile()

Scope isolated include.


    
                includeFile(string $file) : void

Prevents access to $this/self from included files.

Parameters

$file : string

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

Return values

void —

assertEmpty()

Asserts that a variable is empty.


    
                assertEmpty(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertNotEmpty()

Asserts that a variable is not empty.


    
                assertNotEmpty(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

Return values

void —

assertIsReadable()

Asserts that a file/dir is readable.


    
                assertIsReadable(string $filename[, string $message = '' ]) : void

Parameters

$filename : string
$message : string = ''

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 = ''

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 = ''

Return values

void —

assertIsWritable()

Asserts that a file/dir exists and is writable.


    
                assertIsWritable(string $filename[, string $message = '' ]) : void

Parameters

$filename : string
$message : string = ''

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 = ''

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 = ''

Return values

void —

assertDirectoryExists()

Asserts that a directory exists.


    
                assertDirectoryExists(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryDoesNotExist()

Asserts that a directory does not exist.


    
                assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryNotExists()

Asserts that a directory does not exist.


    
                assertDirectoryNotExists(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryIsReadable()

Asserts that a directory exists and is readable.


    
                assertDirectoryIsReadable(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryIsNotReadable()

Asserts that a directory exists and is not readable.


    
                assertDirectoryIsNotReadable(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryNotIsReadable()

Asserts that a directory exists and is not readable.


    
                assertDirectoryNotIsReadable(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryIsWritable()

Asserts that a directory exists and is writable.


    
                assertDirectoryIsWritable(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryIsNotWritable()

Asserts that a directory exists and is not writable.


    
                assertDirectoryIsNotWritable(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertDirectoryNotIsWritable()

Asserts that a directory exists and is not writable.


    
                assertDirectoryNotIsWritable(string $directory[, string $message = '' ]) : void

Parameters

$directory : string
$message : string = ''

Return values

void —

assertFileExists()

Asserts that a file exists.


    
                assertFileExists(string $filename[, string $message = '' ]) : void

Parameters

$filename : string
$message : string = ''

Return values

void —

assertFileDoesNotExist()

Asserts that a file does not exist.


    
                assertFileDoesNotExist(string $filename[, string $message = '' ]) : void

Parameters

$filename : string
$message : string = ''

Return values

void —

assertFileNotExists()

Asserts that a file does not exist.


    
                assertFileNotExists(string $filename[, string $message = '' ]) : void

Parameters

$filename : string
$message : string = ''

Return values

void —

assertFileIsReadable()

Asserts that a file exists and is readable.


    
                assertFileIsReadable(string $file[, string $message = '' ]) : void

Parameters

$file : string
$message : string = ''

Return values

void —

assertFileIsNotReadable()

Asserts that a file exists and is not readable.


    
                assertFileIsNotReadable(string $file[, string $message = '' ]) : void

Parameters

$file : string
$message : string = ''

Return values

void —

assertFileNotIsReadable()

Asserts that a file exists and is not readable.


    
                assertFileNotIsReadable(string $file[, string $message = '' ]) : void

Parameters

$file : string
$message : string = ''

Return values

void —

assertFileIsWritable()

Asserts that a file exists and is writable.


    
                assertFileIsWritable(string $file[, string $message = '' ]) : void

Parameters

$file : string
$message : string = ''

Return values

void —

assertFileIsNotWritable()

Asserts that a file exists and is not writable.


    
                assertFileIsNotWritable(string $file[, string $message = '' ]) : void

Parameters

$file : string
$message : string = ''

Return values

void —

assertFileNotIsWritable()

Asserts that a file exists and is not writable.


    
                assertFileNotIsWritable(string $file[, string $message = '' ]) : void

Parameters

$file : string
$message : string = ''

Return values

void —

assertTrue()

Asserts that a condition is true.


    
                assertTrue(mixed $condition[, string $message = '' ]) : void

Parameters

$condition : mixed
$message : string = ''

Return values

void —

assertNotTrue()

Asserts that a condition is not true.


    
                assertNotTrue(mixed $condition[, string $message = '' ]) : void

Parameters

$condition : mixed
$message : string = ''

Return values

void —

assertFalse()

Asserts that a condition is false.


    
                assertFalse(mixed $condition[, string $message = '' ]) : void

Parameters

$condition : mixed
$message : string = ''

Return values

void —

assertNotFalse()

Asserts that a condition is not false.


    
                assertNotFalse(mixed $condition[, string $message = '' ]) : void

Parameters

$condition : mixed
$message : string = ''

Return values

void —

assertNull()

Asserts that a variable is null.


    
                assertNull(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertNotNull()

Asserts that a variable is not null.


    
                assertNotNull(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertFinite()

Asserts that a variable is finite.


    
                assertFinite(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertInfinite()

Asserts that a variable is infinite.


    
                assertInfinite(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertNan()

Asserts that a variable is nan.


    
                assertNan(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

Return values

void —

assertIsArray()

Asserts that a variable is of type array.


    
                assertIsArray(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsBool()

Asserts that a variable is of type bool.


    
                assertIsBool(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsFloat()

Asserts that a variable is of type float.


    
                assertIsFloat(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsInt()

Asserts that a variable is of type int.


    
                assertIsInt(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNumeric()

Asserts that a variable is of type numeric.


    
                assertIsNumeric(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsObject()

Asserts that a variable is of type object.


    
                assertIsObject(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsResource()

Asserts that a variable is of type resource.


    
                assertIsResource(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

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 = ''

Return values

void —

assertIsString()

Asserts that a variable is of type string.


    
                assertIsString(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsScalar()

Asserts that a variable is of type scalar.


    
                assertIsScalar(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsCallable()

Asserts that a variable is of type callable.


    
                assertIsCallable(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsIterable()

Asserts that a variable is of type iterable.


    
                assertIsIterable(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotArray()

Asserts that a variable is not of type array.


    
                assertIsNotArray(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotBool()

Asserts that a variable is not of type bool.


    
                assertIsNotBool(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotFloat()

Asserts that a variable is not of type float.


    
                assertIsNotFloat(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotInt()

Asserts that a variable is not of type int.


    
                assertIsNotInt(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotNumeric()

Asserts that a variable is not of type numeric.


    
                assertIsNotNumeric(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotObject()

Asserts that a variable is not of type object.


    
                assertIsNotObject(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotResource()

Asserts that a variable is not of type resource.


    
                assertIsNotResource(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotClosedResource()

Asserts that a variable is not of type resource.


    
                assertIsNotClosedResource(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotString()

Asserts that a variable is not of type string.


    
                assertIsNotString(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotScalar()

Asserts that a variable is not of type scalar.


    
                assertIsNotScalar(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotCallable()

Asserts that a variable is not of type callable.


    
                assertIsNotCallable(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

Return values

void —

assertIsNotIterable()

Asserts that a variable is not of type iterable.


    
                assertIsNotIterable(mixed $actual[, string $message = '' ]) : void

Parameters

$actual : mixed
$message : string = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

Return values

void —

assertStringContainsString()


    
                assertStringContainsString(string $needle, string $haystack[, string $message = '' ]) : void

Parameters

$needle : string
$haystack : string
$message : string = ''

Return values

void —

assertStringContainsStringIgnoringCase()


    
                assertStringContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void

Parameters

$needle : string
$haystack : string
$message : string = ''

Return values

void —

assertStringNotContainsString()


    
                assertStringNotContainsString(string $needle, string $haystack[, string $message = '' ]) : void

Parameters

$needle : string
$haystack : string
$message : string = ''

Return values

void —

assertStringNotContainsStringIgnoringCase()


    
                assertStringNotContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void

Parameters

$needle : string
$haystack : string
$message : string = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

Return values

void —

assertJson()

Asserts that a string is a valid JSON string.


    
                assertJson(string $actualJson[, string $message = '' ]) : void

Parameters

$actualJson : string
$message : string = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 = ''

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 —

ctype_alnum()


    
                ctype_alnum(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_alpha()


    
                ctype_alpha(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_cntrl()


    
                ctype_cntrl(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_digit()


    
                ctype_digit(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_graph()


    
                ctype_graph(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_lower()


    
                ctype_lower(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_print()


    
                ctype_print(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_punct()


    
                ctype_punct(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_space()


    
                ctype_space(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_upper()


    
                ctype_upper(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_xdigit()


    
                ctype_xdigit(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

ctype_alnum()


    
                ctype_alnum(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_alpha()


    
                ctype_alpha(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_cntrl()


    
                ctype_cntrl(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_digit()


    
                ctype_digit(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_graph()


    
                ctype_graph(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_lower()


    
                ctype_lower(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_print()


    
                ctype_print(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_punct()


    
                ctype_punct(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_space()


    
                ctype_space(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_upper()


    
                ctype_upper(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

ctype_xdigit()


    
                ctype_xdigit(mixed $text) : bool

Parameters

$text : mixed

Return values

bool —

Application

Interfaces, Classes and Traits

Table of Contents

Constants

ARGS

LIB

PARAMS

T_NAME_FULLY_QUALIFIED

T_NAME_QUALIFIED

Functions

generate_variables()

Parameters

Return values

generate_getter_and_setter()

Parameters

Return values

generate_to_array()

Parameters

Return values

composerRequirebad2687492e23cbe8723d3e5c914a517()

Parameters

Return values

includeFile()

Parameters

Tags

Return values

deep_copy()

Parameters

Return values

preprocessGrammar()

Parameters

Return values

resolveNodes()

Parameters

Return values

resolveMacros()

Parameters

Return values

assertArgs()

Parameters

Return values

resolveStackAccess()

Parameters

Return values

removeTrailingWhitespace()

Parameters

Return values

regex()

Parameters

Return values

magicSplit()

Parameters

Return values

ensureDirExists()

Parameters

Return values

execCmd()

Parameters

Return values

assertArrayHasKey()

Parameters

Tags

Return values

assertArrayNotHasKey()

Parameters

Tags

Return values

assertContains()

Parameters

Tags

Return values

assertContainsEquals()

Parameters

Return values

assertNotContains()

Parameters

Tags

Return values

assertNotContainsEquals()

Parameters