Documentation

Application

Interfaces, Classes and Traits

CacheInterface: Cache interface
ExceptionInterface: Provides a domain-level interface for broad capture of all framework-related exceptions.
CloneableCookieInterface: Interface for a fresh Cookie instance with selected attribute(s) only changed from the original instance.
CookieInterface: Interface for a value object representation of an HTTP cookie.
ConnectionInterface: Interface ConnectionInterface
ExceptionInterface: Provides a domain-level interface for broad capture of all database-related exceptions.
PreparedQueryInterface: Prepared query interface
QueryInterface: Interface QueryInterface
ResultInterface: Interface ResultInterface
EncrypterInterface: CodeIgniter Encryption Handler
CastInterface: Interface CastInterface
ExceptionInterface: Provides a domain-level interface for broad capture of all framework-related exceptions.
FilterInterface: Filter interface
FormatterInterface: Formatter interface
UploadedFileInterface: Value object representing a single file uploaded through an HTTP request. Used by the IncomingRequest class to provide files.
MessageInterface: Expected behavior of an HTTP request
RequestInterface: Expected behavior of an HTTP request
ResponseInterface: Representation of an outgoing, getServer-side response.
ImageHandlerInterface: Expected behavior of an Image handler
HandlerInterface: Expected behavior for a Log handler
PagerInterface: Expected behavior for a Pager
RouteCollectionInterface: Interface RouteCollectionInterface
RouterInterface: Expected behavior of a Router.
SecurityInterface: Expected behavior of a Security.
SessionInterface: Expected behavior of a session container used with CodeIgniter.
FabricatorModel: FabricatorModel
ExceptionInterface
ObjectPluginInterface
PluginInterface
TabPluginInterface
LoggerAwareInterface: Describes a logger-aware instance.
LoggerInterface: Describes a logger instance.
ThrottlerInterface: Expected behavior of a Throttler
ValidationInterface: Expected behavior of a validator
RendererInterface: Interface RendererInterface
ExceptionInterface: Base exception marker interface for the instantiator component
InstantiatorInterface: Instantiator provides utility methods to build objects without invoking their constructors
AddressExtension: An extension is the only way to add new functionality to Faker.
BarcodeExtension: An extension is the only way to add new functionality to Faker.
BloodExtension: An extension is the only way to add new functionality to Faker.
CompanyExtension: An extension is the only way to add new functionality to Faker.
CountryExtension: An extension is the only way to add new functionality to Faker.
Extension: An extension is the only way to add new functionality to Faker.
FileExtension: An extension is the only way to add new functionality to Faker.
GeneratorAwareExtension: An extension is the only way to add new functionality to Faker.
NumberExtension: An extension is the only way to add new functionality to Faker.
PersonExtension: An extension is the only way to add new functionality to Faker.
PhoneNumberExtension: An extension is the only way to add new functionality to Faker.
VersionExtension: An extension is the only way to add new functionality to Faker.
ObjectPluginInterface
PluginInterface
TabPluginInterface
ExceptionInterface
Filter: Filter to apply to a property while copying an object
Matcher
TypeFilter
Builder
ErrorHandler
FunctionLike
Node
NodeTraverserInterface
NodeVisitor
Parser
Exception
Requirement
VersionConstraint
Exception
Element: Interface for Api Elements
File: Interface for files processed by the ProjectFactory
Project: Interface for project. Since the definition of a project can be different per factory this interface will be small.
ProjectFactory: Interface for project factories. A project factory shall convert a set of files into an object implementing the Project interface.
Tag
TagFactory
StaticMethod
Formatter
Reference: Interface for references in {@see \phpDocumentor\Reflection\DocBlock\Tags\See}
DocBlockFactoryInterface
PseudoType
Type
TokenInterface: Argument token interface.
ClassPatchInterface: Class patch interface.
DoubleInterface: Core double interface.
ReflectionInterface: Reflection interface.
DoublerException: Core Prophecy exception interface.
Exception: Core Prophecy exception interface.
PredictionException: Core Prophecy exception interface.
ProphecyException: Core Prophecy exception interface.
PredictionInterface: Prediction interface.
PromiseInterface: Promise interface.
ProphecyInterface: Core Prophecy interface.
ProphecySubjectInterface: Controllable doubles interface.
RevealerInterface: Prophecies revealer interface.
Exception
Exception
Exception
Exception
InvocationStubber
MockObject
ParametersRule
Stub
Test
TestListener
AfterIncompleteTestHook
AfterLastTestHook
AfterRiskyTestHook
AfterSkippedTestHook
AfterSuccessfulTestHook
AfterTestErrorHook
AfterTestFailureHook
AfterTestHook
AfterTestWarningHook
BeforeFirstTestHook
BeforeTestHook
Hook
TestHook
TestSuiteLoader
ResultPrinter
ClientContextInterface: Interface defining a client-side context such as a pipeline or transaction.
ClientInterface: Interface defining a client able to execute commands against Redis.
DistributorInterface: A distributor implements the logic to automatically distribute keys among several nodes for client-side sharding.
HashGeneratorInterface: An hash generator implements the logic used to calculate the hash of a key to distribute operations among Redis nodes.
StrategyInterface: Interface for classes defining the strategy used to calculate an hash out of keys extracted from supported commands.
CommandInterface: Defines an abstraction representing a Redis command.
PrefixableCommandInterface: Defines a command whose keys can be prefixed.
ProcessorInterface: A command processor processes Redis commands before they are sent to Redis.
OptionInterface: Defines an handler used by Predis\Configuration\Options to filter, validate or return default values for a given option.
OptionsInterface: Interface defining a container for client options.
ClusterInterface: Defines a cluster of Redis servers formed by aggregating multiple connection instances to single Redis nodes.
ReplicationInterface: Defines a group of Redis nodes in a master / slave replication setup.
AggregateConnectionInterface: Defines a virtual connection composed of multiple connection instances to single Redis nodes.
CompositeConnectionInterface: Defines a connection to communicate with a single Redis server that leverages an external protocol processor to handle pluggable protocol handlers.
ConnectionInterface: Defines a connection object used to communicate with one or multiple Redis servers.
FactoryInterface: Interface for classes providing a factory of connections to Redis nodes.
NodeConnectionInterface: Defines a connection used to communicate with a single Redis node.
ParametersInterface: Interface defining a container for connection parameters.
ProfileInterface: A profile defines all the features and commands supported by certain versions of Redis. Instances of Predis\Client should use a server profile matching the version of Redis being used.
ProtocolProcessorInterface: Defines a pluggable protocol processor capable of serializing commands and deserializing responses into PHP objects directly from a connection.
RequestSerializerInterface: Defines a pluggable serializer for Redis commands.
ResponseReaderInterface: Defines a pluggable reader capable of parsing responses returned by Redis and deserializing them to PHP objects.
ResponseHandlerInterface: Defines a pluggable handler used to parse a particular type of response.
ErrorInterface: Represents an error returned by Redis (responses identified by "-" in the Redis protocol) during the execution of an operation on the server.
ResponseInterface: Represents a complex response object from Redis.
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.
LoggerAwareInterface: Describes a logger-aware instance.
LoggerInterface: Describes a logger instance.
Exception
Exception
Exception
Exception
Exception
LongestCommonSubsequenceCalculator
DiffOutputBuilderInterface: Defines how an output builder should take a generated diff array and return a string representation of that diff.
Exception
Exception
Exception
Exception
Exception
Exception
Report
Sniff
App: Class BaseConfig
Autoload: ------------------------------------------------------------------- AUTOLOADER CONFIGURATION -------------------------------------------------------------------
Cache: Class BaseConfig
ContentSecurityPolicy: Stores the default settings for the ContentSecurityPolicy, if you choose to use it. The values here will be read in and set as defaults for the site. If needed, they can be overridden on a page-by-page basis.
Cookie: Class BaseConfig
Database: Database Configuration
DocTypes
Email: Class BaseConfig
Encryption: Encryption configuration.
Exceptions: Setup how the exception handler works.
Filters: Class BaseConfig
ForeignCharacters: Describes foreign characters for transliteration with the text helper.
Format: Class BaseConfig
Generators: Class BaseConfig
GroceryCrudEnterprise: Class BaseConfig
Honeypot: Class BaseConfig
Images: Class BaseConfig
Kint: -------------------------------------------------------------------------- Kint --------------------------------------------------------------------------
Logger: Class BaseConfig
Migrations: Class BaseConfig
Mimes: Mimes
Modules: Modules Class
Pager: Class BaseConfig
Paths: Paths
Security: Class BaseConfig
Services: Services Configuration file.
Toolbar: -------------------------------------------------------------------------- Debug Toolbar --------------------------------------------------------------------------
UserAgents: ------------------------------------------------------------------- User Agents -------------------------------------------------------------------
Validation
View: View configuration
Accesos: Class BaseController
Ajustes: Class BaseController
Alerta: Class BaseController
Analitica: Class BaseController
BaseController: Class BaseController
ClienteAdmin: Placeholder
Clientes: Class BaseController
Conductores: Class BaseController
Dashboard: Class BaseController
Flotas: Class BaseController
Gestor: Class BaseController
Grupos: Class BaseController
Home: Class BaseController
Idioma: Class BaseController
Informe: Class BaseController
Lineas: Class BaseController
Mapa: Class BaseController
Paradas: Class BaseController
Planificaciones: Class BaseController
Profile: Class BaseController
SuperAdmin: Class BaseController
User: Class BaseController
Usuarios: Class BaseController
Vehiculos: Class BaseController
Auth
Noauth
AccesosModel: Class Model
AccesosViewModel: Class Model
ClientesModel: Class Model
ClientesViewModel: Class Model
ConductoresModel: Class Model
ConductoresViewModel: Class Model
FlotasModel: Class Model
GruposModel: Class Model
GruposViewModel: Class Model
LineasModel: Class Model
LineasViewModel: Class Model
ParadasModel: Class Model
ParadasViewModel: Class Model
PlanificacionesModel: Class Model
PlanificacionesViewModel: Class Model
UserModel: Class Model
UsuariosModel: Class Model
VehiculosModel: Class Model
VehiculosViewModel: Class Model
Userrules
Autoloader: CodeIgniter Autoloader
FileLocator: Class FileLocator
BaseModel: Class Model
CacheFactory: Class Cache
CacheException: CacheException
BaseHandler: Base class for cache handling
DummyHandler: Dummy cache handler
FileHandler: File system cache handler
MemcachedHandler: Mamcached cache handler
PredisHandler: Predis cache handler
RedisHandler: Redis cache handler
WincacheHandler: Cache handler for WinCache from Microsoft & IIS.
BaseCommand: BaseCommand is the base class used in creating CLI commands.
CLI: Set of static methods useful for CLI request handling.
CommandRunner: Command runner
Commands: Core functionality for running, listing, etc commands.
Console: Console
CLIException: CLIException
CodeIgniter: This class is the core of the framework, and will analyse the request, route it to a controller, and send back the response.
ClearCache: Clears current cache.
InfoCache: Shows information on the cache.
CreateDatabase: Creates a new database.
Migrate: Runs all new migrations.
MigrateRefresh: Does a rollback followed by a latest to refresh the current state of the database.
MigrateRollback: Runs all of the migrations in reverse order, until they have all been unapplied.
MigrateStatus: Displays a list of all migrations and whether they've been run or not.
Seed: Runs the specified Seeder file to populate the database with some data.
GenerateKey: Generates a new encryption key.
CommandGenerator: Generates a skeleton command file.
ConfigGenerator: Generates a skeleton config file.
ControllerGenerator: Generates a skeleton controller file.
EntityGenerator: Generates a skeleton Entity file.
FilterGenerator: Generates a skeleton Filter file.
MigrateCreate: Deprecated class for the migration creation command.
MigrationGenerator: Generates a skeleton migration file.
ModelGenerator: Generates a skeleton Model file.
ScaffoldGenerator: Generates a complete set of scaffold files.
SeederGenerator: Generates a skeleton seeder file.
SessionMigrationGenerator: Generates a migration file for database sessions.
ValidationGenerator: Generates a skeleton Validation file.
Help: CI Help command for the spark script.
ClearDebugbar: ClearDebugbar Command
ClearLogs: ClearLogs command.
ListCommands: CI Help command for the spark script.
Serve: Launch the PHP development server
Environment: Command to display the current environment, or set a new one in the `.env` file.
Namespaces: Lists namespaces set in Config\Autoload with their full server path. Helps you to verify that you have the namespaces setup correctly.
Routes: Lists all of the user-defined routes. This will include any Routes files that can be discovered, but will NOT include any routes that are not defined in a routes file, but are instead discovered through auto-routing.
AutoloadConfig: AUTOLOADER CONFIGURATION
BaseConfig: Class BaseConfig
BaseService: Services Configuration file.
Config: Class Config
DotEnv: Environment-specific configuration
Factories: Factories for creating instances.
Factory: Factories Configuration file.
ForeignCharacters: Describes foreign characters for transliteration with the text helper.
Services: Services Configuration file.
View: View configuration
Controller: Class Controller
Cookie: A `Cookie` class represents an immutable HTTP cookie value object.
CookieStore: The CookieStore object represents an immutable collection of `Cookie` value objects.
CookieException: CookieException is thrown for invalid cookies initialization and management.
BaseBuilder: Class BaseBuilder
BaseConnection: Class BaseConnection
BasePreparedQuery: Base prepared query
BaseResult: Class BaseResult
BaseUtils: Class BaseUtils
Config: Class Config
Database: Database Connection Factory
DatabaseException
DataException
Forge: The Forge class transforms migrations to executable SQL statements.
Migration: Class Migration
MigrationRunner: Class MigrationRunner
ModelFactory: Returns new or shared Model instances
Builder: Builder for MySQLi
Connection: Connection for MySQLi
Forge: Forge for MySQLi
PreparedQuery: Prepared query for MySQLi
Result: Result for MySQLi
Utils: Utils for MySQLi
Builder: Builder for Postgre
Connection: Connection for Postgre
Forge: Forge for Postgre
PreparedQuery: Prepared query for Postgre
Result: Result for Postgre
Utils: Utils for Postgre
Query: Query builder
Seeder: Class Seeder
Builder: Builder for SQLite3
Connection: Connection for SQLite3
Forge: Forge for SQLite3
PreparedQuery: Prepared query for SQLite3
Result: Result for SQLite3
Table: Class Table
Utils: Utils for SQLite3
Builder: Builder for SQLSRV
Connection: Connection for SQLSRV
Forge: Forge for SQLSRV
PreparedQuery: Prepared query for Postgre
Result: Result for SQLSRV
Utils: Utils for SQLSRV
Exceptions: Exceptions manager
Iterator: Iterator for debugging.
Timer: Class Timer
BaseCollector: Base Toolbar collector
Config: Debug toolbar configuration
Database: Collector for the Database tab of the Debug Toolbar.
Events: Views collector
Files: Files collector
History: History collector
Logs: Loags collector
Routes: Routes collector
Timers: Timers collector
Views: Views collector
Toolbar: Debug Toolbar
Email: CodeIgniter Email Class
Encryption: CodeIgniter Encryption Manager
EncryptionException: Encryption exception
BaseHandler: Base class for encryption handling
OpenSSLHandler: Encryption handling for OpenSSL library
SodiumHandler: SodiumHandler uses libsodium in encryption.
ArrayCast: Class ArrayCast
BaseCast: Class BaseCast
BooleanCast: Class BooleanCast
CSVCast: Class CSVCast
DatetimeCast: Class DatetimeCast
FloatCast: Class FloatCast
IntegerCast: Class IntegerCast
JsonCast: Class JsonCast
ObjectCast: Class ObjectCast
StringCast: Class StringCast
TimestampCast: Class TimestampCast
URICast: Class URICast
Entity: Entity encapsulation, for use with CodeIgniter\Model
CastException: CastException is thrown for invalid cast initialization and management.
Entity: Entity encapsulation, for use with CodeIgniter\Model
Events: Events
AlertError: Error: Action must be taken immediately (system/db down, etc)
CastException: Cast Exceptions.
ConfigException: Exception for automatic logging.
CriticalError: Error: Critical conditions, like component unavailable, etc.
DownloadException: Class DownloadException
EmergencyError: Error: system is unusable
FrameworkException: Class FrameworkException
ModelException: Model Exceptions.
PageNotFoundException
FileException
FileNotFoundException
File: Wrapper for PHP's built-in SplFileInfo, with goodies.
CSRF: CSRF filter.
DebugToolbar: Debug toolbar filter
FilterException: FilterException
Filters: Filters
Honeypot: Honeypot filter
FormatException: FormatException
Format: The Format class is a convenient place to create Formatters.
JSONFormatter: JSON data formatter
XMLFormatter: XML data formatter
HoneypotException: Exception for automatic logging.
Honeypot: class Honeypot
CLIRequest: Class CLIRequest
ContentSecurityPolicy: Provides tools for working with the Content-Security-Policy header to help defeat XSS attacks.
CURLRequest: Class OutgoingRequest
DownloadResponse: HTTP response when a download is requested.
HTTPException: Things that can go wrong with HTTP
FileCollection: Class FileCollection
UploadedFile: Value object representing a single file uploaded through an HTTP request. Used by the IncomingRequest class to provide files.
Header: Class Header
IncomingRequest: Class IncomingRequest
Message: An HTTP message
Negotiate: Class Negotiate
RedirectResponse: Handle a redirect response
Request: Representation of an HTTP request.
Response: Representation of an outgoing, getServer-side response.
URI: Abstraction for a uniform resource identifier (URI).
UserAgent: Abstraction for an HTTP user agent
I18nException: I18nException
Time: Class Time
TimeDifference: Class TimeDifference
ImageException: Class FrameworkException
BaseHandler: Base image handling implementation
GDHandler: Image handler for GD package
ImageMagickHandler: Class ImageMagickHandler
Image: Encapsulation of an Image file
Language: Handle system messages and localization.
LogException: Class FrameworkException
BaseHandler: Base class for logging
ChromeLoggerHandler: Class ChromeLoggerHandler
ErrorlogHandler: Log handler that writes to PHP's `error_log()`
FileHandler: Log error messages to file system
Logger: The CodeIgntier Logger
Model: Class Model
Modules: Modules Class
PagerException: Class FrameworkException
Pager: Class Pager
PagerRenderer: Class PagerRenderer
BaseResource: Class Controller
ResourceController: An extendable controller to provide a RESTful API for a resource.
ResourcePresenter: An extendable controller to help provide a UI for a resource.
RedirectException: RedirectException
RouterException: RouterException
RouteCollection: Class RouteCollection
Router: Request router.
SecurityException: Class FrameworkException
Security: Class Security
SessionException: Class FrameworkException
ArrayHandler: Session handler using static array for storage.
BaseHandler: Base class for session handling
DatabaseHandler: Session handler using current Database for storage
FileHandler: Session handler using file system for storage
MemcachedHandler: Session handler using Memcache for persistence
RedisHandler: Session handler using Redis for persistence
Session: Implementation of CodeIgniter session container.
CIDatabaseTestCase: CIDatabaseTestCase
CIUnitTestCase: Framework test case for PHPUnit.
SeeInDatabase
ControllerResponse: Testable response from a controller
DOMParser: Load a response into a DOMDocument for testing assertions based on that
Fabricator: Fabricator
FeatureResponse: Assertions for a response
FeatureTestCase: Class FeatureTestCase
CITestStreamFilter: Class to extract an output snapshot.
MockAppConfig: Class BaseConfig
MockAutoload: ------------------------------------------------------------------- AUTOLOADER CONFIGURATION -------------------------------------------------------------------
MockBuilder: Class BaseBuilder
MockCache: Base class for cache handling
MockCLIConfig: Class BaseConfig
MockCodeIgniter: This class is the core of the framework, and will analyse the request, route it to a controller, and send back the response.
MockConnection: Class BaseConnection
MockCURLRequest: Class MockCURLRequest
MockEmail: CodeIgniter Email Class
MockEvents: Events
MockFileLogger: Class MockFileLogger
MockIncomingRequest: Class IncomingRequest
MockLanguage: Handle system messages and localization.
MockLogger
MockQuery: Query builder
MockResourceController: An extendable controller to provide a RESTful API for a resource.
MockResourcePresenter: An extendable controller to help provide a UI for a resource.
MockResponse: Class MockResponse
MockResult: Class BaseResult
MockSecurity: Class Security
MockSecurityConfig: Class BaseConfig
MockServices: Services Configuration file.
MockSession: Class MockSession
MockTable: HTML Table Generating Class
TestLogger: The CodeIgntier Logger
TestResponse: Test Response Class
Escaper: Context specific methods for use in secure output escaping
InvalidArgumentException: Invalid argument exception
RuntimeException: Invalid argument exception
CallFinder
BasicObject
BlobObject
ClosureObject
DateTimeObject
InstanceObject
MethodObject
ParameterObject
ColorRepresentation
DocstringRepresentation
MicrotimeRepresentation
Representation
SourceRepresentation
SplFileInfoRepresentation
ResourceObject
StreamObject
ThrowableObject
TraceFrameObject
TraceObject
ArrayObjectPlugin
Base64Plugin
BinaryPlugin
BlacklistPlugin
ClassMethodsPlugin
ClassStaticsPlugin
ClosurePlugin
ColorPlugin
DateTimePlugin
DOMDocumentPlugin: The DOMDocument parser plugin is particularly useful as it is both the only way to see inside the DOMNode without print_r, and the only way to see mixed text and node inside XML (SimpleXMLElement will strip out the text).
FsPathPlugin
IteratorPlugin
JsonPlugin
MicrotimePlugin
MysqliPlugin: Adds support for Mysqli object parsing.
Parser
Plugin
ProxyPlugin
SerializePlugin
SimpleXMLElementPlugin
SplFileInfoPlugin
SplObjectStoragePlugin
StreamPlugin
TablePlugin
ThrowablePlugin
TimestampPlugin
ToStringPlugin
TracePlugin
XmlPlugin
CliRenderer
PlainRenderer
Renderer
BinaryPlugin
BlacklistPlugin
CallablePlugin
ClosurePlugin
ColorPlugin
DepthLimitPlugin
DocstringPlugin
MicrotimePlugin
Plugin
RecursionPlugin
SimpleXMLElementPlugin
SourcePlugin
TablePlugin
TimestampPlugin
TraceFramePlugin
RichRenderer
BlacklistPlugin
DepthLimitPlugin
MicrotimePlugin
Plugin
RecursionPlugin
TracePlugin
TextRenderer
Utils: A collection of utility methods. Should all be static methods with no dependencies.
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.
Throttler: Class Throttler
Typography: Typography Class
CreditCardRules: Class CreditCardRules
ValidationException: Class FrameworkException
FileRules: File validation rules
FormatRules: Format validation Rules.
Rules: Validation Rules.
Validation: Validator
Cell: Class Cell
ViewException: Class FrameworkException
Filters: View filters
Parser: Class for parsing pseudo-vars
Plugins: View plugins
Table: HTML Table Generating Class
View: Class View
Alertas: Class BaseController
Cron: Class BaseController
Eventos: Class BaseController
ApiAzimut
AlertasModel: Class Model
EventosModel: Class Model
ComposerAutoloaderInit66b555c03b1bdd972d10d22cdbe0b48d
ComposerStaticInit66b555c03b1bdd972d10d22cdbe0b48d
ClassLoader: ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
InstalledVersions: This class is copied in every Composer installed project and available to all
InvalidArgumentException: Exception for invalid arguments provided to the instantiator
UnexpectedValueException: Exception for given parameters causing invalid/unexpected state on instantiation
Instantiator
Ean: Utility class for validating EAN-8 and EAN-13 numbers
Iban
Inn
Isbn: Utility class for validating ISBN-10
Luhn: Utility class for generating and validating Luhn numbers.
TCNo
Barcode
Blood
Coordinates
File
Number
Version
DefaultGenerator: This generator returns a default value for all called properties and methods. It works with Faker\Generator\Base->optional().
Documentor
Container: A simple implementation of a container.
ContainerBuilder
ContainerException
ExtensionNotFound
Helper: A class with some methods that may make building extensions easier.
NotInContainerException
Factory
Generator
Name
ColumnTypeGuesser
EntityPopulator
Populator
ColumnTypeGuesser
EntityPopulator: Service class for populating a table through a Doctrine Entity class.
Populator: Service class for populating a database using the Doctrine ORM or ODM.
ColumnTypeGuesser
EntityPopulator: Service class for populating a table through a Mandango ActiveRecord class.
Populator: Service class for populating a database using Mandango.
ColumnTypeGuesser
EntityPopulator: Service class for populating a table through a Propel ActiveRecord class.
Populator: Service class for populating a database using the Propel ORM.
ColumnTypeGuesser
EntityPopulator: Service class for populating a table through a Propel ActiveRecord class.
Populator: Service class for populating a database using the Propel ORM.
ColumnTypeGuesser
EntityPopulator: Service class for populating a table through a Spot Entity class.
Populator: Service class for populating a database using the Spot ORM.
Address
Address
Company
Internet
Person
Text
Address
Color
Company
Internet
Payment
Person
Text
Payment
Barcode
Base
Internet
Payment
Person
PhoneNumber
Biased
Address
Company
Person
PhoneNumber
Utils
Color
Company
Address
Company
DateTime: Czech months and days without setting locale
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
DateTime
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Text
Address
Internet
PhoneNumber
Address: Extend US class since most fields share the same format
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Internet
PhoneNumber
Address
Internet
Person
PhoneNumber
Address
Internet
Person
PhoneNumber
Address
Internet
PhoneNumber
Address
PhoneNumber
Address
Person
PhoneNumber
Address
Internet
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Person
PhoneNumber
Address
Company
Person
PhoneNumber
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Person
PhoneNumber
Address
Company
Internet
Person
PhoneNumber
Person
Address
Company
Internet
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
File
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Company
Person
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
HtmlLorem
Address
Company
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Person
PhoneNumber
Address
Color
Company
Internet
Person
PhoneNumber
Image: Depends on image generation from http://lorempixel.com/
Internet
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Person
PhoneNumber
Text
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Person
PhoneNumber
Text
Lorem
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Color
Internet
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Medical
Miscellaneous
Person
PhoneNumber
Address
Company
Miscellaneous
Payment
Person
PhoneNumber
Address
Company
Payment
Person
PhoneNumber
Address
Internet
Person
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Payment
Person
PhoneNumber
Address
Company
Internet
LicensePlate: Generator of Polish vehicle registration numbers.
Payment
Person: Most popular first and last names published by Ministry of the Interior:
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Payment
Person
PhoneNumber
Text
Address
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Company
Internet
Payment
Person
PhoneNumber
Address
Payment
Person
Address
Payment
Person
Address
Payment
Person
Address
Company
Municipality
Payment
Person
PhoneNumber
Text
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Address
Color
Company
Internet
Payment
Person
PhoneNumber
Text
UserAgent
Uuid
Address
Color
Internet
Person
PhoneNumber
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Address
Color
Company
DateTime
Internet
Payment
Person
PhoneNumber
Text
UniqueGenerator: Proxy for other generators that returns only unique values.
ValidGenerator: Proxy for other generators, to return only valid values. Works with Faker\Generator\Base->valid()
CallFinder
BasicObject
BlobObject
ClosureObject
DateTimeObject
InstanceObject
MethodObject
ParameterObject
ColorRepresentation
DocstringRepresentation
MicrotimeRepresentation
Representation
SourceRepresentation
SplFileInfoRepresentation
ResourceObject
StreamObject
ThrowableObject
TraceFrameObject
TraceObject
ArrayObjectPlugin
Base64Plugin
BinaryPlugin
BlacklistPlugin
ClassMethodsPlugin
ClassStaticsPlugin
ClosurePlugin
ColorPlugin
DateTimePlugin
DOMDocumentPlugin: The DOMDocument parser plugin is particularly useful as it is both the only way to see inside the DOMNode without print_r, and the only way to see mixed text and node inside XML (SimpleXMLElement will strip out the text).
FsPathPlugin
IteratorPlugin
JsonPlugin
MicrotimePlugin
MysqliPlugin: Adds support for Mysqli object parsing.
Parser
Plugin
ProxyPlugin
SerializePlugin
SimpleXMLElementPlugin
SplFileInfoPlugin
SplObjectStoragePlugin
StreamPlugin
TablePlugin
ThrowablePlugin
TimestampPlugin
ToStringPlugin
TracePlugin
XmlPlugin
CliRenderer
PlainRenderer
Renderer
BinaryPlugin
BlacklistPlugin
CallablePlugin
ClosurePlugin
ColorPlugin
DepthLimitPlugin
DocstringPlugin
MicrotimePlugin
Plugin
RecursionPlugin
SimpleXMLElementPlugin
SourcePlugin
TablePlugin
TimestampPlugin
TraceFramePlugin
RichRenderer
BlacklistPlugin
DepthLimitPlugin
MicrotimePlugin
Plugin
RecursionPlugin
TracePlugin
TextRenderer
Utils: A collection of utility methods. Should all be static methods with no dependencies.
Escaper: Context specific methods for use in secure output escaping
InvalidArgumentException: Invalid argument exception
RuntimeException: Invalid argument exception
PHPUnit_Util_ErrorHandler
PHPUnit_TextUI_ResultPrinter
BC_PHPUnit_Framework_TestCase: A modified version of PHPUnit's TestCase to rid ourselves of deprecation warnings since we're using two different versions of PHPUnit in this branch (PHPUnit 4 and 5).
vfsStreamDirectoryIssue134TestCase: A modified version of PHPUnit's TestCase to rid ourselves of deprecation warnings since we're using two different versions of PHPUnit in this branch (PHPUnit 4 and 5).
DeepCopy
CloneException
PropertyException
DoctrineCollectionFilter
DoctrineEmptyCollectionFilter
DoctrineProxyFilter
KeepFilter
ReplaceFilter
SetNullFilter
DoctrineProxyMatcher
PropertyMatcher
PropertyNameMatcher
PropertyTypeMatcher: Matches a property by its type.
ReflectionHelper
DateIntervalFilter
ReplaceFilter
ShallowCopyFilter
ArrayObjectFilter: In PHP 7.4 the storage of an ArrayObject isn't returned as ReflectionProperty. So we deep copy its array copy.
SplDoublyLinkedList
SplDoublyLinkedListFilter
TypeMatcher
Class_
ClassConst
Declaration
Function_
FunctionLike
Interface_
Method
Namespace_
Param
Property
Trait_
TraitUse
TraitUseAdaptation
Use_
BuilderFactory
Doc
Comment
ConstExprEvaluationException
ConstExprEvaluator: Evaluates constant expressions.
Error
Collecting: Error handler that collects all errors into an array.
Throwing: Error handler that handles all errors by throwing them.
JsonDecoder
Emulative
AttributeEmulator
CoaleseEqualTokenEmulator
EnumTokenEmulator
ExplicitOctalEmulator
FlexibleDocStringEmulator
FnTokenEmulator
KeywordEmulator
MatchTokenEmulator
NullsafeTokenEmulator
NumericLiteralSeparatorEmulator
ReadonlyTokenEmulator
ReverseEmulator: Reverses emulation direction of the inner emulator.
Lexer
NameContext
Arg
Attribute
AttributeGroup
ComplexType: This is a base class for complex types, including nullable types and union types.
Const_
Array_
ArrayDimFetch
ArrayItem
ArrowFunction
Assign
BitwiseAnd
BitwiseOr
BitwiseXor
Coalesce
Concat
Div
Minus
Mod
Mul
Plus
Pow
ShiftLeft
ShiftRight
AssignOp
AssignRef
BitwiseAnd
BitwiseOr
BitwiseXor
BooleanAnd
BooleanOr
Coalesce
Concat
Div
Equal
Greater
GreaterOrEqual
Identical
LogicalAnd
LogicalOr
LogicalXor
Minus
Mod
Mul
NotEqual
NotIdentical
Plus
Pow
ShiftLeft
ShiftRight
Smaller
SmallerOrEqual
Spaceship
BinaryOp
BitwiseNot
BooleanNot
CallLike
Array_
Bool_
Double
Int_
Object_
String_
Unset_
Cast
ClassConstFetch
Clone_
Closure
ClosureUse
ConstFetch
Empty_
Error: Error node used during parsing with error recovery.
ErrorSuppress
Eval_
Exit_
FuncCall
Include_
Instanceof_
Isset_
List_
Match_
MethodCall
New_
NullsafeMethodCall
NullsafePropertyFetch
PostDec
PostInc
PreDec
PreInc
Print_
PropertyFetch
ShellExec
StaticCall
StaticPropertyFetch
Ternary
Throw_
UnaryMinus
UnaryPlus
Variable
Yield_
YieldFrom
Expr
Identifier: Represents a non-namespaced name. Namespaced names are represented using Name nodes.
IntersectionType: This is a base class for complex types, including nullable types and union types.
MatchArm
FullyQualified
Relative
Name
NullableType: This is a base class for complex types, including nullable types and union types.
Param
DNumber
Encapsed
EncapsedStringPart
LNumber
Class_
Dir
File
Function_
Line
Method
Namespace_
Trait_
MagicConst
String_
Scalar
Break_
Case_
Catch_
Class_
ClassConst
ClassLike
ClassMethod
Const_
Continue_
Declare_
DeclareDeclare
Do_
Echo_
Else_
ElseIf_
Enum_
EnumCase
Expression: Represents statements of type "expr;"
Finally_
For_
Foreach_
Function_
Global_
Goto_
GroupUse
HaltCompiler
If_
InlineHTML
Interface_
Label
Namespace_
Nop: Nop/empty statement (;).
Property
PropertyProperty
Return_
Static_
StaticVar
Switch_
Throw_
Trait_
TraitUse
Alias
Precedence
TraitUseAdaptation
TryCatch
Unset_
Use_
UseUse
While_
Stmt
UnionType: This is a base class for complex types, including nullable types and union types.
VariadicPlaceholder: Represents the "..." in "foo(...)" of the first-class callable syntax.
VarLikeIdentifier: Represents a name that is written in source code with a leading dollar, but is not a proper variable. The leading dollar is not stored as part of the name.
NodeAbstract
NodeDumper
NodeFinder
NodeTraverser
CloningVisitor: Visitor cloning all nodes and linking to the original nodes using an attribute.
FindingVisitor: This visitor can be used to find and collect all nodes satisfying some criterion determined by a filter callback.
FirstFindingVisitor: This visitor can be used to find the first node satisfying some criterion determined by a filter callback.
NameResolver
NodeConnectingVisitor: Visitor that connects a child node to its parent node as well as its sibling nodes.
ParentConnectingVisitor: Visitor that connects a child node to its parent node.
NodeVisitorAbstract
Multiple
Php5
Php7
Tokens
ParserAbstract
ParserFactory
Standard
PrettyPrinterAbstract
ElementCollectionException
InvalidApplicationNameException
InvalidEmailException
InvalidUrlException
ManifestDocumentException
ManifestDocumentLoadingException
ManifestDocumentMapperException
ManifestElementException
ManifestLoaderException
ManifestDocumentMapper
ManifestLoader
ManifestSerializer
Application
ApplicationName
Author
AuthorCollection
AuthorCollectionIterator
BundledComponent
BundledComponentCollection
BundledComponentCollectionIterator
CopyrightInformation
Email
Extension
Library
License
Manifest
PhpExtensionRequirement
PhpVersionRequirement
RequirementCollection
RequirementCollectionIterator
Type
Url
AuthorElement
AuthorElementCollection
BundlesElement
ComponentElement
ComponentElementCollection
ContainsElement
CopyrightElement
ElementCollection
ExtElement
ExtElementCollection
ExtensionElement
LicenseElement
ManifestDocument
ManifestElement
PhpElement
RequiresElement
AbstractVersionConstraint
AndVersionConstraintGroup
AnyVersionConstraint
ExactVersionConstraint
GreaterThanOrEqualToVersionConstraint
OrVersionConstraintGroup
SpecificMajorAndMinorVersionConstraint
SpecificMajorVersionConstraint
InvalidPreReleaseSuffixException
InvalidVersionException
NoPreReleaseSuffixException
UnsupportedVersionConstraintException
PreReleaseSuffix
Version
VersionConstraintParser
VersionConstraintValue
VersionNumber
Fqsen: Value Object for Fqsen.
Location: The location where an element occurs within a file.
Description: Object representing to description for a DocBlock.
DescriptionFactory: Creates a new Description object given a body of text.
ExampleFinder: Class used to find an example file's location based on a given ExampleDescriptor.
Serializer: Converts a DocBlock back from an object to a complete DocComment including Asterisks.
StandardTagFactory: Creates a Tag object given the contents of a tag.
Author: Reflection class for an {@}author tag in a Docblock.
BaseTag: Parses a tag definition for a DocBlock.
Covers: Reflection class for a @covers tag in a Docblock.
Deprecated: Reflection class for a {@}deprecated tag in a Docblock.
Example: Reflection class for a {@}example tag in a Docblock.
AlignFormatter
PassthroughFormatter
Generic: Parses a tag definition for a DocBlock.
InvalidTag: This class represents an exception during the tag creation
Link: Reflection class for a {@}link tag in a Docblock.
Method: Reflection class for an {@}method in a Docblock.
Param: Reflection class for the {@}param tag in a Docblock.
Property: Reflection class for a {@}property tag in a Docblock.
PropertyRead: Reflection class for a {@}property-read tag in a Docblock.
PropertyWrite: Reflection class for a {@}property-write tag in a Docblock.
Fqsen: Fqsen reference used by {@see \phpDocumentor\Reflection\DocBlock\Tags\See}
Url: Url reference used by {@see \phpDocumentor\Reflection\DocBlock\Tags\See}
Return_: Reflection class for a {@}return tag in a Docblock.
See: Reflection class for an {@}see tag in a Docblock.
Since: Reflection class for a {@}since tag in a Docblock.
Source: Reflection class for a {@}source tag in a Docblock.
TagWithType: Parses a tag definition for a DocBlock.
Throws: Reflection class for a {@}throws tag in a Docblock.
Uses: Reflection class for a {@}uses tag in a Docblock.
Var_: Reflection class for a {@}var tag in a Docblock.
Version: Reflection class for a {@}version tag in a Docblock.
DocBlock
DocBlockFactory
PcreException
Utils
FqsenResolver: Resolver for Fqsen using Context information
CallableString: Value Object representing the type 'string'.
False_: Value Object representing the PseudoType 'False', which is a Boolean type.
HtmlEscapedString: Value Object representing the type 'string'.
LiteralString: Value Object representing the type 'string'.
LowercaseString: Value Object representing the type 'string'.
NonEmptyLowercaseString: Value Object representing the type 'string'.
NonEmptyString: Value Object representing the type 'string'.
NumericString: Value Object representing the type 'string'.
PositiveInteger: Value Object representing the type 'string'.
TraitString: Value Object representing the type 'string'.
True_: Value Object representing the PseudoType 'False', which is a Boolean type.
TypeResolver
AbstractList: Represents a list of values. This is an abstract class for Array_ and Collection.
AggregatedType: Base class for aggregated types like Compound and Intersection
Array_: Represents an array type as described in the PSR-5, the PHPDoc Standard.
ArrayKey: Value Object representing a array-key Type.
Boolean: Value Object representing a Boolean type.
Callable_: Value Object representing a Callable type.
ClassString: Value Object representing the type 'string'.
Collection: Represents a collection type as described in the PSR-5, the PHPDoc Standard.
Compound: Value Object representing a Compound Type.
Context: Provides information about the Context in which the DocBlock occurs that receives this context.
ContextFactory: Convenience class to create a Context for DocBlocks when not using the Reflection Component of phpDocumentor.
Expression: Represents an expression type as described in the PSR-5, the PHPDoc Standard.
Float_: Value Object representing a Float.
Integer: Value object representing Integer type
InterfaceString: Value Object representing the type 'string'.
Intersection: Value Object representing a Compound Type.
Iterable_: Value Object representing iterable type
Mixed_: Value Object representing an unknown, or mixed, type.
Never_: Value Object representing the return-type 'never'.
Null_: Value Object representing a null value or type.
Nullable: Value Object representing a nullable type. The real type is wrapped.
Object_: Value Object representing an object.
Parent_: Value Object representing the 'parent' type.
Resource_: Value Object representing the 'resource' Type.
Scalar: Value Object representing the 'scalar' pseudo-type, which is either a string, integer, float or boolean.
Self_: Value Object representing the 'self' type.
Static_: Value Object representing the 'static' type.
String_: Value Object representing the type 'string'.
This: Value Object representing the '$this' pseudo-type.
Void_: Value Object representing the return-type 'void'.
ArgumentsWildcard: Arguments wildcarding.
AnyValuesToken: Any values token.
AnyValueToken: Any single value token.
ApproximateValueToken: Approximate value token
ArrayCountToken: Array elements count token.
ArrayEntryToken: Array entry token.
ArrayEveryEntryToken: Array every entry token.
CallbackToken: Callback-verified token.
ExactValueToken: Exact value token.
IdenticalValueToken: Identical value token.
InArrayToken: Check if values is in array
LogicalAndToken: Logical AND token.
LogicalNotToken: Logical NOT token.
NotInArrayToken: Check if values is not in array
ObjectStateToken: Object state-checker token.
StringContainsToken: String contains token.
TypeToken: Value type token.
Argument: Argument tokens shortcuts.
Call: Call object.
CallCenter: Calls receiver & manager.
ClosureComparator: Closure comparator.
Factory: Prophecy comparator factory.
ProphecyComparator: Compares objects for equality.
CachedDoubler: Cached class doubler.
DisableConstructorPatch: Disable constructor.
HhvmExceptionPatch: Exception patch for HHVM to remove the stubs from special methods
KeywordPatch: Remove method functionality from the double which will clash with php keywords.
MagicCallPatch: Discover Magical API using "@method" PHPDoc format.
ProphecySubjectPatch: Add Prophecy functionality to the double.
ReflectionClassNewInstancePatch: ReflectionClass::newInstance patch.
SplFileInfoPatch: SplFileInfo patch.
ThrowablePatch
TraversablePatch: Traversable interface patch.
Doubler: Cached class doubler.
ClassCodeGenerator: Class code creator.
ClassCreator: Class creator.
ClassMirror: Class mirror.
ArgumentNode: Argument node.
ArgumentTypeNode
ClassNode: Class node.
MethodNode: Method node.
ReturnTypeNode
TypeNodeAbstract
TypeHintReference: Tells whether a keyword refers to a class or to a built-in type for the current version of php
LazyDouble: Lazy double.
NameGenerator: Name generator.
UnexpectedCallException
ClassCreatorException
ClassMirrorException
ClassNotFoundException
DoubleException
InterfaceNotFoundException
MethodNotExtendableException
MethodNotFoundException
ReturnByReferenceException
InvalidArgumentException
AggregateException
FailedPredictionException: Basic failed prediction exception.
NoCallsException
UnexpectedCallsCountException
UnexpectedCallsException
MethodProphecyException
ObjectProphecyException
CallbackPrediction: Callback prediction.
CallPrediction: Call prediction.
CallTimesPrediction: Prediction interface.
NoCallsPrediction: No calls prediction.
CallbackPromise: Callback promise.
ReturnArgumentPromise: Return argument promise.
ReturnPromise: Return promise.
ThrowPromise: Throw promise.
MethodProphecy: Method prophecy.
ObjectProphecy: Object prophecy.
Revealer: Basic prophecies revealer.
Prophet: Prophet creates prophecies.
ExportUtil: This class is a modification from sebastianbergmann/exporter
StringUtil: String utility.
CodeCoverage: Provides collection functionality for PHP code coverage information.
Selector
BranchAndPathCoverageNotSupportedException
DeadCodeDetectionNotSupportedException
DirectoryCouldNotBeCreatedException
InvalidArgumentException
NoCodeCoverageDriverAvailableException
NoCodeCoverageDriverWithPathCoverageSupportAvailableException
ParserException
PathExistsButIsNotDirectoryException
PcovNotAvailableException
PhpdbgNotAvailableException
ReflectionException
ReportAlreadyFinalizedException
StaticAnalysisCacheNotConfiguredException
TestIdMissingException
UnintentionallyCoveredCodeException
WriteOperationFailedException
WrongXdebugVersionException
Xdebug2NotEnabledException
Xdebug3NotEnabledException
XdebugNotAvailableException
XmlException
Filter
Clover
Cobertura
Crap4j
Facade
PHP
Text
Facade
CacheWarmer
Version
Facade
Factory
Iterator
ProcessControlExtensionNotLoadedException
TimeoutException
Invoker
InvalidArgumentException
RuntimeException
Template
Duration
NoActiveTimerException
TimeSinceStartOfRequestNotAvailableException
ResourceUsageFormatter
Timer
Assert
IsFalse
IsTrue
Callback
Count
GreaterThan
IsEmpty
LessThan
SameSize
Constraint
IsEqual
IsEqualCanonicalizing
IsEqualIgnoringCase
IsEqualWithDelta
Exception
ExceptionCode
ExceptionMessage
ExceptionMessageRegularExpression
DirectoryExists
FileExists
IsReadable
IsWritable
IsAnything
IsIdentical
JsonMatches
JsonMatchesErrorMessageProvider
IsFinite
IsInfinite
IsNan
ClassHasAttribute
ClassHasStaticAttribute
ObjectEquals
ObjectHasAttribute
BinaryOperator
LogicalAnd
LogicalNot
LogicalOr
LogicalXor
Operator
UnaryOperator
IsJson
RegularExpression
StringContains
StringEndsWith
StringMatchesFormatDescription
StringStartsWith
ArrayHasKey
TraversableContains
TraversableContainsEqual
TraversableContainsIdentical
TraversableContainsOnly
IsInstanceOf
IsNull
IsType
InvocationMocker
MockBuilder
TestCase
Version
Command
Blacklist
ExcludeList
NaiveDistributor
SimpleDebuggableConnection: Standard connection to Redis servers implemented on top of PHP's streams.
EventsListener
IncrementExistingKeysBy: Base class used to implement an higher level abstraction for commands based on Lua scripting with EVAL and EVALSHA.
HashMultipleGetAll: Base class used to implement an higher level abstraction for commands based on Lua scripting with EVAL and EVALSHA.
Autoloader: Implements a lightweight PSR-0 compliant autoloader for Predis.
Client: Client class used for connecting and executing commands on Redis.
ClientException: Exception class that identifies client-side errors.
ClusterStrategy: Common class implementing the logic needed to support clustering strategies.
EmptyRingException: Exception class that identifies empty rings.
HashRing: This class implements an hashring-based distributor that uses the same algorithm of memcache to distribute keys in a cluster using client-side sharding.
KetamaRing: This class implements an hashring-based distributor that uses the same algorithm of libketama to distribute keys in a cluster using client-side sharding.
CRC16: Hash generator implementing the CRC-CCITT-16 algorithm used by redis-cluster.
PredisStrategy: Default cluster strategy used by Predis to handle client-side sharding.
RedisStrategy: Default class used by Predis to calculate hashes out of keys of commands supported by redis-cluster.
CursorBasedIterator: Provides the base implementation for a fully-rewindable PHP iterator that can incrementally iterate over cursor-based collections stored on Redis using the commands in the `SCAN` family.
HashKey: Abstracts the iteration of fields and values of an hash by leveraging the HSCAN command (Redis >= 2.8) wrapped in a fully-rewindable PHP iterator.
Keyspace: Abstracts the iteration of the keyspace on a Redis instance by leveraging the SCAN command (Redis >= 2.8) wrapped in a fully-rewindable PHP iterator.
ListKey: Abstracts the iteration of items stored in a list by leveraging the LRANGE command wrapped in a fully-rewindable PHP iterator.
SetKey: Abstracts the iteration of members stored in a set by leveraging the SSCAN command (Redis >= 2.8) wrapped in a fully-rewindable PHP iterator.
SortedSetKey: Abstracts the iteration of members stored in a sorted set by leveraging the ZSCAN command (Redis >= 2.8) wrapped in a fully-rewindable PHP iterator.
Command: Base class for Redis commands.
ConnectionAuth: Base class for Redis commands.
ConnectionEcho: Base class for Redis commands.
ConnectionPing: Base class for Redis commands.
ConnectionQuit: Base class for Redis commands.
ConnectionSelect: Base class for Redis commands.
GeospatialGeoAdd: Base class for Redis commands.
GeospatialGeoDist: Base class for Redis commands.
GeospatialGeoHash: Base class for Redis commands.
GeospatialGeoPos: Base class for Redis commands.
GeospatialGeoRadius: Base class for Redis commands.
GeospatialGeoRadiusByMember: Base class for Redis commands.
HashDelete: Base class for Redis commands.
HashExists: Base class for Redis commands.
HashGet: Base class for Redis commands.
HashGetAll: Base class for Redis commands.
HashGetMultiple: Base class for Redis commands.
HashIncrementBy: Base class for Redis commands.
HashIncrementByFloat: Base class for Redis commands.
HashKeys: Base class for Redis commands.
HashLength: Base class for Redis commands.
HashScan: Base class for Redis commands.
HashSet: Base class for Redis commands.
HashSetMultiple: Base class for Redis commands.
HashSetPreserve: Base class for Redis commands.
HashStringLength: Base class for Redis commands.
HashValues: Base class for Redis commands.
HyperLogLogAdd: Base class for Redis commands.
HyperLogLogCount: Base class for Redis commands.
HyperLogLogMerge: Base class for Redis commands.
KeyDelete: Base class for Redis commands.
KeyDump: Base class for Redis commands.
KeyExists: Base class for Redis commands.
KeyExpire: Base class for Redis commands.
KeyExpireAt: Base class for Redis commands.
KeyKeys: Base class for Redis commands.
KeyMigrate: Base class for Redis commands.
KeyMove: Base class for Redis commands.
KeyPersist: Base class for Redis commands.
KeyPreciseExpire: Base class for Redis commands.
KeyPreciseExpireAt: Base class for Redis commands.
KeyPreciseTimeToLive: Base class for Redis commands.
KeyRandom: Base class for Redis commands.
KeyRename: Base class for Redis commands.
KeyRenamePreserve: Base class for Redis commands.
KeyRestore: Base class for Redis commands.
KeyScan: Base class for Redis commands.
KeySort: Base class for Redis commands.
KeyTimeToLive: Base class for Redis commands.
KeyType: Base class for Redis commands.
ListIndex: Base class for Redis commands.
ListInsert: Base class for Redis commands.
ListLength: Base class for Redis commands.
ListPopFirst: Base class for Redis commands.
ListPopFirstBlocking: Base class for Redis commands.
ListPopLast: Base class for Redis commands.
ListPopLastBlocking: Base class for Redis commands.
ListPopLastPushHead: Base class for Redis commands.
ListPopLastPushHeadBlocking: Base class for Redis commands.
ListPushHead: Base class for Redis commands.
ListPushHeadX: Base class for Redis commands.
ListPushTail: Base class for Redis commands.
ListPushTailX: Base class for Redis commands.
ListRange: Base class for Redis commands.
ListRemove: Base class for Redis commands.
ListSet: Base class for Redis commands.
ListTrim: Base class for Redis commands.
KeyPrefixProcessor: Command processor capable of prefixing keys stored in the arguments of Redis commands supported.
ProcessorChain: Default implementation of a command processors chain.
PubSubPublish: Base class for Redis commands.
PubSubPubsub: Base class for Redis commands.
PubSubSubscribe: Base class for Redis commands.
PubSubSubscribeByPattern: Base class for Redis commands.
PubSubUnsubscribe: Base class for Redis commands.
PubSubUnsubscribeByPattern: Base class for Redis commands.
RawCommand: Class for generic "anonymous" Redis commands.
ScriptCommand: Base class used to implement an higher level abstraction for commands based on Lua scripting with EVAL and EVALSHA.
ServerBackgroundRewriteAOF: Base class for Redis commands.
ServerBackgroundSave: Base class for Redis commands.
ServerClient: Base class for Redis commands.
ServerCommand: Base class for Redis commands.
ServerConfig: Base class for Redis commands.
ServerDatabaseSize: Base class for Redis commands.
ServerEval: Base class for Redis commands.
ServerEvalSHA: Base class for Redis commands.
ServerFlushAll: Base class for Redis commands.
ServerFlushDatabase: Base class for Redis commands.
ServerInfo: Base class for Redis commands.
ServerInfoV26x: Base class for Redis commands.
ServerLastSave: Base class for Redis commands.
ServerMonitor: Base class for Redis commands.
ServerObject: Base class for Redis commands.
ServerSave: Base class for Redis commands.
ServerScript: Base class for Redis commands.
ServerSentinel: Base class for Redis commands.
ServerShutdown: Base class for Redis commands.
ServerSlaveOf: Base class for Redis commands.
ServerSlowlog: Base class for Redis commands.
ServerTime: Base class for Redis commands.
SetAdd: Base class for Redis commands.
SetCardinality: Base class for Redis commands.
SetDifference: Base class for Redis commands.
SetDifferenceStore: Base class for Redis commands.
SetIntersection: Base class for Redis commands.
SetIntersectionStore: Base class for Redis commands.
SetIsMember: Base class for Redis commands.
SetMembers: Base class for Redis commands.
SetMove: Base class for Redis commands.
SetPop: Base class for Redis commands.
SetRandomMember: Base class for Redis commands.
SetRemove: Base class for Redis commands.
SetScan: Base class for Redis commands.
SetUnion: Base class for Redis commands.
SetUnionStore: Base class for Redis commands.
StringAppend: Base class for Redis commands.
StringBitCount: Base class for Redis commands.
StringBitField: Base class for Redis commands.
StringBitOp: Base class for Redis commands.
StringBitPos: Base class for Redis commands.
StringDecrement: Base class for Redis commands.
StringDecrementBy: Base class for Redis commands.
StringGet: Base class for Redis commands.
StringGetBit: Base class for Redis commands.
StringGetMultiple: Base class for Redis commands.
StringGetRange: Base class for Redis commands.
StringGetSet: Base class for Redis commands.
StringIncrement: Base class for Redis commands.
StringIncrementBy: Base class for Redis commands.
StringIncrementByFloat: Base class for Redis commands.
StringPreciseSetExpire: Base class for Redis commands.
StringSet: Base class for Redis commands.
StringSetBit: Base class for Redis commands.
StringSetExpire: Base class for Redis commands.
StringSetMultiple: Base class for Redis commands.
StringSetMultiplePreserve: Base class for Redis commands.
StringSetPreserve: Base class for Redis commands.
StringSetRange: Base class for Redis commands.
StringStrlen: Base class for Redis commands.
StringSubstr: Base class for Redis commands.
TransactionDiscard: Base class for Redis commands.
TransactionExec: Base class for Redis commands.
TransactionMulti: Base class for Redis commands.
TransactionUnwatch: Base class for Redis commands.
TransactionWatch: Base class for Redis commands.
ZSetAdd: Base class for Redis commands.
ZSetCardinality: Base class for Redis commands.
ZSetCount: Base class for Redis commands.
ZSetIncrementBy: Base class for Redis commands.
ZSetIntersectionStore: Base class for Redis commands.
ZSetLexCount: Base class for Redis commands.
ZSetRange: Base class for Redis commands.
ZSetRangeByLex: Base class for Redis commands.
ZSetRangeByScore: Base class for Redis commands.
ZSetRank: Base class for Redis commands.
ZSetRemove: Base class for Redis commands.
ZSetRemoveRangeByLex: Base class for Redis commands.
ZSetRemoveRangeByRank: Base class for Redis commands.
ZSetRemoveRangeByScore: Base class for Redis commands.
ZSetReverseRange: Base class for Redis commands.
ZSetReverseRangeByLex: Base class for Redis commands.
ZSetReverseRangeByScore: Base class for Redis commands.
ZSetReverseRank: Base class for Redis commands.
ZSetScan: Base class for Redis commands.
ZSetScore: Base class for Redis commands.
ZSetUnionStore: Base class for Redis commands.
CommunicationException: Base exception class for network-related errors.
ClusterOption: Configures an aggregate connection used for clustering multiple Redis nodes using various implementations with different algorithms or strategies.
ConnectionFactoryOption: Configures a connection factory used by the client to create new connection instances for single Redis nodes.
ExceptionsOption: Configures whether consumers (such as the client) should throw exceptions on Redis errors (-ERR responses) or just return instances of error responses.
Options: Manages Predis options with filtering, conversion and lazy initialization of values using a mini-DI container approach.
PrefixOption: Configures a command processor that apply the specified prefix string to a series of Redis commands considered prefixable.
ProfileOption: Configures the server profile to be used by the client to create command instances depending on the specified version of the Redis server.
ReplicationOption: Configures an aggregate connection used for master/slave replication among multiple Redis nodes.
AbstractConnection: Base class with the common logic used by connection classes to communicate with Redis.
MasterSlaveReplication: Aggregate connection handling replication of Redis nodes configured in a single master / multiple slaves setup.
PredisCluster: Abstraction for a cluster of aggregate connections to various Redis servers implementing client-side sharding based on pluggable distribution strategies.
RedisCluster: Abstraction for a Redis-backed cluster of nodes (Redis >= 3.0.0).
SentinelReplication
CompositeStreamConnection: Connection abstraction to Redis servers based on PHP's stream that uses an external protocol processor defining the protocol used for the communication.
ConnectionException: Exception class that identifies connection-related errors.
Factory: Standard connection factory for creating connections to Redis nodes.
Parameters: Container for connection parameters used to initialize connections to Redis.
PhpiredisSocketConnection: This class provides the implementation of a Predis connection that uses the PHP socket extension for network communication and wraps the phpiredis C extension (PHP bindings for hiredis) to parse the Redis protocol.
PhpiredisStreamConnection: This class provides the implementation of a Predis connection that uses PHP's streams for network communication and wraps the phpiredis C extension (PHP bindings for hiredis) to parse and serialize the Redis protocol.
StreamConnection: Standard connection to Redis servers implemented on top of PHP's streams.
WebdisConnection: This class implements a Predis connection that actually talks with Webdis instead of connecting directly to Redis. It relies on the cURL extension to communicate with the web server and the phpiredis extension to parse the protocol for responses returned in the http response bodies.
Consumer: Redis MONITOR consumer.
NotSupportedException: Exception class thrown when trying to use features not supported by certain classes or abstractions of Predis.
Atomic: Command pipeline wrapped into a MULTI / EXEC transaction.
ConnectionErrorProof: Command pipeline that does not throw exceptions on connection errors, but returns the exception instances as the rest of the response elements.
FireAndForget: Command pipeline that writes commands to the servers but discards responses.
Pipeline: Implementation of a command pipeline in which write and read operations of Redis commands are pipelined to alleviate the effects of network round-trips.
PredisException: Base exception class for Predis-related errors.
Factory: Factory class for creating profile instances from strings.
RedisProfile: Base class implementing common functionalities for Redis server profiles.
RedisUnstable: Server profile for the current unstable version of Redis.
RedisVersion200: Server profile for Redis 2.0.
RedisVersion220: Server profile for Redis 2.2.
RedisVersion240: Server profile for Redis 2.4.
RedisVersion260: Server profile for Redis 2.6.
RedisVersion280: Server profile for Redis 2.8.
RedisVersion300: Server profile for Redis 3.0.
RedisVersion320: Server profile for Redis 3.0.
ProtocolException: Exception used to indentify errors encountered while parsing the Redis wire protocol.
CompositeProtocolProcessor: Composite protocol processor for the standard Redis wire protocol using pluggable handlers to serialize requests and deserialize responses.
BulkResponse: Handler for the bulk response type in the standard Redis wire protocol.
ErrorResponse: Handler for the error response type in the standard Redis wire protocol.
IntegerResponse: Handler for the integer response type in the standard Redis wire protocol.
MultiBulkResponse: Handler for the multibulk response type in the standard Redis wire protocol.
StatusResponse: Handler for the status response type in the standard Redis wire protocol. It translates certain classes of status response to PHP objects or just returns the payload as a string.
StreamableMultiBulkResponse: Handler for the multibulk response type in the standard Redis wire protocol.
ProtocolProcessor: Protocol processor for the standard Redis wire protocol.
RequestSerializer: Request serializer for the standard Redis wire protocol.
ResponseReader: Response reader for the standard Redis wire protocol.
AbstractConsumer: Base implementation of a PUB/SUB consumer abstraction based on PHP iterators.
Consumer: PUB/SUB consumer abstraction.
DispatcherLoop: Method-dispatcher loop built around the client-side abstraction of a Redis PUB / SUB context.
MissingMasterException: Exception class that identifies when master is missing in a replication setup.
ReplicationStrategy: Defines a strategy for master/slave replication.
RoleException: Exception class that identifies a role mismatch when connecting to node managed by redis-sentinel.
Error: Represents an error returned by Redis (-ERR responses) during the execution of a command on the server.
MultiBulk: Streamable multibulk response.
MultiBulkIterator: Iterator that abstracts the access to multibulk responses allowing them to be consumed in a streamable fashion without keeping the whole payload in memory.
MultiBulkTuple: Outer iterator consuming streamable multibulk responses by yielding tuples of keys and values.
ServerException: Exception class that identifies server-side Redis errors.
Status: Represents a status response returned by Redis.
Handler: Session handler class that relies on Predis\Client to store PHP's sessions data into one or multiple Redis servers.
AbortedMultiExecException: Exception class that identifies a MULTI / EXEC transaction aborted by Redis.
MultiExec: Client-side abstraction of a Redis transaction based on MULTI / EXEC.
MultiExecState: Utility class used to track the state of a MULTI / EXEC transaction.
AbstractLogger: This is a simple Logger implementation that other Loggers can inherit from.
InvalidArgumentException
LogLevel: Describes log levels.
NullLogger: This Logger can be used to avoid conditional log calls.
LoggerInterfaceTest: Provides a base test class for ensuring compliance with the LoggerInterface.
TestLogger: Used for testing purposes.
AmbiguousOptionException
OptionDoesNotAllowArgumentException
RequiredOptionArgumentMissingException
UnknownOptionException
Parser
ClassMethodUnit
ClassUnit
CodeUnit
CodeUnitCollection
CodeUnitCollectionIterator
InvalidCodeUnitException
NoTraitException
ReflectionException
FunctionUnit
InterfaceMethodUnit
InterfaceUnit
Mapper
TraitMethodUnit
TraitUnit
Wizard
ArrayComparator: Compares arrays for equality.
Comparator: Abstract base class for comparators which compare values for equality.
ComparisonFailure: Thrown when an assertion for string equality failed.
DateTimeComparator: Compares DateTimeInterface instances for equality.
DOMNodeComparator: Compares DOMNode instances for equality.
DoubleComparator: Compares doubles for equality.
ExceptionComparator: Compares Exception instances for equality.
RuntimeException
Factory: Factory for comparators which compare values for equality.
MockObjectComparator: Compares PHPUnit\Framework\MockObject\MockObject instances for equality.
NumericComparator: Compares numerical values for equality.
ObjectComparator: Compares objects for equality.
ResourceComparator: Compares resources for equality.
ScalarComparator: Compares scalar or NULL values for equality.
SplObjectStorageComparator: Compares \SplObjectStorage instances for equality.
TypeComparator: Compares values for type equality.
Calculator
Complexity
ComplexityCollection
ComplexityCollectionIterator
RuntimeException
ComplexityCalculatingVisitor
CyclomaticComplexityCalculatingVisitor
Chunk
Diff
Differ
ConfigurationException
InvalidArgumentException
Line
MemoryEfficientLongestCommonSubsequenceCalculator
AbstractChunkOutputBuilder
DiffOnlyOutputBuilder: Builds a diff string representation in a loose unified diff format listing only changes lines. Does not include line numbers.
StrictUnifiedDiffOutputBuilder: Strict Unified diff output builder.
UnifiedDiffOutputBuilder: Builds a diff string representation in unified diff format in chunks.
Parser: Unified diff parser.
TimeEfficientLongestCommonSubsequenceCalculator
Console
OperatingSystem
Runtime: Utility class for HHVM/PHP environment handling.
Exporter: A nifty utility for visualizing PHP variables.
CodeExporter: Exports parts of a Snapshot as PHP code.
RuntimeException
ExcludeList
Restorer: Restorer of snapshots of global state.
Snapshot: A snapshot of global state.
Counter
IllogicalValuesException
NegativeValueException
RuntimeException
LineCountingVisitor
LinesOfCode
Enumerator: Traverses array structures and object graphs to enumerate all referenced objects.
InvalidArgumentException
InvalidArgumentException
ObjectReflector
Context: A context containing previously processed arrays and objects when recursively processing a value.
InvalidArgumentException
ResourceOperations
CallableType
LogicException
RuntimeException
FalseType
GenericObjectType
IterableType
MixedType
NullType
ObjectType
ReflectionMapper
SimpleType
StaticType
Type
TypeName
UnionType
UnknownType
VoidType
Version
Autoload
Config: Stores the configuration used to run PHPCS and PHPCBF.
DeepExitException
RuntimeException
TokenizerException
DummyFile
File
FileList
LocalFile
ExactMatch
Filter
GitModified
GitStaged
Fixer
Generator
HTML
Markdown
Text
Reporter
Cbf
Checkstyle
Code
Csv
Diff
Emacs
Full
Gitblame
Hgblame
Info
Json
Junit
Notifysend
Source
Summary
Svnblame
VersionControl
Xml
Ruleset
Runner
AbstractArraySniff
AbstractPatternSniff
AbstractScopeSniff
AbstractVariableSniff
ArrayIndentSniff
DisallowLongArraySyntaxSniff
DisallowShortArraySyntaxSniff
DuplicateClassNameSniff
OpeningBraceSameLineSniff
AssignmentInConditionSniff
EmptyPHPStatementSniff
EmptyStatementSniff
ForLoopShouldBeWhileLoopSniff
ForLoopWithTestFunctionCallSniff
JumbledIncrementerSniff
UnconditionalIfStatementSniff
UnnecessaryFinalModifierSniff
UnusedFunctionParameterSniff
UselessOverridingMethodSniff
DocCommentSniff
FixmeSniff
TodoSniff
DisallowYodaConditionsSniff
InlineControlStructureSniff
ClosureLinterSniff
CSSLintSniff
ESLintSniff
JSHintSniff
ByteOrderMarkSniff
EndFileNewlineSniff
EndFileNoNewlineSniff
ExecutableFileSniff
InlineHTMLSniff
LineEndingsSniff
LineLengthSniff
LowercasedFilenameSniff
OneClassPerFileSniff
OneInterfacePerFileSniff
OneObjectStructurePerFileSniff
OneTraitPerFileSniff
DisallowMultipleStatementsSniff
MultipleStatementAlignmentSniff
NoSpaceAfterCastSniff
SpaceAfterCastSniff
SpaceAfterNotSniff
SpaceBeforeCastSniff
CallTimePassByReferenceSniff
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
UnnecessaryStringConcatSniff
GitMergeConflictSniff
SubversionPropertiesSniff
ArbitraryParenthesesSpacingSniff
DisallowSpaceIndentSniff
DisallowTabIndentSniff
IncrementDecrementSpacingSniff
LanguageConstructSpacingSniff
ScopeIndentSniff
SpreadOperatorSpacingAfterSniff
ArrayIndentUnitTest
DisallowLongArraySyntaxUnitTest
DisallowShortArraySyntaxUnitTest
DuplicateClassNameUnitTest
OpeningBraceSameLineUnitTest
AssignmentInConditionUnitTest
EmptyPHPStatementUnitTest
EmptyStatementUnitTest
ForLoopShouldBeWhileLoopUnitTest
ForLoopWithTestFunctionCallUnitTest
JumbledIncrementerUnitTest
UnconditionalIfStatementUnitTest
UnnecessaryFinalModifierUnitTest
UnusedFunctionParameterUnitTest
UselessOverridingMethodUnitTest
DocCommentUnitTest
FixmeUnitTest
TodoUnitTest
DisallowYodaConditionsUnitTest
InlineControlStructureUnitTest
ClosureLinterUnitTest
CSSLintUnitTest
ESLintUnitTest
JSHintUnitTest
ByteOrderMarkUnitTest
EndFileNewlineUnitTest
EndFileNoNewlineUnitTest
ExecutableFileUnitTest
InlineHTMLUnitTest
LineEndingsUnitTest
LineLengthUnitTest
LowercasedFilenameUnitTest
OneClassPerFileUnitTest
OneInterfacePerFileUnitTest
OneObjectStructurePerFileUnitTest
OneTraitPerFileUnitTest
DisallowMultipleStatementsUnitTest
MultipleStatementAlignmentUnitTest
NoSpaceAfterCastUnitTest
SpaceAfterCastUnitTest
SpaceAfterNotUnitTest
SpaceBeforeCastUnitTest
CallTimePassByReferenceUnitTest
FunctionCallArgumentSpacingUnitTest
OpeningFunctionBraceBsdAllmanUnitTest
OpeningFunctionBraceKernighanRitchieUnitTest
CyclomaticComplexityUnitTest
NestingLevelUnitTest
AbstractClassNamePrefixUnitTest
CamelCapsFunctionNameUnitTest
ConstructorNameUnitTest
InterfaceNameSuffixUnitTest
TraitNameSuffixUnitTest
UpperCaseConstantNameUnitTest
BacktickOperatorUnitTest
CharacterBeforePHPOpeningTagUnitTest
ClosingPHPTagUnitTest
DeprecatedFunctionsUnitTest
DisallowAlternativePHPTagsUnitTest
DisallowRequestSuperglobalUnitTest
DisallowShortOpenTagUnitTest
DiscourageGotoUnitTest
ForbiddenFunctionsUnitTest
LowerCaseConstantUnitTest
LowerCaseKeywordUnitTest
LowerCaseTypeUnitTest
NoSilencedErrorsUnitTest
RequireStrictTypesUnitTest
SAPIUsageUnitTest
SyntaxUnitTest
UpperCaseConstantUnitTest
UnnecessaryStringConcatUnitTest
GitMergeConflictUnitTest
SubversionPropertiesUnitTest
ArbitraryParenthesesSpacingUnitTest
DisallowSpaceIndentUnitTest
DisallowTabIndentUnitTest
IncrementDecrementSpacingUnitTest
LanguageConstructSpacingUnitTest
ScopeIndentUnitTest
SpreadOperatorSpacingAfterUnitTest
DisallowSelfActionsSniff
IncludeOwnSystemSniff
IncludeSystemSniff
UnusedSystemSniff
FunctionCommentSniff
BrowserSpecificStylesSniff
DebugCodeSniff
FirebugConsoleSniff
AssignThisSniff
CreateWidgetTypeCallbackSniff
DisallowNewWidgetSniff
AjaxNullComparisonSniff
EvalObjectFactorySniff
GetRequestDataSniff
ReturnFunctionValueSniff
JoinStringsSniff
DisallowSelfActionsUnitTest
IncludeSystemUnitTest
UnusedSystemUnitTest
FunctionCommentUnitTest
BrowserSpecificStylesUnitTest
DebugCodeUnitTest
FirebugConsoleUnitTest
AssignThisUnitTest
CreateWidgetTypeCallbackUnitTest
DisallowNewWidgetUnitTest
AjaxNullComparisonUnitTest
EvalObjectFactoryUnitTest
GetRequestDataUnitTest
ReturnFunctionValueUnitTest
JoinStringsUnitTest
ClassDeclarationSniff
ClassCommentSniff
FileCommentSniff
FunctionCommentSniff
InlineCommentSniff
ControlSignatureSniff
MultiLineConditionSniff
IncludingFileSniff
MultiLineAssignmentSniff
FunctionCallSignatureSniff
FunctionDeclarationSniff
ValidDefaultValueSniff
ValidClassNameSniff
ValidFunctionNameSniff
ValidVariableNameSniff
ObjectOperatorIndentSniff
ScopeClosingBraceSniff
ScopeIndentSniff
ClassDeclarationUnitTest
ClassCommentUnitTest
FileCommentUnitTest
FunctionCommentUnitTest
InlineCommentUnitTest
ControlSignatureUnitTest
MultiLineConditionUnitTest
IncludingFileUnitTest
MultiLineAssignmentUnitTest
FunctionCallSignatureUnitTest
FunctionDeclarationUnitTest
ValidDefaultValueUnitTest
ValidClassNameUnitTest
ValidFunctionNameUnitTest
ValidVariableNameUnitTest
ObjectOperatorIndentUnitTest
ScopeClosingBraceUnitTest
ScopeIndentUnitTest
ClassDeclarationSniff
SideEffectsSniff
CamelCapsMethodNameSniff
ClassDeclarationUnitTest
SideEffectsUnitTest
CamelCapsMethodNameUnitTest
AnonClassDeclarationSniff
ClassInstantiationSniff
ClosingBraceSniff
BooleanOperatorPlacementSniff
ControlStructureSpacingSniff
DeclareStatementSniff
FileHeaderSniff
ImportStatementSniff
OpenTagSniff
NullableTypeDeclarationSniff
ReturnTypeDeclarationSniff
ShortFormTypeKeywordsSniff
CompoundNamespaceDepthSniff
OperatorSpacingSniff
ConstantVisibilitySniff
UseDeclarationSniff
AnonClassDeclarationUnitTest
ClassInstantiationUnitTest
ClosingBraceUnitTest
BooleanOperatorPlacementUnitTest
ControlStructureSpacingUnitTest
DeclareStatementUnitTest
FileHeaderUnitTest
ImportStatementUnitTest
OpenTagUnitTest
NullableTypeDeclarationUnitTest
ReturnTypeDeclarationUnitTest
ShortFormTypeKeywordsUnitTest
CompoundNamespaceDepthUnitTest
OperatorSpacingUnitTest
ConstantVisibilityUnitTest
UseDeclarationUnitTest
ClassDeclarationSniff
PropertyDeclarationSniff
ControlStructureSpacingSniff
ElseIfDeclarationSniff
SwitchDeclarationSniff
ClosingTagSniff
EndFileNewlineSniff
FunctionCallSignatureSniff
FunctionClosingBraceSniff
MethodDeclarationSniff
NamespaceDeclarationSniff
UseDeclarationSniff
ClassDeclarationUnitTest
PropertyDeclarationUnitTest
ControlStructureSpacingUnitTest
ElseIfDeclarationUnitTest
SwitchDeclarationUnitTest
ClosingTagUnitTest
EndFileNewlineUnitTest
FunctionCallSignatureUnitTest
FunctionClosingBraceUnitTest
MethodDeclarationUnitTest
NamespaceDeclarationUnitTest
UseDeclarationUnitTest
ArrayBracketSpacingSniff
ArrayDeclarationSniff
ClassDeclarationSniff
ClassFileNameSniff
DuplicatePropertySniff
LowercaseClassKeywordsSniff
SelfMemberReferenceSniff
ValidClassNameSniff
BlockCommentSniff
ClassCommentSniff
ClosingDeclarationCommentSniff
DocCommentAlignmentSniff
EmptyCatchCommentSniff
FileCommentSniff
FunctionCommentSniff
FunctionCommentThrowTagSniff
InlineCommentSniff
LongConditionClosingCommentSniff
PostStatementCommentSniff
VariableCommentSniff
ControlSignatureSniff
ElseIfDeclarationSniff
ForEachLoopDeclarationSniff
ForLoopDeclarationSniff
InlineIfDeclarationSniff
LowercaseDeclarationSniff
SwitchDeclarationSniff
ClassDefinitionClosingBraceSpaceSniff
ClassDefinitionNameSpacingSniff
ClassDefinitionOpeningBraceSpaceSniff
ColonSpacingSniff
ColourDefinitionSniff
DisallowMultipleStyleDefinitionsSniff
DuplicateClassDefinitionSniff
DuplicateStyleDefinitionSniff
EmptyClassDefinitionSniff
EmptyStyleDefinitionSniff
ForbiddenStylesSniff
IndentationSniff
LowercaseStyleDefinitionSniff
MissingColonSniff
NamedColoursSniff
OpacitySniff
SemicolonSpacingSniff
ShorthandSizeSniff
JavaScriptLintSniff
JSLintSniff
FileExtensionSniff
OperatorBracketSniff
FunctionDeclarationArgumentSpacingSniff
FunctionDeclarationSniff
FunctionDuplicateArgumentSniff
GlobalFunctionSniff
LowercaseFunctionKeywordsSniff
MultiLineFunctionDeclarationSniff
ValidFunctionNameSniff
ValidVariableNameSniff
DisallowObjectStringIndexSniff
ObjectInstantiationSniff
ObjectMemberCommaSniff
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
LanguageConstructSpacingSniff
LogicalOperatorSpacingSniff
MemberVarSpacingSniff
ObjectOperatorSpacingSniff
OperatorSpacingSniff
PropertyLabelSpacingSniff
ScopeClosingBraceSniff
ScopeKeywordSpacingSniff
SemicolonSpacingSniff
SuperfluousWhitespaceSniff
ArrayBracketSpacingUnitTest
ArrayDeclarationUnitTest
ClassDeclarationUnitTest
ClassFileNameUnitTest
DuplicatePropertyUnitTest
LowercaseClassKeywordsUnitTest
SelfMemberReferenceUnitTest
ValidClassNameUnitTest
BlockCommentUnitTest
ClassCommentUnitTest
ClosingDeclarationCommentUnitTest
DocCommentAlignmentUnitTest
EmptyCatchCommentUnitTest
FileCommentUnitTest
FunctionCommentThrowTagUnitTest
FunctionCommentUnitTest
InlineCommentUnitTest
LongConditionClosingCommentUnitTest
PostStatementCommentUnitTest
VariableCommentUnitTest
ControlSignatureUnitTest
ElseIfDeclarationUnitTest
ForEachLoopDeclarationUnitTest
ForLoopDeclarationUnitTest
InlineIfDeclarationUnitTest
LowercaseDeclarationUnitTest
SwitchDeclarationUnitTest
ClassDefinitionClosingBraceSpaceUnitTest
ClassDefinitionNameSpacingUnitTest
ClassDefinitionOpeningBraceSpaceUnitTest
ColonSpacingUnitTest
ColourDefinitionUnitTest
DisallowMultipleStyleDefinitionsUnitTest
DuplicateClassDefinitionUnitTest
DuplicateStyleDefinitionUnitTest
EmptyClassDefinitionUnitTest
EmptyStyleDefinitionUnitTest
ForbiddenStylesUnitTest
IndentationUnitTest
LowercaseStyleDefinitionUnitTest
MissingColonUnitTest
NamedColoursUnitTest
OpacityUnitTest
SemicolonSpacingUnitTest
ShorthandSizeUnitTest
JavaScriptLintUnitTest
JSLintUnitTest
FileExtensionUnitTest
OperatorBracketUnitTest
FunctionDeclarationArgumentSpacingUnitTest
FunctionDeclarationUnitTest
FunctionDuplicateArgumentUnitTest
GlobalFunctionUnitTest
LowercaseFunctionKeywordsUnitTest
MultiLineFunctionDeclarationUnitTest
ValidFunctionNameUnitTest
ValidVariableNameUnitTest
DisallowObjectStringIndexUnitTest
ObjectInstantiationUnitTest
ObjectMemberCommaUnitTest
ComparisonOperatorUsageUnitTest
IncrementDecrementUsageUnitTest
ValidLogicalOperatorsUnitTest
CommentedOutCodeUnitTest
DisallowBooleanStatementUnitTest
DisallowComparisonAssignmentUnitTest
DisallowInlineIfUnitTest
DisallowMultipleAssignmentsUnitTest
DisallowSizeFunctionsInLoopsUnitTest
DiscouragedFunctionsUnitTest
EmbeddedPhpUnitTest
EvalUnitTest
GlobalKeywordUnitTest
HeredocUnitTest
InnerFunctionsUnitTest
LowercasePHPFunctionsUnitTest
NonExecutableCodeUnitTest
MemberVarScopeUnitTest
MethodScopeUnitTest
StaticThisUsageUnitTest
ConcatenationSpacingUnitTest
DoubleQuoteUsageUnitTest
EchoedStringsUnitTest
CastSpacingUnitTest
ControlStructureSpacingUnitTest
FunctionClosingBraceSpaceUnitTest
FunctionOpeningBraceSpaceUnitTest
FunctionSpacingUnitTest
LanguageConstructSpacingUnitTest
LogicalOperatorSpacingUnitTest
MemberVarSpacingUnitTest
ObjectOperatorSpacingUnitTest
OperatorSpacingUnitTest
PropertyLabelSpacingUnitTest
ScopeClosingBraceUnitTest
ScopeKeywordSpacingUnitTest
SemicolonSpacingUnitTest
SuperfluousWhitespaceUnitTest
CodeAnalyzerSniff
ClosingTagSniff
ValidVariableNameSniff
CodeAnalyzerUnitTest
ClosingTagUnitTest
ValidVariableNameUnitTest
Comment
CSS
JS
PHP
Tokenizer
Cache
Common
Standards
Timing
Tokens
PHP_CodeSniffer_AllTests
AbstractMethodUnitTest
AllTests
DetermineLoadedClassTest
ErrorSuppressionTest
FindEndOfStatementTest
FindExtendedClassNameTest
FindImplementedInterfaceNamesTest
FindStartOfStatementTest
GetMemberPropertiesTest
GetMethodParametersTest
GetMethodPropertiesTest
IsReferenceTest
AcceptTest
IsCamelCapsTest
RuleInclusionAbsoluteLinuxTest
RuleInclusionAbsoluteWindowsTest
RuleInclusionTest
AbstractArraySniffTest
AbstractArraySniffTestable
AnonClassParenthesisOwnerTest
ArrayKeywordTest
AttributesTest
BackfillFnTokenTest
BackfillMatchTokenTest
BackfillNumericSeparatorTest
BitwiseOrTest
DefaultKeywordTest
DoubleArrowTest
FinallyTest
GotoLabelTest
NamedFunctionCallArgumentsTest
NullsafeObjectOperatorTest
ScopeSettingWithNamespaceOperatorTest
ShortArrayTest
StableCommentWhitespaceTest
StableCommentWhitespaceWinTest
UndoNamespacedNameSingleTokenTest
FileList
AbstractSniffUnitTest
AllSniffs
TestSuite
TestSuite
Exception
NamespaceUri
NamespaceUriException
Token
TokenCollection
TokenCollectionException
Tokenizer
XMLSerializer
Assert: Efficient assertions to validate the input/output of your methods.
InvalidArgumentException
ResponseTrait: Response trait.
GeneratorTrait: GeneratorTrait contains a collection of methods to build the commands that generates a file.
DebugTraceableTrait: This trait provides framework exceptions the ability to pinpoint accurately where the exception was raised rather than instantiated.
MessageTrait: Message Trait Additional methods to make a PSR-7 Message class compliant with the framework's own MessageInterface.
RequestTrait: Request Trait
ResponseTrait: Request Trait
ControllerTester: ControllerTester Trait
ControllerTestTrait: Controller Test Trait
DatabaseTestTrait: DatabaseTestTrait
FeatureTestTrait: Trait FeatureTestTrait
FilterTestTrait: Filter Test Trait
ReflectionHelper: Testing helper.
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.
GeneratorAwareExtensionTrait: A helper trait to be used with GeneratorAwareExtension.
TestListenerDefaultImplementation
LoggerAwareTrait: Basic Implementation of LoggerAwareInterface.
LoggerTrait: This is a simple Logger trait that classes unable to extend AbstractLogger (because they extend another class, etc) can include.
Mixin: This trait aids static analysis tooling in introspecting assertion magic methods.

