Documentation

Lwt

Table of Contents

Packages

Config
Api
Modules
Views
Entity
Shared
Database
Core
Documentation
Tests

Interfaces

ApiRoutableInterface
Interface for API handlers that participate in route dispatch.
Cancellation
Cancellations are simple objects that allow registering handlers to subscribe to cancellation requests.
Closable
ReadableStream
A `ReadableStream` allows reading byte streams in chunks.
ResourceStream
WritableStream
A `WritableStream` allows writing data in chunks. Writers can wait on the returned promises to feel the backpressure.
Cache
StringCache
DnsConfigLoader
DnsResolver
Context
Interface for sending messages between execution contexts, such as two coroutines or two processes.
ContextFactory
IpcHub
LimitedWorkerPool
An interface for worker pools.
Task
A runnable unit of execution.
TaskFailureThrowable
Common interface for exceptions thrown when Task::run() throws an exception when being executed in a worker.
Worker
An interface for a parallel worker thread that runs a queue of tasks.
WorkerFactory
Interface for factories used to create new workers.
WorkerPool
An interface for worker pools.
ConcurrentIterator
Serializer
ServerSocket
ServerSocketFactory
Socket
A `ReadableStream` allows reading byte streams in chunks.
SocketAddress
SocketConnector
SocketPool
Allows pooling of connections for stateless protocols.
UdpSocket
Channel
Interface for sending messages between execution contexts, such as two coroutines or two processes.
KeyedMutex
A synchronization primitive that can be used for mutual exclusion across contexts based on keys.
KeyedSemaphore
A counting semaphore based on keys.
Mutex
A synchronization primitive that can be used for mutual exclusion across contexts.
Parcel
Semaphore
A counting semaphore.
ConstraintInterface
DO NOT IMPLEMENT this interface. It is only meant for usage as a type hint in libraries relying on composer/semver but creating your own constraint class that implements this interface is not a supported use case and will cause the composer/semver components to return unexpected results.
DataInterface
ProcessExecutor
CpuCoreFinder
JWTExceptionWithPayloadInterface
BodySummarizerInterface
ClientInterface
Client interface for sending HTTP requests.
CookieJarInterface
Stores HTTP cookies.
GuzzleException
Every HTTP client related exception MUST implement this interface.
CurlFactoryInterface
MessageFormatterInterface
PromiseInterface
A promise represents the eventual result of an asynchronous operation.
PromisorInterface
Interface used with classes that return a promise.
TaskQueueInterface
ConverterInterface
Interface for a service which converts content from one format (like Markdown) to another (like HTML).
DelimiterInterface
CacheableDelimiterProcessorInterface
Special marker interface for delimiter processors that return dynamic values from getDelimiterUse()
DelimiterProcessorCollectionInterface
DelimiterProcessorInterface
Interface for a delimiter processor
EnvironmentAwareInterface
EnvironmentBuilderInterface
Interface for building the Environment with any extensions, parsers, listeners, etc. that it may need
EnvironmentInterface
Interface for a service which provides a readable configuration object
CommonMarkException
Marker interface for all exceptions thrown by this library.
ConfigurableExtensionInterface
EmbedAdapterInterface
Interface for a service which updates the embed code(s) for the given array of embeds
ExtensionInterface
FrontMatterDataParserInterface
FrontMatterParserInterface
FrontMatterProviderInterface
MentionGeneratorInterface
NormalizerStrategyInterface
TableOfContentsGeneratorInterface
MarkdownInputInterface
MarkdownConverterInterface
Interface for a service which converts Markdown to HTML.
TightBlockInterface
DelimitedInterface
ExpressionInterface
RawMarkupContainerInterface
Interface for a node which contains raw, unprocessed markup (like HTML)
StringContainerInterface
Interface for a node which directly contains line(s) of text
TextNormalizerInterface
Creates a normalized version of the given input text
UniqueSlugNormalizerInterface
Creates a normalized version of the given input text
RenderedContentInterface
BlockContinueParserInterface
Interface for a block continuation parser
BlockContinueParserWithInlinesInterface
Interface for a block continuation parser
BlockStartParserInterface
Interface for a block parser which identifies block starts.
InlineParserInterface
InlineParserEngineInterface
Parser for inline content (text, links, emphasized text, etc).
MarkdownParserInterface
MarkdownParserStateInterface
ReferenceableInterface
ReferenceInterface
Link reference
ReferenceMapInterface
A collection of references
ChildNodeRendererInterface
Renders multiple nodes by delegating to the individual node renderers and adding spacing where needed
DocumentRendererInterface
Renders a parsed Document AST
MarkdownRendererInterface
Renders a parsed Document AST
NodeRendererInterface
XmlNodeRendererInterface
ConfigurationAwareInterface
Implement this class to facilitate setter injection of the configuration where needed
ConfigurationBuilderInterface
An interface that provides the ability to set both the schema and configuration values
ConfigurationInterface
Interface for reading configuration values
ConfigurationProviderInterface
Interface for a service which provides a readable configuration object
ConfigurationExceptionInterface
Marker interface for any/all exceptions thrown by this library
MutableConfigurationInterface
Interface for setting/merging user-defined configuration values into the configuration object
SchemaBuilderInterface
Interface that allows new schemas to be added to a configuration
OptionProviderInterface
Interface for access token options provider
ResourceOwnerInterface
Classes implementing `ResourceOwnerInterface` may be used to represent the resource owner authenticated with a service provider.
AccessTokenInterface
ResourceOwnerAccessTokenInterface
SettableRefreshTokenInterface
AuthorityInterface
Conditionable
DataPathInterface
DomainHostInterface
FragmentDirective
FragmentInterface
HostInterface
IpHostInterface
PathInterface
PortInterface
QueryInterface
SegmentedPathInterface
UriAccess
UriComponentInterface
UriException
UriInterface
UserInfoInterface
Calculator
Filter
Filter to apply to a property while copying an object
Matcher
TypeFilter
DynamicParameter
Schema
IHtmlString
ITranslator
Translator adapter.
HtmlStringable
Translator
Translator adapter.
Builder
ErrorHandler
FunctionLike
Node
NodeTraverserInterface
NodeVisitor
Parser
PrettyPrinter
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
Factory
PHPStanFactory
StaticMethod
Formatter
Reference
Interface for references in {@see \phpDocumentor\Reflection\DocBlock\Tags\See}
DocBlockFactoryInterface
PseudoType
Type
OAuthTokenProvider
OAuthTokenProvider - OAuth2 token provider interface.
ConstExprNode
Node
NodeVisitor
Inspired by https://github.com/nikic/PHP-Parser/tree/36a6dcd04e7b0285e8f0868f44bd4927802f7df1
PhpDocChildNode
PhpDocTagValueNode
TypeNode
Exception
Exception
Exception
Exception
FinishedSubscriber
StartedSubscriber
Event
AssertionFailedSubscriber
AssertionSucceededSubscriber
ComparatorRegisteredSubscriber
AfterLastTestMethodCalledSubscriber
AfterLastTestMethodErroredSubscriber
AfterLastTestMethodFinishedSubscriber
AfterTestMethodCalledSubscriber
AfterTestMethodErroredSubscriber
AfterTestMethodFinishedSubscriber
BeforeFirstTestMethodCalledSubscriber
BeforeFirstTestMethodErroredSubscriber
BeforeFirstTestMethodFinishedSubscriber
BeforeTestMethodCalledSubscriber
BeforeTestMethodErroredSubscriber
BeforeTestMethodFinishedSubscriber
PostConditionCalledSubscriber
PostConditionErroredSubscriber
PostConditionFinishedSubscriber
PreConditionCalledSubscriber
PreConditionErroredSubscriber
PreConditionFinishedSubscriber
ConsideredRiskySubscriber
DeprecationTriggeredSubscriber
ErrorTriggeredSubscriber
NoticeTriggeredSubscriber
PhpDeprecationTriggeredSubscriber
PhpNoticeTriggeredSubscriber
PhpunitDeprecationTriggeredSubscriber
PhpunitErrorTriggeredSubscriber
PhpunitWarningTriggeredSubscriber
PhpWarningTriggeredSubscriber
WarningTriggeredSubscriber
DataProviderMethodCalledSubscriber
DataProviderMethodFinishedSubscriber
FinishedSubscriber
PreparationFailedSubscriber
PreparationStartedSubscriber
PreparedSubscriber
ErroredSubscriber
FailedSubscriber
MarkedIncompleteSubscriber
PassedSubscriber
SkippedSubscriber
PrintedUnexpectedOutputSubscriber
MockObjectCreatedSubscriber
MockObjectForAbstractClassCreatedSubscriber
MockObjectForIntersectionOfInterfacesCreatedSubscriber
MockObjectForTraitCreatedSubscriber
MockObjectFromWsdlCreatedSubscriber
PartialMockObjectCreatedSubscriber
TestProxyCreatedSubscriber
TestStubCreatedSubscriber
TestStubForIntersectionOfInterfacesCreatedSubscriber
BootstrapFinishedSubscriber
ConfiguredSubscriber
DeprecationTriggeredSubscriber
EventFacadeSealedSubscriber
ExecutionAbortedSubscriber
ExecutionFinishedSubscriber
ExecutionStartedSubscriber
ExtensionBootstrappedSubscriber
ExtensionLoadedFromPharSubscriber
FinishedSubscriber
GarbageCollectionDisabledSubscriber
GarbageCollectionEnabledSubscriber
GarbageCollectionTriggeredSubscriber
StartedSubscriber
WarningTriggeredSubscriber
FilteredSubscriber
FinishedSubscriber
LoadedSubscriber
SkippedSubscriber
SortedSubscriber
StartedSubscriber
Exception
Subscriber
Tracer
Exception
InvocationStubber
MockObject
Stub
ParametersRule
Test
Exception
Extension
ContainerExceptionInterface
Base interface representing a generic exception in a container.
ContainerInterface
Describes the interface of a container that exposes methods to read its entries.
NotFoundExceptionInterface
No entry was found in the container.
EventDispatcherInterface
Defines a dispatcher for events.
ListenerProviderInterface
Mapper from an event to the listeners that are applicable to that event.
StoppableEventInterface
An Event whose processing may be interrupted when the event has been handled.
ClientExceptionInterface
Every HTTP client related exception MUST implement this interface.
ClientInterface
NetworkExceptionInterface
Thrown when the request cannot be completed because of network issues.
RequestExceptionInterface
Exception for when a request failed.
RequestFactoryInterface
ResponseFactoryInterface
ServerRequestFactoryInterface
StreamFactoryInterface
UploadedFileFactoryInterface
UriFactoryInterface
MessageInterface
HTTP messages consist of requests from a client to a server and responses from a server to a client. This interface defines the methods common to each.
RequestInterface
Representation of an outgoing, client-side request.
ResponseInterface
Representation of an outgoing, server-side response.
ServerRequestInterface
Representation of an incoming, server-side HTTP request.
StreamInterface
Describes a data stream.
UploadedFileInterface
Value object representing a file uploaded through an HTTP request.
UriInterface
Value object representing a URI.
LoggerAwareInterface
Describes a logger-aware instance.
LoggerInterface
Describes a logger instance.
Driver
The driver MUST run in its own fiber and execute callbacks in a separate fiber. If fibers are reused, the driver needs to call {@see FiberLocal::clear()} after running the callback.
Suspension
Should be used to run and suspend the event loop instead of directly interacting with fibers.
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
Report
DeprecatedSniff
Sniff
SignalableCommandInterface
Interface for command reacting to signal.
CommandLoaderInterface
CompletionOutputInterface
Transforms the {@see CompletionSuggestions} object into output readable by the shell completion.
DescriptorInterface
Descriptor interface.
ExceptionInterface
ExceptionInterface.
OutputFormatterInterface
Formatter interface for console output.
OutputFormatterStyleInterface
Formatter style interface for defining styles.
WrappableOutputFormatterInterface
Formatter interface for console output that supports word wrapping.
HelperInterface
HelperInterface is the interface all helpers must implement.
InputAwareInterface
InputAwareInterface should be implemented by classes that depends on the Console Input.
InputInterface
InputInterface is the interface implemented by all input classes.
StreamableInputInterface
StreamableInputInterface is the interface implemented by all input classes that have an input stream.
ConsoleOutputInterface
ConsoleOutputInterface is the interface implemented by ConsoleOutput class.
OutputInterface
OutputInterface is the interface implemented by all Output classes.
StyleInterface
Output style helpers.
ExceptionInterface
Exception interface for all exceptions thrown by the component.
IOExceptionInterface
IOException interface for file and input/output stream related exceptions thrown by the component.
Stringable
ResetInterface
Provides a way to reset an object to its initial state.
ServiceCollectionInterface
A ServiceProviderInterface that is also countable and iterable.
ServiceProviderInterface
A ServiceProviderInterface exposes the identifiers and the types of services provided by a container.
ServiceSubscriberInterface
A ServiceSubscriber exposes its dependencies via the static {@link getSubscribedServices} method.
ExceptionInterface
InflectorInterface
SluggerInterface
Creates a URL-friendly slug from a given string.
FileSource
EmitterInterface
Event Emitter Interface
ProtocolReader
Must emit a "message" event with a Message object as parameter when a message comes in
ProtocolWriter
TypeAlias
MixedIssue
VirtualNode
Describe a Node that is not part of the original AST and was created by Psalm for analysis
NodeTypeProvider
AddTaintsInterface
AfterAnalysisInterface
AfterClassLikeAnalysisInterface
AfterClassLikeExistenceCheckInterface
AfterClassLikeVisitInterface
AfterCodebasePopulatedInterface
AfterEveryFunctionCallAnalysisInterface
AfterExpressionAnalysisInterface
AfterFileAnalysisInterface
AfterFunctionCallAnalysisInterface
AfterFunctionLikeAnalysisInterface
AfterMethodCallAnalysisInterface
AfterStatementAnalysisInterface
BeforeAddIssueInterface
BeforeExpressionAnalysisInterface
BeforeFileAnalysisInterface
BeforeStatementAnalysisInterface
DynamicFunctionStorageProviderInterface
FunctionExistenceProviderInterface
FunctionParamsProviderInterface
FunctionReturnTypeProviderInterface
MethodExistenceProviderInterface
MethodParamsProviderInterface
MethodReturnTypeProviderInterface
MethodVisibilityProviderInterface
PropertyExistenceProviderInterface
PropertyTypeProviderInterface
PropertyVisibilityProviderInterface
RemoveTaintsInterface
StringInterpreterInterface
FileExtensionsInterface
PluginEntryPointInterface
PluginFileExtensionsInterface
PluginInterface
RegistrationInterface
StatementsSource
HasAttributesInterface
DependentType
TCallableInterface
TypeNode

Classes

