Documentation

Application

Table of Contents

Interfaces

PermissionCacheInterface
ResolvesToAny
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToArray
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToBinData
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToBool
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToDate
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToDecimal
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToDouble
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToInt
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToJavascript
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToLong
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToNull
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToNumber
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToObject
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToObjectId
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToRegex
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToString
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
ResolvesToTimestamp
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
AccumulatorInterface
Aggregation Pipeline Accumulators for $group stage.
DictionaryInterface
ExpressionInterface
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
FieldPathInterface
Aggregation expressions use field path to access fields in the input documents.
FieldQueryInterface
Query operators that need to be associated with a field path.
GeometryInterface
OperatorExpressionInterface
Expressions can include field paths, literals, system variables, expression objects, and expression operators.
OperatorInterface
Marker interface for MongoDB operators.
QueryInterface
Query are operator and object that can be used in $match stage.
SearchOperatorInterface
StageInterface
Aggregation Pipeline Stages
SwitchBranchInterface
Interface for branches in $switch operators
WindowInterface
Window Operators can be used for $setWindowFields stage partition.
Codec
The Codec interface allows decoding BSON data to native PHP types and back to BSON.
Decoder
DocumentCodec
The DocumentCodec interface allows decoding BSON document data to native PHP objects and back to BSON documents.
Encoder
Exception
AssetFetcherInterface
BarcodeInterface
ContainerInterface
LocalContentLoaderInterface
ClientInterface
LanguageToFontInterface
mPDF recognises IETF language tags as: - a single primary language subtag composed of a two letter language code from ISO 639-1 (2002), or a three letter code from ISO 639-2 (1998), ISO 639-3 (2007) or ISO 639-5 (2008) (usually written in lower case); - an optional script subtag, composed of a four letter script code from ISO 15924 (usually written in title case); - an optional region subtag composed of a two letter country code from ISO 3166-1 alpha-2 (usually written in upper case), or a three digit code from UN M.49 for geographical regions;
ScriptToLanguageInterface
Watermark
Filter
Filter to apply to a property while copying an object
Matcher
TypeFilter
Operand
AddressRange
IValueBinder
IRenderer
IComparable
IReader
IReadFilter
ITextElement
WizardInterface
Wizard
IWriter
MessageInterface
HTTP messages consist of requests from a client to a server and responses from a server to a client. This interface defines the methods common to each.
RequestInterface
Representation of an outgoing, client-side request.
ResponseInterface
Representation of an outgoing, server-side response.
ServerRequestInterface
Representation of an incoming, server-side HTTP request.
StreamInterface
Describes a data stream.
UploadedFileInterface
Value object representing a file uploaded through an HTTP request.
UriInterface
Value object representing a URI.
LoggerAwareInterface
Describes a logger-aware instance.
LoggerInterface
Describes a logger instance.
CacheException
Interface used for all types of exceptions thrown by the implementing library.
CacheInterface
InvalidArgumentException
Exception interface for invalid cache arguments.

Classes