APPPATH = ealpath( trim($paths->appDirectory, '\/ ')) . DIRECTORY_SEPARATOR
ARGS = '$(?<args>[^()]*+(?:\((?&args)$[^()]*+)*+)\)'
ENVIRONMENT = 'testing'
EVENT_PRIORITY_HIGH = 10
EVENT_PRIORITY_LOW = 200
EVENT_PRIORITY_NORMAL = 100
FCPATH = __DIR__ . DIRECTORY_SEPARATOR
KINT_DIR = __DIR__
KINT_DIR = __DIR__
KINT_PHP56 = ersion_compare(PHP_VERSION, '5.6') >= 0
KINT_PHP56 = ersion_compare(PHP_VERSION, '5.6') >= 0
KINT_PHP70 = ersion_compare(PHP_VERSION, '7.0') >= 0
KINT_PHP70 = ersion_compare(PHP_VERSION, '7.0') >= 0
KINT_PHP72 = ersion_compare(PHP_VERSION, '7.2') >= 0
KINT_PHP72 = ersion_compare(PHP_VERSION, '7.2') >= 0
KINT_PHP73 = ersion_compare(PHP_VERSION, '7.3') >= 0
KINT_PHP73 = ersion_compare(PHP_VERSION, '7.3') >= 0
KINT_PHP74 = ersion_compare(PHP_VERSION, '7.4') >= 0
KINT_PHP74 = ersion_compare(PHP_VERSION, '7.4') >= 0
KINT_WIN = DIRECTORY_SEPARATOR !== '/'
KINT_WIN = DIRECTORY_SEPARATOR !== '/'
LIB = '(?(DEFINE) (?<singleQuotedString>'[^\\']*+(?:\\.[^\\']*+)*+') (?<doubleQuotedString>"[^\\"]*+(?:\\.[^\\"]*+)*+") (?<string>(?&singleQuotedString)|(?&doubleQuotedString)) (?<comment>/\*[^*]*+(?:\*(?!/)[^*]*+)*+\*/) (?<code>\{[^'"/{}]*+(?:(?:(?&string)|(?&comment)|(?&code)|/)[^'"/{}]*+)*+}) )'
PARAMS = '\[(?<params>[^[\]]*+(?:\[(?&params)\][^[\]]*+)*+)\]'
PHP_CODESNIFFER_CBF = alse
PHP_CODESNIFFER_IN_TESTS = rue
PHP_CODESNIFFER_VERBOSITY = 0
ROOTPATH = ealpath(APPPATH . '../') . DIRECTORY_SEPARATOR
SYSTEMPATH = ealpath( trim($paths->systemDirectory, '\/ ')) . DIRECTORY_SEPARATOR
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_ARRAY_HINT = 'PHPCS_T_ARRAY_HINT'
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_OBJECT = 'PHPCS_T_CLOSE_OBJECT'
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 = 'PHPCS_T_COALESCE'
T_COALESCE_EQUAL = 'PHPCS_T_COALESCE_EQUAL'
T_COLON = 'PHPCS_T_COLON'
T_COLOUR = 'PHPCS_T_COLOUR'
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_ELLIPSIS = 'PHPCS_T_ELLIPSIS'
T_EMBEDDED_PHP = 'PHPCS_T_EMBEDDED_PHP'
T_END_NOWDOC = 'PHPCS_T_END_NOWDOC'
T_EQUAL = 'PHPCS_T_EQUAL'
T_FALSE = 'PHPCS_T_FALSE'
T_FINALLY = 'PHPCS_T_FINALLY'
T_FN = 'PHPCS_T_FN'
T_FN_ARROW = 'PHPCS_T_FN_ARROW'
T_GOTO_LABEL = 'PHPCS_T_GOTO_LABEL'
T_GREATER_THAN = 'PHPCS_T_GREATER_THAN'
T_HASH = 'PHPCS_T_HASH'
T_HEREDOC = 'PHPCS_T_HEREDOC'
T_INLINE_ELSE = 'PHPCS_T_INLINE_ELSE'
T_INLINE_THEN = 'PHPCS_T_INLINE_THEN'
T_LABEL = 'PHPCS_T_LABEL'
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 = 'T_NAME_FULLY_QUALIFIED'
T_NAME_FULLY_QUALIFIED = 'PHPCS_T_NAME_FULLY_QUALIFIED'
T_NAME_QUALIFIED = 'T_NAME_QUALIFIED'
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_OBJECT = 'PHPCS_T_OBJECT'
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_POW = 'PHPCS_T_POW'
T_POW_EQUAL = 'PHPCS_T_POW_EQUAL'
T_PROPERTY = 'PHPCS_T_PROPERTY'
T_PROTOTYPE = 'PHPCS_T_PROTOTYPE'
T_REGULAR_EXPRESSION = 'PHPCS_T_REGULAR_EXPRESSION'
T_RETURN_TYPE = 'PHPCS_T_RETURN_TYPE'
T_SELF = 'PHPCS_T_SELF'
T_SEMICOLON = 'PHPCS_T_SEMICOLON'
T_SPACESHIP = 'PHPCS_T_SPACESHIP'
T_START_NOWDOC = 'PHPCS_T_START_NOWDOC'
T_STRING_CONCAT = 'PHPCS_T_STRING_CONCAT'
T_STYLE = 'PHPCS_T_STYLE'
T_THIS = 'PHPCS_T_THIS'
T_TRUE = 'PHPCS_T_TRUE'
T_TYPE_UNION = 'PHPCS_T_TYPE_UNION'
T_TYPEOF = 'PHPCS_T_TYPEOF'
T_URL = 'PHPCS_T_URL'
T_YIELD = 'PHPCS_T_YIELD'
T_YIELD_FROM = 'PHPCS_T_YIELD_FROM'
T_ZSR = 'PHPCS_T_ZSR'
T_ZSR_EQUAL = 'PHPCS_T_ZSR_EQUAL'
TESTPATH = ealpath( trim($paths->testsDirectory, '\/ ')) . DIRECTORY_SEPARATOR
VENDORPATH = ealpath(ROOTPATH . 'vendor') . DIRECTORY_SEPARATOR
VENDORPATH = ealpath(ROOTPATH . 'vendor') . DIRECTORY_SEPARATOR
WRITEPATH = ealpath( trim($paths->writableDirectory, '\/ ')) . DIRECTORY_SEPARATOR
register_ci_instance() : mixed
get_instance() : BaseController
app_timezone() : string: Returns the timezone the application has been set to display dates in. This might be different than the timezone set at the server level, as you often want to stores dates in UTC and convert them on the fly for the user.
cache() : CacheInterface|mixed: A convenience method that provides access to the Cache object. If no parameter is provided, will return the object, otherwise, will attempt to return the cached value.
clean_path() : string: A convenience method to clean paths for a nicer looking output. Useful for exception handling, error logging, etc.
command() : false|string: Runs a single command.
config() : mixed: More simple way of getting config instances from Factories
cookie() : Cookie: Simpler way to create a new Cookie instance.
cookies() : CookieStore: Fetches the global `CookieStore` instance held by `Response`.
csrf_token() : string: Returns the CSRF token name.
csrf_header() : string: Returns the CSRF header name.
csrf_hash() : string: Returns the current hash value for the CSRF protection.
csrf_field() : string: Generates a hidden input field for use within manually generated forms.
csrf_meta() : string: Generates a meta tag for use within javascript calls.
db_connect() : BaseConnection: Grabs a database connection and returns it to the user.
dd() : mixed: Prints a Kint debug report and exits.
env() : mixed: Allows user to retrieve values from the environment variables that have been set. Especially useful for retrieving values set from the .env file for use in config files.
esc() : string|array<string|int, mixed>: Performs simple auto-escaping of data for security reasons.
force_https() : mixed: Used to force a page to be accessed in via HTTPS.
function_usable() : bool: Function usable
helper() : mixed: Loads a helper file into memory. Supports namespaced helpers, both in and out of the 'helpers' directory of a namespaced directory.
is_cli() : bool: Check if PHP was invoked from the command line.
is_really_writable() : bool: Tests for file writability
lang() : string: A convenience method to translate a string or array of them and format the result with the intl extension's MessageFormatter.
log_message() : mixed: A convenience/compatibility method for logging events through the Log system.
model() : mixed: More simple way of getting model instances from Factories
old() : mixed|null: Provides access to "old input" that was set in the session during a redirect()->withInput().
redirect() : RedirectResponse: Convenience method that works with the current global $request and $router instances to redirect using named/reverse-routed routes to determine the URL to go to. If nothing is found, will treat as a traditional redirect and pass the string in, letting $response->redirect() determine the correct method and code.
remove_invisible_characters() : string: Remove Invisible Characters
route_to() : false|string: Given a controller/method string and any params, will attempt to build the relative URL to the matching route.
session() : Session|mixed|null: A convenience method for accessing the session instance, or an item that has been set in the session.
service() : mixed: Allows cleaner access to the Services Config file.
single_service() : mixed: Always returns a new instance of the class.
slash_item() : string|null: Fetch a config file item with slash appended (if not empty)
stringify_attributes() : string: Stringify attributes for use in HTML tags.
timer() : Timer|mixed: A convenience method for working with the timer.
trace() : mixed: Provides a backtrace to the current execution point, from Kint.
view() : string: Grabs the current RendererInterface-compatible class and tells it to render the specified view. Simply provides a convenience method that can be used in Controllers, libraries, and routed closures.
view_cell() : string: View cells are used within views to insert HTML chunks that are managed by other classes.
class_basename() : string: Get the class "basename" of the given object / class.
class_uses_recursive() : array<string|int, mixed>: Returns all traits used by a class, its parent classes and trait of their traits.
trait_uses_recursive() : array<string|int, mixed>: Returns all traits used by a trait and its traits.
dot_array_search() : mixed: Searches an array through dot syntax. Supports wildcard searches, like foo.*.bar
array_deep_search() : mixed|null: Returns the value of an element at a key in an array of uncertain depth.
array_sort_by_multiple_keys() : bool: Sorts a multidimensional array by its elements values. The array columns to be used for sorting are passed as an associative array of key names and sorting flags.
array_flatten_with_dots() : array<string|int, mixed>: Flatten a multidimensional array using dots as separators.
set_cookie() : mixed: Set cookie
get_cookie() : mixed: Fetch an item from the $_COOKIE array
delete_cookie() : void: Delete a cookie
has_cookie() : bool: Checks if a cookie exists by name.
now() : int: Get "now" time
timezone_select() : string: Generates a select field of all available timezones
directory_map() : array<string|int, mixed>: Create a Directory Map
directory_mirror() : void: Recursively copies the files and directories of the origin directory into the target directory, i.e. "mirror" its contents.
write_file() : bool: Write File
delete_files() : bool: Delete Files
get_filenames() : array<string|int, mixed>: Get Filenames
get_dir_file_info() : array<string|int, mixed>: Get Directory File Information
get_file_info() : array<string|int, mixed>|null: Get File Info
symbolic_permissions() : string: Symbolic Permissions
octal_permissions() : string: Octal Permissions
same_file() : bool: Checks if two files both exist and have identical hashes
set_realpath() : string: Set Realpath
form_open() : string: Form Declaration
form_open_multipart() : string: Form Declaration - Multipart type
form_hidden() : string: Hidden Input Field
form_input() : string: Text Input Field. If 'type' is passed in the $type field, it will be used as the input type, for making 'email', 'phone', etc input fields.
form_password() : string: Password Field
form_upload() : string: Upload Field
form_textarea() : string: Textarea field
form_multiselect() : string: Multi-select menu
form_dropdown() : string: Drop-down Menu
form_checkbox() : string: Checkbox Field
form_radio() : string: Radio Button
form_submit() : string: Submit Button
form_reset() : string: Reset Button
form_button() : string: Form Button
form_label() : string: Form Label Tag
form_datalist() : string: Datalist
form_fieldset() : string: Fieldset Tag
form_fieldset_close() : string: Fieldset Close Tag
form_close() : string: Form Close Tag
set_value() : string|array<string|int, string>: Form Value
set_select() : string: Set Select
set_checkbox() : string: Set Checkbox
set_radio() : string: Set Radio
parse_form_attributes() : string: Parse the form attributes
ul() : string: Unordered List
ol() : string: Ordered List
_list() : string: Generates the list
img() : string: Image
img_data() : string: Image (data)
doctype() : string: Doctype
script_tag() : string: Script
link_tag() : string: Link
video() : string: Video
audio() : string: Audio
_media() : string: Generate media based tag
source() : string: Source
track() : string: Track
object() : string: Object
param() : string: Param
embed() : string: Embed
_has_protocol() : false|int: Test the protocol of a URI.
_space_indent() : string: Provide space indenting.
singular() : string: Singular
plural() : string: Plural
counted() : string: Counted
camelize() : string: Camelize
pascalize() : string: Pascalize
underscore() : string: Underscore
humanize() : string: Humanize
is_pluralizable() : bool: Checks if the given word has a plural version.
dasherize() : string: Replaces underscores with dashes in the string.
ordinal() : string: Returns the suffix that should be added to a number to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
ordinalize() : string: Turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
number_to_size() : bool|string: Formats a numbers as bytes, based on size, and adds the appropriate suffix
number_to_amount() : bool|string: Converts numbers to a more readable representation when dealing with very large numbers (in the thousands or above), up to the quadrillions, because you won't often deal with numbers larger than that.
number_to_currency() : string
format_number() : string: A general purpose, locale-aware, number_format method.
number_to_roman() : string|null: Convert a number to a roman numeral.
sanitize_filename() : string: Sanitize a filename to use in a URI.
strip_image_tags() : string: Strip Image Tags
encode_php_tags() : string: Convert PHP tags to entities
fake() : object|array<string|int, mixed>: Creates a single item using Fabricator.
word_limiter() : string: Word Limiter
character_limiter() : string: Character Limiter
ascii_to_entities() : string: High ASCII to Entities
entities_to_ascii() : string: Entities to ASCII
word_censor() : string: Word Censoring Function
highlight_code() : string: Code Highlighter
highlight_phrase() : string: Phrase Highlighter
convert_accented_characters() : string: Convert Accented Foreign Characters to ASCII
word_wrap() : string: Word Wrap
ellipsize() : string: Ellipsize String
strip_slashes() : mixed: Strip Slashes
strip_quotes() : string: Strip Quotes
quotes_to_entities() : string: Quotes to Entities
reduce_double_slashes() : string: Reduce Double Slashes
reduce_multiples() : string: Reduce Multiples
random_string() : string: Create a Random String
increment_string() : string: Add's _1 to a string or increment the ending number to allow _2, _3, etc
alternator() : string: Alternator
excerpt() : string: Excerpt.
site_url() : string: Returns a site URL as defined by the App config.
base_url() : string: Returns the base URL as defined by the App config.
current_url() : string|URI: Returns the current full URL based on the IncomingRequest.
previous_url() : URI|mixed|string: Returns the previous URL the current visitor was on. For security reasons we first check in a saved session variable, if it exists, and use that.
uri_string() : string: URL String
index_page() : string: Index page
anchor() : string: Anchor Link
anchor_popup() : string: Anchor Link - Pop-up version
mailto() : string: Mailto Link
safe_mailto() : string: Encoded Mailto Link
auto_link() : string: Auto-linker
prep_url() : string: Prep URL - Simply adds the http:// or https:// part if no scheme is included.
url_title() : string: Create URL Title
mb_url_title() : string: Create URL Title that takes into account accented characters
url_to() : string: Get the full, absolute URL to a controller method (with additional arguments)
url_is() : bool: Determines if current url path contains the given path. It may contain a wildcard (*) which will allow any valid character.
xml_convert() : string: Convert Reserved XML characters to Entities
is_cli() : bool: Is CLI?
d() : int|string: Alias of Kint::dump().
s() : int|string: Alias of Kint::dump(), however the output is in plain text.
composerRequire66b555c03b1bdd972d10d22cdbe0b48d() : mixed
includeFile() : mixed: Scope isolated include.
check_digit() : int: Calculates one MOD 11 check digit based on customary Brazilian algorithms.
d() : int|string: Alias of Kint::dump().
s() : int|string: Alias of Kint::dump(), however the output is in plain text.
customErrorHandler() : mixed
deep_copy() : mixed: Deep copies the given value.
preprocessGrammar() : mixed
resolveNodes() : mixed
resolveMacros() : mixed
assertArgs() : mixed
resolveStackAccess() : mixed
removeTrailingWhitespace() : mixed
regex() : mixed
magicSplit() : mixed
ensureDirExists() : mixed
execCmd() : mixed
assertArrayHasKey() : void: Asserts that an array has a specified key.
assertArrayNotHasKey() : void: Asserts that an array does not have a specified key.
assertContains() : void: Asserts that a haystack contains a needle.
assertContainsEquals() : void
assertNotContains() : void: Asserts that a haystack does not contain a needle.
assertNotContainsEquals() : void
assertContainsOnly() : void: Asserts that a haystack contains only values of a given type.
assertContainsOnlyInstancesOf() : void: Asserts that a haystack contains only instances of a given class name.
assertNotContainsOnly() : void: Asserts that a haystack does not contain only values of a given type.
assertCount() : void: Asserts the number of elements of an array, Countable or Traversable.
assertNotCount() : void: Asserts the number of elements of an array, Countable or Traversable.
assertEquals() : void: Asserts that two variables are equal.
assertEqualsCanonicalizing() : void: Asserts that two variables are equal (canonicalizing).
assertEqualsIgnoringCase() : void: Asserts that two variables are equal (ignoring case).
assertEqualsWithDelta() : void: Asserts that two variables are equal (with delta).
assertNotEquals() : void: Asserts that two variables are not equal.
assertNotEqualsCanonicalizing() : void: Asserts that two variables are not equal (canonicalizing).
assertNotEqualsIgnoringCase() : void: Asserts that two variables are not equal (ignoring case).
assertNotEqualsWithDelta() : void: Asserts that two variables are not equal (with delta).
assertObjectEquals() : void
assertEmpty() : void: Asserts that a variable is empty.
assertNotEmpty() : void: Asserts that a variable is not empty.
assertGreaterThan() : void: Asserts that a value is greater than another value.
assertGreaterThanOrEqual() : void: Asserts that a value is greater than or equal to another value.
assertLessThan() : void: Asserts that a value is smaller than another value.
assertLessThanOrEqual() : void: Asserts that a value is smaller than or equal to another value.
assertFileEquals() : void: Asserts that the contents of one file is equal to the contents of another file.
assertFileEqualsCanonicalizing() : void: Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
assertFileEqualsIgnoringCase() : void: Asserts that the contents of one file is equal to the contents of another file (ignoring case).
assertFileNotEquals() : void: Asserts that the contents of one file is not equal to the contents of another file.
assertFileNotEqualsCanonicalizing() : void: Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
assertFileNotEqualsIgnoringCase() : void: Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
assertStringEqualsFile() : void: Asserts that the contents of a string is equal to the contents of a file.
assertStringEqualsFileCanonicalizing() : void: Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
assertStringEqualsFileIgnoringCase() : void: Asserts that the contents of a string is equal to the contents of a file (ignoring case).
assertStringNotEqualsFile() : void: Asserts that the contents of a string is not equal to the contents of a file.
assertStringNotEqualsFileCanonicalizing() : void: Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
assertStringNotEqualsFileIgnoringCase() : void: Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
assertIsReadable() : void: Asserts that a file/dir is readable.
assertIsNotReadable() : void: Asserts that a file/dir exists and is not readable.
assertNotIsReadable() : void: Asserts that a file/dir exists and is not readable.
assertIsWritable() : void: Asserts that a file/dir exists and is writable.
assertIsNotWritable() : void: Asserts that a file/dir exists and is not writable.
assertNotIsWritable() : void: Asserts that a file/dir exists and is not writable.
assertDirectoryExists() : void: Asserts that a directory exists.
assertDirectoryDoesNotExist() : void: Asserts that a directory does not exist.
assertDirectoryNotExists() : void: Asserts that a directory does not exist.
assertDirectoryIsReadable() : void: Asserts that a directory exists and is readable.
assertDirectoryIsNotReadable() : void: Asserts that a directory exists and is not readable.
assertDirectoryNotIsReadable() : void: Asserts that a directory exists and is not readable.
assertDirectoryIsWritable() : void: Asserts that a directory exists and is writable.
assertDirectoryIsNotWritable() : void: Asserts that a directory exists and is not writable.
assertDirectoryNotIsWritable() : void: Asserts that a directory exists and is not writable.
assertFileExists() : void: Asserts that a file exists.
assertFileDoesNotExist() : void: Asserts that a file does not exist.
assertFileNotExists() : void: Asserts that a file does not exist.
assertFileIsReadable() : void: Asserts that a file exists and is readable.
assertFileIsNotReadable() : void: Asserts that a file exists and is not readable.
assertFileNotIsReadable() : void: Asserts that a file exists and is not readable.
assertFileIsWritable() : void: Asserts that a file exists and is writable.
assertFileIsNotWritable() : void: Asserts that a file exists and is not writable.
assertFileNotIsWritable() : void: Asserts that a file exists and is not writable.
assertTrue() : void: Asserts that a condition is true.
assertNotTrue() : void: Asserts that a condition is not true.
assertFalse() : void: Asserts that a condition is false.
assertNotFalse() : void: Asserts that a condition is not false.
assertNull() : void: Asserts that a variable is null.
assertNotNull() : void: Asserts that a variable is not null.
assertFinite() : void: Asserts that a variable is finite.
assertInfinite() : void: Asserts that a variable is infinite.
assertNan() : void: Asserts that a variable is nan.
assertClassHasAttribute() : void: Asserts that a class has a specified attribute.
assertClassNotHasAttribute() : void: Asserts that a class does not have a specified attribute.
assertClassHasStaticAttribute() : void: Asserts that a class has a specified static attribute.
assertClassNotHasStaticAttribute() : void: Asserts that a class does not have a specified static attribute.
assertObjectHasAttribute() : void: Asserts that an object has a specified attribute.
assertObjectNotHasAttribute() : void: Asserts that an object does not have a specified attribute.
assertSame() : void: Asserts that two variables have the same type and value.
assertNotSame() : void: Asserts that two variables do not have the same type and value.
assertInstanceOf() : void: Asserts that a variable is of a given type.
assertNotInstanceOf() : void: Asserts that a variable is not of a given type.
assertIsArray() : void: Asserts that a variable is of type array.
assertIsBool() : void: Asserts that a variable is of type bool.
assertIsFloat() : void: Asserts that a variable is of type float.
assertIsInt() : void: Asserts that a variable is of type int.
assertIsNumeric() : void: Asserts that a variable is of type numeric.
assertIsObject() : void: Asserts that a variable is of type object.
assertIsResource() : void: Asserts that a variable is of type resource.
assertIsClosedResource() : void: Asserts that a variable is of type resource and is closed.
assertIsString() : void: Asserts that a variable is of type string.
assertIsScalar() : void: Asserts that a variable is of type scalar.
assertIsCallable() : void: Asserts that a variable is of type callable.
assertIsIterable() : void: Asserts that a variable is of type iterable.
assertIsNotArray() : void: Asserts that a variable is not of type array.
assertIsNotBool() : void: Asserts that a variable is not of type bool.
assertIsNotFloat() : void: Asserts that a variable is not of type float.
assertIsNotInt() : void: Asserts that a variable is not of type int.
assertIsNotNumeric() : void: Asserts that a variable is not of type numeric.
assertIsNotObject() : void: Asserts that a variable is not of type object.
assertIsNotResource() : void: Asserts that a variable is not of type resource.
assertIsNotClosedResource() : void: Asserts that a variable is not of type resource.
assertIsNotString() : void: Asserts that a variable is not of type string.
assertIsNotScalar() : void: Asserts that a variable is not of type scalar.
assertIsNotCallable() : void: Asserts that a variable is not of type callable.
assertIsNotIterable() : void: Asserts that a variable is not of type iterable.
assertMatchesRegularExpression() : void: Asserts that a string matches a given regular expression.
assertRegExp() : void: Asserts that a string matches a given regular expression.
assertDoesNotMatchRegularExpression() : void: Asserts that a string does not match a given regular expression.
assertNotRegExp() : void: Asserts that a string does not match a given regular expression.
assertSameSize() : void: Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
assertNotSameSize() : void: Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
assertStringMatchesFormat() : void: Asserts that a string matches a given format string.
assertStringNotMatchesFormat() : void: Asserts that a string does not match a given format string.
assertStringMatchesFormatFile() : void: Asserts that a string matches a given format file.
assertStringNotMatchesFormatFile() : void: Asserts that a string does not match a given format string.
assertStringStartsWith() : void: Asserts that a string starts with a given prefix.
assertStringStartsNotWith() : void: Asserts that a string starts not with a given prefix.
assertStringContainsString() : void
assertStringContainsStringIgnoringCase() : void
assertStringNotContainsString() : void
assertStringNotContainsStringIgnoringCase() : void
assertStringEndsWith() : void: Asserts that a string ends with a given suffix.
assertStringEndsNotWith() : void: Asserts that a string ends not with a given suffix.
assertXmlFileEqualsXmlFile() : void: Asserts that two XML files are equal.
assertXmlFileNotEqualsXmlFile() : void: Asserts that two XML files are not equal.
assertXmlStringEqualsXmlFile() : void: Asserts that two XML documents are equal.
assertXmlStringNotEqualsXmlFile() : void: Asserts that two XML documents are not equal.
assertXmlStringEqualsXmlString() : void: Asserts that two XML documents are equal.
assertXmlStringNotEqualsXmlString() : void: Asserts that two XML documents are not equal.
assertEqualXMLStructure() : void: Asserts that a hierarchy of DOMElements matches.
assertThat() : void: Evaluates a PHPUnit\Framework\Constraint matcher object.
assertJson() : void: Asserts that a string is a valid JSON string.
assertJsonStringEqualsJsonString() : void: Asserts that two given JSON encoded objects or arrays are equal.
assertJsonStringNotEqualsJsonString() : void: Asserts that two given JSON encoded objects or arrays are not equal.
assertJsonStringEqualsJsonFile() : void: Asserts that the generated JSON encoded object and the content of the given file are equal.
assertJsonStringNotEqualsJsonFile() : void: Asserts that the generated JSON encoded object and the content of the given file are not equal.
assertJsonFileEqualsJsonFile() : void: Asserts that two JSON files are equal.
assertJsonFileNotEqualsJsonFile() : void: Asserts that two JSON files are not equal.
logicalAnd() : LogicalAnd
logicalOr() : LogicalOr
logicalNot() : LogicalNot
logicalXor() : LogicalXor
anything() : IsAnything
isTrue() : IsTrue
callback() : Callback
isFalse() : IsFalse
isJson() : IsJson
isNull() : IsNull
isFinite() : IsFinite
isInfinite() : IsInfinite
isNan() : IsNan
containsEqual() : TraversableContainsEqual
containsIdentical() : TraversableContainsIdentical
containsOnly() : TraversableContainsOnly
containsOnlyInstancesOf() : TraversableContainsOnly
arrayHasKey() : ArrayHasKey
equalTo() : IsEqual
equalToCanonicalizing() : IsEqualCanonicalizing
equalToIgnoringCase() : IsEqualIgnoringCase
equalToWithDelta() : IsEqualWithDelta
isEmpty() : IsEmpty
isWritable() : IsWritable
isReadable() : IsReadable
directoryExists() : DirectoryExists
fileExists() : FileExists
greaterThan() : GreaterThan
greaterThanOrEqual() : LogicalOr
classHasAttribute() : ClassHasAttribute
classHasStaticAttribute() : ClassHasStaticAttribute
objectHasAttribute() : ObjectHasAttribute
identicalTo() : IsIdentical
isInstanceOf() : IsInstanceOf
isType() : IsType
lessThan() : LessThan
lessThanOrEqual() : LogicalOr
matchesRegularExpression() : RegularExpression
matches() : StringMatchesFormatDescription
stringStartsWith() : StringStartsWith
stringContains() : StringContains
stringEndsWith() : StringEndsWith
countOf() : Count
objectEquals() : ObjectEquals
any() : AnyInvokedCount: Returns a matcher that matches when the method is executed zero or more times.
never() : InvokedCount: Returns a matcher that matches when the method is never executed.
atLeast() : InvokedAtLeastCount: Returns a matcher that matches when the method is executed at least N times.
atLeastOnce() : InvokedAtLeastOnce: Returns a matcher that matches when the method is executed at least once.
once() : InvokedCount: Returns a matcher that matches when the method is executed exactly once.
exactly() : InvokedCount: Returns a matcher that matches when the method is executed exactly $count times.
atMost() : InvokedAtMostCount: Returns a matcher that matches when the method is executed at most N times.
at() : InvokedAtIndex: Returns a matcher that matches when the method is executed at the given index.
returnValue() : ReturnStub
returnValueMap() : ReturnValueMap
returnArgument() : ReturnArgument
returnCallback() : ReturnCallback
returnSelf() : ReturnSelf: Returns the current object.
throwException() : Exception
onConsecutiveCalls() : ConsecutiveCalls
redis_version() : mixed
zpop() : mixed
printPHPCodeSnifferTestOutput() : void: A global util function to help print unit test fixing data.
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