FlattedString
Flatted
Endpoints
Registry of API V1 endpoints.
Response
Standardized JSON response helper for API V1.
Application
Main application class that bootstraps and runs LWT.
ApiController
Controller for REST API endpoints.
GoogleTranslateClient
Wrapper class to get translation.
LanguageController
Controller for language configuration.
WhisperClient
HTTP client for communicating with the NLP microservice Whisper endpoints.
LemmatizerFactory
Factory for creating lemmatizers based on language configuration.
HybridLemmatizer
Hybrid lemmatizer that combines dictionary and NLP-based approaches.
NlpServiceLemmatizer
Lemmatizer that uses the NLP microservice (spaCy).
EnvLoader
Simple .env file parser and loader.
Configuration
Database configuration and connection utilities.
Connection
Database connection wrapper providing a clean interface for database operations.
DB
Database facade providing a simplified interface for common operations.
Escaping
SQL escaping and text preparation utilities.
Maintenance
Database maintenance and optimization utilities.
Migrations
Database migrations and initialization utilities.
PreparedStatement
Wrapper class for mysqli prepared statements.
QueryBuilder
Fluent query builder for constructing SQL queries.
Settings
Application settings management.
SqlFileParser
SQL file parser for reading and splitting SQL files into individual queries.
TextParsing
Text parsing and processing utilities.
Validation
Database ID and tag validation utilities.
InputValidator
Centralized input validation for request parameters.
UrlUtilities
URL handling utilities.
ErrorHandler
Error handling utilities.
StringUtils
String manipulation utilities.
ViteHelper
Helper class for Vite asset loading.
FormHelper
Helper class for generating HTML form attributes.
IconHelper
Helper class for rendering Lucide SVG icons.
PageLayoutHelper
Helper class for generating page layout elements.
SearchableSelectHelper
Helper class for rendering searchable select components.
SelectOptionsBuilder
Builder class for generating HTML select options.
TagHelper
Helper class for rendering tags with Bulma styling.
ApiV1RoutingTest
Tests for ApiV1 routing functionality.
ApiV1Test
Unit tests for the ApiV1 class.
EndpointsTest
Unit tests for the Endpoints class.
SettingsHandlerTest
Unit tests for the AdminApiHandler class (settings functionality).
TextHandlerTest
Unit tests for the TextHandler class.
ResponseTest
Unit tests for the Response class.
ApiControllerTest
Unit tests for the ApiController class.
BaseControllerTest
Unit tests for the BaseController class.
TestableController
Concrete implementation of BaseController for testing.
LanguageControllerTest
Unit tests for the LanguageController class.
ReviewControllerTest
Unit tests for the ReviewController class.
TextControllerArchivedTest
Unit tests for the TextController::archived() method and related functionality.
TextControllerEditTest
Unit tests for the TextController::edit() method and related functionality.
TextControllerReadTest
Unit tests for the TextController::read() method and related functionality.
TextPrintControllerTest
Unit tests for the TextPrintController class.
ContainerTest
Unit tests for the DI Container.
TestDependency
TestServiceWithDeps
TestServiceWithDefaults
TestServiceWithNullable
TestAbstractClass
TestCallableService
ConfigurationTest
Unit tests for the Database\Configuration class.
ConnectionTest
Unit tests for the Database\Connection class.
DBTest
Unit tests for the Database\DB facade class.
EscapingTest
Unit tests for the Database\Escaping class.
ForeignKeyTest
Tests for inter-table foreign key constraints.
MaintenanceTest
Unit tests for the Database\Maintenance class.
MigrationsTest
Unit tests for the Database\Migrations class.
PreparedStatementTest
Tests for PreparedStatement class and prepared statement functionality.
QueryBuilderTest
Unit tests for the Database\QueryBuilder class.
QueryBuilderUserScopeTest
Unit tests for QueryBuilder user scope filtering.
SettingsTest
Unit tests for the Database\Settings class.
SqlValidatorTest
Unit tests for the SqlValidator class.
TextParsingTest
Unit tests for the Database\TextParsing class.
ValidationTest
Unit tests for the Database\Validation class.
DatabaseConnectTest
ClassesTest
Comprehensive tests for PHP classes: Language, Term, Text, GoogleTranslate
UserTest
Unit tests for the User entity and UserId value object.
ExportAndAnnotationTest
Unit tests for export and annotation functions.
FeedsTest
Tests for FeedFacade RSS feed operations.
GlobalsTest
Unit tests for the Globals class.
InputValidatorTest
Unit tests for the InputValidator class.
UrlUtilitiesTest
Tests for UrlUtilities class
IntegrationTest
Integration tests for core functionality.
LanguageRepositoryTest
Unit tests for the MySqlLanguageRepository class (formerly LanguageRepository).
TermRepositoryTest
Tests for the MySqlTermRepository class.
TextRepositoryTest
Tests for the MySqlTextRepository class.
UserRepositoryTest
Tests for the MySqlUserRepository class.
StringUtilsMarkdownTest
Tests for StringUtils::parseInlineMarkdown()
TagsTest
Comprehensive tests for TagsFacade
AnnotationManagementTest
Tests for annotation_management.php functions
TextParsingTest
Comprehensive tests for text parsing functions
TextProcessingTest
Unit tests for text processing functions.
UiHelpersTest
Tests for PageLayoutHelper (migrated from ui_helpers.php)
SqlFileParserTest
Tests for SqlFileParser class
StringUtilitiesTest
Tests for string_utilities.php functions
VersionTest
Tests for ApplicationInfo class
WordScoringTest
Tests for WordStatusService scoring functions
WordStatusTest
Tests for WordStatusService
AdminFacadeTest
Unit tests for the AdminFacade class.
FileSystemEnvRepositoryTest
Unit tests for FileSystemEnvRepository.
MediaServiceTest
Unit tests for MediaService.
DeleteBookTest
Unit tests for the DeleteBook use case.
GetBookByIdTest
Unit tests for the GetBookById use case.
GetBookListTest
Unit tests for the GetBookList use case.
DictionaryApiHandlerTest
Unit tests for DictionaryApiHandler.
TranslationControllerTest
Unit tests for the TranslationController class.
TranslationServiceTest
Unit tests for the TranslationService class.
ArticleExtractorTest
Tests for ArticleExtractor service.
FeedOptionsTest
Tests for FeedOptions value object.
FeedFacadeTest
Unit tests for the FeedFacade class.
FeedApiHandlerTest
Unit tests for FeedApiHandler.
FeedWizardSessionManagerTest
Unit tests for FeedWizardSessionManager.
MySqlArticleRepositoryTest
Tests for MySqlArticleRepository.
RssParserTest
Comprehensive tests for RssParser.
ArticleExtractorTest
Unit tests for the ArticleExtractor service.
ImportArticlesUseCaseTest
Unit tests for the ImportArticles use case.
LoadFeedUseCaseTest
Unit tests for the LoadFeed use case.
HomeControllerTest
Unit tests for the Home module HomeController class.
HomeFacadeTest
Unit tests for the HomeFacade class.
GetTextStatisticsTest
Unit tests for the GetTextStatistics use case.
ExternalParserConfigTest
Tests for the ExternalParserConfig class.
LanguageIdTest
Unit tests for LanguageId value object.
LanguageApiHandlerTest
Unit tests for LanguageApiHandler.
LanguageControllerTest
Tests for LanguageController.
NlpServiceHandlerTest
Tests for NlpServiceHandler.
ExternalParserLoaderTest
Tests for the ExternalParserLoader class.
ExternalParserTest
Tests for the ExternalParser class.
ParserRegistryTest
Tests for the ParserRegistry class.
RegexParserTest
Tests for the RegexParser class.
LanguageFacadeTest
Unit tests for the LanguageFacade class.
GetLanguageByIdTest
Unit tests for the GetLanguageById use case.
ListLanguagesTest
Unit tests for the ListLanguages use case.
ReviewConfigurationTest
Unit tests for ReviewConfiguration value object.
ReviewApiHandlerTest
Unit tests for ReviewApiHandler.
MySqlReviewRepositoryTest
Unit tests for MySqlReviewRepository.
ReviewFacadeTest
Unit tests for the ReviewFacade class.
GetReviewConfigurationTest
Unit tests for the GetReviewConfiguration use case.
GetTomorrowCountTest
Unit tests for the GetTomorrowCount use case.
ReviewSessionUseCaseTest
Unit tests for Review Session use cases.
TagTest
Unit tests for Tag entity.
TagTypeTest
Unit tests for TagType enum.
TagIdTest
Unit tests for TagId value object.
TagsFacadeTest
Unit tests for the TagsFacade class.
CreateTagTest
Unit tests for the CreateTag use case.
DeleteTagTest
Unit tests for the DeleteTag use case.
GetAllTagNamesTest
Unit tests for the GetAllTagNames use case.
GetTagByIdTest
Unit tests for the GetTagById use case.
ListTagsTest
Unit tests for the ListTags use case.
UpdateTagTest
Unit tests for the UpdateTag use case.
TextIdTest
Unit tests for TextId value object.
TextApiHandlerTest
Unit tests for TextApiHandler.
TextControllerTest
Unit tests for TextController.
SentenceServiceTest
Unit tests for the SentenceService class.
TextFacadeTest
Unit tests for the TextFacade class.
ImportTextUseCaseTest
Unit tests for the ImportText use case.
ParseTextUseCaseTest
Unit tests for the ParseText use case.
WordPressAuthServiceTest
Unit tests for the WordPressAuthService class.
UserApiHandlerTest
Unit tests for UserApiHandler.
WordPressControllerTest
Unit tests for the WordPressController class.
AuthFormDataManagerTest
Unit tests for AuthFormDataManager.
CompletePasswordResetTest
Unit tests for the CompletePasswordReset use case.
GenerateApiTokenTest
Unit tests for the GenerateApiToken use case.
LoginTest
Unit tests for the Login use case.
RegisterTest
Unit tests for the Register use case.
RequestPasswordResetTest
Unit tests for the RequestPasswordReset use case.
ValidateApiTokenTest
Unit tests for the ValidateApiToken use case.
TermIdTest
Unit tests for TermId value object.
TermStatusTest
Unit tests for TermStatus value object.
MultiWordApiHandlerTest
Unit tests for MultiWordApiHandler.
TermCrudApiHandlerTest
Unit tests for TermCrudApiHandler.
TermStatusApiHandlerTest
Unit tests for TermStatusApiHandler.
TermTranslationApiHandlerTest
Unit tests for TermTranslationApiHandler.
WordListApiHandlerTest
Unit tests for WordListApiHandler.
DictionaryAdapterTest
Tests for DictionaryAdapter.
DictionaryLemmatizerTest
Unit tests for DictionaryLemmatizer.
HybridLemmatizerTest
Unit tests for HybridLemmatizer.
NlpServiceLemmatizerTest
Unit tests for NlpServiceLemmatizer.
ExportServiceTest
Unit tests for the ExportService class.
ExpressionServiceTest
Tests for ExpressionService.
LemmaServiceTest
Unit tests for LemmaService.
MultiWordServiceTest
Unit tests for the MultiWordService class.
WordBulkServiceTest
Unit tests for the WordBulkService class.
WordContextServiceTest
Unit tests for the WordContextService class.
WordCrudServiceTest
Unit tests for the WordCrudService class.
WordDiscoveryServiceTest
Unit tests for the WordDiscoveryService class.
SimilarityCalculatorTest
Comprehensive tests for SimilarityCalculator.
CreateTermTest
Unit tests for the CreateTerm use case.
DeleteTermTest
Unit tests for the DeleteTerm use case.
FindSimilarTermsTest
Unit tests for the FindSimilarTerms use case.
GetTermByIdTest
Unit tests for the GetTermById use case.
UpdateTermStatusTest
Unit tests for the UpdateTermStatus use case.
UpdateTermTest
Unit tests for the UpdateTerm use case.
VocabularyFacadeTest
Comprehensive tests for VocabularyFacade.
AuthServiceTest
Unit tests for the AuthService class.
AuthServiceWithMocksTest
Tests for AuthService with mocked repository.
FeedServiceTest
Unit tests for the FeedFacade class.
LanguageServiceTest
Unit tests for the LanguageFacade class.
PasswordServiceTest
Unit tests for the PasswordService class.
ReviewServiceTest
Unit tests for the ReviewService class.
SubtitleParserServiceTest
Unit tests for the SubtitleParserService class.
TextDisplayServiceTest
Unit tests for the TextDisplayService class.
TextPrintServiceTest
Unit tests for the TextPrintService class.
TextServiceCrudTest
CRUD tests for the TextFacade class.
TextServiceReadingTest
Unit tests for the TextFacade reading-related methods.
TextServiceTest
Unit tests for the TextFacade class.
TtsServiceTest
Unit tests for the TtsService class.
WordListServiceTest
Unit tests for the WordListService class.
UserIdTest
Unit tests for UserId value object.
EnvLoaderTest
Unit tests for the EnvLoader class.
DatabaseExceptionTest
Tests for the DatabaseException class.
LwtExceptionTest
Tests for the base LwtException class.
ValidationExceptionTest
Tests for the ValidationException class.
FlashMessageServiceTest
Unit tests for FlashMessageService.
AuthMiddlewareTest
Unit tests for the AuthMiddleware class.
RateLimitMiddlewareTest
Test cases for RateLimitMiddleware.
RouterTest
Unit tests for the Router class
RoutesTest
Integration tests for all route definitions
MarkdownConverterTest
CancelledException
Will be thrown in case an operation is cancelled.
CompositeCancellation
CompositeException
CompositeLengthException
DeferredCancellation
A deferred cancellation provides a mechanism to cancel operations dynamically.
DeferredFuture
UnhandledFutureError
Will be thrown to the event loop error handler in case a future exception is not handled.
Future
Interval
This object invokes the given callback within a new coroutine every $interval seconds until either the {@see self::disable()} method is called or the object is destroyed.
NullCancellation
A NullCancellation can be used to avoid conditionals to check whether a cancellation has been provided.
SignalCancellation
A SignalCancellation automatically requests cancellation when a given signal is received.
SignalException
Used as the previous exception to {@see CancelledException} when a {@see SignalCancellation} is triggered.
TimeoutCancellation
A TimeoutCancellation automatically requests cancellation after the timeout has elapsed.
TimeoutException
Used as the previous exception to {@see CancelledException} when a {@see TimeoutCancellation} expires.
AsyncWriter
This class provides a tool for efficiently writing to a stream asynchronously. A single fiber is used for all writes to the stream, while each write returns a {@see Future} instead of waiting for each write to complete before returning control to the caller.
Base64DecodingReadableStream
Base64DecodingWritableStream
Base64EncodingReadableStream
Base64EncodingWritableStream
BufferedReader
BufferException
ClosedException
CompressingReadableStream
Allows compression of input streams using Zlib.
CompressingWritableStream
Allows compression of output streams using Zlib.
DecompressingReadableStream
Allows decompression of input streams using Zlib.
DecompressingWritableStream
Allows decompression of output streams using Zlib.
Payload
Creates a buffered message from a ReadableStream.
PendingReadError
Thrown in case a second read operation is attempted while another read operation is still pending.
Pipe
Create a local stream where data written to the pipe is immediately available on the pipe.
ReadableBuffer
ReadableStream with a single already known data chunk.
ReadableIterableStream
Creates a stream from an iterable emitting strings. If the iterable throws an exception, the exception will be thrown from {@see read()} and {@see buffer()}. Consider wrapping any exceptions in {@see StreamException} if you do not wish for another type of exception to be thrown from the stream.
ReadableResourceStream
Readable stream abstraction for PHP's stream resources.
ReadableStreamChain
StreamChannel
An asynchronous channel for sending data between threads and processes.
StreamException
WritableBuffer
WritableIterableStream
WritableResourceStream
Output stream abstraction for PHP's stream resources.
AtomicCache
CacheException
MUST be thrown in case a cache operation fails.
LocalCache
A cache which stores data in an in-memory (local) array.
NullCache
Cache implementation that just ignores all operations and always resolves to `null`.
PrefixCache
SerializedCache
StringCacheAdapter
BlockingFallbackDnsResolver
DnsConfig
DnsConfigException
MUST be thrown in case the config can't be read and no fallback is available.
DnsException
DnsRecord
DnsTimeoutException
HostLoader
InvalidNameException
MissingDnsRecordException
Rfc1035StubDnsResolver
StaticDnsConfigLoader
UnixDnsConfigLoader
WindowsDnsConfigLoader
ContextException
ContextPanicError
DefaultContextFactory
AbstractContext
ProcessContext
ProcessContextFactory
StatusError
ThreadContext
ThreadContextFactory
LocalIpcHub
SocketIpcHub
ContextWorkerFactory
The built-in worker factory type.
ContextWorkerPool
Provides a pool of workers that can be used to execute multiple tasks asynchronously.
DelegatingWorkerPool
Execution
TaskCancelledException
Will be thrown in case an operation is cancelled.
TaskFailureError
TaskFailureException
WorkerException
InvalidDelimiterError
Parser
DisposedException
Will be thrown from {@see Queue::push()} or used to fail the future returned from {@see Queue::pushAsync()} if the associated iterator is disposed.
Pipeline
A pipeline represents an asynchronous set and provides operations which can be applied over the set.
Queue
Queue is an ordered sequence of values with support for concurrent consumption.
Process
ProcessException
CompressingSerializer
JsonSerializer
NativeSerializer
PassthroughSerializer
SerializationException
BindContext
Certificate
CidrMatcher
ClientTlsContext
ConnectContext
ConnectException
Thrown if connecting fails.
DnsSocketConnector
InternetAddress
PendingAcceptError
Thrown in case a second read operation is attempted while another read operation is still pending.
PendingReceiveError
Thrown in case a second read operation is attempted while another receive operation is still pending.
ResourceServerSocket
ResourceServerSocketFactory
ResourceSocket
ResourceUdpSocket
RetrySocketConnector
ServerTlsContext
SocketException
Socks5SocketConnector
StaticSocketConnector
Connector that connects to a statically defined URI instead of the URI passed to the {@code connect()} call.
TlsException
Thrown if TLS can't be properly negotiated or is not supported on the given socket.
TlsInfo
Exposes a connection's negotiated TLS parameters.
UnixAddress
UnlimitedSocketPool
SocketPool implementation that doesn't impose any limits on concurrent open connections.
Barrier
A barrier is a synchronization primitive.
ChannelException
LocalKeyedMutex
LocalKeyedSemaphore
LocalMutex
LocalParcel
LocalSemaphore
Lock
A handle on an acquired lock from a synchronization object.
ParcelException
PosixSemaphore
A non-blocking, inter-process POSIX semaphore.
PrefixedKeyedMutex
PrefixedKeyedSemaphore
PriorityQueue
Uses a binary tree stored in an array to implement a heap.
RateLimitingSemaphore
When a locked is released from this semaphore, it does not become available to be acquired again until the given lock-period has elapsed. This is useful when a number of operations or requests must be limited to a particular quantity within a certain time period.
SemaphoreMutex
SharedMemoryParcel
A container object for sharing a value across contexts.
StaticKeyMutex
StaticKeySemaphore
SyncException
ComposerAutoloaderInitb8bcad29e8d381a39bdcf735862c2deb
ComposerStaticInitb8bcad29e8d381a39bdcf735862c2deb
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
MatchAllResult
MatchAllStrictGroupsResult
MatchAllWithOffsetsResult
MatchResult
MatchStrictGroupsResult
MatchWithOffsetsResult
PcreException
InvalidRegexPatternRule
Copy of PHPStan's RegularExpressionPatternRule
PregMatchFlags
PregMatchParameterOutTypeExtension
PregMatchTypeSpecifyingExtension
PregReplaceCallbackClosureTypeExtension
UnsafeStrictGroupsCallRule
Preg
Regex
ReplaceResult
UnexpectedNullMatchException
Comparator
CompilingMatcher
Helper class to evaluate constraint by compiling and reusing the code to evaluate
Bound
Constraint
Defines a constraint.
MatchAllConstraint
Defines the absence of a constraint.
MatchNoneConstraint
Blackhole of constraints, nothing escapes it
MultiConstraint
Defines a conjunctive or disjunctive set of constraints.
Interval
Intervals
Helper class generating intervals from constraints
Semver
VersionParser
Version parser.
PhpConfig
Process
Process utility functions
XdebugHandler
Data
DataException
Base runtime exception type thrown by this library
InvalidPathException
Thrown when trying to access an invalid path in the data array
MissingPathException
Thrown when trying to access a path that does not exist
Util
Xdg
Simple implementation of the XDG standard http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
Deprecation
Manages Deprecation logging in different ways.
Dispatcher
Error
ErrorCode
The error codes from and including -32768 to -32000 are reserved for pre-defined errors. Any code within this range, but not defined explicitly below is reserved for future use. The error codes are nearly the same as those suggested for XML-RPC at the following url: http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php The remainder of the space is available for application defined errors.
ErrorResponse
When a rpc call is made, the Server MUST reply with a Response, except for in the case of Notifications. The Response is expressed as a single JSON Object, with the following members:
Message
Base message
Notification
A Notification is a Request object without an "id" member. A Request object that is a Notification signifies the Client's lack of interest in the corresponding Response object, and as such no Response object needs to be returned to the client. The Server MUST NOT reply to a Notification, including those that are within a batch request.
Request
A rpc call is represented by sending a Request object to a Server
Response
When a rpc call is made, the Server MUST reply with a Response, except for in the case of Notifications. The Response is expressed as a single JSON Object, with the following members:
SuccessResponse
When a rpc call is made, the Server MUST reply with a Response, except for in the case of Notifications. The Response is expressed as a single JSON Object, with the following members:
CallHierarchyClientCapabilities
ChangeAnnotation
ClientCapabilities
ClientCapabilitiesGeneral
ClientCapabilitiesWindow
ClientCapabilitiesWorkspace
ClientCapabilitiesWorkspaceFileOperations
ClientInfo
CodeAction
A code action represents a change that can be performed in code, e.g. to fix a problem or to refactor code.
CodeActionClientCapabilities
CodeActionClientCapabilitiesCodeActionLiteralSupport
CodeActionClientCapabilitiesCodeActionLiteralSupportcodeActionKind
CodeActionClientCapabilitiesResolveSupport
CodeActionContext
Contains additional diagnostic information about the context in which a code action is run.
CodeActionDisabled
CodeActionKind
A set of predefined code action kinds.
CodeActionTriggerKind
A set of predefined code action kinds.
CodeDescription
Structure to capture a description for an error code.
CodeLens
A code lens represents a command that should be shown along with source text, like the number of references, a way to run tests, etc.
CodeLensClientCapabilities
CodeLensOptions
Code Lens options.
CodeLensWorkspaceClientCapabilities
Command
Represents a reference to a command. Provides a title which will be used to represent a command in the UI and, optionally, an array of arguments which will be passed to the command handler function when invoked.
CompletionClientCapabilities
CompletionClientCapabilitiesCompletionItem
CompletionClientCapabilitiesCompletionItemInsertTextModeSupport
CompletionClientCapabilitiesCompletionItemResolveSupport
CompletionClientCapabilitiesCompletionItemTagSupport
CompletionClientCapabilitiesCompletionList
CompletionContext
Contains additional information about the context in which a completion request is triggered.
CompletionItem
CompletionItemKind
The kind of a completion entry.
CompletionItemLabelDetails
Additional details for a completion item label.
CompletionItemTag
CompletionList
Represents a collection of completion items to be presented in the editor.
CompletionOptions
Completion options.
CompletionTriggerKind
ContentChangeEvent
An event describing a change to a text document. If range and rangeLength are omitted the new text is considered to be the full content of the document.
DeclarationClientCapabilities
DefinitionClientCapabilities
DependencyReference
Diagnostic
Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.
DiagnosticRelatedInformation
Represents a related message and source code location for a diagnostic.
DiagnosticSeverity
DiagnosticTag
How whitespace and indentation is handled during completion item insertion.
DidChangeConfigurationClientCapabilities
DidChangeWatchedFilesClientCapabilities
DocumentColorClientCapabilities
DocumentFormattingClientCapabilities
DocumentHighlight
A document highlight is a range inside a text document which deserves special attention. Usually a document highlight is visualized by changing the background color of its range.
DocumentHighlightClientCapabilities
DocumentHighlightKind
A document highlight kind.
DocumentLinkClientCapabilities
DocumentOnTypeFormattingClientCapabilities
DocumentOnTypeFormattingOptions
Format document on type options
DocumentRangeFormattingClientCapabilities
DocumentSymbolClientCapabilities
DocumentSymbolClientCapabilitiesSymbolKind
Specific capabilities for the `SymbolKind` in the `textDocument/documentSymbol` request.
DocumentSymbolClientCapabilitiesTagSupport
ErrorCode
Enum
ExecuteCommandClientCapabilities
ExecuteCommandOptions
FailureHandlingKind
Defines how the host (editor) should sync document changes to the language server.
FileChangeType
The file event type. Enum
FileEvent
An event describing a file change.
FoldingRangeClientCapabilities
FormattingOptions
Value-object describing what options formatting should use.
Hover
The result of a hover request.
HoverClientCapabilities
ImplementationClientCapabilities
InitializeResult
InitializeResultServerInfo
InsertTextFormat
Defines whether the insert text in a completion item should be interpreted as plain text or a snippet.
InsertTextMode
How whitespace and indentation is handled during completion item insertion.
LinkedEditingRangeClientCapabilities
Location
Represents a location inside a resource, such as a line inside a text file.
LogMessage
The log message notification is sent from the server to the client to ask the client to log a particular message.
LogTrace
A notification to log the trace of the server’s execution.
MarkdownClientCapabilities
MarkedString
MarkupContent
A `MarkupContent` literal represents a string value which content is interpreted base on its kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
MarkupKind
Describes the content type that a client supports in various result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
MessageActionItem
MessageType
Enum
MonikerClientCapabilities
PackageDescriptor
Uniquely identifies a Composer package
ParameterInformation
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
Position
Position in a text document expressed as zero-based line and character offset.
PrepareSupportDefaultBehavior
PublishDiagnosticsClientCapabilities
PublishDiagnosticsClientCapabilitiesTagSupport
Range
A range in a text document expressed as (zero-based) start and end positions.
ReferenceClientCapabilities
ReferenceContext
ReferenceInformation
Metadata about the symbol that can be used to identify or locate its definition.
RegularExpressionsClientCapabilities
RenameClientCapabilities
ResourceOperationKind
Defines how the host (editor) should sync document changes to the language server.
SaveOptions
Options controlling what is sent to the server with save notifications.
SelectionRangeClientCapabilities
SemanticTokensClientCapabilities
SemanticTokensClientCapabilitiesRequests
SemanticTokensWorkspaceClientCapabilities
ServerCapabilities
ShowDocumentClientCapabilities
ShowMessageRequestClientCapabilities
ShowMessageRequestClientCapabilitiesMessageActionItem
SignatureHelp
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
SignatureHelpClientCapabilities
SignatureHelpClientCapabilitiesSignatureInformation
SignatureHelpClientCapabilitiesSignatureInformationParameterInformation
Client capabilities specific to parameter information.
SignatureHelpOptions
Signature help options.
SignatureInformation
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
SymbolDescriptor
Uniquely identifies a symbol
SymbolInformation
Represents information about programming constructs like variables, classes, interfaces etc.
SymbolKind
A symbol kind.
SymbolLocationInformation
SymbolTag
Symbol tags are extra annotations that tweak the rendering of a symbol.
TextDocumentClientCapabilities
TextDocumentContentChangeEvent
An event describing a change to a text document. If range and rangeLength are omitted the new text is considered to be the full content of the document.
TextDocumentIdentifier
TextDocumentItem
An item to transfer a text document from the client to the server.
TextDocumentSyncClientCapabilities
TextDocumentSyncKind
Defines how the host (editor) should sync document changes to the language server.
TextDocumentSyncOptions
A detailed structure defining expected notifications from the client of changes to text documents.
TextEdit
A textual edit applicable to a text document.
TokenFormat
TypeDefinitionClientCapabilities
VersionedTextDocumentIdentifier
WorkspaceEdit
A workspace edit represents changes to many resources managed in the workspace.
WorkspaceEditClientCapabilities
WorkspaceEditClientCapabilitiesChangeAnnotationSupport
WorkspaceFolder
WorkspaceSymbolClientCapabilities
WorkspaceSymbolClientCapabilitiesResolveSupport
WorkspaceSymbolClientCapabilitiesSymbolKind
WorkspaceSymbolClientCapabilitiesTagSupport
CpuCoreCounter
Diagnoser
Utility to debug.
ProcOpenExecutor
_NProcessorFinder
Find the number of logical CPU cores for Linux and the likes.
CmiCmdletLogicalFinder
Find the number of logical CPU cores for Windows leveraging the Get-CimInstance cmdlet, which is a newer version that is recommended over Get-WmiObject.
CmiCmdletPhysicalFinder
Find the number of physical CPU cores for Windows.
CpuInfoFinder
Find the number of CPU cores looking up at the cpuinfo file which is available on Linux systems and Windows systems with a Linux sub-system.
DummyCpuCoreFinder
This finder returns whatever value you gave to it. This is useful for testing or as a fallback to avoid to catch the NumberOfCpuCoreNotFound exception.
EnvVariableFinder
FinderRegistry
HwLogicalFinder
Find the number of logical CPU cores for Linux, BSD and OSX.
HwPhysicalFinder
Find the number of physical CPU cores for Linux, BSD and OSX.
LscpuLogicalFinder
The number of logical cores.
LscpuPhysicalFinder
The number of physical processors.
NProcessorFinder
Find the number of logical CPU cores for FreeSBD, Solaris and the likes.
NProcFinder
The number of (logical) cores.
NullCpuCoreFinder
This finder returns whatever value you gave to it. This is useful for testing.
OnlyInPowerShellFinder
OnlyOnOSFamilyFinder
ProcOpenBasedFinder
SkipOnOSFamilyFinder
WindowsRegistryLogicalFinder
Find the number of logical CPU cores for Windows.
WmicLogicalFinder
Find the number of logical CPU cores for Windows.
WmicPhysicalFinder
Find the number of physical CPU cores for Windows.
NumberOfCpuCoreNotFound
ParallelisationResult
BeforeValidException
CachedKeySet
ExpiredException
Key
SignatureInvalidException
BodySummarizer
Client
CookieJar
Cookie jar that stores cookies as an array
FileCookieJar
Persists non-session cookies using a JSON formatted file
SessionCookieJar
Persists cookies in the client session
SetCookie
Set-Cookie object
BadResponseException
Exception when an HTTP error occurs (4xx or 5xx error)
ClientException
Exception when a client error is encountered (4xx codes)
ConnectException
Exception thrown when a connection cannot be established.
InvalidArgumentException
RequestException
HTTP Request exception
ServerException
Exception when a server error is encountered (5xx codes)
TooManyRedirectsException
HTTP Request exception
TransferException
CurlFactory
Creates curl resources from a request
CurlHandler
HTTP handler that uses cURL easy handles as a transport layer.
CurlMultiHandler
Returns an asynchronous response using curl_multi_* functions.
MockHandler
Handler that returns responses or throw exceptions from a queue.
Proxy
Provides basic proxies for handlers.
StreamHandler
HTTP handler that uses PHP's HTTP stream wrapper.
HandlerStack
Creates a composed Guzzle handler function by stacking middlewares on top of an HTTP handler function.
MessageFormatter
Formats log messages using variable substitutions for requests, responses, and other transactional data.
Middleware
Functions used to create and wrap handlers with handler middleware.
Pool
Sends an iterator of requests concurrently using a capped pool size.
PrepareBodyMiddleware
Prepares requests that contain a body, adding the Content-Length, Content-Type, and Expect headers.
RedirectMiddleware
Request redirect middleware.
RequestOptions
This class contains a list of built-in Guzzle request options.
RetryMiddleware
Middleware that retries requests based on the boolean result of invoking the provided "decider" function.
TransferStats
Represents data at the point after it was transferred either successfully or after a network error.
Utils
AggregateException
Exception thrown when too many errors occur in the some() or any() methods.
CancellationException
Exception that is set as the reason for a promise that has been cancelled.
Coroutine
Creates a promise that is resolved using a generator that yields values or promises (somewhat similar to C#'s async keyword).
Create
Each
EachPromise
Represents a promise that iterates over many promises and invokes side-effect functions in the process.
FulfilledPromise
A promise that has been fulfilled.
Is
Promise
Promises/A+ implementation that avoids recursion when possible.
RejectedPromise
A promise that has been rejected.
RejectionException
A special exception that is thrown when waiting on a rejected promise.
TaskQueue
A task queue that executes tasks in a FIFO order.
Utils
AppendStream
Reads from multiple streams, one after the other.
BufferStream
Provides a buffer stream that can be written to to fill a buffer, and read from to remove bytes from the buffer.
CachingStream
Stream decorator that can cache previously read bytes from a sequentially read stream.
DroppingStream
Stream decorator that begins dropping data once the size of the underlying stream becomes too full.
MalformedUriException
Exception thrown if a URI cannot be parsed because it's malformed.
FnStream
Compose stream implementations based on a hash of functions.
Header
HttpFactory
Implements all of the PSR-17 interfaces.
InflateStream
Uses PHP's zlib.inflate filter to inflate zlib (HTTP deflate, RFC1950) or gzipped (RFC1952) content.
LazyOpenStream
Lazily reads or writes to a file that is opened only after an IO operation take place on the stream.
LimitStream
Decorator used to return only a subset of a stream.
Message
MimeType
MultipartStream
Stream that when read returns bytes for a streaming multipart or multipart/form-data stream.
NoSeekStream
Stream decorator that prevents a stream from being seeked.
PumpStream
Provides a read only stream that pumps data from a PHP callable.
Query
Request
PSR-7 request implementation.
Response
PSR-7 response implementation.
ServerRequest
Server-side HTTP request
Stream
PHP stream implementation.
StreamWrapper
Converts Guzzle streams into PHP stream resources.
UploadedFile
Uri
PSR-7 URI implementation.
UriComparator
Provides methods to determine if a modified URL should be considered cross-origin.
UriNormalizer
Provides methods to normalize and compare URIs.
UriResolver
Resolves a URI reference in the context of a base URI and the opposite way.
Utils
Certificate
FieldNotSupportedException
InvalidCertificateException
Profile
Archive
ArchiveTemporaryDirectory
ArchiveZipCreate
ArchiveFile
ArchiveItem
ArchiveStat
PdfMeta
SevenZipProcess
ArchivePdf
ArchivePhar
ArchiveRar
ArchiveSevenZip
ArchiveZip
BaseArchive
EbookCreator
Ebook
EbookCover
AudiobookModule
CbaModule
CbamTemplate
CbaTemplate
DjvuModule
DjvuParser
EbookModule
EbookParser
EpubModule
EpubChapter
Merge `.ncx` and `.html` files to create chapters.
EpubContainer
Transform `container.xml` file to an object.
EpubHtml
Read `.html` file from `.epub` archive to extract content.
NcxItem
Transform `.ncx` file to an object.
NcxItemHead
NcxItemNavPoint
OpfItem
Transform `.opf` file to an object.
Fb2Module
Fb2Parser
Fb2MetaDescription
Fb2MetaDescriptionTitle
Fb2MetaDescriptionDocument
Fb2MetaDescriptionPublish
Fb2MetaBinaryItem
Fb2MetaAuthor
Fb2MetaSequence
Fb2MetaCoverpage
MobiModule
MobiImages
MobiParser
Inspired by https://stackoverflow.com/a/15199117/11008206
PalmDOCHeader
PalmRecord
MobiHeader
ExthHeader
ExthRecord
MobiReader
PdfModule
BookAuthor
BookContributor
BookDescription
Advanced book description.
BookIdentifier
BookMeta
ComicMeta
MetaTitle
Convert eBook title and metadata to a slug.
EbookUtils
Stream
XmlConverter
XmlReader
Convert XML string.
XmlValidator
CommonMarkConverter
Converts CommonMark-compatible Markdown to HTML.
Bracket
Delimiter
DelimiterStack
DelimiterProcessorCollection
Environment
AbstractEvent
Base class for classes containing event data.
DocumentParsedEvent
Event dispatched when the document has been fully parsed
DocumentPreParsedEvent
Event dispatched when the document is about to be parsed
DocumentPreRenderEvent
Event dispatched just before rendering begins
DocumentRenderedEvent
Base class for classes containing event data.
AlreadyInitializedException
InvalidArgumentException
IOException
LogicException
MissingDependencyException
UnexpectedEncodingException
AttributesExtension
AttributesListener
Attributes
Block-level element
AttributesInline
AttributesBlockContinueParser
Base class for a block parser
AttributesBlockStartParser
AttributesInlineParser
AutolinkExtension
EmailAutolinkParser
UrlAutolinkParser
CommonMarkCoreExtension
EmphasisDelimiterProcessor
BlockQuote
Block-level element
FencedCode
Block-level element
Heading
Block-level element
HtmlBlock
Block-level element
IndentedCode
Block-level element
ListBlock
Block-level element
ListData
ListItem
Block-level element
ThematicBreak
Block-level element
AbstractWebResource
Code
Emphasis
HtmlInline
Image
Link
Strong
BlockQuoteParser
Base class for a block parser
BlockQuoteStartParser
FencedCodeParser
Base class for a block parser
FencedCodeStartParser
HeadingParser
Base class for a block parser
HeadingStartParser
HtmlBlockParser
Base class for a block parser
HtmlBlockStartParser
IndentedCodeParser
Base class for a block parser
IndentedCodeStartParser
ListBlockParser
Base class for a block parser
ListBlockStartParser
ListItemParser
Base class for a block parser
ThematicBreakParser
Base class for a block parser
ThematicBreakStartParser
AutolinkParser
BacktickParser
BangParser
CloseBracketParser
EntityParser
EscapableParser
HtmlInlineParser
OpenBracketParser
BlockQuoteRenderer
FencedCodeRenderer
HeadingRenderer
HtmlBlockRenderer
IndentedCodeRenderer
ListBlockRenderer
ListItemRenderer
ThematicBreakRenderer
CodeRenderer
EmphasisRenderer
HtmlInlineRenderer
ImageRenderer
LinkRenderer
StrongRenderer
ApplyDefaultAttributesProcessor
DefaultAttributesExtension
DescriptionListExtension
ConsecutiveDescriptionListMerger
LooseDescriptionHandler
Description
Block-level element
DescriptionList
Block-level element
DescriptionTerm
Block-level element
DescriptionContinueParser
Base class for a block parser
DescriptionListContinueParser
Base class for a block parser
DescriptionStartParser
DescriptionTermContinueParser
Base class for a block parser
DescriptionListRenderer
DescriptionRenderer
DescriptionTermRenderer
DisallowedRawHtmlExtension
DisallowedRawHtmlRenderer
OscaroteroEmbedAdapter
DomainFilteringAdapter
Embed
Block-level element
EmbedExtension
EmbedParser
EmbedProcessor
EmbedRenderer
EmbedStartParser
ExternalLinkExtension
ExternalLinkProcessor
AnonymousFootnotesListener
FixOrphanedFootnotesAndRefsListener
GatherFootnotesListener
NumberFootnotesListener
FootnoteExtension
Footnote
Block-level element
FootnoteBackref
Link from the footnote on the bottom of the document back to the reference
FootnoteContainer
Block-level element
FootnoteRef
AnonymousFootnoteRefParser
FootnoteParser
Base class for a block parser
FootnoteRefParser
FootnoteStartParser
FootnoteBackrefRenderer
FootnoteContainerRenderer
FootnoteRefRenderer
FootnoteRenderer
LibYamlFrontMatterParser
SymfonyYamlFrontMatterParser
InvalidFrontMatterException
FrontMatterExtension
FrontMatterParser
MarkdownInputWithFrontMatter
FrontMatterPostRenderListener
FrontMatterPreParser
RenderedContentWithFrontMatter
GithubFlavoredMarkdownExtension
HeadingPermalink
Represents an anchor link within a heading
HeadingPermalinkExtension
Extension which automatically anchor links to heading elements
HeadingPermalinkProcessor
Searches the Document for Heading elements and adds HeadingPermalinks to each one
HeadingPermalinkRenderer
Renders the HeadingPermalink elements
ChildRenderer
Simply renders child elements as-is, adding newlines as needed.
InlinesOnlyExtension
CallbackGenerator
StringTemplateLinkGenerator
Mention
MentionExtension
MentionParser
DashParser
EllipsesParser
Quote
QuoteParser
QuoteProcessor
ReplaceUnpairedQuotesListener
Identifies any lingering Quote nodes that were missing pairs and converts them into Text nodes
SmartPunctExtension
Strikethrough
StrikethroughDelimiterProcessor
StrikethroughExtension
StrikethroughRenderer
Table
Block-level element
TableCell
Block-level element
TableCellRenderer
TableExtension
TableParser
Base class for a block parser
TableRenderer
TableRow
Block-level element
TableRowRenderer
TableSection
Block-level element
TableSectionRenderer
TableStartParser
TableOfContents
Block-level element
TableOfContentsPlaceholder
Block-level element
AsIsNormalizerStrategy
FlatNormalizerStrategy
RelativeNormalizerStrategy
TableOfContentsBuilder
TableOfContentsExtension
TableOfContentsGenerator
TableOfContentsPlaceholderParser
Base class for a block parser
TableOfContentsPlaceholderRenderer
TableOfContentsRenderer
TaskListExtension
TaskListItemMarker
TaskListItemMarkerParser
TaskListItemMarkerRenderer
GithubFlavoredMarkdownConverter
Converts GitHub Flavored Markdown to HTML.
MarkdownInput
MarkdownConverter
AbstractBlock
Block-level element
Document
Block-level element
Paragraph
Block-level element
AbstractInline
AbstractStringContainer
Newline
Text
Node
NodeIterator
NodeWalker
NodeWalkerEvent
Query
StringContainerHelper
SlugNormalizer
Creates URL-friendly strings based on the given string input
TextNormalizer
UniqueSlugNormalizer
RenderedContent
AbstractBlockContinueParser
Base class for a block parser
BlockContinue
Result object for continuing parsing of a block; see static methods for constructors.
BlockStart
Result object for starting parsing of a block; see static methods for constructors
DocumentBlockParser
Parser implementation which ensures everything is added to the root-level Document
ParagraphParser
Base class for a block parser
Cursor
InlineParserMatch
NewlineParser
InlineParserContext
MarkdownParser
ParserLogicException
MemoryLimitedReferenceMap
Reference
ReferenceMap
A collection of references, indexed by label
ReferenceParser
DocumentRenderer
ParagraphRenderer
HtmlDecorator
HtmlRenderer
NewlineRenderer
TextRenderer
NoMatchingRendererException
Html5EntityDecoder
HtmlElement
HtmlFilter
LinkParserHelper
RegexHelper
Provides regular expressions and utilities for parsing Markdown
SpecReader
Reads in a CommonMark spec document and extracts the input/output examples for testing against them
UrlEncoder
Xml
Utility class for handling/generating XML and HTML
MarkdownToXmlConverter
XmlRenderer
Configuration
InvalidConfigurationException
UnknownOptionException
ValidationException
ReadOnlyConfiguration
Provides read-only access to a given Configuration object
AbstractGrant
Represents a type of authorization grant.
AuthorizationCode
Represents an authorization code grant.
ClientCredentials
Represents a client credentials grant.
InvalidGrantException
Exception thrown if the grant does not extend from AbstractGrant.
GrantFactory
Represents a factory used when retrieving an authorization grant type.
Password
Represents a resource owner password credentials grant.
RefreshToken
Represents a refresh token grant.
HttpBasicAuthOptionProvider
Add http basic auth into access token request options
PostAuthOptionProvider
Provide options for access token
AbstractProvider
Represents a service provider (authorization server).
IdentityProviderException
Exception thrown if the provider response contains errors.
GenericProvider
Represents a generic service provider that may be used to interact with any OAuth 2.0 service provider, using Bearer token authentication.
GenericResourceOwner
Represents a generic resource owner for use with the GenericProvider.
AccessToken
Represents an access token.
RequestFactory
Used to produce PSR-7 Request instances.
HostedDomainException
Exception thrown if the Google Provider is configured with a hosted domain that the user doesn't belong to
Google
Represents a service provider (authorization server).
GoogleUser
BaseUri
Http
HttpFactory
Uri
UriInfo
UriResolver
TemplateCanNotBeExpanded
Urn
Encoder
ConversionFailed
MissingFeature
OffsetOutOfBounds
SyntaxError
FeatureDetection
Allow detecting features needed to make the packages work.
HostRecord
Converter
Option
Result
BCMathCalculator
Converter
GMPCalculator
NativeCalculator
Converter
Converter
QueryString
A class to parse the URI query string.
DeepCopy
CloneException
PropertyException
ChainableFilter
Defines a decorator filter that will not stop the chain of filters.
DoctrineCollectionFilter
DoctrineEmptyCollectionFilter
DoctrineProxyFilter
KeepFilter
ReplaceFilter
SetNullFilter
DoctrineProxyMatcher
PropertyMatcher
PropertyNameMatcher
PropertyTypeMatcher
Matches a property by its type.
ReflectionHelper
DateIntervalFilter
DatePeriodFilter
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
Context
AnyOf
Structure
Type
Expect
Schema generator.
Message
Processor
Schema validator.
ValidationException
Validation error.
ArgumentOutOfRangeException
The value is outside the allowed range.
InvalidStateException
The object is in a state that does not allow the requested operation.
NotImplementedException
The requested feature is not implemented.
NotSupportedException
The requested operation is not supported.
DeprecatedException
The requested feature is deprecated and no longer available.
MemberAccessException
Cannot access the requested class property or method.
IOException
Failed to read from or write to a file or stream.
FileNotFoundException
The requested file does not exist.
DirectoryNotFoundException
The requested directory does not exist.
InvalidArgumentException
The provided argument has invalid type or format.
OutOfRangeException
The requested array or collection index does not exist.
UnexpectedValueException
The returned value has unexpected type or format.
ShouldNotHappenException
Houston, we have a problem.
CachingIterator
Smarter caching iterator.
Mapper
ArrayHash
Provides objects to work as array.
ArrayList
Provides the base class for a generic list (items can be accessed by index).
Arrays
Array tools library.
Callback
PHP callable tools.
DateTime
DateTime.
ImageException
An error occurred while working with the image.
UnknownImageFileException
The image file is invalid or in an unsupported format.
JsonException
JSON encoding or decoding failed.
RegexpException
Regular expression pattern or execution failed.
AssertionException
Type validation failed. The value doesn't match the expected type constraints.
FileSystem
File system tool.
Finder
Finder allows searching through directory trees using iterator.
Floats
Floating-point numbers comparison.
Helpers
Html
HTML helper.
Image
Basic manipulation with images. Supported types are JPEG, PNG, GIF, WEBP, AVIF and BMP.
ImageColor
Represent RGB color (0..255) with opacity (0..1).
ImageType
Type of image file.
Iterables
Utilities for iterables.
Json
JSON encoder and decoder.
Paginator
Paginating math.
Random
Secure random string generator.
Reflection
PHP reflection helpers.
Strings
String tools library.
Type
PHP type reflection.
Validators
Validation utilities.
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
AsymmetricVisibilityTokenEmulator
AttributeEmulator
EnumTokenEmulator
ExplicitOctalEmulator
KeywordEmulator
MatchTokenEmulator
NullsafeTokenEmulator
PipeOperatorEmulator
PropertyTokenEmulator
ReadonlyFunctionTokenEmulator
ReadonlyTokenEmulator
ReverseEmulator
Reverses emulation direction of the inner emulator.
VoidCastEmulator
Lexer
Modifiers
Modifiers used (as a bit mask) by various flags subnodes, for example on classes, functions, properties and constants.
NameContext
Arg
ArrayItem
Attribute
AttributeGroup
ClosureUse
ComplexType
This is a base class for complex types, including nullable types and union types.
Const_
DeclareItem
Array_
ArrayDimFetch
ArrayItem
For classmap-authoritative support.
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
Pipe
Plus
Pow
ShiftLeft
ShiftRight
Smaller
SmallerOrEqual
Spaceship
BinaryOp
BitwiseNot
BooleanNot
CallLike
Array_
Bool_
Double
Int_
Object_
String_
Unset_
Void_
Cast
ClassConstFetch
Clone_
Closure
ClosureUse
For classmap-authoritative support.
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.
InterpolatedStringPart
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
PropertyHook
PropertyItem
DNumber
For classmap-authoritative support.
Encapsed
For classmap-authoritative support.
EncapsedStringPart
For classmap-authoritative support.
Float_
Int_
InterpolatedString
LNumber
For classmap-authoritative support.
Class_
Dir
File
Function_
Line
Method
Namespace_
Property
Trait_
MagicConst
String_
Scalar
StaticVar
Block
Break_
Case_
Catch_
Class_
ClassConst
ClassLike
ClassMethod
Const_
Continue_
Declare_
DeclareDeclare
For classmap-authoritative support.
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
For classmap-authoritative support.
Return_
Static_
StaticVar
For classmap-authoritative support.
Switch_
Trait_
TraitUse
Alias
Precedence
TraitUseAdaptation
TryCatch
Unset_
Use_
UseUse
For classmap-authoritative support.
While_
Stmt
UnionType
This is a base class for complex types, including nullable types and union types.
UseItem
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.
CommentAnnotatingVisitor
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
Php7
Php8
ParserAbstract
ParserFactory
PhpVersion
A PHP version, representing only the major and minor version components.
Standard
PrettyPrinterAbstract
Token
A PHP token. On PHP 8.0 this extends from PhpToken.
Config
FileNotFound
InvalidPackageName
InvalidXML
Loader
Mapper
ValidationFailed
ConfiguredMediator
File
FileList
KeyDirectory
KeyNotFound
NoSemanticVersioning
OperationPackage
PackageVersion
PluginBase
SemanticVersion
Download
GpgError
Installer
KeyError
Verify
VersionConstraintReplacer
SomebodyElsesProblem
Url
InstallationTest
LoaderTest
MapperTest
GnuPG
SemanticVersionTest
DownloadTest
VerifyTest
PhpdocSingleLineVarFixer
Main implementation taken from kubawerlos/php-cs-fixer-customere-fixers Copyright (c) 2018 Kuba Werłos
Executor
Exception
ExecutorResult
Directory
DirectoryException
Exception
File
Filename
FilenameException
LastModifiedDate
DirectoryTest
FilenameTest
FileTest
LastModifiedDateTest
ErrorStrings
Exception
Factory
GnuPG
This is a (thin) wrapper around the gnupg binary, mimicking the pecl/gnupg api Currently, only the methods required by phive (import, info, geterror and verify) are implemented
GnuPGTest
PhpdocSingleLineVarFixer
Main implementation taken from kubawerlos/php-cs-fixer-customere-fixers Copyright (c) 2018 Kuba Werłos
ElementCollectionException
InvalidApplicationNameException
InvalidEmailException
InvalidUrlException
ManifestDocumentException
ManifestDocumentLoadingException
ManifestDocumentMapperException
ManifestElementException
ManifestLoaderException
NoEmailAddressException
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
PhpdocSingleLineVarFixer
Main implementation taken from kubawerlos/php-cs-fixer-customere-fixers Copyright (c) 2018 Kuba Werłos
BuildMetaData
AbstractVersionConstraint
AndVersionConstraintGroup
AnyVersionConstraint
ExactVersionConstraint
GreaterThanOrEqualToVersionConstraint
OrVersionConstraintGroup
SpecificMajorAndMinorVersionConstraint
SpecificMajorVersionConstraint
InvalidPreReleaseSuffixException
InvalidVersionException
NoBuildMetaDataException
NoPreReleaseSuffixException
UnsupportedVersionConstraintException
PreReleaseSuffix
Version
VersionConstraintParser
VersionConstraintValue
VersionNumber
Fqsen
Value Object for Fqsen.
Location
The location where an element occurs within a file.
Description
Object representing to description for a DocBlock.
DescriptionFactory
Creates a new Description object given a body of text.
ExampleFinder
Class used to find an example file's location based on a given ExampleDescriptor.
Serializer
Converts a DocBlock back from an object to a complete DocComment including Asterisks.
StandardTagFactory
Creates a Tag object given the contents of a tag.
Author
Reflection class for an {@}author tag in a Docblock.
BaseTag
Parses a tag definition for a DocBlock.
Covers
Reflection class for a @covers tag in a Docblock.
Deprecated
Reflection class for a {@}deprecated tag in a Docblock.
Example
Reflection class for a {@}example tag in a Docblock.
Extends_
Reflection class for a {@}extends tag in a Docblock.
AlignFormatter
PassthroughFormatter
Generic
Parses a tag definition for a DocBlock.
Implements_
Reflection class for a {@}implements tag in 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.
MethodParameter
Mixin
Reflection class for a {@}mixin tag 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.
Template
Reflection class for a {@}template tag in a Docblock.
TemplateCovariant
Reflection class for a {@}template-covariant tag in a Docblock.
TemplateExtends
Reflection class for a {@}template-extends tag in a Docblock.
TemplateImplements
Reflection class for a {@}template-implements tag in 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
Plugin
FqsenResolver
Resolver for Fqsen using Context information
ArrayShape
ArrayShapeItem
CallableString
Value Object representing the type 'string'.
Conditional
Value Object representing the conditional type.
ConditionalForParameter
Value Object representing the conditional type for parameter.
ConstExpression
False_
Value Object representing the PseudoType 'False', which is a Boolean type.
FloatValue
HtmlEscapedString
Value Object representing the type 'string'.
IntegerRange
Value Object representing the type 'int'.
IntegerValue
IntMask
Value Object representing the `int-mask` type.
IntMaskOf
Value Object representing the `int-mask-of` type.
KeyOf
Value Object representing the `key-of` type.
List_
Value Object representing the type 'list'.
ListShape
ListShapeItem
LiteralString
Value Object representing the type 'string'.
LowercaseString
Value Object representing the type 'string'.
NegativeInteger
Value Object representing the type 'int'.
NonEmptyArray
Value Object representing the type 'non-empty-array'.
NonEmptyList
Value Object representing the type 'non-empty-list'.
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'.
ObjectShape
ObjectShapeItem
OffsetAccess
Value Object representing the offset access type.
PositiveInteger
Value Object representing the type 'int'.
ShapeItem
StringValue
TraitString
Value Object representing the type 'string'.
True_
Value Object representing the PseudoType 'False', which is a Boolean type.
ValueOf
Value Object representing the `value-of` 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.
CallableParameter
Value Object representing a Callable parameters.
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'.
DSNConfigurator
Configure PHPMailer with DSN string.
Exception
PHPMailer exception handler.
OAuth
OAuth - OAuth2 authentication wrapper class.
PHPMailer
PHPMailer - PHP email creation and transport class.
POP3
PHPMailer POP-Before-SMTP Authentication Class.
SMTP
PHPMailer RFC821 SMTP email transport class.
AbstractNodeVisitor
Inspired by https://github.com/nikic/PHP-Parser/tree/36a6dcd04e7b0285e8f0868f44bd4927802f7df1
Attribute
Comment
ConstExprArrayItemNode
ConstExprArrayNode
ConstExprFalseNode
ConstExprFloatNode
ConstExprIntegerNode
ConstExprNullNode
ConstExprStringNode
ConstExprTrueNode
ConstFetchNode
DoctrineConstExprStringNode
NodeTraverser
Inspired by https://github.com/nikic/PHP-Parser/tree/36a6dcd04e7b0285e8f0868f44bd4927802f7df1
CloningVisitor
Inspired by https://github.com/nikic/PHP-Parser/tree/36a6dcd04e7b0285e8f0868f44bd4927802f7df1
AssertTagMethodValueNode
AssertTagPropertyValueNode
AssertTagValueNode
DeprecatedTagValueNode
DoctrineAnnotation
DoctrineArgument
DoctrineArray
DoctrineArrayItem
DoctrineTagValueNode
ExtendsTagValueNode
GenericTagValueNode
ImplementsTagValueNode
InvalidTagValueNode
MethodTagValueNode
MethodTagValueParameterNode
MixinTagValueNode
ParamClosureThisTagValueNode
ParamImmediatelyInvokedCallableTagValueNode
ParamLaterInvokedCallableTagValueNode
ParamOutTagValueNode
ParamTagValueNode
PhpDocNode
PhpDocTagNode
PhpDocTextNode
PropertyTagValueNode
PureUnlessCallableIsImpureTagValueNode
RequireExtendsTagValueNode
RequireImplementsTagValueNode
ReturnTagValueNode
SealedTagValueNode
SelfOutTagValueNode
TemplateTagValueNode
ThrowsTagValueNode
TypeAliasImportTagValueNode
TypeAliasTagValueNode
TypelessParamTagValueNode
UsesTagValueNode
VarTagValueNode
ArrayShapeItemNode
ArrayShapeNode
ArrayShapeUnsealedTypeNode
ArrayTypeNode
CallableTypeNode
CallableTypeParameterNode
ConditionalTypeForParameterNode
ConditionalTypeNode
ConstTypeNode
GenericTypeNode
IdentifierTypeNode
IntersectionTypeNode
InvalidTypeNode
NullableTypeNode
ObjectShapeItemNode
ObjectShapeNode
OffsetAccessTypeNode
ThisTypeNode
UnionTypeNode
Lexer
Implementation based on Nette Tokenizer (New BSD License; https://github.com/nette/tokenizer)
ConstExprParser
ParserException
PhpDocParser
StringUnescaper
TokenIterator
TypeParser
ParserConfig
Printer
Inspired by https://github.com/nikic/PHP-Parser/tree/36a6dcd04e7b0285e8f0868f44bd4927802f7df1
CodeCoverage
Provides collection functionality for PHP code coverage information.
Selector
BranchAndPathCoverageNotSupportedException
DeadCodeDetectionNotSupportedException
DirectoryCouldNotBeCreatedException
FileCouldNotBeWrittenException
InvalidArgumentException
NoCodeCoverageDriverAvailableException
NoCodeCoverageDriverWithPathCoverageSupportAvailableException
ParserException
PathExistsButIsNotDirectoryException
PcovNotAvailableException
ReflectionException
ReportAlreadyFinalizedException
StaticAnalysisCacheNotConfiguredException
TestIdMissingException
UnintentionallyCoveredCodeException
WriteOperationFailedException
XdebugNotAvailableException
XdebugNotEnabledException
XmlException
Filter
Clover
Cobertura
Crap4j
Colors
CustomCssFile
Facade
PHP
Text
Thresholds
Facade
CacheWarmer
Known
Large
Medium
Small
TestSize
Unknown
Failure
Known
Success
TestStatus
Unknown
Version
Facade
ProcessControlExtensionNotLoadedException
TimeoutException
Invoker
InvalidArgumentException
RuntimeException
Template
Duration
NoActiveTimerException
TimeSinceStartOfRequestNotAvailableException
ResourceUsageFormatter
Timer
Finished
Started
EventCollection
EventCollectionIterator
AssertionFailed
AssertionSucceeded
ComparatorRegistered
AfterLastTestMethodCalled
AfterLastTestMethodErrored
AfterLastTestMethodFinished
AfterTestMethodCalled
AfterTestMethodErrored
AfterTestMethodFinished
BeforeFirstTestMethodCalled
BeforeFirstTestMethodErrored
BeforeFirstTestMethodFinished
BeforeTestMethodCalled
BeforeTestMethodErrored
BeforeTestMethodFinished
PostConditionCalled
PostConditionErrored
PostConditionFinished
PreConditionCalled
PreConditionErrored
PreConditionFinished
ConsideredRisky
DeprecationTriggered
ErrorTriggered
NoticeTriggered
PhpDeprecationTriggered
PhpNoticeTriggered
PhpunitDeprecationTriggered
PhpunitErrorTriggered
PhpunitWarningTriggered
PhpWarningTriggered
WarningTriggered
DataProviderMethodCalled
DataProviderMethodFinished
Finished
PreparationFailed
PreparationStarted
Prepared
Errored
Failed
MarkedIncomplete
Passed
Skipped
PrintedUnexpectedOutput
MockObjectCreated
MockObjectForAbstractClassCreated
MockObjectForIntersectionOfInterfacesCreated
MockObjectForTraitCreated
MockObjectFromWsdlCreated
PartialMockObjectCreated
TestProxyCreated
TestStubCreated
TestStubForIntersectionOfInterfacesCreated
BootstrapFinished
Configured
DeprecationTriggered
EventFacadeSealed
ExecutionAborted
ExecutionFinished
ExecutionStarted
ExtensionBootstrapped
ExtensionLoadedFromPhar
Finished
GarbageCollectionDisabled
GarbageCollectionEnabled
GarbageCollectionTriggered
Started
WarningTriggered
Filtered
Finished
Loaded
Skipped
Sorted
Started
EventAlreadyAssignedException
EventFacadeIsSealedException
InvalidArgumentException
InvalidEventException
InvalidSubscriberException
MapError
MoreThanOneDataSetFromDataProviderException
NoComparisonFailureException
NoDataSetFromDataProviderException
NoPreviousThrowableException
RuntimeException
SubscriberTypeAlreadyRegisteredException
UnknownEventException
UnknownEventTypeException
UnknownSubscriberException
UnknownSubscriberTypeException
ClassMethod
ComparisonFailure
OperatingSystem
PHP
PHPUnit
Runtime
Duration
GarbageCollectorStatus
HRTime
Info
MemoryUsage
Snapshot
Phpt
Test
TestCollection
TestCollectionIterator
DataFromDataProvider
DataFromTestDependency
TestData
TestDataCollection
TestDataCollectionIterator
TestDox
TestMethod
TestSuite
TestSuiteForTestClass
TestSuiteForTestMethodWithDataProvider
TestSuiteWithName
Throwable
Assert
After
AfterClass
BackupGlobals
BackupStaticProperties
Before
BeforeClass
CodeCoverageIgnore
CoversClass
CoversFunction
CoversNothing
DataProvider
DataProviderExternal
Depends
DependsExternal
DependsExternalUsingDeepClone
DependsExternalUsingShallowClone
DependsOnClass
DependsOnClassUsingDeepClone
DependsOnClassUsingShallowClone
DependsUsingDeepClone
DependsUsingShallowClone
DoesNotPerformAssertions
ExcludeGlobalVariableFromBackup
ExcludeStaticPropertyFromBackup
Group
IgnoreClassForCodeCoverage
IgnoreDeprecations
IgnoreFunctionForCodeCoverage
IgnoreMethodForCodeCoverage
Large
Medium
PostCondition
PreCondition
PreserveGlobalState
RequiresFunction
RequiresMethod
RequiresOperatingSystem
RequiresOperatingSystemFamily
RequiresPhp
RequiresPhpExtension
RequiresPhpunit
RequiresSetting
RunClassInSeparateProcess
RunInSeparateProcess
RunTestsInSeparateProcesses
Small
Test
TestDox
TestWith
TestWithJson
Ticket
UsesClass
UsesFunction
WithoutErrorHandler
IsFalse
IsTrue
Callback
Count
GreaterThan
IsEmpty
LessThan
SameSize
Constraint
IsEqual
IsEqualCanonicalizing
IsEqualIgnoringCase
IsEqualWithDelta
DirectoryExists
FileExists
IsReadable
IsWritable
IsAnything
IsIdentical
JsonMatches
IsFinite
IsInfinite
IsNan
ObjectEquals
ObjectHasProperty
BinaryOperator
LogicalAnd
LogicalNot
LogicalOr
LogicalXor
Operator
UnaryOperator
IsJson
RegularExpression
StringContains
StringEndsWith
StringEqualsStringIgnoringLineEndings
StringMatchesFormatDescription
StringStartsWith
ArrayHasKey
IsList
TraversableContains
TraversableContainsEqual
TraversableContainsIdentical
TraversableContainsOnly
IsInstanceOf
IsNull
IsType
NeverReturningMethodException
MockBuilder
InvocationMocker
TestCase
After
AfterClass
BackupGlobals
BackupStaticProperties
Before
BeforeClass
Covers
CoversClass
CoversDefaultClass
CoversFunction
CoversNothing
DataProvider
DependsOnClass
DependsOnMethod
DoesNotPerformAssertions
InvalidVersionRequirementException
NoVersionRequirementException
ExcludeGlobalVariableFromBackup
ExcludeStaticPropertyFromBackup
Group
IgnoreClassForCodeCoverage
IgnoreDeprecations
IgnoreFunctionForCodeCoverage
IgnoreMethodForCodeCoverage
Metadata
MetadataCollection
MetadataCollectionIterator
PostCondition
PreCondition
PreserveGlobalState
RequiresFunction
RequiresMethod
RequiresOperatingSystem
RequiresOperatingSystemFamily
RequiresPhp
RequiresPhpExtension
RequiresPhpunit
RequiresSetting
RunClassInSeparateProcess
RunInSeparateProcess
RunTestsInSeparateProcesses
Test
TestDox
TestWith
Uses
UsesClass
UsesDefaultClass
UsesFunction
ComparisonRequirement
ConstraintRequirement
Requirement
WithoutErrorHandler
Facade
ParameterCollection
Version
Builder
Configuration
Constant
ConstantCollection
ConstantCollectionIterator
Directory
DirectoryCollection
DirectoryCollectionIterator
ExtensionBootstrap
ExtensionBootstrapCollection
ExtensionBootstrapCollectionIterator
File
FileCollection
FileCollectionIterator
FilterDirectory
FilterDirectoryCollection
FilterDirectoryCollectionIterator
Group
GroupCollection
GroupCollectionIterator
IniSetting
IniSettingCollection
IniSettingCollectionIterator
Php
Source
TestDirectory
TestDirectoryCollection
TestDirectoryCollectionIterator
TestFile
TestFileCollection
TestFileCollectionIterator
TestSuite
TestSuiteCollection
TestSuiteCollectionIterator
Variable
VariableCollection
VariableCollectionIterator
UnexpectedOutputPrinter
ExcludeList
VersionComparisonOperator
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.
EvDriver
EventDriver
StreamSelectDriver
TracingDriver
UvDriver
DriverFactory
FiberLocal
Fiber local storage.
InvalidCallbackError
UncaughtThrowable
UnsupportedFeatureException
MUST be thrown if a feature is not supported by the system.
EventLoop
Accessor to allow global access to the event loop.
AmbiguousOptionException
OptionDoesNotAllowArgumentException
RequiredOptionArgumentMissingException
UnknownOptionException
Parser
ClassMethodUnit
ClassUnit
CodeUnit
CodeUnitCollection
CodeUnitCollectionIterator
InvalidCodeUnitException
NoTraitException
ReflectionException
FileUnit
FunctionUnit
InterfaceMethodUnit
InterfaceUnit
Mapper
TraitMethodUnit
TraitUnit
Wizard
ArrayComparator
Arrays are equal if they contain the same key-value pairs.
Comparator
ComparisonFailure
DateTimeComparator
Arrays are equal if they contain the same key-value pairs.
DOMNodeComparator
Arrays are equal if they contain the same key-value pairs.
ExceptionComparator
Compares Exception instances for equality.
RuntimeException
Factory
MockObjectComparator
Compares PHPUnit\Framework\MockObject\MockObject instances for equality.
NumericComparator
Compares scalar or NULL values for equality.
ObjectComparator
Arrays are equal if they contain the same key-value pairs.
ResourceComparator
ScalarComparator
Compares scalar or NULL values for equality.
SplObjectStorageComparator
TypeComparator
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
Runtime
Exporter
CodeExporter
RuntimeException
ExcludeList
Restorer
Snapshot
A snapshot of global state.
Counter
IllogicalValuesException
NegativeValueException
RuntimeException
LineCountingVisitor
LinesOfCode
Enumerator
ObjectReflector
Context
RuntimeException
Parameter
ReflectionMapper
CallableType
FalseType
GenericObjectType
IntersectionType
IterableType
MixedType
NeverType
NullType
ObjectType
SimpleType
StaticType
TrueType
Type
UnionType
UnknownType
VoidType
TypeName
Version
Config
This class contains configurations used in various classes. You can override them manually, in case default values aren't working.
Document
Technical references : - http://www.mactech.com/articles/mactech/Vol.15/15.09/PDFIntro/index.html - http://framework.zend.com/issues/secure/attachment/12512/Pdf.php - http://www.php.net/manual/en/ref.pdf.php#74211 - http://cpansearch.perl.org/src/JV/PostScript-Font-1.10.02/lib/PostScript/ISOLatin1Encoding.pm - http://cpansearch.perl.org/src/JV/PostScript-Font-1.10.02/lib/PostScript/ISOLatin9Encoding.pm - http://cpansearch.perl.org/src/JV/PostScript-Font-1.10.02/lib/PostScript/StandardEncoding.pm - http://cpansearch.perl.org/src/JV/PostScript-Font-1.10.02/lib/PostScript/WinAnsiEncoding.pm
ElementArray
Class ElementArray
ElementBoolean
Class ElementBoolean
ElementDate
Class ElementDate
ElementHexa
Class ElementHexa
ElementMissing
Class ElementMissing
ElementName
Class ElementName
ElementNull
Class ElementNull
ElementNumeric
Class ElementNumeric
ElementString
Class ElementString
ElementStruct
Class ElementStruct
ElementXRef
Class ElementXRef
Element
Class Element
AbstractEncoding
EncodingLocator
ISOLatin1Encoding
Class ISOLatin1Encoding
ISOLatin9Encoding
Class ISOLatin9Encoding
MacRomanEncoding
Class MacRomanEncoding
PDFDocEncoding
Class PDFDocEncoding
PostScriptGlyphs
Class PostScriptGlyphs
StandardEncoding
Class StandardEncoding
WinAnsiEncoding
Class WinAnsiEncoding
Encoding
Class Encoding
EmptyPdfException
This Exception is thrown when no PDF data was given.
EncodingNotFoundException
InvalidDictionaryObjectException
This exception is thrown when an invalid dictionary object is encountered.
MissingCatalogException
This exception is thrown when the catalog is missing.
MissingPdfHeaderException
This Exception is thrown when the %PDF- header is missing.
NotImplementedException
This Exception is thrown when a functionality has not yet been implemented.
FontCIDFontType0
Class FontCIDFontType0
FontCIDFontType2
Class FontCIDFontType2
FontTrueType
Class FontTrueType
FontType0
Class FontType0
FontType1
Class FontType1
FontType3
Class FontType3
Font
Class Font
Header
Class Header
Page
Class PDFObject
Pages
Class Pages
Parser
Class Parser
PDFObject
Class PDFObject
FilterHelper
RawDataParser
Form
Class Form
Image
Class Image
ArrayToXml
InvalidDirectoryName
PathAlreadyExists
TemporaryDirectory
Autoload
Config
Stores the configuration used to run PHPCS and PHPCBF.
DeepExitException
GeneratorException
RuntimeException
TokenizerException
DummyFile
File
FileList
LocalFile
ExactMatch
Filter
GitModified
GitStaged
Fixer
Generator
HTML
Markdown
Text
Reporter
Manages reporting of errors and warnings.
Cbf
Checkstyle
Code
Csv
Diff
Emacs
Full
Gitblame
Hgblame
Info
Json
Junit
Notifysend
Performance
Source
Summary
Svnblame
VersionControl
Xml
Ruleset
Runner
AbstractArraySniff
AbstractPatternSniff
AbstractScopeSniff
AbstractVariableSniff
ArrayIndentSniff
DisallowLongArraySyntaxSniff
DisallowShortArraySyntaxSniff
DuplicateClassNameSniff
OpeningBraceSameLineSniff
AssignmentInConditionSniff
EmptyPHPStatementSniff
EmptyStatementSniff
ForLoopShouldBeWhileLoopSniff
ForLoopWithTestFunctionCallSniff
JumbledIncrementerSniff
RequireExplicitBooleanOperatorPrecedenceSniff
UnconditionalIfStatementSniff
UnnecessaryFinalModifierSniff
UnusedFunctionParameterSniff
UselessOverridingMethodSniff
DocCommentSniff
FixmeSniff
TodoSniff
DisallowYodaConditionsSniff
InlineControlStructureSniff
ByteOrderMarkSniff
EndFileNewlineSniff
EndFileNoNewlineSniff
ExecutableFileSniff
InlineHTMLSniff
LineEndingsSniff
LineLengthSniff
LowercasedFilenameSniff
OneClassPerFileSniff
OneInterfacePerFileSniff
OneObjectStructurePerFileSniff
OneTraitPerFileSniff
DisallowMultipleStatementsSniff
MultipleStatementAlignmentSniff
SpaceAfterCastSniff
SpaceAfterNotSniff
SpaceBeforeCastSniff
FunctionCallArgumentSpacingSniff
OpeningFunctionBraceBsdAllmanSniff
OpeningFunctionBraceKernighanRitchieSniff
CyclomaticComplexitySniff
NestingLevelSniff
AbstractClassNamePrefixSniff
CamelCapsFunctionNameSniff
ConstructorNameSniff
InterfaceNameSuffixSniff
TraitNameSuffixSniff
UpperCaseConstantNameSniff
BacktickOperatorSniff
CharacterBeforePHPOpeningTagSniff
ClosingPHPTagSniff
DeprecatedFunctionsSniff
DisallowAlternativePHPTagsSniff
DisallowRequestSuperglobalSniff
DisallowShortOpenTagSniff
DiscourageGotoSniff
ForbiddenFunctionsSniff
LowerCaseConstantSniff
LowerCaseKeywordSniff
LowerCaseTypeSniff
NoSilencedErrorsSniff
RequireStrictTypesSniff
SAPIUsageSniff
SyntaxSniff
UpperCaseConstantSniff
UnnecessaryHeredocSniff
UnnecessaryStringConcatSniff
GitMergeConflictSniff
SubversionPropertiesSniff
ArbitraryParenthesesSpacingSniff
DisallowSpaceIndentSniff
DisallowTabIndentSniff
GotoTargetSpacingSniff
HereNowdocIdentifierSpacingSniff
IncrementDecrementSpacingSniff
LanguageConstructSpacingSniff
ScopeIndentSniff
SpreadOperatorSpacingAfterSniff
ClassDeclarationSniff
ClassCommentSniff
FileCommentSniff
FunctionCommentSniff
InlineCommentSniff
ControlSignatureSniff
MultiLineConditionSniff
IncludingFileSniff
MultiLineAssignmentSniff
FunctionCallSignatureSniff
FunctionDeclarationSniff
ValidDefaultValueSniff
ValidClassNameSniff
ValidFunctionNameSniff
ValidVariableNameSniff
ObjectOperatorIndentSniff
ScopeClosingBraceSniff
ScopeIndentSniff
ClassDeclarationSniff
SideEffectsSniff
CamelCapsMethodNameSniff
AnonClassDeclarationSniff
ClassInstantiationSniff
ClosingBraceSniff
OpeningBraceSpaceSniff
BooleanOperatorPlacementSniff
ControlStructureSpacingSniff
DeclareStatementSniff
FileHeaderSniff
ImportStatementSniff
OpenTagSniff
NullableTypeDeclarationSniff
ReturnTypeDeclarationSniff
ShortFormTypeKeywordsSniff
CompoundNamespaceDepthSniff
OperatorSpacingSniff
ConstantVisibilitySniff
UseDeclarationSniff
ClassDeclarationSniff
PropertyDeclarationSniff
ControlStructureSpacingSniff
ElseIfDeclarationSniff
SwitchDeclarationSniff
ClosingTagSniff
EndFileNewlineSniff
FunctionCallSignatureSniff
FunctionClosingBraceSniff
MethodDeclarationSniff
NamespaceDeclarationSniff
UseDeclarationSniff
ArrayBracketSpacingSniff
ArrayDeclarationSniff
ClassDeclarationSniff
ClassFileNameSniff
LowercaseClassKeywordsSniff
SelfMemberReferenceSniff
ValidClassNameSniff
BlockCommentSniff
ClassCommentSniff
ClosingDeclarationCommentSniff
DocCommentAlignmentSniff
EmptyCatchCommentSniff
FileCommentSniff
FunctionCommentSniff
FunctionCommentThrowTagSniff
InlineCommentSniff
LongConditionClosingCommentSniff
PostStatementCommentSniff
VariableCommentSniff
ControlSignatureSniff
ElseIfDeclarationSniff
ForEachLoopDeclarationSniff
ForLoopDeclarationSniff
InlineIfDeclarationSniff
LowercaseDeclarationSniff
SwitchDeclarationSniff
FileExtensionSniff
OperatorBracketSniff
FunctionDeclarationArgumentSpacingSniff
FunctionDeclarationSniff
FunctionDuplicateArgumentSniff
GlobalFunctionSniff
LowercaseFunctionKeywordsSniff
MultiLineFunctionDeclarationSniff
ValidFunctionNameSniff
ValidVariableNameSniff
ObjectInstantiationSniff
ComparisonOperatorUsageSniff
IncrementDecrementUsageSniff
ValidLogicalOperatorsSniff
CommentedOutCodeSniff
DisallowBooleanStatementSniff
DisallowComparisonAssignmentSniff
DisallowInlineIfSniff
DisallowMultipleAssignmentsSniff
DisallowSizeFunctionsInLoopsSniff
DiscouragedFunctionsSniff
EmbeddedPhpSniff
EvalSniff
GlobalKeywordSniff
HeredocSniff
InnerFunctionsSniff
LowercasePHPFunctionsSniff
NonExecutableCodeSniff
MemberVarScopeSniff
MethodScopeSniff
StaticThisUsageSniff
ConcatenationSpacingSniff
DoubleQuoteUsageSniff
EchoedStringsSniff
CastSpacingSniff
ControlStructureSpacingSniff
FunctionClosingBraceSpaceSniff
FunctionOpeningBraceSpaceSniff
FunctionSpacingSniff
LogicalOperatorSpacingSniff
MemberVarSpacingSniff
ObjectOperatorSpacingSniff
OperatorSpacingSniff
ScopeClosingBraceSniff
ScopeKeywordSpacingSniff
SemicolonSpacingSniff
SuperfluousWhitespaceSniff
ClosingTagSniff
ValidVariableNameSniff
Comment
PHP
Tokenizer
Cache
Common
Standards
Tokens
ConfigDouble
Stores the configuration used to run PHPCS and PHPCBF.
AbstractMethodTestCase
AbstractSniffTestCase
Application
An Application is the container for a collection of commands.
Argument
AsCommand
Service tag to autoconfigure commands.
Ask
Interact
MapInput
Maps a command input into an object (DTO).
Option
GithubActionReporter
Utility class for Github actions.
Color
Command
Base class for all commands.
CompleteCommand
Responsible for providing the values to the shell completion.
DumpCompletionCommand
Dumps the completion script for the current shell.
HelpCommand
HelpCommand displays the help for a given command.
LazyCommand
Base class for all commands.
ListCommand
ListCommand displays the list of all available commands for the application.
ContainerCommandLoader
Loads commands from a PSR-11 container.
FactoryCommandLoader
A simple command loader using factories to instantiate commands lazily.
CompletionInput
An input specialized for shell completion.
CompletionSuggestions
Stores all completion suggestions for the current input.
BashCompletionOutput
FishCompletionOutput
ZshCompletionOutput
Suggestion
Represents a single suggested value.
ConsoleEvents
Contains all events dispatched by an Application.
Cursor
AddConsoleCommandPass
Registers console commands.
ReStructuredTextDescriptor
ConsoleAlarmEvent
Allows to inspect input and output of a command.
ConsoleCommandEvent
Allows to do things before the command is executed, like skipping the command or executing code before the command is going to be executed.
ConsoleErrorEvent
Allows to handle throwables thrown while running a command.
ConsoleEvent
Allows to inspect input and output of a command.
ConsoleSignalEvent
Allows to inspect input and output of a command.
ConsoleTerminateEvent
Allows to manipulate the exit code of a command after its execution.
ErrorListener
CommandNotFoundException
Represents an incorrect command name typed in the console.
InvalidArgumentException
InvalidOptionException
Represents an incorrect option name or value typed in the console.
LogicException
MissingInputException
Represents failure to read input from stdin.
NamespaceNotFoundException
Represents an incorrect namespace typed in the console.
RunCommandFailedException
RuntimeException
NullOutputFormatter
NullOutputFormatterStyle
OutputFormatter
Formatter class for console output.
OutputFormatterStyle
Formatter style class for defining styles.
OutputFormatterStyleStack
DebugFormatterHelper
Helps outputting debug information when running an external program from a command.
DescriptorHelper
This class adds helper method to describe objects in various formats.
Dumper
FormatterHelper
The Formatter class provides helpers to format messages.
Helper
Helper is the base class for all helper classes.
HelperSet
HelperSet represents a set of helpers to be used with a command.
InputAwareHelper
An implementation of InputAwareInterface for Helpers.
OutputWrapper
Simple output wrapper for "tagged outputs" instead of wordwrap(). This solution is based on a StackOverflow answer: https://stackoverflow.com/a/20434776/1476819 from user557597 (alias SLN).
ProcessHelper
The ProcessHelper class provides helpers to run external processes.
ProgressBar
The ProgressBar provides helpers to display progress output.
ProgressIndicator
QuestionHelper
The QuestionHelper class provides helpers to interact with the user.
SymfonyQuestionHelper
Symfony Style Guide compliant question helper.
Table
Provides helpers to display a table.
TableCell
TableCellStyle
TableSeparator
Marks a row as being a separator.
TableStyle
Defines the styles for a Table.
TreeHelper
The TreeHelper class provides methods to display tree-like structures.
TreeNode
TreeStyle
Configures the output of the Tree helper.
ArgvInput
ArgvInput represents an input coming from the CLI arguments.
ArrayInput
ArrayInput represents an input provided as an array.
Input
Input is the base class for all concrete Input classes.
InputArgument
Represents a command line argument.
InputDefinition
A InputDefinition represents a set of valid command line arguments and options.
InputOption
Represents a command line option.
StringInput
StringInput represents an input provided as a string.
ConsoleLogger
PSR-3 compliant console logger.
RunCommandContext
RunCommandMessage
RunCommandMessageHandler
BufferedOutput
Base class for output classes.
ConsoleOutput
ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
ConsoleSectionOutput
StreamOutput writes the output to a given stream.
NullOutput
NullOutput suppresses all output.
Output
Base class for output classes.
StreamOutput
StreamOutput writes the output to a given stream.
TrimmedBufferOutput
A BufferedOutput that keeps only the last N chars.
ChoiceQuestion
Represents a choice question.
ConfirmationQuestion
Represents a yes/no question.
Question
Represents a Question.
SignalMap
SignalRegistry
SingleCommandApplication
Base class for all commands.
OutputStyle
Decorates output to add console style guide helpers.
SymfonyStyle
Output decorator helpers for the Symfony Style Guide.
Terminal
ApplicationTester
Eases the testing of console applications.
CommandCompletionTester
Eases the testing of command completion.
CommandTester
Eases the testing of console commands.
CommandIsSuccessful
FileNotFoundException
Exception class thrown when a file couldn't be found.
InvalidArgumentException
IOException
Exception class thrown when a filesystem operation failure happens.
RuntimeException
Filesystem
Provides basic utility to manipulate the file system.
Path
Contains utility methods for handling path strings.
Normalizer
Attribute
PhpToken
UnhandledMatchError
ValueError
Required
A required dependency.
SubscribedService
For use as the return value for {@see ServiceSubscriberInterface}.
ServiceLocatorTest
ServiceLocatorTestCase
AbstractString
Represents a string of abstract characters.
AbstractUnicodeString
Represents a string of abstract Unicode characters.
ByteString
Represents a binary-safe string of bytes.
CodePointString
Represents a string of Unicode code points encoded as UTF-8.
InvalidArgumentException
RuntimeException
EnglishInflector
FrenchInflector
French inflector.
SpanishInflector
LazyString
A string whose value is computed lazily by a callback.
AsciiSlugger
UnicodeString
Represents a string of Unicode grapheme clusters encoded as UTF-8.
JwtBearer
Represents a type of authorization grant.
Azure
Represents a service provider (authorization server).
AzureResourceOwner
AccessToken
Represents an access token.
B2cTokenFaker
KeysFaker
AzureHelper
AzureResourceOwnerTest
AzureTest
AccessTokenTest
Exception
NamespaceUri
NamespaceUriException
Token
TokenCollection
TokenCollectionException
Tokenizer
XMLSerializer
Aliases
Codebase
DocblockTypeLocation
ParseErrorLocation
Raw
CodeLocation
FileFilter
Config
Context
DocComment
ErrorBaseline
CircularReferenceException
CodeException
ComplicatedExpressionException
ConfigCreationException
ConfigException
ConfigNotFoundException
DocblockParseException
FileIncludeException
IncorrectDocblockException
InvalidClasslikeOverrideException
InvalidMethodOverrideException
RefactorException
ScopeAnalysisException
TypeParseTreeException
UnanalyzedFileException
UnpopulatedClasslikeException
UnpreparedAnalysisException
UnresolvableConstantException
UnsupportedIssueToFixException
FileManipulation
AbstractInstantiation
AbstractMethodCall
AmbiguousConstantInheritance
ArgumentIssue
ArgumentTypeCoercion
AssignmentToVoid
CheckType
CircularReference
ClassConstantIssue
ClassIssue
CodeIssue
ComplexFunction
ComplexMethod
ConfigIssue
ConflictingReferenceConstraint
ConstantDeclarationInTrait
ConstructorSignatureMismatch
ContinueOutsideLoop
DeprecatedClass
DeprecatedConstant
DeprecatedFunction
DeprecatedInterface
DeprecatedMethod
DeprecatedProperty
DeprecatedTrait
DirectConstructorCall
DocblockTypeContradiction
DuplicateArrayKey
DuplicateClass
DuplicateConstant
DuplicateEnumCase
DuplicateEnumCaseValue
DuplicateFunction
DuplicateMethod
DuplicateParam
DuplicateProperty
EmptyArrayAccess
ExtensionRequirementViolation
FalsableReturnStatement
FalseOperand
ForbiddenCode
FunctionIssue
IfThisIsMismatch
ImplementationRequirementViolation
ImplementedParamTypeMismatch
ImplementedReturnTypeMismatch
ImplicitToStringCast
ImpureByReferenceAssignment
ImpureFunctionCall
ImpureMethodCall
ImpurePropertyAssignment
ImpurePropertyFetch
ImpureStaticProperty
ImpureStaticVariable
ImpureVariable
InaccessibleClassConstant
InaccessibleMethod
InaccessibleProperty
InheritorViolation
InterfaceInstantiation
InternalClass
InternalMethod
InternalProperty
InvalidArgument
InvalidArrayAccess
InvalidArrayAssignment
InvalidArrayOffset
InvalidAttribute
InvalidCast
InvalidCatch
InvalidClass
InvalidClassConstantType
InvalidClone
InvalidConstantAssignmentValue
InvalidDocblock
InvalidDocblockParamName
InvalidEnumBackingType
InvalidEnumCaseValue
InvalidEnumMethod
InvalidExtendClass
InvalidFalsableReturnType
InvalidFunctionCall
InvalidGlobal
InvalidInterfaceImplementation
InvalidIterator
InvalidLiteralArgument
InvalidMethodCall
InvalidNamedArgument
InvalidNullableReturnType
InvalidOperand
InvalidOverride
InvalidParamDefault
InvalidParent
InvalidPassByReference
InvalidPropertyAssignment
InvalidPropertyAssignmentValue
InvalidPropertyFetch
InvalidReturnStatement
InvalidReturnType
InvalidScalarArgument
InvalidScope
InvalidStaticInvocation
InvalidStringClass
InvalidTemplateParam
InvalidThrow
InvalidToString
InvalidTraversableImplementation
InvalidTypeImport
LessSpecificClassConstantType
LessSpecificImplementedReturnType
LessSpecificReturnStatement
LessSpecificReturnType
LiteralKeyUnshapedArray
LoopInvalidation
MethodIssue
MethodSignatureMismatch
MethodSignatureMustOmitReturnType
MethodSignatureMustProvideReturnType
MismatchingDocblockParamType
MismatchingDocblockPropertyType
MismatchingDocblockReturnType
MissingClassConstType
MissingClosureParamType
MissingClosureReturnType
MissingConstructor
MissingDependency
MissingDocblockType
MissingFile
MissingImmutableAnnotation
MissingOverrideAttribute
MissingParamType
MissingPropertyType
MissingReturnType
MissingTemplateParam
MissingThrowsDocblock
MixedArgument
MixedArgumentTypeCoercion
MixedArrayAccess
MixedArrayAssignment
MixedArrayOffset
MixedArrayTypeCoercion
MixedAssignment
MixedClone
MixedFunctionCall
MixedMethodCall
MixedOperand
MixedPropertyAssignment
MixedPropertyFetch
MixedPropertyTypeCoercion
MixedReturnStatement
MixedReturnTypeCoercion
MixedStringOffsetAssignment
MoreSpecificImplementedParamType
MoreSpecificReturnType
MutableDependency
NamedArgumentNotAllowed
NoEnumProperties
NoInterfaceProperties
NonInvariantDocblockPropertyType
NonInvariantPropertyType
NonStaticSelfCall
NonVariableReferenceReturn
NoValue
NullableReturnStatement
NullArgument
NullArrayAccess
This is different from NullReference, as PHP throws a notice (vs the possibility of a fatal error with a null reference)
NullArrayOffset
NullFunctionCall
NullIterator
NullOperand
NullPropertyAssignment
This is different from NullReference, as PHP throws a notice (vs the possibility of a fatal error with a null reference)
NullPropertyFetch
This is different from NullReference, as PHP throws a notice (vs the possibility of a fatal error with a null reference)
NullReference
OverriddenFinalConstant
OverriddenInterfaceConstant
OverriddenMethodAccess
OverriddenPropertyAccess
ParadoxicalCondition
ParamNameMismatch
ParentNotFound
ParseError
PluginIssue
PossibleRawObjectIteration
PossiblyFalseArgument
PossiblyFalseIterator
PossiblyFalseOperand
PossiblyFalsePropertyAssignmentValue
PossiblyFalseReference
PossiblyInvalidArgument
PossiblyInvalidArrayAccess
PossiblyInvalidArrayAssignment
PossiblyInvalidArrayOffset
PossiblyInvalidCast
PossiblyInvalidClone
PossiblyInvalidDocblockTag
PossiblyInvalidFunctionCall
PossiblyInvalidIterator
PossiblyInvalidMethodCall
PossiblyInvalidOperand
PossiblyInvalidPropertyAssignment
PossiblyInvalidPropertyAssignmentValue
PossiblyInvalidPropertyFetch
PossiblyNullArgument
PossiblyNullArrayAccess
This is different from PossiblyNullReference, as PHP throws a notice (vs the possibility of a fatal error with a null reference)
PossiblyNullArrayAssignment
PossiblyNullArrayOffset
PossiblyNullFunctionCall
PossiblyNullIterator
PossiblyNullOperand
PossiblyNullPropertyAssignment
This is different from PossiblyNullReference, as PHP throws a notice (vs the possibility of a fatal error with a null reference)
PossiblyNullPropertyAssignmentValue
PossiblyNullPropertyFetch
This is different from PossiblyNullReference, as PHP throws a notice (vs the possibility of a fatal error with a null reference)
PossiblyNullReference
PossiblyUndefinedArrayOffset
PossiblyUndefinedGlobalVariable
PossiblyUndefinedIntArrayOffset
PossiblyUndefinedMethod
PossiblyUndefinedStringArrayOffset
PossiblyUndefinedVariable
PossiblyUnusedMethod
PossiblyUnusedParam
PossiblyUnusedProperty
PossiblyUnusedReturnValue
PrivateFinalMethod
PropertyIssue
PropertyNotSetInConstructor
PropertyTypeCoercion
PsalmInternalError
RawObjectIteration
RedundantCast
RedundantCastGivenDocblockType
RedundantCondition
RedundantConditionGivenDocblockType
RedundantFlag
RedundantFunctionCall
RedundantFunctionCallGivenDocblockType
RedundantIdentityWithTrue
RedundantPropertyInitializationCheck
ReferenceConstraintViolation
ReferenceReusedFromConfusingScope
ReservedWord
RiskyCast
RiskyTruthyFalsyComparison
StringIncrement
TaintedCallable
TaintedCookie
TaintedCustom
TaintedEval
TaintedExtract
TaintedFile
TaintedHeader
TaintedHtml
TaintedInclude
TaintedInput
TaintedLdap
TaintedShell
TaintedSleep
TaintedSql
TaintedSSRF
TaintedSystemSecret
TaintedTextWithQuotes
TaintedUnserialize
TaintedUserSecret
TaintedXpath
TooFewArguments
TooManyArguments
TooManyTemplateParams
Trace
TraitMethodSignatureMismatch
TypeDoesNotContainNull
TypeDoesNotContainType
UncaughtThrowInGlobalScope
UndefinedAttributeClass
UndefinedClass
UndefinedConstant
UndefinedDocblockClass
UndefinedFunction
UndefinedGlobalVariable
UndefinedInterface
UndefinedInterfaceMethod
UndefinedMagicMethod
UndefinedMagicPropertyAssignment
UndefinedMagicPropertyFetch
UndefinedMethod
UndefinedPropertyAssignment
UndefinedPropertyFetch
UndefinedThisPropertyAssignment
UndefinedThisPropertyFetch
UndefinedTrace
UndefinedTrait
UndefinedVariable
UnevaluatedCode
UnhandledMatchCondition
UnimplementedAbstractMethod
UnimplementedInterfaceMethod
UninitializedProperty
UnnecessaryVarAnnotation
UnrecognizedExpression
UnrecognizedStatement
UnresolvableConstant
UnresolvableInclude
UnsafeGenericInstantiation
UnsafeInstantiation
UnsupportedPropertyReferenceUsage
UnsupportedReferenceUsage
UnusedBaselineEntry
UnusedClass
UnusedClosureParam
UnusedConstructor
UnusedDocblockParam
UnusedForeachValue
UnusedFunctionCall
UnusedIssueHandlerSuppression
UnusedMethod
UnusedMethodCall
UnusedParam
UnusedProperty
UnusedPsalmSuppress
UnusedReturnValue
UnusedVariable
VariableIssue
IssueBuffer
VirtualBitwiseAnd
VirtualBitwiseOr
VirtualBitwiseXor
VirtualCoalesce
VirtualConcat
VirtualDiv
VirtualMinus
VirtualMod
VirtualMul
VirtualPlus
VirtualPow
VirtualShiftLeft
VirtualShiftRight
VirtualBitwiseAnd
VirtualBitwiseOr
VirtualBitwiseXor
VirtualBooleanAnd
VirtualBooleanOr
VirtualCoalesce
VirtualConcat
VirtualDiv
VirtualEqual
VirtualGreater
VirtualGreaterOrEqual
VirtualIdentical
VirtualLogicalAnd
VirtualLogicalOr
VirtualLogicalXor
VirtualMinus
VirtualMod
VirtualMul
VirtualNotEqual
VirtualNotIdentical
VirtualPlus
VirtualPow
VirtualShiftLeft
VirtualShiftRight
VirtualSmaller
VirtualSmallerOrEqual
VirtualSpaceship
VirtualArray
VirtualBool
VirtualDouble
VirtualInt
VirtualObject
VirtualString
VirtualUnset
VirtualArray
VirtualArrayDimFetch
VirtualArrowFunction
VirtualAssign
VirtualAssignRef
VirtualBitwiseNot
VirtualBooleanNot
VirtualClassConstFetch
VirtualClone
VirtualClosure
VirtualConstFetch
VirtualEmpty
VirtualError
Error node used during parsing with error recovery.
VirtualErrorSuppress
VirtualEval
VirtualExit
VirtualFuncCall
VirtualInclude
VirtualInstanceof
VirtualIsset
VirtualList
VirtualMatch
VirtualMethodCall
VirtualNew
VirtualNullsafeMethodCall
VirtualNullsafePropertyFetch
VirtualPostDec
VirtualPostInc
VirtualPreDec
VirtualPreInc
VirtualPrint
VirtualPropertyFetch
VirtualShellExec
VirtualStaticCall
VirtualStaticPropertyFetch
VirtualTernary
VirtualThrow
VirtualUnaryMinus
VirtualUnaryPlus
VirtualVariable
VirtualYield
VirtualYieldFrom
VirtualFullyQualified
VirtualRelative
VirtualClass
VirtualDir
VirtualFile
VirtualFunction
VirtualLine
VirtualMethod
VirtualNamespace
VirtualTrait
VirtualFloat
VirtualInt
VirtualInterpolatedString
VirtualInterpolatedStringPart
VirtualString
VirtualAlias
VirtualPrecedence
VirtualBreak
VirtualCase
VirtualCatch
VirtualClass
VirtualClassConst
VirtualClassMethod
VirtualConst
VirtualContinue
VirtualDeclare
VirtualDeclareItem
VirtualDo
VirtualEcho
VirtualElse
VirtualElseIf
VirtualExpression
Represents statements of type "expr;"
VirtualFinally
VirtualFor
VirtualForeach
VirtualFunction
VirtualGlobal
VirtualGoto
VirtualGroupUse
VirtualHaltCompiler
VirtualIf
VirtualInlineHTML
VirtualInterface
VirtualLabel
VirtualNamespace
VirtualNop
Nop/empty statement (;).
VirtualProperty
VirtualReturn
VirtualStatic
VirtualSwitch
VirtualTrait
VirtualTraitUse
VirtualTryCatch
VirtualUnset
VirtualUse
VirtualWhile
VirtualArg
VirtualArrayItem
VirtualAttribute
VirtualAttributeGroup
VirtualClosureUse
VirtualConst
VirtualIdentifier
Represents a non-namespaced name. Namespaced names are represented using Name nodes.
VirtualMatchArm
VirtualName
VirtualNullableType
This is a base class for complex types, including nullable types and union types.
VirtualParam
VirtualPropertyItem
VirtualStaticVar
VirtualUnionType
This is a base class for complex types, including nullable types and union types.
VirtualUseItem
VirtualVarLikeIdentifier
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.
ArgTypeInferer
DynamicFunctionStorage
DynamicTemplateProvider
AddRemoveTaintsEvent
AfterAnalysisEvent
AfterClassLikeAnalysisEvent
AfterClassLikeExistenceCheckEvent
AfterClassLikeVisitEvent
AfterCodebasePopulatedEvent
AfterEveryFunctionCallAnalysisEvent
AfterExpressionAnalysisEvent
AfterFileAnalysisEvent
AfterFunctionCallAnalysisEvent
AfterFunctionLikeAnalysisEvent
AfterMethodCallAnalysisEvent
AfterStatementAnalysisEvent
BeforeAddIssueEvent
BeforeExpressionAnalysisEvent
BeforeFileAnalysisEvent
BeforeStatementAnalysisEvent
DynamicFunctionStorageProviderEvent
FunctionExistenceProviderEvent
FunctionParamsProviderEvent
FunctionReturnTypeProviderEvent
MethodExistenceProviderEvent
MethodParamsProviderEvent
MethodReturnTypeProviderEvent
MethodVisibilityProviderEvent
PropertyExistenceProviderEvent
PropertyTypeProviderEvent
PropertyVisibilityProviderEvent
StringInterpreterEvent
Shepherd
PluginFileExtensionsSocket
PluginRegistrationSocket
DebugProgress
DefaultProgress
LongProgress
Progress
VoidProgress
ByIssueLevelAndTypeReport
CheckstyleReport
CodeClimateReport
CodeClimate format This is the format used by Gitlab for CodeQuality
CompactReport
ConsoleReport
CountReport
EmacsReport
GithubActionsReport
JsonReport
JsonSummaryReport
JunitReport
based on https://github.com/m50/psalm-json-to-junit Copyright (c) Marisa Clardy marisa@clardy.eu
PhpStormReport
PylintReport
ReportOptions
SarifReport
SARIF report format suitable for import into any SARIF compatible solution
SonarqubeReport
JSON report format suitable for import into SonarQube or SonarCloud as generic (external) issue data via `sonar.externalIssuesReportPaths`.
TextReport
XmlReport
Report
CommitInfo
Commit info.
GitInfo
Data represents "git" of Coveralls API.
RemoteInfo
Remote info.
SourceControlInfo
Any
ArrayKeyDoesNotExist
ArrayKeyExists
DoesNotHaveAtLeastCount
DoesNotHaveExactCount
DoesNotHaveMethod
Empty_
Falsy
HasArrayKey
HasAtLeastCount
HasExactCount
HasIntOrStringArrayAccess
HasMethod
HasStringArrayAccess
InArray
IsAClass
IsClassEqual
IsClassNotEqual
IsCountable
IsEqualIsset
IsGreaterThan
IsGreaterThanOrEqualTo
IsIdentical
IsIsset
IsLessThan
IsLessThanOrEqualTo
IsLooselyEqual
IsNotAClass
IsNotCountable
IsNotIdentical
IsNotIsset
IsNotLooselyEqual
IsNotType
IsType
NestedAssertions
NonEmpty
NonEmptyCountable
NotInArray
NotNestedAssertions
NotNonEmptyCountable
Truthy
Assertion
AttributeArg
AttributeStorage
ClassConstantStorage
ClassLikeStorage
EnumCaseStorage
FileStorage
FunctionLikeParameter
FunctionLikeStorage
FunctionStorage
MethodStorage
Possibilities
PropertyStorage
Scalar
TAnonymousClassInstance
Denotes an anonymous class (i.e. `new class{}`) with potential methods
TArray
Denotes a simple array of the form `array<TKey, TValue>`. It expects an array with two elements, both union types.
TArrayKey
Denotes the `array-key` type, used for something that could be the offset of an `array`.
TBool
Denotes the `bool` type where the exact value is unknown.
TCallable
Denotes the `callable` type. Can result from an `is_callable` check.
TCallableKeyedArray
Denotes an object-like array that is _also_ `callable`.
TCallableObject
Denotes an object that is also `callable` (i.e. it has `__invoke` defined).
TCallableString
Denotes the `callable-string` type, used to represent an unknown string that is also `callable`.
TClassConstant
Denotes a class constant whose value might not yet be known.
TClassString
Denotes the `class-string` type, used to describe a string representing a valid PHP class.
TClassStringMap
Represents an array where the type of each value is a function of its string key value
TClosedResource
Denotes the `resource` type that has been closed (e.g. a file handle through `fclose()`).
TClosure
Represents a closure where we know the return type and params
TConditional
Internal representation of a conditional return type in phpdoc. For example ($param1 is int ? int : string)
TDependentGetClass
Represents a string whose value is a fully-qualified class found by get_class($var)
TDependentGetDebugType
Represents a string whose value is that of a type found by get_debug_type($var)
TDependentGetType
Represents a string whose value is that of a type found by gettype($var)
TEmptyMixed
Denotes the `mixed` type, but empty.
TEmptyNumeric
Denotes the `numeric` type that's also empty (which can also result from an `is_numeric` and `empty` check).
TEmptyScalar
Denotes a `scalar` type that is also empty.
TEnumCase
Denotes an enum with a specific value
TFalse
Denotes the `false` value type
TFloat
Denotes the `float` type, where the exact value is unknown.
TGenericObject
Denotes an object type that has generic parameters e.g. `ArrayObject<string, Foo\Bar>`
TInt
Denotes the `int` type, where the exact value is unknown.
TIntMask
Represents the type that is the result of a bitmask combination of its parameters.
TIntMaskOf
Represents the type that is the result of a bitmask combination of its parameters.
TIntRange
Denotes an interval of integers between two bounds
TIterable
denotes the `iterable` type(which can also result from an `is_iterable` check).
TKeyedArray
Represents an 'object-like array' - an array with known keys.
TKeyOf
Represents an offset of an array.
TLiteralClassString
Denotes a specific class string, generated by expressions like `A::class`.
TLiteralFloat
Denotes a floating point value where the exact numeric value is known.
TLiteralInt
Denotes an integer value where the exact numeric value is known.
TLiteralString
Denotes a string whose value is known.
TLowercaseString
Denotes the `string` type, where the exact value is unknown.
TMixed
Denotes the `mixed` type, used when you don’t know the type of an expression.
TNamedObject
Denotes an object type where the type of the object is known e.g. `Exception`, `Throwable`, `Foo\Bar`
TNever
Denotes the `no-return`/`never-return` type for functions that never return, either throwing an exception or terminating (like the builtin `exit()`).
TNonEmptyArray
Denotes array known to be non-empty of the form `non-empty-array<TKey, TValue>`.
TNonEmptyLowercaseString
Denotes a non-empty-string where every character is lowercased. (which can also result from a `strtolower` call).
TNonEmptyMixed
Denotes the `mixed` type, but not empty.
TNonEmptyNonspecificLiteralString
Denotes the `literal-string` type, where the exact value is unknown but we know that the string is not from user input
TNonEmptyScalar
Denotes a `scalar` type that is also non-empty.
TNonEmptyString
Denotes a string, that is also non-empty (every string except '')
TNonFalsyString
Denotes a string, that is also non-falsy (every string except '' and '0')
TNonspecificLiteralInt
Denotes the `literal-int` type, where the exact value is unknown but we know that the int is not from user input
TNonspecificLiteralString
Denotes the `literal-string` type, where the exact value is unknown but we know that the string is not from user input
TNull
Denotes the `null` type
TNumeric
Denotes the `numeric` type (which can also result from an `is_numeric` check).
TNumericString
Denotes a string that's also a numeric value e.g. `"5"`. It can result from `is_string($s) && is_numeric($s)`.
TObject
Denotes the `object` type
TObjectWithProperties
Denotes an object with specified member variables e.g. `object{foo:int, bar:string}`.
TPropertiesOf
Type that resolves to a keyed-array with properties of a class as keys and their appropriate types as values.
TResource
Denotes the `resource` type (e.g. a file handle).
TScalar
Denotes the `scalar` super type (which can also result from an `is_scalar` check).
TSingleLetter
Denotes a string that has a length of 1
TString
Denotes the `string` type, where the exact value is unknown.
TTemplateIndexedAccess
TTemplateKeyOf
Represents the type used when using TKeyOf when the type of the array is a template
TTemplateParam
denotes a template parameter that has been previously specified in a `@template` tag.
TTemplateParamClass
Denotes a `class-string` corresponding to a template parameter previously specified in a `@template` tag.
TTemplatePropertiesOf
Represents the type used when using TPropertiesOf when the type of the array is a template
TTemplateValueOf
Represents the type used when using TValueOf when the type of the array or enum is a template
TTraitString
Denotes the `trait-string` type, used to describe a string representing a valid PHP trait.
TTrue
Denotes the `true` value type
TTypeAlias
TUnknownClassString
Denotes the `class-string` type, used to describe a string representing a valid PHP class.
TValueOf
Represents a value of an array or enum.
TVoid
Denotes the `void` type, normally just used to annotate a function/method that returns nothing
Atomic
MutableTypeVisitor
MutableUnion
Reconciler
TaintKind
An Enum class holding all the taint types that Psalm recognises
TaintKindGroup
An Enum class holding all the taint types that Psalm recognises
TypeVisitor
Union
Type
Assert
Efficient assertions to validate the input/output of your methods.
InvalidArgumentException

Traits

ApiRoutableTrait
Default implementations for ApiRoutableInterface methods.
ForbidCloning
ForbidSerialization
ReadableStreamIteratorAggregate
VerifyDeprecations
ClientTrait
Client interface for sending HTTP requests.
MessageTrait
Trait implementing functionality common to requests and responses.
StreamDecoratorTrait
Stream decorator trait
ArrayAccessorTrait
Provides generic array navigation tools.
BearerAuthorizationTrait
Enables `Bearer` header authorization for providers.
GuardedPropertyTrait
Provides support for blacklisting explicit properties from the mass assignment behavior.
MacAuthorizationTrait
Enables `MAC` header authorization for providers.
ProviderRedirectTrait
QueryBuilderTrait
Provides a standard way to generate query strings.
RequiredParameterTrait
Provides functionality to check for required parameters.
SmartObject
Strict class for better experience.
StaticClass
Static class.
IteratorImplementation
NodeAttributes
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.
LockableTrait
Basic lock feature for commands.
TesterTrait
ServiceLocatorTrait
A trait to help implement ServiceProviderInterface.
ServiceMethodsSubscriberTrait
Implementation of ServiceSubscriberInterface that determines subscribed services from methods that have the #[SubscribedService] attribute.
ServiceSubscriberTrait
Implementation of ServiceSubscriberInterface that determines subscribed services from methods that have the #[SubscribedService] attribute.
MixedIssueTrait
CustomMetadataTrait
ImmutableNonCloneableTrait
UnserializeMemoryUsageSuppressionTrait
Suppresses memory usage when unserializing objects.
CallableTrait
GenericTrait
HasIntersectionTrait
UnionTrait
Mixin
This trait provides nullOr*, all* and allNullOr* variants of assertion base methods.

Enums

InternetAddressVersion
SocketAddressType
TlsState
ArchiveEnum
AgeRatingEnum
For ComicRack's ComicInfo.xml
EbookFormatEnum
MangaEnum
For ComicRack's ComicInfo.xml
SchemeType
UriScheme
HostFormat
HostType
Error
UriComparisonMode
UrnComparisonMode
CallbackType
AnsiColorMode
TruncateMode

Constants

AMP_CONTEXT  = "process"
AMP_CONTEXT  = "parallel"
AMP_CONTEXT_ID  = \getmypid()
BIN_DIR  = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'bin'
CONNECTION_BUSY  = \defined('SOCKET_EAGAIN') ? \SOCKET_EAGAIN : 11
CONNECTION_REFUSED  = \defined('SOCKET_ECONNREFUSED') ? \SOCKET_ECONNREFUSED : 111
CONNECTION_TIMEOUT  = \defined('SOCKET_ETIMEDOUT') ? \SOCKET_ETIMEDOUT : 110
FILTER_VALIDATE_BOOL  = \FILTER_VALIDATE_BOOLEAN
GRAPHEME_EXTR_COUNT  = 0
GRAPHEME_EXTR_COUNT  = 0
GRAPHEME_EXTR_MAXBYTES  = 1
GRAPHEME_EXTR_MAXBYTES  = 1
GRAPHEME_EXTR_MAXCHARS  = 2
GRAPHEME_EXTR_MAXCHARS  = 2
IS_WINDOWS  = \PHP_OS_FAMILY === 'Windows'
LWT_BASE_PATH  = __DIR__
LWT Front Controller
MB_CASE_LOWER  = 1
MB_CASE_LOWER  = 1
MB_CASE_TITLE  = 2
MB_CASE_TITLE  = 2
MB_CASE_UPPER  = 0
MB_CASE_UPPER  = 0
PDF  = __DIR__ . '/tests/media/example.pdf'
PHP_CODESNIFFER_CBF  = false
PHP_CODESNIFFER_CBF  = \false
PHP_CODESNIFFER_IN_TESTS  = \true
PHP_CODESNIFFER_VERBOSITY  = $this->config->verbosity
PHP_CODESNIFFER_VERBOSITY  = 0
PHP_PARSER_VERSION  = VersionUtils::getPhpParserVersion()
PSALM_VERSION  = VersionUtils::getPsalmVersion()
STDERR  = \fopen('php://stderr', 'wb')
STDOUT  = \fopen('php://stdout', 'wb')
SYMFONY_GRAPHEME_CLUSTER_RX  = ((float) \PCRE_VERSION < 10 ? (float) \PCRE_VERSION >= 8.32 : (float) \PCRE_VERSION >= 10.39) ? '\X' : \Symfony\Polyfill\Intl\Grapheme\Grapheme::GRAPHEME_CLUSTER_RX
T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG  = 'PHPCS_T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG'
T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG  = 'PHPCS_T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG'
T_ANON_CLASS  = 'PHPCS_T_ANON_CLASS'
T_ASPERAND  = 'PHPCS_T_ASPERAND'
T_ATTRIBUTE  = 'PHPCS_T_ATTRIBUTE'
T_ATTRIBUTE_END  = 'PHPCS_T_ATTRIBUTE_END'
T_BACKTICK  = 'PHPCS_T_BACKTICK'
T_BAD_CHARACTER  = 'PHPCS_T_BAD_CHARACTER'
T_BINARY_CAST  = 'PHPCS_T_BINARY_CAST'
T_BITWISE_AND  = 'PHPCS_T_BITWISE_AND'
T_BITWISE_NOT  = 'PHPCS_T_BITWISE_NOT'
T_BITWISE_OR  = 'PHPCS_T_BITWISE_OR'
T_BITWISE_XOR  = 'PHPCS_T_BITWISE_XOR'
T_BOOLEAN_NOT  = 'PHPCS_T_BOOLEAN_NOT'
T_CLOSE_CURLY_BRACKET  = 'PHPCS_T_CLOSE_CURLY_BRACKET'
T_CLOSE_PARENTHESIS  = 'PHPCS_T_CLOSE_PARENTHESIS'
T_CLOSE_SHORT_ARRAY  = 'PHPCS_T_CLOSE_SHORT_ARRAY'
T_CLOSE_SQUARE_BRACKET  = 'PHPCS_T_CLOSE_SQUARE_BRACKET'
T_CLOSE_USE_GROUP  = 'PHPCS_T_CLOSE_USE_GROUP'
T_CLOSURE  = 'PHPCS_T_CLOSURE'
T_COALESCE_EQUAL  = 'PHPCS_T_COALESCE_EQUAL'
T_COLON  = 'PHPCS_T_COLON'
T_COMMA  = 'PHPCS_T_COMMA'
T_DIVIDE  = 'PHPCS_T_DIVIDE'
T_DOC_COMMENT_CLOSE_TAG  = 'PHPCS_T_DOC_COMMENT_CLOSE_TAG'
T_DOC_COMMENT_OPEN_TAG  = 'PHPCS_T_DOC_COMMENT_OPEN_TAG'
T_DOC_COMMENT_STAR  = 'PHPCS_T_DOC_COMMENT_STAR'
T_DOC_COMMENT_STRING  = 'PHPCS_T_DOC_COMMENT_STRING'
T_DOC_COMMENT_TAG  = 'PHPCS_T_DOC_COMMENT_TAG'
T_DOC_COMMENT_WHITESPACE  = 'PHPCS_T_DOC_COMMENT_WHITESPACE'
T_DOLLAR  = 'PHPCS_T_DOLLAR'
T_DOUBLE_QUOTED_STRING  = 'PHPCS_T_DOUBLE_QUOTED_STRING'
T_END_NOWDOC  = 'PHPCS_T_END_NOWDOC'
T_ENUM  = 'PHPCS_T_ENUM'
T_ENUM_CASE  = 'PHPCS_T_ENUM_CASE'
T_EQUAL  = 'PHPCS_T_EQUAL'
T_FALSE  = 'PHPCS_T_FALSE'
T_FN  = 'PHPCS_T_FN'
T_FN_ARROW  = 'PHPCS_T_FN_ARROW'
T_GOTO_COLON  = 'PHPCS_T_GOTO_COLON'
T_GOTO_LABEL  = 'PHPCS_T_GOTO_LABEL'
T_GREATER_THAN  = 'PHPCS_T_GREATER_THAN'
T_HEREDOC  = 'PHPCS_T_HEREDOC'
T_INLINE_ELSE  = 'PHPCS_T_INLINE_ELSE'
T_INLINE_THEN  = 'PHPCS_T_INLINE_THEN'
T_LESS_THAN  = 'PHPCS_T_LESS_THAN'
T_MATCH  = 'PHPCS_T_MATCH'
T_MATCH_ARROW  = 'PHPCS_T_MATCH_ARROW'
T_MATCH_DEFAULT  = 'PHPCS_T_MATCH_DEFAULT'
T_MINUS  = 'PHPCS_T_MINUS'
T_MODULUS  = 'PHPCS_T_MODULUS'
T_MULTIPLY  = 'PHPCS_T_MULTIPLY'
T_NAME_FULLY_QUALIFIED  = 10002
T_NAME_FULLY_QUALIFIED  = 'PHPCS_T_NAME_FULLY_QUALIFIED'
T_NAME_QUALIFIED  = 10001
T_NAME_QUALIFIED  = 'PHPCS_T_NAME_QUALIFIED'
T_NAME_RELATIVE  = 'PHPCS_T_NAME_RELATIVE'
T_NONE  = 'PHPCS_T_NONE'
T_NOWDOC  = 'PHPCS_T_NOWDOC'
T_NULL  = 'PHPCS_T_NULL'
T_NULLABLE  = 'PHPCS_T_NULLABLE'
T_NULLSAFE_OBJECT_OPERATOR  = 'PHPCS_T_NULLSAFE_OBJECT_OPERATOR'
T_OPEN_CURLY_BRACKET  = 'PHPCS_T_OPEN_CURLY_BRACKET'
T_OPEN_PARENTHESIS  = 'PHPCS_T_OPEN_PARENTHESIS'
T_OPEN_SHORT_ARRAY  = 'PHPCS_T_OPEN_SHORT_ARRAY'
T_OPEN_SQUARE_BRACKET  = 'PHPCS_T_OPEN_SQUARE_BRACKET'
T_OPEN_USE_GROUP  = 'PHPCS_T_OPEN_USE_GROUP'
T_PARAM_NAME  = 'PHPCS_T_PARAM_NAME'
T_PARENT  = 'PHPCS_T_PARENT'
T_PHPCS_DISABLE  = 'PHPCS_T_PHPCS_DISABLE'
T_PHPCS_ENABLE  = 'PHPCS_T_PHPCS_ENABLE'
T_PHPCS_IGNORE  = 'PHPCS_T_PHPCS_IGNORE'
T_PHPCS_IGNORE_FILE  = 'PHPCS_T_PHPCS_IGNORE_FILE'
T_PHPCS_SET  = 'PHPCS_T_PHPCS_SET'
T_PLUS  = 'PHPCS_T_PLUS'
T_PRIVATE_SET  = 'PHPCS_T_PRIVATE_SET'
T_PROTECTED_SET  = 'PHPCS_T_PROTECTED_SET'
T_PUBLIC_SET  = 'PHPCS_T_PUBLIC_SET'
T_READONLY  = 'PHPCS_T_READONLY'
T_SELF  = 'PHPCS_T_SELF'
T_SEMICOLON  = 'PHPCS_T_SEMICOLON'
T_START_NOWDOC  = 'PHPCS_T_START_NOWDOC'
T_STRING_CONCAT  = 'PHPCS_T_STRING_CONCAT'
T_TRUE  = 'PHPCS_T_TRUE'
T_TYPE_CLOSE_PARENTHESIS  = 'PHPCS_T_TYPE_CLOSE_PARENTHESIS'
T_TYPE_INTERSECTION  = 'PHPCS_T_TYPE_INTERSECTION'
T_TYPE_OPEN_PARENTHESIS  = 'PHPCS_T_TYPE_OPEN_PARENTHESIS'
T_TYPE_UNION  = 'PHPCS_T_TYPE_UNION'

Functions

url()  : string
Generate a URL with the application base path prepended.
base_path()  : string
Get the configured application base path.
userLogging()  : array<string|int, string>
async()  : Future<string|int, T>
Creates a new fiber to execute the given closure asynchronously. A Future is returned which is completed with the return value of the passed closure or will fail if the closure throws an exception.
now()  : float
Returns the current time relative to an arbitrary point in time.
delay()  : void
Non-blocking sleep for the specified number of seconds.
trapSignal()  : int
Wait for signal(s) in a non-blocking way.
weakClosure()  : TClosure
Returns a Closure that maintains a weak reference to any $this object held by the Closure (a weak-Closure).
awaitFirst()  : T
Unwraps the first completed future.
awaitAny()  : Tv
Awaits the first successfully completed future, ignoring errors.
awaitAnyN()  : array<string|int, mixed>
Awaits the first N successfully completed futures, ignoring errors.
awaitAll()  : array<string|int, mixed>
Awaits all futures to complete or error.
await()  : array<string|int, mixed>
Awaits all futures to complete or aborts if any errors.
pipe()  : int
buffer()  : string
getInputBufferStream()  : ReadableResourceStream
The php://input buffer stream for the process associated with the currently active event loop.
getOutputBufferStream()  : WritableResourceStream
The php://output buffer stream for the process associated with the currently active event loop.
getStdin()  : ReadableResourceStream
The STDIN stream for the process associated with the currently active event loop.
getStdout()  : WritableResourceStream
The STDOUT stream for the process associated with the currently active event loop.
getStderr()  : WritableResourceStream
The STDERR stream for the process associated with the currently active event loop.
split()  : Traversable<int, string>
Splits the stream into chunks based on a delimiter.
splitLines()  : Traversable<int, string>
Splits the stream into lines.
parseLineDelimitedJson()  : Traversable<int, mixed>
dnsResolver()  : DnsResolver
Retrieve the application-wide DNS resolver instance.
createDefaultResolver()  : DnsResolver
Create a new DNS resolver best-suited for the current environment.
resolve()  : array<string|int, mixed>
query()  : array<string|int, mixed>
isValidName()  : bool
Checks whether a string is a valid DNS name.
normalizeName()  : string
Normalizes a DNS name and automatically checks it for validity.
startContext()  : Context<TReceive, TSend>
contextFactory()  : ContextFactory
Gets or sets the global context factory.
flattenThrowableBacktrace()  : array<int, FlattenedTraceEntry>
formatFlattenedBacktrace()  : string
flattenArgument()  : string
readKey()  : string
connect()  : Socket
Note that this is designed to be used in the child process/thread to connect to an IPC socket.
workerPool()  : WorkerPool
Gets or sets the global worker pool.
submit()  : Execution<TReceive, TSend>
getWorker()  : Worker
Gets an available worker from the global worker pool.
createWorker()  : Worker
Creates a worker using the global worker factory.
workerFactory()  : WorkerFactory
Gets or sets the global worker factory.
escapeArgument()  : string
Escapes the command argument for safe inclusion into a Posix shell command string.
encodeUnprintableChars()  : string
listen()  : ResourceServerSocket
Listen for client connections on the specified server address.
bindUdpSocket()  : ResourceUdpSocket
Create a new Datagram (UDP server) on the specified server address.
socketConnector()  : SocketConnector
Set or access the global SocketConnector instance.
connect()  : Socket
Establish a socket connection to the specified URI.
connectTls()  : Socket
Establish a socket connection to the specified URI and enable TLS.
createSocketPair()  : ResourceSocket}
Returns a pair of connected stream socket resources.
hasTlsAlpnSupport()  : bool
hasTlsSecurityLevelSupport()  : bool
fromResourcePeer()  : SocketAddress
fromResourceLocal()  : SocketAddress
fromString()  : SocketAddress
synchronized()  : T
Invokes the given Closure while maintaining a lock from the provided mutex.
createChannelPair()  : Channel}
normalize_name()  : string
describe_type()  : string
Debug function used to describe the provided value type and class.
headers_from_lines()  : array<string|int, mixed>
Parses an array of header lines into an associative array of headers.
debug_resource()  : resource
Returns a debug stream based on the provided variable.
choose_handler()  : callable(RequestInterface, array<string|int, mixed>): PromiseInterface
Chooses and creates a default handler to use based on the environment.
default_user_agent()  : string
Get the default User-Agent string to use with Guzzle.
default_ca_bundle()  : string
Returns the default cacert bundle for the current system.
normalize_header_keys()  : array<string|int, mixed>
Creates an associative array of lowercase header names to the actual header casing.
is_host_in_noproxy()  : bool
Returns true if the provided host matches any of the no proxy areas.
json_decode()  : object|array<string|int, mixed>|string|int|float|bool|null
Wrapper for json_decode that throws when an error occurs.
json_encode()  : string
Wrapper for JSON encoding that throws when an error occurs.
pdfImageExtract()  : mixed
deep_copy()  : mixed
Deep copies the given value.
defineCompatibilityTokens()  : void
assertArrayHasKey()  : void
Asserts that an array has a specified key.
assertArrayNotHasKey()  : void
Asserts that an array does not have a specified key.
assertIsList()  : void
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.
assertIsWritable()  : void
Asserts that a file/dir exists and is writable.
assertIsNotWritable()  : 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.
assertDirectoryIsReadable()  : void
Asserts that a directory exists and is readable.
assertDirectoryIsNotReadable()  : 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.
assertFileExists()  : void
Asserts that a file exists.
assertFileDoesNotExist()  : 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.
assertFileIsWritable()  : void
Asserts that a file exists and is writable.
assertFileIsNotWritable()  : 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.
assertObjectHasProperty()  : void
Asserts that an object has a specified property.
assertObjectNotHasProperty()  : void
Asserts that an object does not have a specified property.
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.
assertDoesNotMatchRegularExpression()  : 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.
assertStringContainsStringIgnoringLineEndings()  : void
assertStringEqualsStringIgnoringLineEndings()  : void
Asserts that two strings are equal except for line endings.
assertFileMatchesFormat()  : void
Asserts that a string matches a given format string.
assertFileMatchesFormatFile()  : void
Asserts that a string matches a given format string.
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.
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
isFalse()  : IsFalse
isJson()  : IsJson
isNull()  : IsNull
isFinite()  : IsFinite
isInfinite()  : IsInfinite
isNan()  : IsNan
containsEqual()  : TraversableContainsEqual
containsIdentical()  : TraversableContainsIdentical
containsOnly()  : TraversableContainsOnly
containsOnlyInstancesOf()  : TraversableContainsOnly
arrayHasKey()  : ArrayHasKey
isList()  : IsList
equalTo()  : IsEqual
equalToCanonicalizing()  : IsEqualCanonicalizing
equalToIgnoringCase()  : IsEqualIgnoringCase
equalToWithDelta()  : IsEqualWithDelta
isEmpty()  : IsEmpty
isWritable()  : IsWritable
isReadable()  : IsReadable
directoryExists()  : DirectoryExists
fileExists()  : FileExists
greaterThan()  : GreaterThan
greaterThanOrEqual()  : LogicalOr
identicalTo()  : IsIdentical
isInstanceOf()  : IsInstanceOf
isType()  : IsType
lessThan()  : LessThan
lessThanOrEqual()  : LogicalOr
matchesRegularExpression()  : RegularExpression
matches()  : StringMatchesFormatDescription
stringStartsWith()  : StringStartsWith
stringContains()  : StringContains
stringEndsWith()  : StringEndsWith
stringEqualsStringIgnoringLineEndings()  : StringEqualsStringIgnoringLineEndings
countOf()  : Count
objectEquals()  : ObjectEquals
callback()  : Callback
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.
returnValue()  : ReturnStub
returnValueMap()  : ReturnValueMap
returnArgument()  : ReturnArgument
returnCallback()  : ReturnCallback
returnSelf()  : ReturnSelf
Returns the current object.
throwException()  : Exception
onConsecutiveCalls()  : ConsecutiveCalls
getallheaders()  : string[string]
Get all HTTP header key/values as an associative array for the current request.
checkRequirements()  : void
Exits if the minimum requirements of PHP_CodeSniffer are not met.
trigger_deprecation()  : void
Triggers a silenced deprecation notice.
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
grapheme_extract()  : mixed
grapheme_stripos()  : mixed
grapheme_stristr()  : mixed
grapheme_strlen()  : mixed
grapheme_strpos()  : mixed
grapheme_strripos()  : mixed
grapheme_strrpos()  : mixed
grapheme_strstr()  : mixed
grapheme_substr()  : mixed
grapheme_str_split()  : mixed
grapheme_str_split()  : array<string|int, mixed>|false
grapheme_extract()  : string|false
grapheme_stripos()  : int|false
grapheme_stristr()  : string|false
grapheme_strlen()  : int|false|null
grapheme_strpos()  : int|false
grapheme_strripos()  : int|false
grapheme_strrpos()  : int|false
grapheme_strstr()  : string|false
grapheme_substr()  : string|false
normalizer_is_normalized()  : mixed
normalizer_normalize()  : mixed
normalizer_is_normalized()  : bool
normalizer_normalize()  : string|false
mb_convert_encoding()  : mixed
mb_decode_mimeheader()  : mixed
mb_encode_mimeheader()  : mixed
mb_decode_numericentity()  : mixed
mb_encode_numericentity()  : mixed
mb_convert_case()  : mixed
mb_internal_encoding()  : mixed
mb_language()  : mixed
mb_list_encodings()  : mixed
mb_encoding_aliases()  : mixed
mb_check_encoding()  : mixed
mb_detect_encoding()  : mixed
mb_detect_order()  : mixed
mb_parse_str()  : mixed
mb_strlen()  : mixed
mb_strpos()  : mixed
mb_strtolower()  : mixed
mb_strtoupper()  : mixed
mb_substitute_character()  : mixed
mb_substr()  : mixed
mb_stripos()  : mixed
mb_stristr()  : mixed
mb_strrchr()  : mixed
mb_strrichr()  : mixed
mb_strripos()  : mixed
mb_strrpos()  : mixed
mb_strstr()  : mixed
mb_get_info()  : mixed
mb_http_output()  : mixed
mb_strwidth()  : mixed
mb_substr_count()  : mixed
mb_output_handler()  : mixed
mb_http_input()  : mixed
mb_convert_variables()  : mixed
mb_ord()  : mixed
mb_chr()  : mixed
mb_scrub()  : mixed
mb_str_split()  : mixed
mb_str_pad()  : string
mb_ucfirst()  : string
mb_lcfirst()  : string
mb_trim()  : string
mb_ltrim()  : string
mb_rtrim()  : string
mb_convert_encoding()  : array<string|int, mixed>|string|false
mb_decode_mimeheader()  : string
mb_encode_mimeheader()  : string
mb_decode_numericentity()  : string
mb_encode_numericentity()  : string
mb_convert_case()  : string
mb_internal_encoding()  : string|bool
mb_language()  : string|bool
mb_list_encodings()  : array<string|int, mixed>
mb_encoding_aliases()  : array<string|int, mixed>
mb_check_encoding()  : bool
mb_detect_encoding()  : string|false
mb_detect_order()  : array<string|int, mixed>|bool
mb_parse_str()  : bool
mb_strlen()  : int
mb_strpos()  : int|false
mb_strtolower()  : string
mb_strtoupper()  : string
mb_substitute_character()  : string|int|bool
mb_substr()  : string
mb_stripos()  : int|false
mb_stristr()  : string|false
mb_strrchr()  : string|false
mb_strrichr()  : string|false
mb_strripos()  : int|false
mb_strrpos()  : int|false
mb_strstr()  : string|false
mb_get_info()  : array<string|int, mixed>|string|int|false|null
mb_http_output()  : string|bool
mb_strwidth()  : int
mb_substr_count()  : int
mb_output_handler()  : string
mb_http_input()  : array<string|int, mixed>|string|false
mb_convert_variables()  : string|false
mb_ord()  : int|false
mb_chr()  : string|false
mb_scrub()  : string
mb_str_split()  : array<string|int, mixed>
mb_str_pad()  : string
mb_ucfirst()  : string
mb_lcfirst()  : string
mb_trim()  : string
mb_ltrim()  : string
mb_rtrim()  : string
fdiv()  : float
preg_last_error_msg()  : string
str_contains()  : bool
str_starts_with()  : bool
str_ends_with()  : bool
get_debug_type()  : string
get_resource_id()  : int
u()  : UnicodeString
b()  : ByteString
s()  : UnicodeString|ByteString