DataValidator
Bootstrap
AccidentTypeController
AdminPanelController
AdminSettingsController
BodyPartController
Classification1Controller
Classification2Controller
Classification3Controller
CodeRangeController
CompaniesManagementController
CompanyDivisionController
CompanyLegalEntityController
CompanyPlantController
CompanyRelationsController
CompanyStructureController
CurrencyController
DatapointController
DatapointSubtopicController
DatapointTopicController
DBMasterDataController
ExportFormatController
HierarchyController
KpiManagmentController
LanguageController
LocationController
MasterDataNewController
ModuleManagementController
PersonController
PlantDepartmentController
PlantMachineController
ReferenceNewController
ReferenceTypeController
SourceController
SourceTypeController
StatusController
SystemSettingsController
TimePeriodController
UnitController
UserManagementController
WorkActivityController
BenchmarkingController
CompanyController
IndexController
ReportGenerateController
SafetyController
SustainabilityController
UsersController
IndexController
LogInController
RegisterController
CodeRangeGenerator
CodeRangeGenerator
DataValidator
Filesystem
FileUploader
Image
Lang
QueryLogger
Action
Logger
Permission
PermissionResolver
Rbac
Resource
Role
SessionPermissionCache
Accident
Class Accident
AccidentFiles
Handles operations related to accident and fact files, including saving, retrieving, and deleting files linked with accidents and ESG safety facts.
AccidentType
The AccidentType class manages CRUD operations for accident types.
Autosuggest
Provides functionality for generating a pool of topics, subtopics, and datapoints based on a specified hierarchy code.
BodyPart
Class responsible for handling operations related to body parts.
Classification1
Handles operations related to the classification_1 table.
Classification2
Classification2 class.
Classification3
A class responsible for managing operations related to classification_3 records.
CodeRange
Class CodeRange
Company
Class Company
CompanyCurrency
Class CompanyCurrency
CompanyDivision
Class responsible for managing company divisions.
CompanyLegalEntity
Class for managing company legal entities, including fetching, creating, updating, and retrieving entities based on division or company codes.
CompanyPlant
Update plant by code (admin).
CompanyStructure
Class responsible for managing hierarchical company structures including companies, divisions, legal entities, plants, and departments.
CompanyType
Class CompanyType
CompanyUnit
Manages operations related to the assignment of units to companies, including listing, creating, updating, and soft-deleting associations between companies and units.
CompanyWorkActivity
Class CompanyWorkActivity
Person
Class representing operations related to a person.
PlantDepartment
Class PlantDepartment
PlantMachine
Class PlantMachine
Currency
Class Currency
DataPoint
Class representing operations on datapoints in the database.
DatapointSubtopic
Class DatapointSubtopic
DatapointTopic
Class DatapointTopic
DbMasterData
Class DbMasterData
EsgSection
EsgSection class provides methods to retrieve ESG-related data such as retrieving all hierarchies for a module or all company sections associated with a module and company code.
ExportFormat
Class ExportFormat
FactEsg
Class FactEsg
FactEsgSafety
Class FactEsgSafety
FactFile
Class FactFile
FactSafetyFile
Handles the management of safety files associated with facts, including uploading, retrieval, and deletion.
FactUploader
Class responsible for uploading and managing fact data, including validation, database interaction, and parsing from external sources like Excel files.
Hierarchy
Class Hierarchy
Kpi
Class Kpi
KpiCategory
Class KpiCategory
KpiSafety
Class KpiSafety
Language
Class Language
LexEsrs
Class LexEsrs
Location
The Location class provides methods to interact with the locations in a database.
Module
The Module class provides functionalities to interact with the `module` database table.
ModuleDatapoint
Class ModuleDatapoint
ModuleDatapointSubtopic
Class ModuleDatapointSubtopic
ModuleDatapointTopic
Class ModuleDatapointTopic
ModuleHierarchy
Class ModuleHierarchy
Reference
The Reference class provides methods for managing and retrieving reference data from a MySQL database.
ReferenceCompany
Class ReferenceCompany
ReferenceType
Handles operations related to reference types.
Report
The Report class provides methods to interact with report data in the database.
ReportEntry
Handles operations related to report entries, such as fetching entries by code or report ID and creating new report entries.
ReportEntryImage
Class ReportEntryImage
ReportExportFormat
Class ReportExportFormat
ReportPdfExporter
Class ReportPdfExporter
ReportType
Handles operations related to report types.
Source
Class Source
SourceType
The SourceType class provides methods to interact with the `source_type` database table.
Status
Class Status
Time
TimePeriod
Class TimePeriod
Topic
Represents operations for managing topics, subtopics, and datapoints within a hierarchical structure based on reference codes.
Unit
Represents a Unit entity and provides various methods to interact with the database for unit-related operations.
User
Class User
UserData
Class UserData Handles operations related to user data, including retrieval and update operations.
WorkActivity
Class WorkActivity
ExternalTaxonomyNotResolvedException
Represents an exception that is thrown when an external taxonomy cannot be resolved during processing.
UnexpectedSubstitutionGroupException
Represents an exception that is thrown when an unexpected substitution group is encountered.
EfragDatapointMappingImporter
Handles the import of datapoint mappings from an Excel file into the system.
XbrlTaxonomyImporter
The XbrlTaxonomyImporter class is responsible for importing XBRL taxonomy data and processing associated linkbase files, including presentation, definition, and label types.
DefinitionLinkbaseParser
The DefinitionLinkbaseParser class is responsible for parsing taxonomy definition linkbase XML files. It processes arcs and relationships in the definition linkbase to establish the connections between taxonomy elements such as dimensions, hypercubes, domains, and members.
LabelLinkbaseParser
Handles the parsing of XBRL label linkbase files, enabling the resolution of labels to taxonomy elements and storing them in a database.
PresentationLinkbaseParser
Class responsible for parsing XBRL presentation linkbases, processing XML files, and updating the database with taxonomy presentation information.
SchemaParser
Class SchemaParser
XsdSchemaParser
The XsdSchemaParser class provides functionality to process and parse XSD (XML Schema Definition) files, extracting relevant taxonomy elements and storing them in a database.
NamespaceRegistry
Manages the registration and retrieval of XML namespace mappings for multiple files using prefixes and namespaces.
XhtmlIxbrlRenderer
Represents a class responsible for rendering XHTML iXBRL and XML documents, particularly aimed at generating reports following the Inline XBRL specification.
LocatorResolver
Class LocatorResolver
ContextBuilder
Class ContextBuilder
FactMapper
FactMapper is responsible for transforming raw fact data into structured fact representations suitable for further processing.
ReportAssembler
The ReportAssembler class is responsible for assembling and rendering structured reports based on provided data and taxonomy configurations. It provides methods to create complete report documents in various formats, including XHTML and XML.
ReportFactRepository
A repository class responsible for retrieving and normalizing fact data for reports.
TaxonomyReaderService
Class responsible for retrieving and managing taxonomy-related data, such as elements, labels, parent-child relationships, and dimensions. Interacts with a MySQL database to perform queries and return structured results.
UnitBuilder
Auth
Config
Dice
MongoDb
Class to connect to MongoDB database
MySql
Encryption
Request
Response
Session
Page
Partial
Renderer
Section
Csrf
Escaper
Xss
ComposerAutoloaderInite68b9a3e8c541d3336c0e9a04e2459a3
ComposerStaticInite68b9a3e8c541d3336c0e9a04e2459a3
ClassLoader
ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
InstalledVersions
This class is copied in every Composer installed project and available to all
MatchAllResult
MatchAllStrictGroupsResult
MatchAllWithOffsetsResult
MatchResult
MatchStrictGroupsResult
MatchWithOffsetsResult
PcreException
InvalidRegexPatternRule
Copy of PHPStan's RegularExpressionPatternRule
PregMatchFlags
PregMatchParameterOutTypeExtension
PregMatchTypeSpecifyingExtension
PregReplaceCallbackClosureTypeExtension
UnsafeStrictGroupsCallRule
Preg
Regex
ReplaceResult
UnexpectedNullMatchException
DosTimeOverflowException
This Exception gets invoked if a DOS time is overflowing
FileNotFoundException
This Exception gets invoked if a file wasn't found
FileNotReadableException
This Exception gets invoked if a file isn't readable
FileSizeIncorrectException
This Exception gets invoked if a file is not as large as it was specified.
OverflowException
This Exception gets invoked if a counter value exceeds storage size
ResourceActionException
This Exception gets invoked if a resource like `fread` returns false
SimulationFileUnknownException
This Exception gets invoked if a strict simulation is executed and the file information can't be determined without reading the entire file.
StreamNotReadableException
This Exception gets invoked if a stream can't be read.
StreamNotSeekableException
This Exception gets invoked if a non seekable stream is provided and zero headers are disabled.
Exception
CallbackStreamWrapper
Stream wrapper that allows writing data to a callback function.
ZipStream
Streamed, dynamically generated zip archives.
CallbackOutputTest
CentralDirectoryFileHeaderTest
DataDescriptorTest
EndlessCycleStream
EndOfCentralDirectoryTest
FaultInjectionResource
LocalFileHeaderTest
PackFieldTest
TimeTest
DataDescriptorTest
EndOfCentralDirectoryLocatorTest
EndOfCentralDirectoryTest
ExtendedInformationExtraFieldTest
ZipStreamTest
ExtendedInformationExtraFieldTest
Exception
Functions
Operations
Decomposition
LU
QR
Div0Exception
Exception
Functions
Operations
Addition
DirectSum
Division
Multiplication
Operator
Subtraction
Accumulator
Factories for Aggregation Pipeline Accumulator and Window Operators
BuilderEncoder
ArrayFieldPath
BinDataFieldPath
BoolFieldPath
DateFieldPath
DecimalFieldPath
DoubleFieldPath
FieldPath
IntFieldPath
JavascriptFieldPath
LongFieldPath
NullFieldPath
NumberFieldPath
ObjectFieldPath
ObjectIdFieldPath
RegexFieldPath
StringFieldPath
TimestampFieldPath
Variable
Expression
Factories for Aggregation Pipeline Expression Operators
Pipeline
An aggregation pipeline consists of one or more stages that process documents.
Query
Factories for Query Operators
Search
Stage
OutputWindow
Specifies the window boundaries and parameters. Window boundaries are inclusive.
QueryObject
Helper class to validate query objects.
Variable
Enum for system variables that can be used in aggregation expressions.
BulkWriteResult
Result class for a bulk write operation.
ChangeStream
Iterator for a change stream.
Client
ClientBulkWrite
Collection
Database
DeleteResult
Result class for a delete operation.
BadMethodCallException
InvalidArgumentException
ResumeTokenException
RuntimeException
SearchNotSupportedException
UnexpectedValueException
UnsupportedException
UnsupportedValueException
Bucket
Bucket provides a public API for interacting with the GridFS files and chunks collections.
CorruptFileException
FileNotFoundException
LogicException
StreamException
InsertManyResult
Result class for a multi-document insert operation.
InsertOneResult
Result class for a single-document insert operation.
BSONArray
Model class for a BSON array.
BSONDocument
Model class for a BSON document.
BSONIterator
Iterator for BSON documents.
CodecCursor
CollectionInfo
Collection information model class.
DatabaseInfo
Database information model class.
IndexInfo
Index information model class.
Aggregate
Operation for the aggregate command.
BulkWrite
Operation for executing multiple write operations.
ClientBulkWriteCommand
Operation for executing multiple write operations via the bulkWrite command.
Count
Operation for the count command.
CountDocuments
Operation for obtaining an exact count of documents in a collection
CreateCollection
Operation for the create command.
CreateIndexes
Operation for the createIndexes command.
CreateSearchIndexes
Operation for the createIndexes command.
DatabaseCommand
Operation for executing a database command.
DeleteMany
Operation for deleting multiple document with the delete command.
DeleteOne
Operation for deleting a single document with the delete command.
Distinct
Operation for the distinct command.
DropCollection
Operation for the drop command.
DropDatabase
Operation for the dropDatabase command.
DropIndexes
Operation for the dropIndexes command.
DropSearchIndex
Operation for the dropSearchIndexes command.
EstimatedDocumentCount
Operation for obtaining an estimated count of documents in a collection
Explain
Operation for the explain command.
Find
Operation for the find command.
FindOne
Operation for finding a single document with the find command.
FindOneAndDelete
Operation for deleting a document with the findAndModify command.
FindOneAndReplace
Operation for replacing a document with the findAndModify command.
FindOneAndUpdate
Operation for updating a document with the findAndModify command.
InsertMany
Operation for inserting multiple documents with the insert command.
InsertOne
Operation for inserting a single document with the insert command.
ListCollectionNames
Operation for the listCollectionNames helper.
ListCollections
Operation for the listCollections command.
ListDatabaseNames
Operation for the ListDatabases command, returning only database names.
ListDatabases
Operation for the ListDatabases command.
ListIndexes
Operation for the listIndexes command.
ListSearchIndexes
Operation for the listSearchIndexes command.
ModifyCollection
Operation for the collMod command.
RenameCollection
Operation for the renameCollection command.
ReplaceOne
Operation for replacing a single document with the update command.
UpdateMany
Operation for updating multiple documents with the update command.
UpdateOne
Operation for updating a single document with the update command.
UpdateSearchIndex
Operation for the createIndexes command.
Watch
Operation for creating a change stream with the aggregate command.
UpdateResult
Result class for an update operation.
AssetFetcher
AbstractBarcode
BarcodeException
Codabar
CODABAR barcodes.
Code11
CODE11 barcodes.
Code128
C128 barcodes.
Code39
CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.
Code93
CODE 93 - USS-93 Compact code similar to Code 39
EanExt
UPC-Based Extentions 2-Digit Ext.: Used to indicate magazines and newspaper issue numbers 5-Digit Ext.: Used to mark suggested retail price of books
EanUpc
EAN13 and UPC-A barcodes.
I25
Interleaved 2 of 5 barcodes.
Imb
IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200
Msi
MSI - Variation of Plessey code, with similar applications Contains digits (0 to 9) and encodes the data only in the width of bars.
Postnet
POSTNET and PLANET barcodes.
Rm4Scc
S25
Standard 2 of 5 barcodes.
Barcode
Buffer
Cache
ColorConverter
ColorModeConverter
ColorSpaceRestrictor
NamedColors
ConfigVariables
FontVariables
NotFoundException
SimpleContainer
DecToAlpha
DecToCjk
DecToHebrew
DecToOther
DecToRoman
Border
BorderMerger
CommentParser
CssLoader
CssMerger
CssParser
DefaultCss
InlinePropertyConverter
InlineStyleParser
MediaQueryProcessor
NormalizeProperties
SelectorParser
ShadowParser
TextVars
CssManager
DirectWrite
AssetFetchingException
FontException
InvalidArgumentException
LocalContentLoader
StreamWrapperChecker
FontCache
FontFileFinder
GlyphOperator
MetricsGenerator
Form
ColorTable
GIF Util - (C) 2003 Yamasoft (S/C)
FileHeader
GIF Util - (C) 2003 Yamasoft (S/C)
Gif
GIF Util - (C) 2003 Yamasoft (S/C)
Image
GIF Util - (C) 2003 Yamasoft (S/C)
ImageHeader
GIF Util - (C) 2003 Yamasoft (S/C)
Lzw
GIF Util - (C) 2003 Yamasoft (S/C)
Gradient
HTMLParserMode
CurlHttpClient
ClientException
ForbiddenRequestException
NetworkException
RequestException
SocketHttpClient
Hyphenator
Bmp
ImageProcessor
ImageTypeGuesser
Svg
SVG class modified for mPDF version >= 6.0
Wmf
LanguageToFont
ScriptToLanguage
Context
Mpdf
mPDF, PHP library generating PDF files from UTF-8 encoded HTML
MpdfException
MpdfImageException
Otl
OtlDump
Destination
PageBox
PageFormat
UniqidGenerator
Protection
ServiceFactory
Indic
Myanmar
Sea
SizeConverter
TableOfContents
A
Acronym
Address
Annotation
Article
Aside
B
BarCode
Bdi
Bdo
Big
BlockQuote
BlockTag
Bookmark
Br
Caption
Center
Cite
Code
ColumnBreak
Columns
Dd
Del
Details
Div
Dl
DotTab
Dt
Em
FieldSet
FigCaption
Figure
Font
Footer
Form
FormFeed
H1
H2
H3
H4
H5
H6
Header
HGroup
Hr
I
Img
IndexEntry
IndexInsert
InlineTag
Input
Ins
Kbd
Legend
Li
Main
Mark
Meter
Nav
NewColumn
NewPage
Ol
Option
P
PageBreak
PageFooter
PageHeader
Pre
Progress
Q
S
Samp
Section
Select
SetHtmlPageFooter
SetHtmlPageHeader
SetPageFooter
SetPageHeader
Small
Span
Strike
Strong
Sub
SubstituteTag
Summary
Sup
Table
Tag
TBody
Td
TextArea
TextCircle
TFoot
Th
THead
Time
Toc
TocEntry
TocPageBreak
Tr
Tt
Tta
Tts
Ttz
U
Ul
VarTag
WatermarkImage
WatermarkText
Tag
TTFontFile
TTFontFile class
TTFontFileAnalysis
TTFontFile class
Ucdn
Arrays
NumericString
Path
PdfDate
UtfString
WatermarkImage
WatermarkText
BackgroundWriter
BaseWriter
BookmarkWriter
ColorWriter
FontWriter
FormWriter
ImageWriter
JavaScriptWriter
MetadataWriter
ObjectWriter
OptionalContentWriter
PageWriter
ResourceWriter
Request
PSR-7 URI implementation ported from nyholm/psr7 and adapted for PHP 5.6
Response
PSR-7 URI implementation ported from nyholm/psr7 and adapted for PHP 5.6
Stream
Uri
PSR-7 URI implementation ported from nyholm/psr7 and adapted for PHP 5.6
DeepCopy
CloneException
PropertyException
ChainableFilter
Defines a decorator filter that will not stop the chain of filters.
DoctrineCollectionFilter
DoctrineEmptyCollectionFilter
DoctrineProxyFilter
KeepFilter
ReplaceFilter
SetNullFilter
DoctrineProxyMatcher
PropertyMatcher
PropertyNameMatcher
PropertyTypeMatcher
Matches a property by its type.
ReflectionHelper
DateIntervalFilter
DatePeriodFilter
ReplaceFilter
ShallowCopyFilter
ArrayObjectFilter
In PHP 7.4 the storage of an ArrayObject isn't returned as ReflectionProperty. So we deep copy its array copy.
SplDoublyLinkedList
SplDoublyLinkedListFilter
TypeMatcher
BinaryComparison
Calculation
CalculationBase
CalculationLocale
Category
DatabaseAbstract
DAverage
DCount
DCountA
DGet
DMax
DMin
DProduct
DStDev
DStDevP
DSum
DVar
DVarP
Constants
Current
Date
DateParts
DateValue
Days
Days360
Difference
Helpers
Month
NetworkDays
Time
TimeParts
TimeValue
Week
WorkDay
YearFrac
ArrayArgumentHelper
ArrayArgumentProcessor
BranchPruner
CyclicReferenceStack
FormattedNumber
Logger
StructuredReference
BesselI
BesselJ
BesselK
BesselY
BitWise
Compare
Complex
ComplexFunctions
ComplexOperations
Constants
ConvertBase
ConvertBinary
ConvertDecimal
ConvertHex
ConvertOctal
ConvertUOM
EngineeringValidations
Erf
ErfC
Exception
ExceptionHandler
Amortization
CashFlowValidations
Cumulative
Interest
InterestAndPrincipal
Payments
Periodic
Single
NonPeriodic
Periodic
Constants
Coupons
Depreciation
Dollar
FinancialValidations
Helpers
InterestRate
AccruedInterest
Price
Rates
SecurityValidations
Yields
TreasuryBill
FormulaParser
PARTLY BASED ON: Copyright (c) 2007 E. W. Bachtal, Inc.
FormulaToken
PARTLY BASED ON: Copyright (c) 2007 E. W. Bachtal, Inc.
FunctionArray
Functions
ErrorValue
ExcelError
Info
Value
ExcelArrayPseudoFunctions
MakeMatrix
WildcardMatch
Boolean
Conditional
Operations
Address
ChooseRowsEtc
ExcelMatch
Filter
Formula
Helpers
HLookup
Hstack
Hyperlink
Indirect
Lookup
LookupBase
LookupRefValidations
Matrix
Offset
RowColumnInformation
Selection
Sort
TorowTocol
Unique
VLookup
Vstack
XLookup
Absolute
Angle
Arabic
Base
Ceiling
Combinations
Exp
Factorial
Floor
Gcd
Helpers
IntClass
Lcm
Logarithms
MatrixFunctions
Operations
Random
Roman
Round
SeriesSum
Sign
Sqrt
Subtotal
Sum
SumSquares
Cosecant
Cosine
Cotangent
Secant
Sine
Tangent
Trunc
AggregateBase
Mean
Averages
Conditional
Confidence
Counts
Deviations
Beta
Binomial
ChiSquared
DistributionValidations
Exponential
F
Fisher
Gamma
GammaBase
HyperGeometric
LogNormal
NewtonRaphson
Normal
Poisson
StandardNormal
StudentT
Some of this code is drived from Perl CPAN Statistical::Distributions.
Weibull
Maximum
MaxMinBase
Minimum
Percentiles
Permutations
Size
StandardDeviations
Standardize
StatisticalValidations
Trends
VarianceBase
Variances
CaseConvert
CharacterConvert
Concatenate
Extract
Format
Helpers
Replace
Search
Text
Thai
Trim
Stack
Service
AddressHelper
AdvancedValueBinder
Cell
CellAddress
CellRange
ColumnRange
Coordinate
Helper class to manipulate cell coordinates.
DataType
DataValidation
DataValidator
Validate a cell value according to its validation rules.
DefaultValueBinder
Hyperlink
IgnoredErrors
RowRange
StringValueBinder
CellReferenceHelper
Axis
Created by PhpStorm.
AxisText
Created by PhpStorm.
Chart
ChartColor
DataSeries
DataSeriesValues
Created by PhpStorm.
Exception
GridLines
Created by PhpStorm.
Layout
Legend
PlotArea
Properties
Created by PhpStorm.
JpGraph
Jpgraph is not officially maintained in Composer, so the version there could be out of date. For that reason, all unit test requiring Jpgraph are skipped. So, do not measure code coverage for this class till that is fixed.
JpGraphRendererBase
Base class for different Jpgraph implementations as charts renderer.
MtJpGraphRenderer
Jpgraph is not officially maintained by Composer at packagist.org.
Title
TrendLine
Created by PhpStorm.
Cells
CellsFactory
SimpleCache1
This is the default implementation for in-memory cell collection.
SimpleCache3
This is the default implementation for in-memory cell collection.
Comment
DefinedName
Properties
Security
Exception
HashTable
Dimension
Downloader
Assist downloading files when samples are run in browser.
Handler
Html
Sample
Helper class to be used in sample code.
Size
TextGrid
IOFactory
Factory to create readers and writers easily.
NamedFormula
NamedRange
BaseReader
Delimiter
Csv
CsvNoEscape
DefaultReadFilter
Exception
PageSetup
Properties
Styles
Gnumeric
Html
AutoFilter
BaseLoader
DefinedNames
FormulaTranslator
PageSettings
Properties
Ods
XmlScanner
Slk
Biff5
Biff8
BIFF5
BIFF8
BuiltIn
Color
ConditionalFormatting
DataValidationHelper
ErrorCode
Escher
ListFunctions
LoadSpreadsheet
Mappings
MD5
RC4
Border
CellAlignment
CellFont
FillPattern
Xls
XlsBase
AutoFilter
BaseParserClass
Chart
ColumnAndRowAttributes
ConditionalStyles
DataValidations
Hyperlinks
Namespaces
PageSetup
Properties
SharedFormula
SheetViewOptions
SheetViews
Styles
TableReader
Theme
WorkbookView
Xlsx
DataValidations
PageSettings
Properties
Alignment
Border
Fill
Font
NumberFormat
StyleBase
Style
Xml
Reader for SpreadsheetML, the XML schema for Microsoft Office Excel 2003.
ReferenceHelper
RichText
Run
TextElement
Settings
CodePage
Date
Drawing
SpContainer
SpgrContainer
DgContainer
Blip
BSE
BstoreContainer
DggContainer
Escher
File
Font
IntOrFloat
ChainedBlockStream
File
Class for creating File PPS's for OLE containers.
Root
Class for creating Root PPS's for OLE containers.
PPS
Class for creating PPS's for OLE containers.
OLE
OLE package base class.
OLERead
PasswordHasher
StringHelper
TimeZone
BestFit
ExponentialBestFit
LinearBestFit
LogarithmicBestFit
PolynomialBestFit
PowerBestFit
Trend
Xls
XMLWriter
Spreadsheet
Alignment
Border
Borders
Color
Conditional
CellMatcher
CellStyleAssessor
ConditionalColorScale
ConditionalDataBar
ConditionalDataBarExtension
ConditionalFormattingRuleExtension
ConditionalFormatValueObject
ConditionalIconSet
MergedCellStyle
StyleMerger
Blanks
CellValue
DateValue
Duplicates
Errors
Expression
TextValue
WizardAbstract
Wizard
Fill
Font
BaseFormatter
DateFormatter
Formatter
FractionFormatter
NumberFormatter
PercentageFormatter
Accounting
Currency
CurrencyBase
Date
DateTime
DateTimeWizard
Duration
Locale
Number
NumberBase
Percentage
Scientific
Time
NumberFormat
Protection
RgbTint
Class to handle tint applied to color.
Style
Supervisor
Theme
Rule
Column
AutoFilter
AutoFit
BaseDrawing
CellIterator
Column
ColumnCellIterator
ColumnDimension
ColumnIterator
Dimension
Shadow
Drawing
HeaderFooter
<code> Header/Footer Formatting Syntax taken from Office Open XML Part 4 - Markup Language Reference, page 1970:.
HeaderFooterDrawing
Iterator
MemoryDrawing
PageBreak
PageMargins
PageSetup
<code> Paper size taken from Office Open XML Part 4 - Markup Language Reference, page 1988:.
Pane
ProtectedRange
Protection
Row
RowCellIterator
RowDimension
RowIterator
SheetView
Column
TableDxfsStyle
TableStyle
Table
Validations
Worksheet
BaseWriter
Csv
Exception
Html
AutoFilters
Comment
Style
Content
Formula
Meta
MetaInf
Mimetype
NamedExpressions
Settings
Styles
Thumbnails
WriterPart
Ods
Dompdf
Mpdf
Tcpdf
TcpdfNoDie
Pdf
BIFFwriter
CellDataValidation
ConditionalHelper
ErrorCode
Escher
Font
Parser
CellAlignment
CellBorder
CellFill
Workbook
Worksheet
Xf
Xls
AutoFilter
Chart
Comments
ContentTypes
DefinedNames
DocProps
Drawing
FeaturePropertyBag
FunctionPrefix
Metadata
Rels
RelsRibbon
RelsVBA
RichDataDrawing
StringTable
Style
Table
Theme
Workbook
Worksheet
WriterPart
Xlsx
ZipStream0
ZipStream2
Either ZipStream2 or ZipStream3, but not both, may be used.
ZipStream3
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.
DelayedTargetValidation
FilterException
FilterFailedException
NoDiscard