APPPATH


    public
    Paths
    APPPATH
    = 
ealpath(
trim($paths->appDirectory, '\/ ')) . DIRECTORY_SEPARATOR

ARGS


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

ENVIRONMENT


    public
    mixed
    ENVIRONMENT
    = 'testing'

EVENT_PRIORITY_HIGH


    public
    mixed
    EVENT_PRIORITY_HIGH
    = 10

EVENT_PRIORITY_LOW


    public
    mixed
    EVENT_PRIORITY_LOW
    = 200

EVENT_PRIORITY_NORMAL


    public
    mixed
    EVENT_PRIORITY_NORMAL
    = 100

FCPATH


    public
    mixed
    FCPATH
    = __DIR__ . DIRECTORY_SEPARATOR

KINT_DIR


    public
    mixed
    KINT_DIR
    = __DIR__

KINT_DIR


    public
    mixed
    KINT_DIR
    = __DIR__

KINT_PHP56


    public
    mixed
    KINT_PHP56
    = ersion_compare(PHP_VERSION, '5.6') >= 0

KINT_PHP56


    public
    mixed
    KINT_PHP56
    = ersion_compare(PHP_VERSION, '5.6') >= 0

KINT_PHP70


    public
    mixed
    KINT_PHP70
    = ersion_compare(PHP_VERSION, '7.0') >= 0