Constants

BIN_DIR

public mixed BIN_DIR = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'bin'

CONNECTION_BUSY

public mixed CONNECTION_BUSY = \defined('SOCKET_EAGAIN') ? \SOCKET_EAGAIN : 11

CONNECTION_REFUSED

public mixed CONNECTION_REFUSED = \defined('SOCKET_ECONNREFUSED') ? \SOCKET_ECONNREFUSED : 111

CONNECTION_TIMEOUT

public mixed CONNECTION_TIMEOUT = \defined('SOCKET_ETIMEDOUT') ? \SOCKET_ETIMEDOUT : 110

FILTER_VALIDATE_BOOL

public mixed FILTER_VALIDATE_BOOL = \FILTER_VALIDATE_BOOLEAN

GRAPHEME_EXTR_COUNT

public mixed GRAPHEME_EXTR_COUNT = 0

GRAPHEME_EXTR_COUNT

public mixed GRAPHEME_EXTR_COUNT = 0

GRAPHEME_EXTR_MAXBYTES

public mixed GRAPHEME_EXTR_MAXBYTES = 1

GRAPHEME_EXTR_MAXBYTES

public mixed GRAPHEME_EXTR_MAXBYTES = 1

GRAPHEME_EXTR_MAXCHARS

public mixed GRAPHEME_EXTR_MAXCHARS = 2