Traits

Assertions
Tempfile
Util
FluentFactoryTrait
DecodeIfSupported
EncodeIfSupported
FpdiTrait
Strict
MpdfPsrLogAwareTrait
PsrLogAwareTrait
ArrayEnabled
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.

Enums

CompressionMethod
OperationMode
ZipStream execution operation modes
Version
Sort
Sort order can be used with $sort stage and sortBy properties
TimeUnit
Values for "unit" property of stages like $derivative and $integral, and operators like $dateAdd and $dateDiff
TextGridRightAlign
IconSetValues
CurrencyNegative

Constants

_OTL_OLD_SPEC_COMPAT_2  = true
_RECALC_PROFILE  = false
_RECALC_PROFILE  = false
_TTF_MAC_HEADER  = false
_TTF_MAC_HEADER  = false
K_TCPDF_EXTERNAL_CONFIG  = true
K_TCPDF_THROW_EXCEPTION_ERROR  = true

Functions

add_logger()  : void
Registers a PSR-3 logger to receive log messages from the driver/library.
remove_logger()  : void
Unregisters a PSR-3 logger.
object()  : stdClass
Create a new stdClass instance with the provided properties.
with_transaction()  : void
Execute a callback within a transaction in the given session
dd()  : mixed
str_starts_with()  : mixed
str_ends_with()  : mixed
unicode_hex()  : mixed
unicode_hex()  : mixed
deep_copy()  : mixed
Deep copies the given value.
get_error_handler()  : callable|null
get_exception_handler()  : callable|null
array_first()  : mixed
array_last()  : mixed
locale_is_right_to_left()  : bool
grapheme_levenshtein()  : mixed
grapheme_levenshtein()  : int|false