KINT_PHP70


    public
    mixed
    KINT_PHP70
    = ersion_compare(PHP_VERSION, '7.0') >= 0

KINT_PHP72


    public
    mixed
    KINT_PHP72
    = ersion_compare(PHP_VERSION, '7.2') >= 0

KINT_PHP72


    public
    mixed
    KINT_PHP72
    = ersion_compare(PHP_VERSION, '7.2') >= 0

KINT_PHP73


    public
    mixed
    KINT_PHP73
    = ersion_compare(PHP_VERSION, '7.3') >= 0

KINT_PHP73


    public
    mixed
    KINT_PHP73
    = ersion_compare(PHP_VERSION, '7.3') >= 0

KINT_PHP74


    public
    mixed
    KINT_PHP74
    = ersion_compare(PHP_VERSION, '7.4') >= 0

KINT_PHP74


    public
    mixed
    KINT_PHP74
    = ersion_compare(PHP_VERSION, '7.4') >= 0

KINT_WIN


    public
    mixed
    KINT_WIN
    = DIRECTORY_SEPARATOR !== '/'

KINT_WIN


    public
    mixed
    KINT_WIN
    = DIRECTORY_SEPARATOR !== '/'

LIB


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

PARAMS


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

PHP_CODESNIFFER_CBF


    public
    mixed
    PHP_CODESNIFFER_CBF
    = alse