GRAPHEME_EXTR_MAXCHARS

public mixed GRAPHEME_EXTR_MAXCHARS = 2

IS_WINDOWS

public mixed IS_WINDOWS = \PHP_OS_FAMILY === 'Windows'

LWT_BASE_PATH

LWT Front Controller

public mixed LWT_BASE_PATH = __DIR__

This file serves as the single entry point for all requests. It bootstraps the application and delegates to the Application class.

PHP version 8.1

Tags
category

User_Interface

author

LWT Project lwt-project@hotmail.com

license

Unlicense http://unlicense.org/

link
https://hugofara.github.io/lwt/docs/php/files/index.html
since
3.0.0

"Learning with Texts" (LWT) is free and unencumbered software released into the PUBLIC DOMAIN.

MB_CASE_LOWER

public mixed MB_CASE_LOWER = 1

MB_CASE_TITLE

public mixed MB_CASE_TITLE = 2

MB_CASE_UPPER

public mixed MB_CASE_UPPER = 0

PDF

public mixed PDF = __DIR__ . '/tests/media/example.pdf'

PHP_CODESNIFFER_CBF

public mixed PHP_CODESNIFFER_CBF = false

PHP_CODESNIFFER_CBF

public mixed PHP_CODESNIFFER_CBF = \false