Constants

_OTL_OLD_SPEC_COMPAT_2

public mixed _OTL_OLD_SPEC_COMPAT_2 = true

_RECALC_PROFILE

public mixed _RECALC_PROFILE = false

_RECALC_PROFILE

public mixed _RECALC_PROFILE = false

_TTF_MAC_HEADER

public mixed _TTF_MAC_HEADER = false

_TTF_MAC_HEADER

public mixed _TTF_MAC_HEADER = false

K_TCPDF_EXTERNAL_CONFIG

public mixed K_TCPDF_EXTERNAL_CONFIG = true

K_TCPDF_THROW_EXCEPTION_ERROR

public mixed K_TCPDF_THROW_EXCEPTION_ERROR = true

Functions

add_logger()

Registers a PSR-3 logger to receive log messages from the driver/library.

add_logger(LoggerInterface $logger) : void

Calling this method again with a logger that has already been added will have no effect.

Parameters
$logger : LoggerInterface

remove_logger()

Unregisters a PSR-3 logger.

remove_logger(LoggerInterface $logger) : void

Calling this method with a logger that has not been added will have no effect.

Parameters
$logger : LoggerInterface

object()

Create a new stdClass instance with the provided properties.

object(mixed ...$values) : stdClass

Use named arguments to specify the property names. object( property1: value1, property2: value2 )