PHP_CODESNIFFER_IN_TESTS


    public
    mixed
    PHP_CODESNIFFER_IN_TESTS
    = 	rue

PHP_CODESNIFFER_VERBOSITY


    public
    mixed
    PHP_CODESNIFFER_VERBOSITY
    = 0

ROOTPATH


    public
    mixed
    ROOTPATH
    = 
ealpath(APPPATH . '../') . DIRECTORY_SEPARATOR

SYSTEMPATH


    public
    Paths
    SYSTEMPATH
    = 
ealpath(
trim($paths->systemDirectory, '\/ ')) . DIRECTORY_SEPARATOR

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_ARRAY_HINT


    public
    mixed
    T_ARRAY_HINT
    = 'PHPCS_T_ARRAY_HINT'

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_OBJECT


    public
    mixed
    T_CLOSE_OBJECT
    = 'PHPCS_T_CLOSE_OBJECT'

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


    public
    mixed
    T_COALESCE
    = 'PHPCS_T_COALESCE'

T_COALESCE_EQUAL


    public
    mixed
    T_COALESCE_EQUAL
    = 'PHPCS_T_COALESCE_EQUAL'

T_COLON


    public
    mixed
    T_COLON
    = 'PHPCS_T_COLON'

T_COLOUR


    public
    mixed
    T_COLOUR
    = 'PHPCS_T_COLOUR'

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_ELLIPSIS


    public
    mixed
    T_ELLIPSIS
    = 'PHPCS_T_ELLIPSIS'