PHP_CODESNIFFER_IN_TESTS

public mixed PHP_CODESNIFFER_IN_TESTS = \true

PHP_CODESNIFFER_VERBOSITY

public mixed PHP_CODESNIFFER_VERBOSITY = $this->config->verbosity

PHP_CODESNIFFER_VERBOSITY

public mixed PHP_CODESNIFFER_VERBOSITY = 0

PHP_PARSER_VERSION

public mixed PHP_PARSER_VERSION = VersionUtils::getPhpParserVersion()

PSALM_VERSION

public mixed PSALM_VERSION = VersionUtils::getPsalmVersion()

STDERR

public mixed STDERR = \fopen('php://stderr', 'wb')

STDOUT

public mixed STDOUT = \fopen('php://stdout', 'wb')

SYMFONY_GRAPHEME_CLUSTER_RX

public mixed SYMFONY_GRAPHEME_CLUSTER_RX = ((float) \PCRE_VERSION < 10 ? (float) \PCRE_VERSION >= 8.32 : (float) \PCRE_VERSION >= 10.39) ? '\X' : \Symfony\Polyfill\Intl\Grapheme\Grapheme::GRAPHEME_CLUSTER_RX

T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG

public mixed T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG = 'PHPCS_T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG'

T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG

public mixed T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG = 'PHPCS_T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG'