If property names contain a dot or a dollar characters, use array unpacking syntax. object( ...[ 'author.name' => 1, 'array.$' => 1 ] )

Parameters
$values : mixed
Tags
psalm-suppress

MoreSpecificReturnType

psalm-suppress

LessSpecificReturnStatement

Return values
stdClass

with_transaction()

Execute a callback within a transaction in the given session

with_transaction(Session $session, callable $callback[, array<string|int, mixed> $transactionOptions = [] ]) : void

This helper takes care of retrying the commit operation or the entire transaction if an error occurs.

If the commit fails because of an UnknownTransactionCommitResult error, the commit is retried without re-invoking the callback. If the commit fails because of a TransientTransactionError, the entire transaction will be retried. In this case, the callback will be invoked again. It is important that the logic inside the callback is idempotent.

In case of failures, the commit or transaction are retried until 120 seconds from the initial call have elapsed. After that, no retries will happen and the helper will throw the last exception received from the driver.

Parameters
$session : Session

A session object as retrieved by Client::startSession

$callback : callable

A callback that will be invoked within the transaction

$transactionOptions : array<string|int, mixed> = []

Additional options that are passed to Session::startTransaction

Tags
see
Client::startSession()
see
Session::startTransaction()

for supported transaction options

throws
RuntimeException