T_EMBEDDED_PHP


    public
    mixed
    T_EMBEDDED_PHP
    = 'PHPCS_T_EMBEDDED_PHP'

T_END_NOWDOC


    public
    mixed
    T_END_NOWDOC
    = 'PHPCS_T_END_NOWDOC'

T_EQUAL


    public
    mixed
    T_EQUAL
    = 'PHPCS_T_EQUAL'

T_FALSE


    public
    mixed
    T_FALSE
    = 'PHPCS_T_FALSE'

T_FINALLY


    public
    mixed
    T_FINALLY
    = 'PHPCS_T_FINALLY'

T_FN


    public
    mixed
    T_FN
    = 'PHPCS_T_FN'

T_FN_ARROW


    public
    mixed
    T_FN_ARROW
    = 'PHPCS_T_FN_ARROW'

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_HASH


    public
    mixed
    T_HASH
    = 'PHPCS_T_HASH'

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_LABEL


    public
    mixed
    T_LABEL
    = 'PHPCS_T_LABEL'

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

T_NAME_FULLY_QUALIFIED


    public
    mixed
    T_NAME_FULLY_QUALIFIED
    = 'PHPCS_T_NAME_FULLY_QUALIFIED'

T_NAME_QUALIFIED


    public
    mixed
    T_NAME_QUALIFIED
    = 'T_NAME_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_OBJECT


    public
    mixed
    T_OBJECT
    = 'PHPCS_T_OBJECT'

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_POW


    public
    mixed
    T_POW
    = 'PHPCS_T_POW'