T_ANON_CLASS

public mixed T_ANON_CLASS = 'PHPCS_T_ANON_CLASS'

T_ASPERAND

public mixed T_ASPERAND = 'PHPCS_T_ASPERAND'

T_ATTRIBUTE

public mixed T_ATTRIBUTE = 'PHPCS_T_ATTRIBUTE'

T_ATTRIBUTE_END

public mixed T_ATTRIBUTE_END = 'PHPCS_T_ATTRIBUTE_END'

T_BACKTICK

public mixed T_BACKTICK = 'PHPCS_T_BACKTICK'

T_BAD_CHARACTER

public mixed T_BAD_CHARACTER = 'PHPCS_T_BAD_CHARACTER'

T_BINARY_CAST

public mixed T_BINARY_CAST = 'PHPCS_T_BINARY_CAST'

T_BITWISE_AND

public mixed T_BITWISE_AND = 'PHPCS_T_BITWISE_AND'

T_BITWISE_NOT

public mixed T_BITWISE_NOT = 'PHPCS_T_BITWISE_NOT'

T_BITWISE_OR

public mixed T_BITWISE_OR = 'PHPCS_T_BITWISE_OR'

T_BITWISE_XOR

public mixed T_BITWISE_XOR = 'PHPCS_T_BITWISE_XOR'

T_BOOLEAN_NOT

public mixed T_BOOLEAN_NOT = 'PHPCS_T_BOOLEAN_NOT'

T_CLOSE_CURLY_BRACKET

public mixed T_CLOSE_CURLY_BRACKET = 'PHPCS_T_CLOSE_CURLY_BRACKET'

T_CLOSE_PARENTHESIS

public mixed T_CLOSE_PARENTHESIS = 'PHPCS_T_CLOSE_PARENTHESIS'

T_CLOSE_SHORT_ARRAY

public mixed T_CLOSE_SHORT_ARRAY = 'PHPCS_T_CLOSE_SHORT_ARRAY'

T_CLOSE_SQUARE_BRACKET

public mixed T_CLOSE_SQUARE_BRACKET = 'PHPCS_T_CLOSE_SQUARE_BRACKET'

T_CLOSE_USE_GROUP

public mixed T_CLOSE_USE_GROUP = 'PHPCS_T_CLOSE_USE_GROUP'

T_CLOSURE

public mixed T_CLOSURE = 'PHPCS_T_CLOSURE'

T_COALESCE_EQUAL

public mixed T_COALESCE_EQUAL = 'PHPCS_T_COALESCE_EQUAL'

T_COLON

public mixed T_COLON = 'PHPCS_T_COLON'

T_COMMA

public mixed T_COMMA = 'PHPCS_T_COMMA'

T_DIVIDE

public mixed T_DIVIDE = 'PHPCS_T_DIVIDE'

T_DOC_COMMENT_CLOSE_TAG

public mixed T_DOC_COMMENT_CLOSE_TAG = 'PHPCS_T_DOC_COMMENT_CLOSE_TAG'

T_DOC_COMMENT_OPEN_TAG

public mixed T_DOC_COMMENT_OPEN_TAG = 'PHPCS_T_DOC_COMMENT_OPEN_TAG'

T_DOC_COMMENT_STAR

public mixed T_DOC_COMMENT_STAR = 'PHPCS_T_DOC_COMMENT_STAR'

T_DOC_COMMENT_STRING

public mixed T_DOC_COMMENT_STRING = 'PHPCS_T_DOC_COMMENT_STRING'

T_DOC_COMMENT_TAG

public mixed T_DOC_COMMENT_TAG = 'PHPCS_T_DOC_COMMENT_TAG'

T_DOC_COMMENT_WHITESPACE

public mixed T_DOC_COMMENT_WHITESPACE = 'PHPCS_T_DOC_COMMENT_WHITESPACE'

T_DOLLAR

public mixed T_DOLLAR = 'PHPCS_T_DOLLAR'

T_DOUBLE_QUOTED_STRING

public mixed T_DOUBLE_QUOTED_STRING = 'PHPCS_T_DOUBLE_QUOTED_STRING'

T_END_NOWDOC

public mixed T_END_NOWDOC = 'PHPCS_T_END_NOWDOC'

T_ENUM

public mixed T_ENUM = 'PHPCS_T_ENUM'

T_ENUM_CASE

public mixed T_ENUM_CASE = 'PHPCS_T_ENUM_CASE'

T_EQUAL

public mixed T_EQUAL = 'PHPCS_T_EQUAL'

T_FALSE

public mixed T_FALSE = 'PHPCS_T_FALSE'

T_FN

public mixed T_FN = 'PHPCS_T_FN'

T_FN_ARROW

public mixed T_FN_ARROW = 'PHPCS_T_FN_ARROW'

T_GOTO_COLON

public mixed T_GOTO_COLON = 'PHPCS_T_GOTO_COLON'

T_GOTO_LABEL

public mixed T_GOTO_LABEL = 'PHPCS_T_GOTO_LABEL'

T_GREATER_THAN

public mixed T_GREATER_THAN = 'PHPCS_T_GREATER_THAN'

T_HEREDOC

public mixed T_HEREDOC = 'PHPCS_T_HEREDOC'

T_INLINE_ELSE

public mixed T_INLINE_ELSE = 'PHPCS_T_INLINE_ELSE'

T_INLINE_THEN

public mixed T_INLINE_THEN = 'PHPCS_T_INLINE_THEN'

T_LESS_THAN

public mixed T_LESS_THAN = 'PHPCS_T_LESS_THAN'

T_MATCH

public mixed T_MATCH = 'PHPCS_T_MATCH'

T_MATCH_ARROW

public mixed T_MATCH_ARROW = 'PHPCS_T_MATCH_ARROW'

T_MATCH_DEFAULT

public mixed T_MATCH_DEFAULT = 'PHPCS_T_MATCH_DEFAULT'

T_MINUS

public mixed T_MINUS = 'PHPCS_T_MINUS'

T_MODULUS

public mixed T_MODULUS = 'PHPCS_T_MODULUS'

T_MULTIPLY

public mixed T_MULTIPLY = 'PHPCS_T_MULTIPLY'

T_NAME_FULLY_QUALIFIED

public mixed T_NAME_FULLY_QUALIFIED = 10002

T_NAME_FULLY_QUALIFIED

public mixed T_NAME_FULLY_QUALIFIED = 'PHPCS_T_NAME_FULLY_QUALIFIED'

T_NAME_QUALIFIED

public mixed T_NAME_QUALIFIED = 'PHPCS_T_NAME_QUALIFIED'

T_NAME_RELATIVE

public mixed T_NAME_RELATIVE = 'PHPCS_T_NAME_RELATIVE'

T_NONE

public mixed T_NONE = 'PHPCS_T_NONE'

T_NOWDOC

public mixed T_NOWDOC = 'PHPCS_T_NOWDOC'

T_NULL

public mixed T_NULL = 'PHPCS_T_NULL'

T_NULLABLE

public mixed T_NULLABLE = 'PHPCS_T_NULLABLE'

T_NULLSAFE_OBJECT_OPERATOR

public mixed T_NULLSAFE_OBJECT_OPERATOR = 'PHPCS_T_NULLSAFE_OBJECT_OPERATOR'

T_OPEN_CURLY_BRACKET

public mixed T_OPEN_CURLY_BRACKET = 'PHPCS_T_OPEN_CURLY_BRACKET'

T_OPEN_PARENTHESIS

public mixed T_OPEN_PARENTHESIS = 'PHPCS_T_OPEN_PARENTHESIS'

T_OPEN_SHORT_ARRAY

public mixed T_OPEN_SHORT_ARRAY = 'PHPCS_T_OPEN_SHORT_ARRAY'

T_OPEN_SQUARE_BRACKET

public mixed T_OPEN_SQUARE_BRACKET = 'PHPCS_T_OPEN_SQUARE_BRACKET'

T_OPEN_USE_GROUP

public mixed T_OPEN_USE_GROUP = 'PHPCS_T_OPEN_USE_GROUP'

T_PARAM_NAME

public mixed T_PARAM_NAME = 'PHPCS_T_PARAM_NAME'

T_PARENT

public mixed T_PARENT = 'PHPCS_T_PARENT'

T_PHPCS_DISABLE

public mixed T_PHPCS_DISABLE = 'PHPCS_T_PHPCS_DISABLE'

T_PHPCS_ENABLE

public mixed T_PHPCS_ENABLE = 'PHPCS_T_PHPCS_ENABLE'

T_PHPCS_IGNORE

public mixed T_PHPCS_IGNORE = 'PHPCS_T_PHPCS_IGNORE'

T_PHPCS_IGNORE_FILE

public mixed T_PHPCS_IGNORE_FILE = 'PHPCS_T_PHPCS_IGNORE_FILE'

T_PHPCS_SET

public mixed T_PHPCS_SET = 'PHPCS_T_PHPCS_SET'

T_PLUS

public mixed T_PLUS = 'PHPCS_T_PLUS'

T_PRIVATE_SET

public mixed T_PRIVATE_SET = 'PHPCS_T_PRIVATE_SET'

T_PROTECTED_SET

public mixed T_PROTECTED_SET = 'PHPCS_T_PROTECTED_SET'

T_PUBLIC_SET

public mixed T_PUBLIC_SET = 'PHPCS_T_PUBLIC_SET'

T_READONLY

public mixed T_READONLY = 'PHPCS_T_READONLY'

T_SELF

public mixed T_SELF = 'PHPCS_T_SELF'

T_SEMICOLON

public mixed T_SEMICOLON = 'PHPCS_T_SEMICOLON'

T_START_NOWDOC

public mixed T_START_NOWDOC = 'PHPCS_T_START_NOWDOC'

T_STRING_CONCAT

public mixed T_STRING_CONCAT = 'PHPCS_T_STRING_CONCAT'

T_TRUE

public mixed T_TRUE = 'PHPCS_T_TRUE'

T_TYPE_CLOSE_PARENTHESIS

public mixed T_TYPE_CLOSE_PARENTHESIS = 'PHPCS_T_TYPE_CLOSE_PARENTHESIS'

T_TYPE_INTERSECTION

public mixed T_TYPE_INTERSECTION = 'PHPCS_T_TYPE_INTERSECTION'

T_TYPE_OPEN_PARENTHESIS

public mixed T_TYPE_OPEN_PARENTHESIS = 'PHPCS_T_TYPE_OPEN_PARENTHESIS'

T_TYPE_UNION

public mixed T_TYPE_UNION = 'PHPCS_T_TYPE_UNION'

Functions

url()

Generate a URL with the application base path prepended.

url([string $path = '/' ]) : string

Use this for all internal links to ensure they work correctly when the application is installed in a subdirectory.

Parameters
$path : string = '/'

The path to generate URL for (should start with /)

Tags
example

url('/login') returns '/lwt/login' if APP_BASE_PATH=/lwt

example

url('/') returns '/lwt' if APP_BASE_PATH=/lwt

example

url('/assets/css/main.css') returns '/lwt/assets/css/main.css'

Return values
string

The full URL path with base path prepended

base_path()

Get the configured application base path.

base_path() : string
Return values
string

The base path (e.g., '/lwt') or empty string for root

userLogging()

userLogging() : array<string|int, string>
Tags
psalm-return

list{string, string, string, string}

Return values
array<string|int, string>

async()

Creates a new fiber to execute the given closure asynchronously. A Future is returned which is completed with the return value of the passed closure or will fail if the closure throws an exception.

async(Closure $closure, mixed ...$args) : Future<string|int, T>
Parameters
$closure : Closure
$args : mixed

Arguments forwarded to the closure when starting the fiber.

Tags
template
Return values
Future<string|int, T>

now()

Returns the current time relative to an arbitrary point in time.

now() : float
Return values
float

Time in seconds.

delay()

Non-blocking sleep for the specified number of seconds.

delay(float $timeout[, bool $reference = true ][, Cancellation|null $cancellation = null ]) : void
Parameters
$timeout : float