for driver errors while committing the transaction

throws
Exception

for any other errors, including those thrown in the callback

str_starts_with()

str_starts_with(mixed $haystack, mixed $needle) : mixed
Parameters
$haystack : mixed
$needle : mixed

str_ends_with()

str_ends_with(mixed $haystack, mixed $needle) : mixed
Parameters
$haystack : mixed
$needle : mixed

unicode_hex()

unicode_hex(mixed $unicode_dec) : mixed
Parameters
$unicode_dec : mixed

unicode_hex()

unicode_hex(mixed $unicode_dec) : mixed
Parameters
$unicode_dec : mixed

deep_copy()

Deep copies the given value.

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

get_error_handler()

get_error_handler() : callable|null
Return values
callable|null

get_exception_handler()

get_exception_handler() : callable|null
Return values
callable|null

array_first()

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

array_last()

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

locale_is_right_to_left()

locale_is_right_to_left(string $locale) : bool
Parameters
$locale : string
Return values
bool

grapheme_levenshtein()

grapheme_levenshtein(string $string1, string $string2[, int $insertion_cost = 1 ][, int $replacement_cost = 1 ][, int $deletion_cost = 1 ][, string $locale = '' ]) : mixed
Parameters
$string1 : string
$string2 : string
$insertion_cost : int = 1
$replacement_cost : int = 1
$deletion_cost : int = 1
$locale : string = ''

grapheme_levenshtein()

grapheme_levenshtein(string $string1, string $string2[, int $insertion_cost = 1 ][, int $replacement_cost = 1 ][, int $deletion_cost = 1 ][, string $locale = '' ]) : int|false
Parameters
$string1 : string
$string2 : string
$insertion_cost : int = 1
$replacement_cost : int = 1
$deletion_cost : int = 1
$locale : string = ''
Return values
int|false

        
On this page

Search results