T_POW_EQUAL


    public
    mixed
    T_POW_EQUAL
    = 'PHPCS_T_POW_EQUAL'

T_PROPERTY


    public
    mixed
    T_PROPERTY
    = 'PHPCS_T_PROPERTY'

T_PROTOTYPE


    public
    mixed
    T_PROTOTYPE
    = 'PHPCS_T_PROTOTYPE'

T_REGULAR_EXPRESSION


    public
    mixed
    T_REGULAR_EXPRESSION
    = 'PHPCS_T_REGULAR_EXPRESSION'

T_RETURN_TYPE


    public
    mixed
    T_RETURN_TYPE
    = 'PHPCS_T_RETURN_TYPE'

T_SELF


    public
    mixed
    T_SELF
    = 'PHPCS_T_SELF'

T_SEMICOLON


    public
    mixed
    T_SEMICOLON
    = 'PHPCS_T_SEMICOLON'

T_SPACESHIP


    public
    mixed
    T_SPACESHIP
    = 'PHPCS_T_SPACESHIP'

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_STYLE


    public
    mixed
    T_STYLE
    = 'PHPCS_T_STYLE'

T_THIS


    public
    mixed
    T_THIS
    = 'PHPCS_T_THIS'

T_TRUE


    public
    mixed
    T_TRUE
    = 'PHPCS_T_TRUE'

T_TYPE_UNION


    public
    mixed
    T_TYPE_UNION
    = 'PHPCS_T_TYPE_UNION'

T_TYPEOF


    public
    mixed
    T_TYPEOF
    = 'PHPCS_T_TYPEOF'

T_URL


    public
    mixed
    T_URL
    = 'PHPCS_T_URL'

T_YIELD


    public
    mixed
    T_YIELD
    = 'PHPCS_T_YIELD'

T_YIELD_FROM


    public
    mixed
    T_YIELD_FROM
    = 'PHPCS_T_YIELD_FROM'

T_ZSR


    public
    mixed
    T_ZSR
    = 'PHPCS_T_ZSR'

T_ZSR_EQUAL


    public
    mixed
    T_ZSR_EQUAL
    = 'PHPCS_T_ZSR_EQUAL'

TESTPATH


    public
    Paths
    TESTPATH
    = 
ealpath(
trim($paths->testsDirectory, '\/ ')) . DIRECTORY_SEPARATOR

VENDORPATH


    public
    mixed
    VENDORPATH
    = 
ealpath(ROOTPATH . 'vendor') . DIRECTORY_SEPARATOR

VENDORPATH


    public
    mixed
    VENDORPATH
    = 
ealpath(ROOTPATH . 'vendor') . DIRECTORY_SEPARATOR

WRITEPATH


    public
    Paths
    WRITEPATH
    = 
ealpath(
trim($paths->writableDirectory, '\/ ')) . DIRECTORY_SEPARATOR

register_ci_instance()


    
                register_ci_instance(BaseController &$_ci) : mixed

Parameters

$_ci : BaseController

Return values

mixed —

get_instance()


    
                get_instance() : BaseController

Return values

BaseController —

app_timezone()

Returns the timezone the application has been set to display dates in. This might be different than the timezone set at the server level, as you often want to stores dates in UTC and convert them on the fly for the user.


    
                app_timezone() : string

Return values

string —

cache()

A convenience method that provides access to the Cache object. If no parameter is provided, will return the object, otherwise, will attempt to return the cached value.


    
                cache([string|null $key = null ]) : CacheInterface|mixed

Examples: cache()->save('foo', 'bar'); $foo = cache('bar');

Parameters

$key : string|null = null

Return values

CacheInterface|mixed —

clean_path()

A convenience method to clean paths for a nicer looking output. Useful for exception handling, error logging, etc.


    
                clean_path(string $path) : string

Parameters

$path : string

Return values

string —

command()

Runs a single command.


    
                command(string $command) : false|string

Input expected in a single string as would be used on the command line itself:

command('migrate:create SomeMigration');

Parameters

$command : string

Return values

false|string —

config()

More simple way of getting config instances from Factories


    
                config(string $name[, bool $getShared = true ]) : mixed

Parameters

$name : string
$getShared : bool = true

Return values

mixed —

cookie()

Simpler way to create a new Cookie instance.


    
                cookie(string $name[, string $value = '' ][, array<string|int, mixed> $options = [] ]) : Cookie

Parameters

$name : string: Name of the cookie
$value : string = '': Value of the cookie
$options : array<string|int, mixed> = []: Array of options to be passed to the cookie

Return values

Cookie —

cookies()

Fetches the global `CookieStore` instance held by `Response`.


    
                cookies([array<string|int, Cookie> $cookies = [] ][, bool $getGlobal = true ]) : CookieStore

Parameters

$cookies : array<string|int, Cookie> = []: If getGlobal is false, this is passed to CookieStore's constructor
$getGlobal : bool = true: If false, creates a new instance of CookieStore

Return values

CookieStore —

csrf_token()

Returns the CSRF token name.


    
                csrf_token() : string

Can be used in Views when building hidden inputs manually, or used in javascript vars when using APIs.

Return values

string —

csrf_header()

Returns the CSRF header name.


    
                csrf_header() : string

Can be used in Views by adding it to the meta tag or used in javascript to define a header name when using APIs.

Return values

string —

csrf_hash()

Returns the current hash value for the CSRF protection.


    
                csrf_hash() : string

Can be used in Views when building hidden inputs manually, or used in javascript vars for API usage.

Return values

string —

csrf_field()

Generates a hidden input field for use within manually generated forms.


    
                csrf_field([string|null $id = null ]) : string

Parameters

$id : string|null = null

Return values

string —

csrf_meta()

Generates a meta tag for use within javascript calls.


    
                csrf_meta([string|null $id = null ]) : string

Parameters

$id : string|null = null

Return values

string —

db_connect()

Grabs a database connection and returns it to the user.


    
                db_connect([ConnectionInterface|array<string|int, mixed>|string|null $db = null ][, bool $getShared = true ]) : BaseConnection

This is a convenience wrapper for \Config\Database::connect() and supports the same parameters. Namely:

When passing in $db, you may pass any of the following to connect:

group name
existing connection instance
array of database configuration values

If $getShared === false then a new connection instance will be provided, otherwise it will all calls will return the same instance.

Parameters

$db : ConnectionInterface|array<string|int, mixed>|string|null = null
$getShared : bool = true

Return values

BaseConnection —

dd()

Prints a Kint debug report and exits.


    
                dd(array<string|int, mixed> ...$vars) : mixed

Parameters

$vars : array<string|int, mixed>

Return values

mixed —

env()

Allows user to retrieve values from the environment variables that have been set. Especially useful for retrieving values set from the .env file for use in config files.


    
                env(string $key[, string|null $default = null ]) : mixed

Parameters

$key : string
$default : string|null = null

Return values

mixed —

esc()

Performs simple auto-escaping of data for security reasons.


    
                esc(string|array<string|int, mixed> $data[, string $context = 'html' ][, string $encoding = null ]) : string|array<string|int, mixed>

Might consider making this more complex at a later date.

If $data is a string, then it simply escapes and returns it. If $data is an array, then it loops over it, escaping each 'value' of the key/value pairs.

Valid context values: html, js, css, url, attr, raw, null

Parameters

$data : string|array<string|int, mixed>
$context : string = 'html'
$encoding : string = null

Return values

string|array<string|int, mixed> —

force_https()

Used to force a page to be accessed in via HTTPS.


    
                force_https([int $duration = 31536000 ][, RequestInterface $request = null ][, ResponseInterface $response = null ]) : mixed

Uses a standard redirect, plus will set the HSTS header for modern browsers that support, which gives best protection against man-in-the-middle attacks.

Parameters

$duration : int = 31536000: How long should the SSL header be set for? (in seconds) Defaults to 1 year.
$request : RequestInterface = null
$response : ResponseInterface = null

Return values

mixed —

function_usable()

Function usable


    
                function_usable(string $functionName) : bool

Executes a function_exists() check, and if the Suhosin PHP extension is loaded - checks whether the function that is checked might be disabled in there as well.

This is useful as function_exists() will return FALSE for functions disabled via the disable_functions php.ini setting, but not for suhosin.executor.func.blacklist and suhosin.executor.disable_eval. These settings will just terminate script execution if a disabled function is executed.

The above described behavior turned out to be a bug in Suhosin, but even though a fix was committed for 0.9.34 on 2012-02-12, that version is yet to be released. This function will therefore be just temporary, but would probably be kept for a few years.

Parameters

$functionName : string: Function to check for

Return values

bool —

TRUE if the function exists and is safe to call, FALSE otherwise.

helper()

Loads a helper file into memory. Supports namespaced helpers, both in and out of the 'helpers' directory of a namespaced directory.


    
                helper(string|array<string|int, mixed> $filenames) : mixed

Will load ALL helpers of the matching name, in the following order:

app/Helpers
{namespace}/Helpers
system/Helpers

Parameters

$filenames : string|array<string|int, mixed>

Return values

mixed —

is_cli()

Check if PHP was invoked from the command line.


    
                is_cli() : bool

Return values

bool —

is_really_writable()

Tests for file writability


    
                is_really_writable(string $file) : bool

is_writable() returns TRUE on Windows servers when you really can't write to the file, based on the read-only attribute. is_writable() is also unreliable on Unix servers if safe_mode is on.

Parameters

$file : string

Return values

bool —

lang()

A convenience method to translate a string or array of them and format the result with the intl extension's MessageFormatter.


    
                lang(string $line[, array<string|int, mixed> $args = [] ][, string|null $locale = null ]) : string

Parameters

$line : string
$args : array<string|int, mixed> = []
$locale : string|null = null

Return values

string —

log_message()

A convenience/compatibility method for logging events through the Log system.


    
                log_message(string $level, string $message[, array<string|int, mixed> $context = [] ]) : mixed

Allowed log levels are:

emergency
alert
critical
error
warning
notice
info
debug

Parameters

$level : string
$message : string
$context : array<string|int, mixed> = []

Return values

mixed —

model()

More simple way of getting model instances from Factories


    
                model(string $name[, bool $getShared = true ][, ConnectionInterface|null &$conn = null ]) : mixed

Parameters

$name : string
$getShared : bool = true
$conn : ConnectionInterface|null = null

Return values

mixed —

old()

Provides access to "old input" that was set in the session during a redirect()->withInput().


    
                old(string $key[, null $default = null ][, string|bool $escape = 'html' ]) : mixed|null

Parameters

$key : string
$default : null = null
$escape : string|bool = 'html'

Return values

mixed|null —

redirect()

Convenience method that works with the current global $request and $router instances to redirect using named/reverse-routed routes to determine the URL to go to. If nothing is found, will treat as a traditional redirect and pass the string in, letting $response->redirect() determine the correct method and code.


    
                redirect([string $route = null ]) : RedirectResponse

If more control is needed, you must use $response->redirect explicitly.

Parameters

$route : string = null

Return values

RedirectResponse —

remove_invisible_characters()

Remove Invisible Characters


    
                remove_invisible_characters(string $str[, bool $urlEncoded = true ]) : string

This prevents sandwiching null characters between ascii characters, like Java\0script.

Parameters

$str : string
$urlEncoded : bool = true

Return values

string —

route_to()

Given a controller/method string and any params, will attempt to build the relative URL to the matching route.


    
                route_to(string $method, mixed ...$params) : false|string

NOTE: This requires the controller/method to have a route defined in the routes Config file.

Parameters

$method : string
$params : mixed

Return values

false|string —

session()

A convenience method for accessing the session instance, or an item that has been set in the session.


    
                session([string $val = null ]) : Session|mixed|null

Examples: session()->set('foo', 'bar'); $foo = session('bar');

Parameters

$val : string = null

Return values

Session|mixed|null —

service()

Allows cleaner access to the Services Config file.


    
                service(string $name, mixed ...$params) : mixed

Always returns a SHARED instance of the class, so calling the function multiple times should always return the same instance.

These are equal:

$timer = service('timer')
$timer = \CodeIgniter\Config\Services::timer();

Parameters

$name : string
$params : mixed

Return values

mixed —

single_service()

Always returns a new instance of the class.


    
                single_service(string $name, mixed ...$params) : mixed

Parameters

$name : string
$params : mixed

Return values

mixed —

slash_item()

Fetch a config file item with slash appended (if not empty)


    
                slash_item(string $item) : string|null

Parameters

$item : string: Config item name

Return values

string|null —

The configuration item or NULL if the item doesn't exist

stringify_attributes()

Stringify attributes for use in HTML tags.


    
                stringify_attributes(mixed $attributes[, bool $js = false ]) : string