Number of seconds to wait.

$reference : bool = true

If false, unreference the underlying watcher.

$cancellation : Cancellation|null = null

Cancel waiting if cancellation is requested.

trapSignal()

Wait for signal(s) in a non-blocking way.

trapSignal(int|array<string|int, int> $signals[, bool $reference = true ][, Cancellation|null $cancellation = null ]) : int
Parameters
$signals : int|array<string|int, int>

Signal number or array of signal numbers.

$reference : bool = true

If false, unreference the underlying watcher.

$cancellation : Cancellation|null = null

Cancel waiting if cancellation is requested.

Tags
throws
UnsupportedFeatureException
Return values
int

Caught signal number.

weakClosure()

Returns a Closure that maintains a weak reference to any $this object held by the Closure (a weak-Closure).

weakClosure(TClosure $closure) : TClosure

This allows a class to hold a self-referencing Closure without creating a circular reference that would prevent or delay automatic garbage collection. Invoking the returned Closure after the object is destroyed will throw an instance of Error.

Parameters
$closure : TClosure
Tags
template
Return values
TClosure

awaitFirst()

Unwraps the first completed future.

awaitFirst(iterable<string|int, Future<string|int, T>> $futures[, Cancellation|null $cancellation = null ]) : T

If you want the first future completed without an error, use awaitAny() instead.

Parameters
$futures : iterable<string|int, Future<string|int, T>>
$cancellation : Cancellation|null = null

Optional cancellation.

Tags
template
throws
CompositeLengthException

If $futures is empty.

Return values
T

awaitAny()

Awaits the first successfully completed future, ignoring errors.

awaitAny(iterable<Tk, Future<string|int, Tv>> $futures[, Cancellation|null $cancellation = null ]) : Tv

If you want the first future completed, successful or not, use awaitFirst() instead.

Parameters
$futures : iterable<Tk, Future<string|int, Tv>>
$cancellation : Cancellation|null = null

Optional cancellation.

Tags
template
template
throws
CompositeException

If all futures errored.

throws
CompositeLengthException

If $futures is empty.

Return values
Tv

awaitAnyN()

Awaits the first N successfully completed futures, ignoring errors.

awaitAnyN(positive-int $count, iterable<Tk, Future<string|int, Tv>> $futures[, Cancellation|null $cancellation = null ]) : array<string|int, mixed>
Parameters
$count : positive-int
$futures : iterable<Tk, Future<string|int, Tv>>
$cancellation : Cancellation|null = null

Optional cancellation.

Tags
template
template
throws
CompositeException

If too many futures errored.

throws
CompositeLengthException

If $futures is empty.

Return values
array<string|int, mixed>

awaitAll()

Awaits all futures to complete or error.

awaitAll(iterable<Tk, Future<string|int, Tv>> $futures[, Cancellation|null $cancellation = null ]) : array<string|int, mixed>

This awaits all futures without aborting on first error (unlike await()).

Parameters
$futures : iterable<Tk, Future<string|int, Tv>>
$cancellation : Cancellation|null = null

Optional cancellation.

Tags
template
template
Return values
array<string|int, mixed>

await()

Awaits all futures to complete or aborts if any errors.

await(iterable<Tk, Future<string|int, Tv>> $futures[, Cancellation|null $cancellation = null ]) : array<string|int, mixed>

The returned array keys will be in the order the futures resolved, not in the order given by the iterable. Sort the array after completion if necessary.

This is equivalent to awaiting all futures in a loop, except that it aborts as soon as one of the futures errors instead of relying on the order in the iterable and awaiting the futures sequentially.

Parameters
$futures : iterable<Tk, Future<string|int, Tv>>
$cancellation : Cancellation|null = null

Optional cancellation.

Tags
template
template
Return values
array<string|int, mixed>

split()

Splits the stream into chunks based on a delimiter.

split(ReadableStream $source, non-empty-string $delimiter[, Cancellation|null $cancellation = null ]) : Traversable<int, string>
Parameters
$source : ReadableStream
$delimiter : non-empty-string
$cancellation : Cancellation|null = null
Return values
Traversable<int, string>

parseLineDelimitedJson()

parseLineDelimitedJson(ReadableStream $source[, bool $associative = false ][, int<1, 2147483647> $depth = 512 ][, int $flags = 0 ][, Cancellation|null $cancellation = null ]) : Traversable<int, mixed>
Parameters
$source : ReadableStream
$associative : bool = false
$depth : int<1, 2147483647> = 512
$flags : int = 0
$cancellation : Cancellation|null = null
Tags
throws
JsonException

If JSON parsing fails

Return values
Traversable<int, mixed>

Traversable of decoded JSON values

dnsResolver()

Retrieve the application-wide DNS resolver instance.

dnsResolver([DnsResolver|null $dnsResolver = null ]) : DnsResolver
Parameters
$dnsResolver : DnsResolver|null = null

Optionally specify a new default DNS resolver instance

Return values
DnsResolver

Returns the application-wide DNS resolver instance

createDefaultResolver()

Create a new DNS resolver best-suited for the current environment.

createDefaultResolver() : DnsResolver
Return values
DnsResolver

resolve()

resolve(string $name[, int|null $typeRestriction = null ][, Cancellation|null $cancellation = null ]) : array<string|int, mixed>
Parameters
$name : string
$typeRestriction : int|null = null
$cancellation : Cancellation|null = null
Tags
throws
DnsException
see
DnsResolver::resolve()
Return values
array<string|int, mixed>

isValidName()

Checks whether a string is a valid DNS name.

isValidName(string $name) : bool
Parameters
$name : string

String to check.

Return values
bool

normalizeName()

Normalizes a DNS name and automatically checks it for validity.

normalizeName(string $name) : string
Parameters
$name : string

DNS name.

Tags
throws
InvalidNameException

If an invalid name or an IDN name without ext/intl being installed has been passed.

Return values
string

Normalized DNS name.

startContext()

startContext(string|array<int, string> $script[, Cancellation|null $cancellation = null ]) : Context<TReceive, TSend>
Parameters
$script : string|array<int, string>

Path to PHP script or array with first element as path and following elements as options to the PHP script (e.g.: ['bin/worker', 'Option1Value', 'Option2Value'].

$cancellation : Cancellation|null = null
Tags
template
template
template
Return values
Context<TReceive, TSend>

flattenThrowableBacktrace()

flattenThrowableBacktrace(Throwable $exception) : array<int, FlattenedTraceEntry>
Parameters
$exception : Throwable
Tags
psalm-type

FlattenedTraceEntry = array<non-empty-string, scalar|list>

Return values
array<int, FlattenedTraceEntry>

Serializable exception backtrace, with all function arguments flattened to strings.

formatFlattenedBacktrace()

formatFlattenedBacktrace(array<string|int, mixed> $trace) : string
Parameters
$trace : array<string|int, mixed>

Backtrace produced by flattenThrowableBacktrace().

Return values
string

flattenArgument()

flattenArgument(mixed $value) : string
Parameters
$value : mixed
Return values
string

Serializable string representation of $value for backtraces.

connect()

Note that this is designed to be used in the child process/thread to connect to an IPC socket.

connect(string $uri, string $key[, Cancellation|null $cancellation = null ][, SocketConnector|null $connector = null ]) : Socket
Parameters
$uri : string
$key : string
$cancellation : Cancellation|null = null
$connector : SocketConnector|null = null
Return values
Socket

submit()

submit(Task<TReceive, TSend$task[, Cancellation|null $cancellation = null ]) : Execution<TReceive, TSend>
Parameters
$task : Task<TReceive, TSend>

The task to execute.

$cancellation : Cancellation|null = null

Token to request cancellation. The task must support cancellation for this to have any effect.

Tags
template
template
template

Executes a Task on the global worker pool.

Return values
Execution<TReceive, TSend>

getWorker()

Gets an available worker from the global worker pool.

getWorker() : Worker
Return values
Worker

createWorker()

Creates a worker using the global worker factory.

createWorker() : Worker
Return values
Worker

escapeArgument()

Escapes the command argument for safe inclusion into a Posix shell command string.

escapeArgument(string $arg) : string
Parameters
$arg : string
Return values
string

encodeUnprintableChars()

encodeUnprintableChars(string $data) : string
Parameters
$data : string

Binary data.

Return values
string

Unprintable characters encoded as \x##.

listen()

Listen for client connections on the specified server address.

listen(SocketAddress|string $address[, BindContext|null $bindContext = null ][, positive-int $chunkSize = ResourceSocket::DEFAULT_CHUNK_SIZE ]) : ResourceServerSocket

If you want to accept TLS connections, you have to use yield $socket->setupTls() after accepting new clients.

Parameters
$address : SocketAddress|string

URI in scheme://host:port format. TCP is assumed if no scheme is present.

$bindContext : BindContext|null = null

Context options for listening.

$chunkSize : positive-int = ResourceSocket::DEFAULT_CHUNK_SIZE

Chunk size for the accepted sockets.

Tags
throws
SocketException

If binding to the specified URI failed.

Return values
ResourceServerSocket

bindUdpSocket()

Create a new Datagram (UDP server) on the specified server address.

bindUdpSocket(InternetAddress|string $address[, BindContext|null $bindContext = null ][, positive-int $limit = ResourceUdpSocket::DEFAULT_LIMIT ]) : ResourceUdpSocket
Parameters
$address : InternetAddress|string

URI in scheme://host:port format. UDP is assumed if no scheme is present.

$bindContext : BindContext|null = null

Context options for listening.

$limit : positive-int = ResourceUdpSocket::DEFAULT_LIMIT

Maximum size for received messages.

Tags
throws
SocketException

If binding to the specified URI failed.

Return values
ResourceUdpSocket

connect()

Establish a socket connection to the specified URI.

connect(SocketAddress|string $uri[, ConnectContext|null $context = null ][, Cancellation|null $cancellation = null ]) : Socket
Parameters
$uri : SocketAddress|string

URI in scheme://host:port format. TCP is assumed if no scheme is present.

$context : ConnectContext|null = null

Socket connect context to use when connecting.

$cancellation : Cancellation|null = null
Tags
throws
ConnectException
throws
CancelledException
Return values
Socket

connectTls()

Establish a socket connection to the specified URI and enable TLS.

connectTls(SocketAddress|string $uri[, ConnectContext|null $context = null ][, Cancellation|null $cancellation = null ]) : Socket
Parameters
$uri : SocketAddress|string

URI in scheme://host:port format. TCP is assumed if no scheme is present.

$context : ConnectContext|null = null

Socket connect context to use when connecting.

$cancellation : Cancellation|null = null
Tags
throws
ConnectException
throws
TlsException
throws
CancelledException
Return values
Socket

hasTlsSecurityLevelSupport()

hasTlsSecurityLevelSupport() : bool
Return values
bool

synchronized()

Invokes the given Closure while maintaining a lock from the provided mutex.

synchronized(Semaphore $semaphore, callable(mixed...): T $synchronized, mixed ...$args) : T

The lock is automatically released after the Closure returns.

Parameters
$semaphore : Semaphore
$synchronized : callable(mixed...): T
$args : mixed
Tags
template
Return values
T

The return value of the Closure.

createChannelPair()

createChannelPair([int $bufferSize = 0 ]) : Channel}
Parameters
$bufferSize : int = 0

Number of channel items to buffer in memory before back-pressure is applied.

Return values
Channel}

normalize_name()

normalize_name(string $label) : string
Parameters
$label : string
Return values
string

describe_type()

Debug function used to describe the provided value type and class.

describe_type will be removed in guzzlehttp/guzzle:8.0. Use Utils::describeType instead.

describe_type(mixed $input) : string
Parameters
$input : mixed

Any type of variable to describe the type of. This parameter misses a typehint because of that.

Return values
string

Returns a string containing the type of the variable and if a class is provided, the class name.

headers_from_lines()

Parses an array of header lines into an associative array of headers.

headers_from_lines will be removed in guzzlehttp/guzzle:8.0. Use Utils::headersFromLines instead.

headers_from_lines(iterable<string|int, mixed> $lines) : array<string|int, mixed>
Parameters
$lines : iterable<string|int, mixed>

Header lines array of strings in the following format: "Name: Value"

Return values
array<string|int, mixed>

debug_resource()

Returns a debug stream based on the provided variable.

debug_resource will be removed in guzzlehttp/guzzle:8.0. Use Utils::debugResource instead.

debug_resource([mixed $value = null ]) : resource
Parameters
$value : mixed = null

Optional value

Return values
resource

choose_handler()

Chooses and creates a default handler to use based on the environment.

choose_handler will be removed in guzzlehttp/guzzle:8.0. Use Utils::chooseHandler instead.

choose_handler() : callable(RequestInterface, array<string|int, mixed>): PromiseInterface

The returned handler is not wrapped by any default middlewares.

Tags
throws
RuntimeException

if no viable Handler is available.

Return values
callable(RequestInterface, array<string|int, mixed>): PromiseInterface

Returns the best handler for the given system.

default_user_agent()

Get the default User-Agent string to use with Guzzle.

default_user_agent will be removed in guzzlehttp/guzzle:8.0. Use Utils::defaultUserAgent instead.

default_user_agent() : string
Return values
string

default_ca_bundle()

Returns the default cacert bundle for the current system.

default_ca_bundle will be removed in guzzlehttp/guzzle:8.0. This function is not needed in PHP 5.6+.

default_ca_bundle() : string

First, the openssl.cafile and curl.cainfo php.ini settings are checked. If those settings are not configured, then the common locations for bundles found on Red Hat, CentOS, Fedora, Ubuntu, Debian, FreeBSD, OS X and Windows are checked. If any of these file locations are found on disk, they will be utilized.

Note: the result of this function is cached for subsequent calls.

Tags
throws
RuntimeException

if no bundle can be found.

Return values
string

normalize_header_keys()

Creates an associative array of lowercase header names to the actual header casing.

normalize_header_keys will be removed in guzzlehttp/guzzle:8.0. Use Utils::normalizeHeaderKeys instead.

normalize_header_keys(array<string|int, mixed> $headers) : array<string|int, mixed>
Parameters
$headers : array<string|int, mixed>
Return values
array<string|int, mixed>

is_host_in_noproxy()

Returns true if the provided host matches any of the no proxy areas.

is_host_in_noproxy will be removed in guzzlehttp/guzzle:8.0. Use Utils::isHostInNoProxy instead.

is_host_in_noproxy(string $host, array<string|int, string> $noProxyArray) : bool

This method will strip a port from the host if it is present. Each pattern can be matched with an exact match (e.g., "foo.com" == "foo.com") or a partial match: (e.g., "foo.com" == "baz.foo.com" and ".foo.com" == "baz.foo.com", but ".foo.com" != "foo.com").

Areas are matched in the following cases:

  1. "*" (without quotes) always matches any hosts.
  2. An exact match.
  3. The area starts with "." and the area is the last part of the host. e.g. '.mit.edu' will match any host that ends with '.mit.edu'.
Parameters
$host : string

Host to check against the patterns.

$noProxyArray : array<string|int, string>

An array of host patterns.

Tags
throws
InvalidArgumentException
Return values
bool

json_decode()

Wrapper for json_decode that throws when an error occurs.

json_decode will be removed in guzzlehttp/guzzle:8.0. Use Utils::jsonDecode instead.

json_decode(string $json[, bool $assoc = false ][, int $depth = 512 ][, int $options = 0 ]) : object|array<string|int, mixed>|string|int|float|bool|null
Parameters
$json : string

JSON data to parse

$assoc : bool = false

When true, returned objects will be converted into associative arrays.

$depth : int = 512

User specified recursion depth.

$options : int = 0

Bitmask of JSON decode options.

Tags
throws
InvalidArgumentException

if the JSON cannot be decoded.

see
https://www.php.net/manual/en/function.json-decode.php
Return values
object|array<string|int, mixed>|string|int|float|bool|null

json_encode()

Wrapper for JSON encoding that throws when an error occurs.

json_encode will be removed in guzzlehttp/guzzle:8.0. Use Utils::jsonEncode instead.

json_encode(mixed $value[, int $options = 0 ][, int $depth = 512 ]) : string
Parameters
$value : mixed

The value being encoded

$options : int = 0

JSON encode option bitmask

$depth : int = 512

Set the maximum depth. Must be greater than zero.

Tags
throws
InvalidArgumentException

if the JSON cannot be encoded.

see
https://www.php.net/manual/en/function.json-encode.php
Return values
string

deep_copy()

Deep copies the given value.

deep_copy(mixed $value[, bool $useCloneMethod = false ]) : mixed
Parameters
$value : mixed
$useCloneMethod : bool = false

assertArrayHasKey()

Asserts that an array has a specified key.

assertArrayHasKey(mixed $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
$key : mixed
$array : array<string|int, mixed>|ArrayAccess
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertArrayHasKey

assertArrayNotHasKey()

Asserts that an array does not have a specified key.

assertArrayNotHasKey(mixed $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
$key : mixed
$array : array<string|int, mixed>|ArrayAccess
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertArrayNotHasKey

assertIsList()

assertIsList(mixed $array[, string $message = '' ]) : void
Parameters
$array : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsList

assertContains()

Asserts that a haystack contains a needle.

assertContains(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContains

assertContainsEquals()

assertContainsEquals(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContainsEquals

assertNotContains()

Asserts that a haystack does not contain a needle.

assertNotContains(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotContains

assertNotContainsEquals()

assertNotContainsEquals(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$needle : mixed
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotContainsEquals

assertContainsOnly()

Asserts that a haystack contains only values of a given type.

assertContainsOnly(string $type, iterable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
$type : string
$haystack : iterable<string|int, mixed>
$isNativeType : bool|null = null
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContainsOnly

assertContainsOnlyInstancesOf()

Asserts that a haystack contains only instances of a given class name.

assertContainsOnlyInstancesOf(string $className, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$className : string
$haystack : iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertContainsOnlyInstancesOf

assertNotContainsOnly()

Asserts that a haystack does not contain only values of a given type.

assertNotContainsOnly(string $type, iterable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
$type : string
$haystack : iterable<string|int, mixed>
$isNativeType : bool|null = null
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotContainsOnly

assertCount()

Asserts the number of elements of an array, Countable or Traversable.

assertCount(int $expectedCount, Countable|iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$expectedCount : int
$haystack : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertCount

assertNotCount()

Asserts the number of elements of an array, Countable or Traversable.

assertNotCount(int $expectedCount, Countable|iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
$expectedCount : int
$haystack : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotCount

assertEquals()

Asserts that two variables are equal.

assertEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEquals

assertEqualsCanonicalizing()

Asserts that two variables are equal (canonicalizing).

assertEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEqualsCanonicalizing

assertEqualsIgnoringCase()

Asserts that two variables are equal (ignoring case).

assertEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEqualsIgnoringCase

assertEqualsWithDelta()

Asserts that two variables are equal (with delta).

assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$delta : float
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEqualsWithDelta

assertNotEquals()

Asserts that two variables are not equal.

assertNotEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEquals

assertNotEqualsCanonicalizing()

Asserts that two variables are not equal (canonicalizing).

assertNotEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEqualsCanonicalizing

assertNotEqualsIgnoringCase()

Asserts that two variables are not equal (ignoring case).

assertNotEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEqualsIgnoringCase

assertNotEqualsWithDelta()

Asserts that two variables are not equal (with delta).

assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$delta : float
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEqualsWithDelta

assertObjectEquals()

assertObjectEquals(object $expected, object $actual[, string $method = 'equals' ][, string $message = '' ]) : void
Parameters
$expected : object
$actual : object
$method : string = 'equals'
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertObjectEquals

assertEmpty()

Asserts that a variable is empty.

assertEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
psalm-assert

empty $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertEmpty

assertNotEmpty()

Asserts that a variable is not empty.

assertNotEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
psalm-assert

!empty $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotEmpty

assertGreaterThan()

Asserts that a value is greater than another value.

assertGreaterThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertGreaterThan

assertGreaterThanOrEqual()

Asserts that a value is greater than or equal to another value.

assertGreaterThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertGreaterThanOrEqual

assertLessThan()

Asserts that a value is smaller than another value.

assertLessThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertLessThan

assertLessThanOrEqual()

Asserts that a value is smaller than or equal to another value.

assertLessThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertLessThanOrEqual

assertFileEquals()

Asserts that the contents of one file is equal to the contents of another file.

assertFileEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileEquals

assertFileEqualsCanonicalizing()

Asserts that the contents of one file is equal to the contents of another file (canonicalizing).

assertFileEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileEqualsCanonicalizing

assertFileEqualsIgnoringCase()

Asserts that the contents of one file is equal to the contents of another file (ignoring case).

assertFileEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileEqualsIgnoringCase

assertFileNotEquals()

Asserts that the contents of one file is not equal to the contents of another file.

assertFileNotEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileNotEquals

assertFileNotEqualsCanonicalizing()

Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).

assertFileNotEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileNotEqualsCanonicalizing

assertFileNotEqualsIgnoringCase()

Asserts that the contents of one file is not equal to the contents of another file (ignoring case).

assertFileNotEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileNotEqualsIgnoringCase

assertStringEqualsFile()

Asserts that the contents of a string is equal to the contents of a file.

assertStringEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsFile

assertStringEqualsFileCanonicalizing()

Asserts that the contents of a string is equal to the contents of a file (canonicalizing).

assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsFileCanonicalizing

assertStringEqualsFileIgnoringCase()

Asserts that the contents of a string is equal to the contents of a file (ignoring case).

assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsFileIgnoringCase

assertStringNotEqualsFile()

Asserts that the contents of a string is not equal to the contents of a file.

assertStringNotEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotEqualsFile

assertStringNotEqualsFileCanonicalizing()

Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).

assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotEqualsFileCanonicalizing

assertStringNotEqualsFileIgnoringCase()

Asserts that the contents of a string is not equal to the contents of a file (ignoring case).

assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualString : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotEqualsFileIgnoringCase

assertIsReadable()

Asserts that a file/dir is readable.

assertIsReadable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsReadable

assertIsNotReadable()

Asserts that a file/dir exists and is not readable.

assertIsNotReadable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotReadable

assertIsWritable()

Asserts that a file/dir exists and is writable.

assertIsWritable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsWritable

assertIsNotWritable()

Asserts that a file/dir exists and is not writable.

assertIsNotWritable(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotWritable

assertDirectoryExists()

Asserts that a directory exists.

assertDirectoryExists(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryExists

assertDirectoryDoesNotExist()

Asserts that a directory does not exist.

assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryDoesNotExist

assertDirectoryIsReadable()

Asserts that a directory exists and is readable.

assertDirectoryIsReadable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsReadable

assertDirectoryIsNotReadable()

Asserts that a directory exists and is not readable.

assertDirectoryIsNotReadable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsNotReadable

assertDirectoryIsWritable()

Asserts that a directory exists and is writable.

assertDirectoryIsWritable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsWritable

assertDirectoryIsNotWritable()

Asserts that a directory exists and is not writable.

assertDirectoryIsNotWritable(string $directory[, string $message = '' ]) : void
Parameters
$directory : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDirectoryIsNotWritable

assertFileExists()

Asserts that a file exists.

assertFileExists(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileExists

assertFileDoesNotExist()

Asserts that a file does not exist.

assertFileDoesNotExist(string $filename[, string $message = '' ]) : void
Parameters
$filename : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileDoesNotExist

assertFileIsReadable()

Asserts that a file exists and is readable.

assertFileIsReadable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsReadable

assertFileIsNotReadable()

Asserts that a file exists and is not readable.

assertFileIsNotReadable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsNotReadable

assertFileIsWritable()

Asserts that a file exists and is writable.

assertFileIsWritable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsWritable

assertFileIsNotWritable()

Asserts that a file exists and is not writable.

assertFileIsNotWritable(string $file[, string $message = '' ]) : void
Parameters
$file : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileIsNotWritable

assertTrue()

Asserts that a condition is true.

assertTrue(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

true $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertTrue

assertNotTrue()

Asserts that a condition is not true.

assertNotTrue(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

!true $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotTrue

assertFalse()

Asserts that a condition is false.

assertFalse(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

false $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFalse

assertNotFalse()

Asserts that a condition is not false.

assertNotFalse(mixed $condition[, string $message = '' ]) : void
Parameters
$condition : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

!false $condition

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotFalse

assertNull()

Asserts that a variable is null.

assertNull(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

null $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNull

assertNotNull()

Asserts that a variable is not null.

assertNotNull(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-assert

!null $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotNull

assertFinite()

Asserts that a variable is finite.

assertFinite(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFinite

assertInfinite()

Asserts that a variable is infinite.

assertInfinite(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertInfinite

assertNan()

Asserts that a variable is nan.

assertNan(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNan

assertObjectHasProperty()

Asserts that an object has a specified property.

assertObjectHasProperty(string $propertyName, object $object[, string $message = '' ]) : void
Parameters
$propertyName : string
$object : object
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertObjectHasProperty

assertObjectNotHasProperty()

Asserts that an object does not have a specified property.

assertObjectNotHasProperty(string $propertyName, object $object[, string $message = '' ]) : void
Parameters
$propertyName : string
$object : object
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertObjectNotHasProperty

assertSame()

Asserts that two variables have the same type and value.

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

Used on objects, it asserts that two variables reference the same object.

Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
psalm-template

ExpectedType

psalm-param

ExpectedType $expected

psalm-assert

=ExpectedType $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertSame

assertNotSame()

Asserts that two variables do not have the same type and value.

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

Used on objects, it asserts that two variables do not reference the same object.

Parameters
$expected : mixed
$actual : mixed
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotSame

assertInstanceOf()

Asserts that a variable is of a given type.

assertInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
UnknownClassOrInterfaceException
psalm-template

ExpectedType of object

psalm-param

class-string<ExpectedType> $expected

psalm-assert

=ExpectedType $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertInstanceOf

assertNotInstanceOf()

Asserts that a variable is not of a given type.

assertNotInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-template

ExpectedType of object

psalm-param

class-string<ExpectedType> $expected

psalm-assert

!ExpectedType $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotInstanceOf

assertIsArray()

Asserts that a variable is of type array.

assertIsArray(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

array $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsArray

assertIsBool()

Asserts that a variable is of type bool.

assertIsBool(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

bool $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsBool

assertIsFloat()

Asserts that a variable is of type float.

assertIsFloat(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

float $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsFloat

assertIsInt()

Asserts that a variable is of type int.

assertIsInt(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

int $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsInt

assertIsNumeric()

Asserts that a variable is of type numeric.

assertIsNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

numeric $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNumeric

assertIsObject()

Asserts that a variable is of type object.

assertIsObject(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

object $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsObject

assertIsResource()

Asserts that a variable is of type resource.

assertIsResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsResource

assertIsClosedResource()

Asserts that a variable is of type resource and is closed.

assertIsClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsClosedResource

assertIsString()

Asserts that a variable is of type string.

assertIsString(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

string $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsString

assertIsScalar()

Asserts that a variable is of type scalar.

assertIsScalar(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

scalar $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsScalar

assertIsCallable()

Asserts that a variable is of type callable.

assertIsCallable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

callable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsCallable

assertIsIterable()

Asserts that a variable is of type iterable.

assertIsIterable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

iterable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsIterable

assertIsNotArray()

Asserts that a variable is not of type array.

assertIsNotArray(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!array $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotArray

assertIsNotBool()

Asserts that a variable is not of type bool.

assertIsNotBool(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!bool $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotBool

assertIsNotFloat()

Asserts that a variable is not of type float.

assertIsNotFloat(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!float $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotFloat

assertIsNotInt()

Asserts that a variable is not of type int.

assertIsNotInt(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!int $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotInt

assertIsNotNumeric()

Asserts that a variable is not of type numeric.

assertIsNotNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!numeric $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotNumeric

assertIsNotObject()

Asserts that a variable is not of type object.

assertIsNotObject(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!object $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotObject

assertIsNotResource()

Asserts that a variable is not of type resource.

assertIsNotResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotResource

assertIsNotClosedResource()

Asserts that a variable is not of type resource.

assertIsNotClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!resource $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotClosedResource

assertIsNotString()

Asserts that a variable is not of type string.

assertIsNotString(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!string $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotString

assertIsNotScalar()

Asserts that a variable is not of type scalar.

assertIsNotScalar(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!scalar $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotScalar

assertIsNotCallable()

Asserts that a variable is not of type callable.

assertIsNotCallable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!callable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotCallable

assertIsNotIterable()

Asserts that a variable is not of type iterable.

assertIsNotIterable(mixed $actual[, string $message = '' ]) : void
Parameters
$actual : mixed
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
psalm-assert

!iterable $actual

no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertIsNotIterable

assertMatchesRegularExpression()

Asserts that a string matches a given regular expression.

assertMatchesRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
$pattern : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertMatchesRegularExpression

assertDoesNotMatchRegularExpression()

Asserts that a string does not match a given regular expression.

assertDoesNotMatchRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
$pattern : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertDoesNotMatchRegularExpression

assertSameSize()

Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.

assertSameSize(Countable|iterable<string|int, mixed> $expected, Countable|iterable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
$expected : Countable|iterable<string|int, mixed>
$actual : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertSameSize

assertNotSameSize()

Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.

assertNotSameSize(Countable|iterable<string|int, mixed> $expected, Countable|iterable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
$expected : Countable|iterable<string|int, mixed>
$actual : Countable|iterable<string|int, mixed>
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
GeneratorNotSupportedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertNotSameSize

assertStringContainsStringIgnoringLineEndings()

assertStringContainsStringIgnoringLineEndings(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringContainsStringIgnoringLineEndings

assertStringEqualsStringIgnoringLineEndings()

Asserts that two strings are equal except for line endings.

assertStringEqualsStringIgnoringLineEndings(string $expected, string $actual[, string $message = '' ]) : void
Parameters
$expected : string
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEqualsStringIgnoringLineEndings

assertFileMatchesFormat()

Asserts that a string matches a given format string.

assertFileMatchesFormat(string $format, string $actualFile[, string $message = '' ]) : void
Parameters
$format : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileMatchesFormat

assertFileMatchesFormatFile()

Asserts that a string matches a given format string.

assertFileMatchesFormatFile(string $formatFile, string $actualFile[, string $message = '' ]) : void
Parameters
$formatFile : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertFileMatchesFormatFile

assertStringMatchesFormat()

Asserts that a string matches a given format string.

assertStringMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
$format : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringMatchesFormat

assertStringNotMatchesFormat()

Asserts that a string does not match a given format string.

https://github.com/sebastianbergmann/phpunit/issues/5472

assertStringNotMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
$format : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotMatchesFormat

assertStringMatchesFormatFile()

Asserts that a string matches a given format file.

assertStringMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
$formatFile : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringMatchesFormatFile

assertStringNotMatchesFormatFile()

Asserts that a string does not match a given format string.

https://github.com/sebastianbergmann/phpunit/issues/5472

assertStringNotMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
$formatFile : string
$string : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotMatchesFormatFile

assertStringStartsWith()

Asserts that a string starts with a given prefix.

assertStringStartsWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
$prefix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $prefix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringStartsWith

assertStringStartsNotWith()

Asserts that a string starts not with a given prefix.

assertStringStartsNotWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
$prefix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $prefix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringStartsNotWith

assertStringContainsString()

assertStringContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringContainsString

assertStringContainsStringIgnoringCase()

assertStringContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringContainsStringIgnoringCase

assertStringNotContainsString()

assertStringNotContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotContainsString

assertStringNotContainsStringIgnoringCase()

assertStringNotContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
$needle : string
$haystack : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringNotContainsStringIgnoringCase

assertStringEndsWith()

Asserts that a string ends with a given suffix.

assertStringEndsWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
$suffix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $suffix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEndsWith

assertStringEndsNotWith()

Asserts that a string ends not with a given suffix.

assertStringEndsNotWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
$suffix : string
$string : string
$message : string = ''
Tags
psalm-param

non-empty-string $suffix

throws
ExpectationFailedException
throws
InvalidArgumentException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertStringEndsNotWith

assertXmlFileEqualsXmlFile()

Asserts that two XML files are equal.

assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlFileEqualsXmlFile

assertXmlFileNotEqualsXmlFile()

Asserts that two XML files are not equal.

assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
Exception
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlFileNotEqualsXmlFile

assertXmlStringEqualsXmlFile()

Asserts that two XML documents are equal.

assertXmlStringEqualsXmlFile(string $expectedFile, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringEqualsXmlFile

assertXmlStringNotEqualsXmlFile()

Asserts that two XML documents are not equal.

assertXmlStringNotEqualsXmlFile(string $expectedFile, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringNotEqualsXmlFile

assertXmlStringEqualsXmlString()

Asserts that two XML documents are equal.

assertXmlStringEqualsXmlString(string $expectedXml, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedXml : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringEqualsXmlString

assertXmlStringNotEqualsXmlString()

Asserts that two XML documents are not equal.

assertXmlStringNotEqualsXmlString(string $expectedXml, string $actualXml[, string $message = '' ]) : void
Parameters
$expectedXml : string
$actualXml : string
$message : string = ''
Tags
throws
ExpectationFailedException
throws
XmlException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertXmlStringNotEqualsXmlString

assertThat()

Evaluates a PHPUnit\Framework\Constraint matcher object.

assertThat(mixed $value, Constraint $constraint[, string $message = '' ]) : void
Parameters
$value : mixed
$constraint : Constraint
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertThat

assertJson()

Asserts that a string is a valid JSON string.

assertJson(string $actual[, string $message = '' ]) : void
Parameters
$actual : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJson

assertJsonStringEqualsJsonString()

Asserts that two given JSON encoded objects or arrays are equal.

assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedJson : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringEqualsJsonString

assertJsonStringNotEqualsJsonString()

Asserts that two given JSON encoded objects or arrays are not equal.

assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedJson : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringNotEqualsJsonString

assertJsonStringEqualsJsonFile()

Asserts that the generated JSON encoded object and the content of the given file are equal.

assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringEqualsJsonFile

assertJsonStringNotEqualsJsonFile()

Asserts that the generated JSON encoded object and the content of the given file are not equal.

assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualJson : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonStringNotEqualsJsonFile

assertJsonFileEqualsJsonFile()

Asserts that two JSON files are equal.

assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonFileEqualsJsonFile

assertJsonFileNotEqualsJsonFile()

Asserts that two JSON files are not equal.

assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
$expectedFile : string
$actualFile : string
$message : string = ''
Tags
throws
ExpectationFailedException
no-named-arguments

Parameter names are not covered by the backward compatibility promise for PHPUnit

see
Assert::assertJsonFileNotEqualsJsonFile

objectEquals()

objectEquals(object $object[, string $method = 'equals' ]) : ObjectEquals
Parameters
$object : object
$method : string = 'equals'
Return values
ObjectEquals

callback()

callback(callable $callback) : Callback
Parameters
$callback : callable
Tags
psalm-template

CallbackInput of mixed

psalm-param

callable(CallbackInput $callback): bool $callback

psalm-return

Callback<CallbackInput>

Return values
Callback

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

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(callable $callback) : ReturnCallback
Parameters
$callback : callable
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

getallheaders()

Get all HTTP header key/values as an associative array for the current request.

getallheaders() : string[string]
Return values
string[string]

The HTTP header key/value pairs.

checkRequirements()

Exits if the minimum requirements of PHP_CodeSniffer are not met.

checkRequirements() : void

trigger_deprecation()

Triggers a silenced deprecation notice.

trigger_deprecation(string $package, string $version, string $message, mixed ...$args) : void
Parameters
$package : string

The name of the Composer package that is triggering the deprecation

$version : string

The version of the package that introduced the deprecation

$message : string

The message of the deprecation

$args : mixed

Values to insert in the message using printf() formatting

Tags
author

Nicolas Grekas p@tchwork.com

ctype_alnum()

ctype_alnum(mixed $text) : mixed
Parameters
$text : mixed

ctype_alpha()

ctype_alpha(mixed $text) : mixed
Parameters
$text : mixed

ctype_cntrl()

ctype_cntrl(mixed $text) : mixed
Parameters
$text : mixed

ctype_digit()

ctype_digit(mixed $text) : mixed
Parameters
$text : mixed

ctype_graph()

ctype_graph(mixed $text) : mixed
Parameters
$text : mixed

ctype_lower()

ctype_lower(mixed $text) : mixed
Parameters
$text : mixed

ctype_print()

ctype_print(mixed $text) : mixed
Parameters
$text : mixed

ctype_punct()

ctype_punct(mixed $text) : mixed
Parameters
$text : mixed

ctype_space()

ctype_space(mixed $text) : mixed
Parameters
$text : mixed

ctype_upper()

ctype_upper(mixed $text) : mixed
Parameters
$text : mixed

ctype_xdigit()

ctype_xdigit(mixed $text) : mixed
Parameters
$text : 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

grapheme_extract()

grapheme_extract(mixed $haystack, mixed $size[, mixed $type = 0 ][, mixed $start = 0 ][, mixed &$next = 0 ]) : mixed
Parameters
$haystack : mixed
$size : mixed
$type : mixed = 0
$start : mixed = 0
$next : mixed = 0

grapheme_stripos()

grapheme_stripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_stristr()

grapheme_stristr(mixed $haystack, mixed $needle[, mixed $beforeNeedle = false ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$beforeNeedle : mixed = false

grapheme_strlen()

grapheme_strlen(mixed $input) : mixed
Parameters
$input : mixed

grapheme_strpos()

grapheme_strpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_strripos()

grapheme_strripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_strrpos()

grapheme_strrpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0

grapheme_strstr()

grapheme_strstr(mixed $haystack, mixed $needle[, mixed $beforeNeedle = false ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$beforeNeedle : mixed = false

grapheme_substr()

grapheme_substr(mixed $string, mixed $offset[, mixed $length = null ]) : mixed
Parameters
$string : mixed
$offset : mixed
$length : mixed = null

grapheme_str_split()

grapheme_str_split(mixed $string[, mixed $length = 1 ]) : mixed
Parameters
$string : mixed
$length : mixed = 1

grapheme_str_split()

grapheme_str_split(string $string[, int $length = 1 ]) : array<string|int, mixed>|false
Parameters
$string : string
$length : int = 1
Return values
array<string|int, mixed>|false

grapheme_extract()

grapheme_extract(string|null $haystack, int|null $size[, int|null $type = GRAPHEME_EXTR_COUNT ][, int|null $offset = 0 ][, mixed &$next = null ]) : string|false
Parameters
$haystack : string|null
$size : int|null
$type : int|null = GRAPHEME_EXTR_COUNT
$offset : int|null = 0
$next : mixed = null
Return values
string|false

grapheme_stripos()

grapheme_stripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_stristr()

grapheme_stristr(string|null $haystack, string|null $needle[, bool|null $beforeNeedle = false ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$beforeNeedle : bool|null = false
Return values
string|false

grapheme_strlen()

grapheme_strlen(string|null $string) : int|false|null
Parameters
$string : string|null
Return values
int|false|null

grapheme_strpos()

grapheme_strpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_strripos()

grapheme_strripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_strrpos()

grapheme_strrpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
Return values
int|false

grapheme_strstr()

grapheme_strstr(string|null $haystack, string|null $needle[, bool|null $beforeNeedle = false ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$beforeNeedle : bool|null = false
Return values
string|false

grapheme_substr()

grapheme_substr(string|null $string, int|null $offset[, int|null $length = null ]) : string|false
Parameters
$string : string|null
$offset : int|null
$length : int|null = null
Return values
string|false

normalizer_is_normalized()

normalizer_is_normalized(mixed $string[, mixed $form = Normalizer::FORM_C ]) : mixed
Parameters
$string : mixed
$form : mixed = Normalizer::FORM_C

normalizer_normalize()

normalizer_normalize(mixed $string[, mixed $form = Normalizer::FORM_C ]) : mixed
Parameters
$string : mixed
$form : mixed = Normalizer::FORM_C

normalizer_is_normalized()

normalizer_is_normalized(string|null $string[, int|null $form = Normalizer::FORM_C ]) : bool
Parameters
$string : string|null
$form : int|null = Normalizer::FORM_C
Return values
bool

normalizer_normalize()

normalizer_normalize(string|null $string[, int|null $form = Normalizer::FORM_C ]) : string|false
Parameters
$string : string|null
$form : int|null = Normalizer::FORM_C
Return values
string|false

mb_convert_encoding()

mb_convert_encoding(mixed $string, mixed $to_encoding[, mixed $from_encoding = null ]) : mixed
Parameters
$string : mixed
$to_encoding : mixed
$from_encoding : mixed = null

mb_decode_mimeheader()

mb_decode_mimeheader(mixed $string) : mixed
Parameters
$string : mixed

mb_encode_mimeheader()

mb_encode_mimeheader(mixed $string[, mixed $charset = null ][, mixed $transfer_encoding = null ][, mixed $newline = "\r\n" ][, mixed $indent = 0 ]) : mixed
Parameters
$string : mixed
$charset : mixed = null
$transfer_encoding : mixed = null
$newline : mixed = "\r\n"
$indent : mixed = 0

mb_decode_numericentity()

mb_decode_numericentity(mixed $string, mixed $map[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$map : mixed
$encoding : mixed = null

mb_encode_numericentity()

mb_encode_numericentity(mixed $string, mixed $map[, mixed $encoding = null ][, mixed $hex = false ]) : mixed
Parameters
$string : mixed
$map : mixed
$encoding : mixed = null
$hex : mixed = false

mb_convert_case()

mb_convert_case(mixed $string, mixed $mode[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$mode : mixed
$encoding : mixed = null

mb_internal_encoding()

mb_internal_encoding([mixed $encoding = null ]) : mixed
Parameters
$encoding : mixed = null

mb_language()

mb_language([mixed $language = null ]) : mixed
Parameters
$language : mixed = null

mb_list_encodings()

mb_list_encodings() : mixed

mb_encoding_aliases()

mb_encoding_aliases(mixed $encoding) : mixed
Parameters
$encoding : mixed

mb_check_encoding()

mb_check_encoding([mixed $value = null ][, mixed $encoding = null ]) : mixed
Parameters
$value : mixed = null
$encoding : mixed = null

mb_detect_encoding()

mb_detect_encoding(mixed $string[, mixed $encodings = null ][, mixed $strict = false ]) : mixed
Parameters
$string : mixed
$encodings : mixed = null
$strict : mixed = false

mb_detect_order()

mb_detect_order([mixed $encoding = null ]) : mixed
Parameters
$encoding : mixed = null

mb_parse_str()

mb_parse_str(mixed $string[, mixed &$result = [] ]) : mixed
Parameters
$string : mixed
$result : mixed = []

mb_strlen()

mb_strlen(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_strpos()

mb_strpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_strtolower()

mb_strtolower(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_strtoupper()

mb_strtoupper(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_substitute_character()

mb_substitute_character([mixed $substitute_character = null ]) : mixed
Parameters
$substitute_character : mixed = null

mb_substr()

mb_substr(mixed $string, mixed $start[, mixed $length = 2147483647 ][, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$start : mixed
$length : mixed = 2147483647
$encoding : mixed = null

mb_stripos()

mb_stripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_stristr()

mb_stristr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_strrchr()

mb_strrchr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_strrichr()

mb_strrichr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_strripos()

mb_strripos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_strrpos()

mb_strrpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$offset : mixed = 0
$encoding : mixed = null

mb_strstr()

mb_strstr(mixed $haystack, mixed $needle[, mixed $before_needle = false ][, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$before_needle : mixed = false
$encoding : mixed = null

mb_get_info()

mb_get_info([mixed $type = 'all' ]) : mixed
Parameters
$type : mixed = 'all'

mb_http_output()

mb_http_output([mixed $encoding = null ]) : mixed
Parameters
$encoding : mixed = null

mb_strwidth()

mb_strwidth(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_substr_count()

mb_substr_count(mixed $haystack, mixed $needle[, mixed $encoding = null ]) : mixed
Parameters
$haystack : mixed
$needle : mixed
$encoding : mixed = null

mb_output_handler()

mb_output_handler(mixed $string, mixed $status) : mixed
Parameters
$string : mixed
$status : mixed

mb_http_input()

mb_http_input([mixed $type = null ]) : mixed
Parameters
$type : mixed = null

mb_convert_variables()

mb_convert_variables(mixed $to_encoding, mixed $from_encoding, mixed ...&$vars) : mixed
Parameters
$to_encoding : mixed
$from_encoding : mixed
$vars : mixed

mb_ord()

mb_ord(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_chr()

mb_chr(mixed $codepoint[, mixed $encoding = null ]) : mixed
Parameters
$codepoint : mixed
$encoding : mixed = null

mb_scrub()

mb_scrub(mixed $string[, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$encoding : mixed = null

mb_str_split()

mb_str_split(mixed $string[, mixed $length = 1 ][, mixed $encoding = null ]) : mixed
Parameters
$string : mixed
$length : mixed = 1
$encoding : mixed = null

mb_str_pad()

mb_str_pad(string $string, int $length[, string $pad_string = ' ' ][, int $pad_type = STR_PAD_RIGHT ][, string|null $encoding = null ]) : string
Parameters
$string : string
$length : int
$pad_string : string = ' '
$pad_type : int = STR_PAD_RIGHT
$encoding : string|null = null
Return values
string

mb_ucfirst()

mb_ucfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_lcfirst()

mb_lcfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_trim()

mb_trim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_ltrim()

mb_ltrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_rtrim()

mb_rtrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_convert_encoding()

mb_convert_encoding(array<string|int, mixed>|string|null $string, string|null $to_encoding[, array<string|int, mixed>|string|null $from_encoding = null ]) : array<string|int, mixed>|string|false
Parameters
$string : array<string|int, mixed>|string|null
$to_encoding : string|null
$from_encoding : array<string|int, mixed>|string|null = null
Return values
array<string|int, mixed>|string|false

mb_decode_mimeheader()

mb_decode_mimeheader(string|null $string) : string
Parameters
$string : string|null
Return values
string

mb_encode_mimeheader()

mb_encode_mimeheader(string|null $string[, string|null $charset = null ][, string|null $transfer_encoding = null ][, string|null $newline = "\r\n" ][, int|null $indent = 0 ]) : string
Parameters
$string : string|null
$charset : string|null = null
$transfer_encoding : string|null = null
$newline : string|null = "\r\n"
$indent : int|null = 0
Return values
string

mb_decode_numericentity()

mb_decode_numericentity(string|null $string, array<string|int, mixed> $map[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$map : array<string|int, mixed>
$encoding : string|null = null
Return values
string

mb_encode_numericentity()

mb_encode_numericentity(string|null $string, array<string|int, mixed> $map[, string|null $encoding = null ][, bool|null $hex = false ]) : string
Parameters
$string : string|null
$map : array<string|int, mixed>
$encoding : string|null = null
$hex : bool|null = false
Return values
string

mb_convert_case()

mb_convert_case(string|null $string, int|null $mode[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$mode : int|null
$encoding : string|null = null
Return values
string

mb_internal_encoding()

mb_internal_encoding([string|null $encoding = null ]) : string|bool
Parameters
$encoding : string|null = null
Return values
string|bool

mb_language()

mb_language([string|null $language = null ]) : string|bool
Parameters
$language : string|null = null
Return values
string|bool

mb_list_encodings()

mb_list_encodings() : array<string|int, mixed>
Return values
array<string|int, mixed>

mb_encoding_aliases()

mb_encoding_aliases(string|null $encoding) : array<string|int, mixed>
Parameters
$encoding : string|null
Return values
array<string|int, mixed>

mb_check_encoding()

mb_check_encoding([array<string|int, mixed>|string|null $value = null ][, string|null $encoding = null ]) : bool
Parameters
$value : array<string|int, mixed>|string|null = null
$encoding : string|null = null
Return values
bool

mb_detect_encoding()

mb_detect_encoding(string|null $string[, array<string|int, mixed>|string|null $encodings = null ][, bool|null $strict = false ]) : string|false
Parameters
$string : string|null
$encodings : array<string|int, mixed>|string|null = null
$strict : bool|null = false
Return values
string|false

mb_detect_order()

mb_detect_order([array<string|int, mixed>|string|null $encoding = null ]) : array<string|int, mixed>|bool
Parameters
$encoding : array<string|int, mixed>|string|null = null
Return values
array<string|int, mixed>|bool

mb_parse_str()

mb_parse_str(string|null $string[, mixed &$result = [] ]) : bool
Parameters
$string : string|null
$result : mixed = []
Return values
bool

mb_strlen()

mb_strlen(string|null $string[, string|null $encoding = null ]) : int
Parameters
$string : string|null
$encoding : string|null = null
Return values
int

mb_strpos()

mb_strpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_strtolower()

mb_strtolower(string|null $string[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$encoding : string|null = null
Return values
string

mb_strtoupper()

mb_strtoupper(string|null $string[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$encoding : string|null = null
Return values
string

mb_substitute_character()

mb_substitute_character([string|int|null $substitute_character = null ]) : string|int|bool
Parameters
$substitute_character : string|int|null = null
Return values
string|int|bool

mb_substr()

mb_substr(string|null $string, int|null $start[, int|null $length = null ][, string|null $encoding = null ]) : string
Parameters
$string : string|null
$start : int|null
$length : int|null = null
$encoding : string|null = null
Return values
string

mb_stripos()

mb_stripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_stristr()

mb_stristr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_strrchr()

mb_strrchr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_strrichr()

mb_strrichr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_strripos()

mb_strripos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_strrpos()

mb_strrpos(string|null $haystack, string|null $needle[, int|null $offset = 0 ][, string|null $encoding = null ]) : int|false
Parameters
$haystack : string|null
$needle : string|null
$offset : int|null = 0
$encoding : string|null = null
Return values
int|false

mb_strstr()

mb_strstr(string|null $haystack, string|null $needle[, bool|null $before_needle = false ][, string|null $encoding = null ]) : string|false
Parameters
$haystack : string|null
$needle : string|null
$before_needle : bool|null = false
$encoding : string|null = null
Return values
string|false

mb_get_info()

mb_get_info([string|null $type = 'all' ]) : array<string|int, mixed>|string|int|false|null
Parameters
$type : string|null = 'all'
Return values
array<string|int, mixed>|string|int|false|null

mb_http_output()

mb_http_output([string|null $encoding = null ]) : string|bool
Parameters
$encoding : string|null = null
Return values
string|bool

mb_strwidth()

mb_strwidth(string|null $string[, string|null $encoding = null ]) : int
Parameters
$string : string|null
$encoding : string|null = null
Return values
int

mb_substr_count()

mb_substr_count(string|null $haystack, string|null $needle[, string|null $encoding = null ]) : int
Parameters
$haystack : string|null
$needle : string|null
$encoding : string|null = null
Return values
int

mb_output_handler()

mb_output_handler(string|null $string, int|null $status) : string
Parameters
$string : string|null
$status : int|null
Return values
string

mb_http_input()

mb_http_input([string|null $type = null ]) : array<string|int, mixed>|string|false
Parameters
$type : string|null = null
Return values
array<string|int, mixed>|string|false

mb_convert_variables()

mb_convert_variables(string|null $to_encoding, array<string|int, mixed>|string|null $from_encoding, mixed &$var, mixed ...&$vars) : string|false
Parameters
$to_encoding : string|null
$from_encoding : array<string|int, mixed>|string|null
$var : mixed
$vars : mixed
Return values
string|false

mb_ord()

mb_ord(string|null $string[, string|null $encoding = null ]) : int|false
Parameters
$string : string|null
$encoding : string|null = null
Return values
int|false

mb_chr()

mb_chr(int|null $codepoint[, string|null $encoding = null ]) : string|false
Parameters
$codepoint : int|null
$encoding : string|null = null
Return values
string|false

mb_scrub()

mb_scrub(string|null $string[, string|null $encoding = null ]) : string
Parameters
$string : string|null
$encoding : string|null = null
Return values
string

mb_str_split()

mb_str_split(string|null $string[, int|null $length = 1 ][, string|null $encoding = null ]) : array<string|int, mixed>
Parameters
$string : string|null
$length : int|null = 1
$encoding : string|null = null
Return values
array<string|int, mixed>

mb_str_pad()

mb_str_pad(string $string, int $length[, string $pad_string = ' ' ][, int $pad_type = STR_PAD_RIGHT ][, string|null $encoding = null ]) : string
Parameters
$string : string
$length : int
$pad_string : string = ' '
$pad_type : int = STR_PAD_RIGHT
$encoding : string|null = null
Return values
string

mb_ucfirst()

mb_ucfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_lcfirst()

mb_lcfirst(string $string[, string|null $encoding = null ]) : string
Parameters
$string : string
$encoding : string|null = null
Return values
string

mb_trim()

mb_trim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_ltrim()

mb_ltrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

mb_rtrim()

mb_rtrim(string $string[, string|null $characters = null ][, string|null $encoding = null ]) : string
Parameters
$string : string
$characters : string|null = null
$encoding : string|null = null
Return values
string

fdiv()

fdiv(float $num1, float $num2) : float
Parameters
$num1 : float
$num2 : float
Return values
float

preg_last_error_msg()

preg_last_error_msg() : string
Return values
string

str_contains()

str_contains(string|null $haystack, string|null $needle) : bool
Parameters
$haystack : string|null
$needle : string|null
Return values
bool

str_starts_with()

str_starts_with(string|null $haystack, string|null $needle) : bool
Parameters
$haystack : string|null
$needle : string|null
Return values
bool

str_ends_with()

str_ends_with(string|null $haystack, string|null $needle) : bool
Parameters
$haystack : string|null
$needle : string|null
Return values
bool

get_debug_type()

get_debug_type(mixed $value) : string
Parameters
$value : mixed
Return values
string

get_resource_id()

get_resource_id(mixed $resource) : int
Parameters
$resource : mixed
Return values
int

        
On this page

Search results