Helper function used to convert a string, array, or object of attributes to a string.

Parameters

$attributes : mixed: string, array, object
$js : bool = false

Return values

string —

timer()

A convenience method for working with the timer.


    
                timer([string|null $name = null ]) : Timer|mixed

If no parameter is passed, it will return the timer instance, otherwise will start or stop the timer intelligently.

Parameters

$name : string|null = null

Return values

Timer|mixed —

trace()

Provides a backtrace to the current execution point, from Kint.


    
                trace() : mixed

Return values

mixed —

view()

Grabs the current RendererInterface-compatible class and tells it to render the specified view. Simply provides a convenience method that can be used in Controllers, libraries, and routed closures.


    
                view(string $name[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $options = [] ]) : string

NOTE: Does not provide any escaping of the data, so that must all be handled manually by the developer.

Parameters

$name : string
$data : array<string|int, mixed> = []
$options : array<string|int, mixed> = []: Unused - reserved for third-party extensions.

Return values

string —

view_cell()

View cells are used within views to insert HTML chunks that are managed by other classes.


    
                view_cell(string $library[, null $params = null ], int $ttl[, string|null $cacheName = null ]) : string

Parameters

$library : string
$params : null = null
$ttl : int
$cacheName : string|null = null

Return values

string —

class_basename()

Get the class "basename" of the given object / class.


    
                class_basename(string|object $class) : string

Parameters

$class : string|object

Return values

string —

class_uses_recursive()

Returns all traits used by a class, its parent classes and trait of their traits.


    
                class_uses_recursive(object|string $class) : array<string|int, mixed>

Parameters

$class : object|string

Return values

array<string|int, mixed> —

trait_uses_recursive()

Returns all traits used by a trait and its traits.


    
                trait_uses_recursive(string $trait) : array<string|int, mixed>

Parameters

$trait : string

Return values

array<string|int, mixed> —

dot_array_search()

Searches an array through dot syntax. Supports wildcard searches, like foo.*.bar


    
                dot_array_search(string $index, array<string|int, mixed> $array) : mixed

Parameters

$index : string
$array : array<string|int, mixed>

Return values

mixed —

array_deep_search()

Returns the value of an element at a key in an array of uncertain depth.


    
                array_deep_search(mixed $key, array<string|int, mixed> $array) : mixed|null

Parameters

$key : mixed
$array : array<string|int, mixed>

Return values

mixed|null —

array_sort_by_multiple_keys()

Sorts a multidimensional array by its elements values. The array columns to be used for sorting are passed as an associative array of key names and sorting flags.


    
                array_sort_by_multiple_keys(array<string|int, mixed> &$array, array<string|int, mixed> $sortColumns) : bool

Both arrays of objects and arrays of array can be sorted.

Example: array_sort_by_multiple_keys($players, [ 'team.hierarchy' => SORT_ASC, 'position' => SORT_ASC, 'name' => SORT_STRING, ]);

The '.' dot operator in the column name indicates a deeper array or object level. In principle, any number of sublevels could be used, as long as the level and column exist in every array element.

For information on multi-level array sorting, refer to Example #3 here: https://www.php.net/manual/de/function.array-multisort.php

Parameters

$array : array<string|int, mixed>: the reference of the array to be sorted
$sortColumns : array<string|int, mixed>: an associative array of columns to sort after and their sorting flags

Return values

bool —

array_flatten_with_dots()

Flatten a multidimensional array using dots as separators.


    
                array_flatten_with_dots(iteratable<string|int, mixed> $array[, string $id = '' ]) : array<string|int, mixed>

Parameters

$array : iteratable<string|int, mixed>: The multi-dimensional array
$id : string = '': Something to initially prepend to the flattened keys

Return values

array<string|int, mixed> —

The flattened array

set_cookie()

Set cookie


    
                set_cookie(string|array<string|int, mixed> $name[, string $value = '' ][, string $expire = '' ][, string $domain = '' ][, string $path = '/' ][, string $prefix = '' ][, bool $secure = false ][, bool $httpOnly = false ][, string|null $sameSite = null ]) : mixed

Accepts seven parameters, or you can submit an associative array in the first parameter containing all the values.

Parameters

$name : string|array<string|int, mixed>: Cookie name or array containing binds
$value : string = '': The value of the cookie
$expire : string = '': The number of seconds until expiration
$domain : string = '': For site-wide cookie. Usually: .yourdomain.com
$path : string = '/': The cookie path
$prefix : string = '': The cookie prefix
$secure : bool = false: True makes the cookie secure
$httpOnly : bool = false: True makes the cookie accessible via http(s) only (no javascript)
$sameSite : string|null = null: The cookie SameSite value

Return values

mixed —

get_cookie()

Fetch an item from the $_COOKIE array


    
                get_cookie(string $index[, bool $xssClean = false ]) : mixed

Parameters

$index : string
$xssClean : bool = false

Return values

mixed —

delete_cookie()

Delete a cookie


    
                delete_cookie(mixed $name[, string $domain = '' ][, string $path = '/' ][, string $prefix = '' ]) : void

Parameters

$name : mixed
$domain : string = '': the cookie domain. Usually: .yourdomain.com
$path : string = '/': the cookie path
$prefix : string = '': the cookie prefix

Return values

void —

has_cookie()

Checks if a cookie exists by name.


    
                has_cookie(string $name[, string|null $value = null ][, string $prefix = '' ]) : bool

Parameters

$name : string
$value : string|null = null
$prefix : string = ''

Return values

bool —

now()

Get "now" time


    
                now([string $timezone = null ]) : int

Returns time() based on the timezone parameter or on the app_timezone() setting

Parameters

$timezone : string = null

Return values

int —

timezone_select()

Generates a select field of all available timezones


    
                timezone_select([string $class = '' ][, string $default = '' ][, int $what = DateTimeZone::ALL ][, string $country = null ]) : string

Returns a string with the formatted HTML

Parameters

$class : string = '': Optional class to apply to the select field
$default : string = '': Default value for initial selection
$what : int = DateTimeZone::ALL: One of the DateTimeZone class constants (for listIdentifiers)
$country : string = null: A two-letter ISO 3166-1 compatible country code (for listIdentifiers)

Return values

string —

directory_map()

Create a Directory Map


    
                directory_map(string $sourceDir, int $directoryDepth[, bool $hidden = false ]) : array<string|int, mixed>

Reads the specified directory and builds an array representation of it. Sub-folders contained with the directory will be mapped as well.

Parameters

$sourceDir : string: Path to source
$directoryDepth : int: Depth of directories to traverse (0 = fully recursive, 1 = current dir, etc)
$hidden : bool = false: Whether to show hidden files

Return values

array<string|int, mixed> —

directory_mirror()

Recursively copies the files and directories of the origin directory into the target directory, i.e. "mirror" its contents.


    
                directory_mirror(string $originDir, string $targetDir[, bool $overwrite = true ]) : void

Parameters

$originDir : string
$targetDir : string
$overwrite : bool = true: Whether individual files overwrite on collision

Return values

void —

write_file()

Write File


    
                write_file(string $path, string $data[, string $mode = 'wb' ]) : bool

Writes data to the file specified in the path. Creates a new file if non-existent.

Parameters

$path : string: File path
$data : string: Data to write
$mode : string = 'wb': fopen() mode (default: 'wb')

Return values

bool —

delete_files()

Delete Files


    
                delete_files(string $path[, bool $delDir = false ][, bool $htdocs = false ][, bool $hidden = false ]) : bool

Deletes all files contained in the supplied directory path. Files must be writable or owned by the system in order to be deleted. If the second parameter is set to true, any directories contained within the supplied base directory will be nuked as well.

Parameters

$path : string: File path
$delDir : bool = false: Whether to delete any directories found in the path
$htdocs : bool = false: Whether to skip deleting .htaccess and index page files
$hidden : bool = false: Whether to include hidden files (files beginning with a period)

Return values

bool —

get_filenames()

Get Filenames


    
                get_filenames(string $sourceDir[, bool|null $includePath = false ][, bool $hidden = false ]) : array<string|int, mixed>

Reads the specified directory and builds an array containing the filenames. Any sub-folders contained within the specified path are read as well.

Parameters

$sourceDir : string: Path to source
$includePath : bool|null = false: Whether to include the path as part of the filename; false for no path, null for a relative path, true for full path
$hidden : bool = false: Whether to include hidden files (files beginning with a period)

Return values

array<string|int, mixed> —

get_dir_file_info()

Get Directory File Information


    
                get_dir_file_info(string $sourceDir[, bool $topLevelOnly = true ][, bool $recursion = false ]) : array<string|int, mixed>

Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions

Any sub-folders contained within the specified path are read as well.

Parameters

$sourceDir : string: Path to source
$topLevelOnly : bool = true: Look only at the top level directory specified?
$recursion : bool = false: Internal variable to determine recursion status - do not use in calls

Return values

array<string|int, mixed> —

get_file_info()

Get File Info


    
                get_file_info(string $file[, mixed $returnedValues = ['name', 'server_path', 'size', 'date'] ]) : array<string|int, mixed>|null

Given a file and path, returns the name, path, size, date modified Second parameter allows you to explicitly declare what information you want returned Options are: name, server_path, size, date, readable, writable, executable, fileperms Returns false if the file cannot be found.

Parameters

$file : string: Path to file
$returnedValues : mixed = ['name', 'server_path', 'size', 'date']: Array or comma separated string of information returned

Return values

array<string|int, mixed>|null —

symbolic_permissions()

Symbolic Permissions


    
                symbolic_permissions(int $perms) : string

Takes a numeric value representing a file's permissions and returns standard symbolic notation representing that value

Parameters

$perms : int: Permissions

Return values

string —

octal_permissions()

Octal Permissions


    
                octal_permissions(int $perms) : string

Takes a numeric value representing a file's permissions and returns a three character string representing the file's octal permissions

Parameters

$perms : int: Permissions

Return values

string —

same_file()

Checks if two files both exist and have identical hashes


    
                same_file(string $file1, string $file2) : bool

Parameters

$file1 : string
$file2 : string

Return values

bool —

Same or not

set_realpath()

Set Realpath


    
                set_realpath(string $path[, bool $checkExistence = false ]) : string

Parameters

$path : string
$checkExistence : bool = false: Checks to see if the path exists

Return values

string —

form_open()

Form Declaration


    
                form_open([string $action = '' ][, array<string|int, mixed>|string $attributes = [] ][, array<string|int, mixed> $hidden = [] ]) : string

Creates the opening portion of the form.

Parameters

$action : string = '': the URI segments of the form destination
$attributes : array<string|int, mixed>|string = []: a key/value pair of attributes, or string representation
$hidden : array<string|int, mixed> = []: a key/value pair hidden data

Return values

string —

form_open_multipart()

Form Declaration - Multipart type


    
                form_open_multipart([string $action = '' ][, array<string|int, mixed>|string $attributes = [] ][, array<string|int, mixed> $hidden = [] ]) : string

Creates the opening portion of the form, but with "multipart/form-data".

Parameters

$action : string = '': The URI segments of the form destination
$attributes : array<string|int, mixed>|string = []: A key/value pair of attributes, or the same as a string
$hidden : array<string|int, mixed> = []: A key/value pair hidden data

Return values

string —

form_hidden()

Hidden Input Field


    
                form_hidden(string|array<string|int, mixed> $name[, string|array<string|int, mixed> $value = '' ][, bool $recursing = false ]) : string

Generates hidden fields. You can pass a simple key/value string or an associative array with multiple values.

Parameters

$name : string|array<string|int, mixed>: Field name or associative array to create multiple fields
$value : string|array<string|int, mixed> = '': Field value
$recursing : bool = false

Return values

string —

form_input()

Text Input Field. If 'type' is passed in the $type field, it will be used as the input type, for making 'email', 'phone', etc input fields.


    
                form_input([mixed $data = '' ][, string $value = '' ][, mixed $extra = '' ][, string $type = 'text' ]) : string

Parameters

$data : mixed = ''
$value : string = ''
$extra : mixed = ''
$type : string = 'text'

Return values

string —

form_password()

Password Field


    
                form_password([mixed $data = '' ][, string $value = '' ][, mixed $extra = '' ]) : string

Identical to the input function but adds the "password" type

Parameters

$data : mixed = ''
$value : string = ''
$extra : mixed = ''

Return values

string —

form_upload()

Upload Field


    
                form_upload([mixed $data = '' ][, string $value = '' ][, mixed $extra = '' ]) : string

Identical to the input function but adds the "file" type

Parameters

$data : mixed = ''
$value : string = ''
$extra : mixed = ''

Return values

string —

form_textarea()

Textarea field


    
                form_textarea([mixed $data = '' ][, string $value = '' ][, mixed $extra = '' ]) : string

Parameters

$data : mixed = ''
$value : string = ''
$extra : mixed = ''

Return values

string —

form_multiselect()

Multi-select menu


    
                form_multiselect([mixed $name = '' ][, array<string|int, mixed> $options = [] ][, array<string|int, mixed> $selected = [] ][, mixed $extra = '' ]) : string

Parameters

$name : mixed = ''
$options : array<string|int, mixed> = []
$selected : array<string|int, mixed> = []
$extra : mixed = ''

Return values

string —

form_dropdown()

Drop-down Menu


    
                form_dropdown([mixed $data = '' ][, mixed $options = [] ][, mixed $selected = [] ][, mixed $extra = '' ]) : string

Parameters

$data : mixed = ''
$options : mixed = []
$selected : mixed = []
$extra : mixed = ''

Return values

string —

form_checkbox()

Checkbox Field


    
                form_checkbox([mixed $data = '' ][, string $value = '' ][, bool $checked = false ][, mixed $extra = '' ]) : string

Parameters

$data : mixed = ''
$value : string = ''
$checked : bool = false
$extra : mixed = ''

Return values

string —

form_radio()

Radio Button


    
                form_radio([mixed $data = '' ][, string $value = '' ][, bool $checked = false ][, mixed $extra = '' ]) : string

Parameters

$data : mixed = ''
$value : string = ''
$checked : bool = false
$extra : mixed = ''

Return values

string —

form_submit()

Submit Button


    
                form_submit([mixed $data = '' ][, string $value = '' ][, mixed $extra = '' ]) : string

Parameters

$data : mixed = ''
$value : string = ''
$extra : mixed = ''

Return values

string —

form_reset()

Reset Button


    
                form_reset([mixed $data = '' ][, string $value = '' ][, mixed $extra = '' ]) : string

Parameters

$data : mixed = ''
$value : string = ''
$extra : mixed = ''

Return values

string —

form_button()

Form Button


    
                form_button([mixed $data = '' ][, string $content = '' ][, mixed $extra = '' ]) : string

Parameters

$data : mixed = ''
$content : string = ''
$extra : mixed = ''

Return values

string —

form_label()

Form Label Tag


    
                form_label([string $labelText = '' ][, string $id = '' ][, array<string|int, mixed> $attributes = [] ]) : string

Parameters

$labelText : string = '': The text to appear onscreen
$id : string = '': The id the label applies to
$attributes : array<string|int, mixed> = []: Additional attributes

Return values

string —

form_datalist()

Datalist


    
                form_datalist(string $name, string $value, array<string|int, mixed> $options) : string

The element specifies a list of pre-defined options for an element. Users will see a drop-down list of pre-defined options as they input data. The list attribute of the element, must refer to the id attribute of the element.

Parameters

$name : string
$value : string
$options : array<string|int, mixed>

Return values

string —

form_fieldset()

Fieldset Tag


    
                form_fieldset([string $legendText = '' ][, array<string|int, mixed> $attributes = [] ]) : string

Used to produce

text. To close fieldset use form_fieldset_close()

Parameters

$legendText : string = '': The legend text
$attributes : array<string|int, mixed> = []: Additional attributes

Return values

string —

form_fieldset_close()

Fieldset Close Tag


    
                form_fieldset_close([string $extra = '' ]) : string

Parameters

$extra : string = ''

Return values

string —

form_close()

Form Close Tag


    
                form_close([string $extra = '' ]) : string

Parameters

$extra : string = ''

Return values

string —

set_value()

Form Value


    
                set_value(string $field[, string|array<string|int, string> $default = '' ][, bool $htmlEscape = true ]) : string|array<string|int, string>

Grabs a value from the POST array for the specified field so you can re-populate an input field or textarea

Parameters

$field : string: Field name
$default : string|array<string|int, string> = '': Default value
$htmlEscape : bool = true: Whether to escape HTML special characters or not

Return values

string|array<string|int, string> —

set_select()

Set Select


    
                set_select(string $field[, string $value = '' ][, bool $default = false ]) : string

Let's you set the selected value of a

Application

Interfaces, Classes and Traits

Table of Contents

Constants

APPPATH

ARGS

ENVIRONMENT

EVENT_PRIORITY_HIGH

EVENT_PRIORITY_LOW

EVENT_PRIORITY_NORMAL

FCPATH

KINT_DIR

KINT_DIR

KINT_PHP56

KINT_PHP56

KINT_PHP70

KINT_PHP70

KINT_PHP72

KINT_PHP72

KINT_PHP73

KINT_PHP73

KINT_PHP74

KINT_PHP74

KINT_WIN

KINT_WIN

LIB

PARAMS

PHP_CODESNIFFER_CBF

PHP_CODESNIFFER_IN_TESTS

PHP_CODESNIFFER_VERBOSITY

ROOTPATH

SYSTEMPATH

T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG

T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG

T_ANON_CLASS

T_ARRAY_HINT

T_ASPERAND

T_ATTRIBUTE

T_ATTRIBUTE_END

T_BACKTICK

T_BAD_CHARACTER

T_BINARY_CAST

T_BITWISE_AND

T_BITWISE_NOT

T_BITWISE_OR

T_BITWISE_XOR

T_BOOLEAN_NOT

T_CLOSE_CURLY_BRACKET

T_CLOSE_OBJECT

T_CLOSE_PARENTHESIS

T_CLOSE_SHORT_ARRAY

T_CLOSE_SQUARE_BRACKET

T_CLOSE_USE_GROUP

T_CLOSURE

T_COALESCE

T_COALESCE_EQUAL

T_COLON

T_COLOUR

T_COMMA

T_DIVIDE

T_DOC_COMMENT_CLOSE_TAG

T_DOC_COMMENT_OPEN_TAG

T_DOC_COMMENT_STAR

T_DOC_COMMENT_STRING

T_DOC_COMMENT_TAG

T_DOC_COMMENT_WHITESPACE

T_DOLLAR

T_DOUBLE_QUOTED_STRING

T_ELLIPSIS

T_EMBEDDED_PHP

T_END_NOWDOC

T_EQUAL

T_FALSE

T_FINALLY

T_FN

T_FN_ARROW

T_GOTO_LABEL

T_GREATER_THAN

T_HASH

T_HEREDOC