Documentation

Foundry

Table of Contents

Interfaces

ClientInterface
Client interface for sending HTTP requests.
CookieJarInterface
Stores HTTP cookies.
GuzzleException
CurlFactoryInterface
PromiseInterface
A promise represents the eventual result of an asynchronous operation.
PromisorInterface
Interface used with classes that return a promise.
TaskQueueInterface
FilterInterface
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.

Classes

FCUtility
FCStringBase
FCJString
FCContentHelperRoute
FCArrayHelper
FCArchive
FCApplicationHelper
FoundryLibrary
Unlike the helper, FoundryLibrary needs to be aware of the current extension it is serving.
FH
Helpers does not need to be aware of the component.
StringHelper
Admin
AdminWidgets
Alert
Attachment
Avatar
Base
Button
Dialog
Dropdown
Email
Filter
Form
Giphy
Html
Icon
Label
Layout
Loader
Location
Overlay
Panel
Placeholder
Progress
Quote
Radio
Rank
Rating
Settings
Snackbar
Stats
Str
Table
Tabs
ActionLog
Ajax
AkismetObject
AkismetHttpClient
Akismet
Cleantalk
Cleantalk class create request
CleantalkAPI
CleantalkHelper
CleantalkRequest
Request class
CleantalkResponse
Response class
TransportException
CleanTalk
Colors
Author: Arlo Carreon <http://arlocarreon.com> Info: http://mexitek.github.io/phpColors/ License: http://arlo.mit-license.org/
Connector
Date
DateHelper
Exception
Exif
Data
Giphy
Image
Info
Pagination
QRbitstream
qrstr
QRrsblock
QRrawcode
QRcode
FrameFiller
QRencode
QRimage
QRinputItem
QRinput
QRmask
QRrsItem
QRrs
QRspec
QRsplit
Responsive
OembedAdapter
OembedAdapterApple
OembedAdapterDailyMotion
OembedAdapterFacebook
OembedAdapterGist
OembedAdapterGoogle
OembedAdapterMixCloud
OembedAdapterPastebin
OembedAdapterSoundCloud
OembedAdapterSpotify
OembedAdapterTikTok
OembedAdapterTwitch
OembedAdapterVimeo
OembedAdapterVk
OembedAdapterYoutube
ScraperPluginDescription
ScraperPluginImages
ScraperPluginKeywords
ScraperPluginOpengraph
ScraperPlugin
ScraperPluginTitle
Scraper
Scripts
SimpleHtml
StyleSheets
Textavatar
Themes
VideoParserBase
VideoParserDailyMotion
VideoParserFacebook
VideoParserNicoVideo
VideoParserSmule
VideoParserVimeo
VideoParserYoutube
VideoParser
Base
Mail
Sidebar
Table
ComposerAutoloaderInitf1092432418ab61d5f23aa67dd83cd6e
ComposerStaticInitf1092432418ab61d5f23aa67dd83cd6e
ClassLoader
ClassLoader implements a PSR-0, PSR-4 and classmap class loader.
Client
CookieJar
Cookie jar that stores cookies as an array
FileCookieJar
Persists non-session cookies using a JSON formatted file
SessionCookieJar
Persists cookies in the client session
SetCookie
Set-Cookie object
BadResponseException
Exception when an HTTP error occurs (4xx or 5xx error)
ClientException
Exception when a client error is encountered (4xx codes)
ConnectException
Exception thrown when a connection cannot be established.
InvalidArgumentException
RequestException
HTTP Request exception
SeekException
Exception thrown when a seek fails on a stream.
ServerException
Exception when a server error is encountered (5xx codes)
TooManyRedirectsException
HTTP Request exception
TransferException
CurlFactory
Creates curl resources from a request
CurlHandler
HTTP handler that uses cURL easy handles as a transport layer.
CurlMultiHandler
Returns an asynchronous response using curl_multi_* functions.
MockHandler
Handler that returns responses or throw exceptions from a queue.
Proxy
Provides basic proxies for handlers.
StreamHandler
HTTP handler that uses PHP's HTTP stream wrapper.
HandlerStack
Creates a composed Guzzle handler function by stacking middlewares on top of an HTTP handler function.
MessageFormatter
Formats log messages using variable substitutions for requests, responses, and other transactional data.
Middleware
Functions used to create and wrap handlers with handler middleware.
Pool
Sends an iterator of requests concurrently using a capped pool size.
PrepareBodyMiddleware
Prepares requests that contain a body, adding the Content-Length, Content-Type, and Expect headers.
RedirectMiddleware
Request redirect middleware.
RequestOptions
This class contains a list of built-in Guzzle request options.
RetryMiddleware
Middleware that retries requests based on the boolean result of invoking the provided "decider" function.
TransferStats
Represents data at the point after it was transferred either successfully or after a network error.
UriTemplate
Expands URI templates. Userland implementation of PECL uri_template.
Utils
AggregateException
Exception thrown when too many errors occur in the some() or any() methods.
CancellationException
Exception that is set as the reason for a promise that has been cancelled.
Coroutine
Creates a promise that is resolved using a generator that yields values or promises (somewhat similar to C#'s async keyword).
Create
Each
EachPromise
Represents a promise that iterates over many promises and invokes side-effect functions in the process.
FulfilledPromise
A promise that has been fulfilled.
Is
Promise
Promises/A+ implementation that avoids recursion when possible.
RejectedPromise
A promise that has been rejected.
RejectionException
A special exception that is thrown when waiting on a rejected promise.
TaskQueue
A task queue that executes tasks in a FIFO order.
Utils
AppendStream
Reads from multiple streams, one after the other.
BufferStream
Provides a buffer stream that can be written to to fill a buffer, and read from to remove bytes from the buffer.
AbstractColor
AbstractDecoder
AbstractDriver
AbstractEncoder
AbstractFont
AbstractShape
AbstractCommand
Argument
ChecksumCommand
CircleCommand
EllipseCommand
ExifCommand
IptcCommand
LineCommand
OrientateCommand
PolygonCommand
PsrResponseCommand
RectangleCommand
ResponseCommand
StreamCommand
TextCommand
Constraint
ImageException
InvalidArgumentException
MissingDependencyException
NotFoundException
NotReadableException
NotSupportedException
NotWritableException
RuntimeException
Image
File
DemoFilter
Color
BackupCommand
BlurCommand
BrightnessCommand
ColorizeCommand
ContrastCommand
CropCommand
DestroyCommand
FillCommand
FitCommand
FlipCommand
GammaCommand
GetSizeCommand
GreyscaleCommand
HeightenCommand
InsertCommand
InterlaceCommand
InvertCommand
LimitColorsCommand
MaskCommand
OpacityCommand
PickColorCommand
PixelateCommand
PixelCommand
ResetCommand
ResizeCanvasCommand
ResizeCommand
RotateCommand
SharpenCommand
TrimCommand
WidenCommand
Decoder
Driver
Encoder
Font
EllipseShape
LineShape
PolygonShape
RectangleShape
Image
ImageManager
ImageManagerStatic
ImageServiceProvider
ImageServiceProviderLaravel4
ImageServiceProviderLaravelRecent
ImageServiceProviderLeague
ImageServiceProviderLumen
Color
BackupCommand
BlurCommand
BrightnessCommand
ColorizeCommand
ContrastCommand
CropCommand
DestroyCommand
ExifCommand
FillCommand
FitCommand
FlipCommand
GammaCommand
GetSizeCommand
GreyscaleCommand
HeightenCommand
InsertCommand
InterlaceCommand
InvertCommand
LimitColorsCommand
MaskCommand
OpacityCommand
PickColorCommand
PixelateCommand
PixelCommand
ResetCommand
ResizeCanvasCommand
ResizeCommand
RotateCommand
SharpenCommand
TrimCommand
WidenCommand
Decoder
Driver
Encoder
Font
CircleShape
EllipseShape
LineShape
PolygonShape
RectangleShape
Point
Response
Size
Condition
ConditionNotAllowedException
FileNotFoundException
InvalidJsonException
InvalidNodeException
NullValueException
Jsonq
Jsonq
JsonqServiceProvider
ValueNotFound
This class represents a query result where a given value was queried but did not exist.
Normalizer
plgSystemFoundry
pkg_foundryInstallerScript

Traits

JsonQueriable

Constants

AKISMET_INVALID_KEY  = 2
AKISMET_RESPONSE_FAILED  = 1
AKISMET_SERVER_NOT_FOUND  = 0
08.11.2010 22:25:17est
DEFAULT_BR_TEXT  = "\r\n"
DEFAULT_SPAN_TEXT  = " "
DEFAULT_TARGET_CHARSET  = 'UTF-8'
FD_COMPILER  = 'http://compiler.stackideas.com'
FD_ERROR  = 'error'
FD_INFO  = 'info'
FD_JROUTER_MODE_SEF  = 1
FD_MEDIA  = \JPATH_ROOT . '/media/foundry'
FD_MODE  = 'production'
FD_ROOT  = \JPATH_LIBRARIES . '/foundry'
FD_SUCCESS  = 'success'
FD_THEMES  = \FD_ROOT . '/themes'
FD_THEMES_OVERRIDES  = \JPATH_ROOT . '/templates/stackideas/foundry'
FD_URI_CSS  = \FD_URI_MEDIA . '/css'
FD_URI_IMAGES  = \FD_URI_MEDIA . '/images'
FD_URI_MEDIA  = \rtrim(\JURI::root(), '/') . '/media/foundry'
FD_WARNING  = 'warning'
HDOM_INFO_BEGIN  = 0
HDOM_INFO_END  = 1
HDOM_INFO_ENDSPACE  = 7
HDOM_INFO_INNER  = 5
HDOM_INFO_OUTER  = 6
HDOM_INFO_QUOTE  = 2
HDOM_INFO_SPACE  = 3
HDOM_INFO_TEXT  = 4
HDOM_QUOTE_DOUBLE  = 0
HDOM_QUOTE_NO  = 3
HDOM_QUOTE_SINGLE  = 1
HDOM_TYPE_COMMENT  = 2
HDOM_TYPE_ELEMENT  = 1
All of the Defines for the classes below.
HDOM_TYPE_ENDTAG  = 4
HDOM_TYPE_ROOT  = 5
HDOM_TYPE_TEXT  = 3
HDOM_TYPE_UNKNOWN  = 6
IDNA_ALLOW_UNASSIGNED  = 1
IDNA_ALLOW_UNASSIGNED  = 1
IDNA_CHECK_BIDI  = 4
IDNA_CHECK_BIDI  = 4
IDNA_CHECK_CONTEXTJ  = 8
IDNA_CHECK_CONTEXTJ  = 8
IDNA_DEFAULT  = 0
IDNA_DEFAULT  = 0
IDNA_ERROR_BIDI  = 2048
IDNA_ERROR_BIDI  = 2048
IDNA_ERROR_CONTEXTJ  = 4096
IDNA_ERROR_CONTEXTJ  = 4096
IDNA_ERROR_DISALLOWED  = 128
IDNA_ERROR_DISALLOWED  = 128
IDNA_ERROR_DOMAIN_NAME_TOO_LONG  = 4
IDNA_ERROR_DOMAIN_NAME_TOO_LONG  = 4
IDNA_ERROR_EMPTY_LABEL  = 1
IDNA_ERROR_EMPTY_LABEL  = 1
IDNA_ERROR_HYPHEN_3_4  = 32
IDNA_ERROR_HYPHEN_3_4  = 32
IDNA_ERROR_INVALID_ACE_LABEL  = 1024
IDNA_ERROR_INVALID_ACE_LABEL  = 1024
IDNA_ERROR_LABEL_HAS_DOT  = 512
IDNA_ERROR_LABEL_HAS_DOT  = 512
IDNA_ERROR_LABEL_TOO_LONG  = 2
IDNA_ERROR_LABEL_TOO_LONG  = 2
IDNA_ERROR_LEADING_COMBINING_MARK  = 64
IDNA_ERROR_LEADING_COMBINING_MARK  = 64
IDNA_ERROR_LEADING_HYPHEN  = 8
IDNA_ERROR_LEADING_HYPHEN  = 8
IDNA_ERROR_PUNYCODE  = 256
IDNA_ERROR_PUNYCODE  = 256
IDNA_ERROR_TRAILING_HYPHEN  = 16
IDNA_ERROR_TRAILING_HYPHEN  = 16
IDNA_NONTRANSITIONAL_TO_ASCII  = 16
IDNA_NONTRANSITIONAL_TO_ASCII  = 16
IDNA_NONTRANSITIONAL_TO_UNICODE  = 32
IDNA_NONTRANSITIONAL_TO_UNICODE  = 32
IDNA_USE_STD3_RULES  = 2
IDNA_USE_STD3_RULES  = 2
INTL_IDNA_VARIANT_2003  = 0
INTL_IDNA_VARIANT_UTS46  = 1
INTL_IDNA_VARIANT_UTS46  = 1
MAX_FILE_SIZE  = 6000000
MAX_STRUCTURED_SYMBOLS  = 16
N1  = 3
N2  = 3
N3  = 40
N4  = 10
PHP_FLOAT_DIG  = 15
PHP_FLOAT_EPSILON  = 2.2204460492503E-16
PHP_FLOAT_MAX  = 1.7976931348623157E+308
PHP_FLOAT_MIN  = 2.2250738585072E-308
PHP_OS_FAMILY  = \Symfony\Polyfill\Php72\Php72::php_os_family()
QR_CACHE_DIR  = \dirname(__FILE__) . \DIRECTORY_SEPARATOR . 'cache' . \DIRECTORY_SEPARATOR
QR_CACHEABLE  = \false
QR_DEFAULT_MASK  = 2
QR_ECLEVEL_H  = 3
QR_ECLEVEL_L  = 0
QR_ECLEVEL_M  = 1
QR_ECLEVEL_Q  = 2
QR_FIND_BEST_MASK  = \true
QR_FIND_FROM_RANDOM  = \false
QR_FORMAT_PNG  = 1
QR_FORMAT_TEXT  = 0
QR_IMAGE  = \true
QR_LOG_DIR  = \dirname(__FILE__) . \DIRECTORY_SEPARATOR
QR_MODE_8  = 2
QR_MODE_AN  = 1
QR_MODE_KANJI  = 3
QR_MODE_NUL  = -1
QR_MODE_NUM  = 0
QR_MODE_STRUCTURE  = 4
QR_PNG_MAXIMUM_SIZE  = 128
QRCAP_EC  = 3
QRCAP_REMINDER  = 2
QRCAP_WIDTH  = 0
QRCAP_WORDS  = 1
QRSPEC_VERSION_MAX  = 40
QRSPEC_WIDTH_MAX  = 177
STRUCTURE_HEADER_BITS  = 20
U_IDNA_ACE_PREFIX_ERROR  = 66564
U_IDNA_ACE_PREFIX_ERROR  = 66564
U_IDNA_CHECK_BIDI_ERROR  = 66562
U_IDNA_CHECK_BIDI_ERROR  = 66562
U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR  = 66568
U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR  = 66568
U_IDNA_ERROR_LIMIT  = 66569
U_IDNA_ERROR_LIMIT  = 66569
U_IDNA_ERROR_START  = 66560
U_IDNA_ERROR_START  = 66560
U_IDNA_LABEL_TOO_LONG_ERROR  = 66566
U_IDNA_LABEL_TOO_LONG_ERROR  = 66566
U_IDNA_PROHIBITED_ERROR  = 66560
U_IDNA_PROHIBITED_ERROR  = 66560
U_IDNA_STD3_ASCII_RULES_ERROR  = 66563
U_IDNA_STD3_ASCII_RULES_ERROR  = 66563
U_IDNA_UNASSIGNED_ERROR  = 66561
U_IDNA_UNASSIGNED_ERROR  = 66561
U_IDNA_VERIFICATION_ERROR  = 66565
U_IDNA_VERIFICATION_ERROR  = 66565
U_IDNA_ZERO_LENGTH_LABEL_ERROR  = 66567
U_IDNA_ZERO_LENGTH_LABEL_ERROR  = 66567
U_STRINGPREP_CHECK_BIDI_ERROR  = 66562
U_STRINGPREP_CHECK_BIDI_ERROR  = 66562
U_STRINGPREP_PROHIBITED_ERROR  = 66560
U_STRINGPREP_PROHIBITED_ERROR  = 66560
U_STRINGPREP_UNASSIGNED_ERROR  = 66561
U_STRINGPREP_UNASSIGNED_ERROR  = 66561

Functions

dump()  : mixed
vd()  : mixed
pdump()  : mixed
apache_request_headers()  : mixed
locale_get_display_region()  : mixed
utf8_decode()  : mixed
composerRequiref1092432418ab61d5f23aa67dd83cd6e()  : mixed
includeFile()  : mixed
Scope isolated include.
uri_template()  : string
Expands a URI template
describe_type()  : string
Debug function used to describe the provided value type and class.
headers_from_lines()  : array<string|int, mixed>
Parses an array of header lines into an associative array of headers.
debug_resource()  : resource
Returns a debug stream based on the provided variable.
choose_handler()  : callable
Chooses and creates a default handler to use based on the environment.
default_user_agent()  : string
Get the default User-Agent string to use with Guzzle
default_ca_bundle()  : string
Returns the default cacert bundle for the current system.
normalize_header_keys()  : array<string|int, mixed>
Creates an associative array of lowercase header names to the actual header casing.
is_host_in_noproxy()  : bool
Returns true if the provided host matches any of the no proxy areas.
json_decode()  : mixed
Wrapper for json_decode that throws when an error occurs.
json_encode()  : string
Wrapper for JSON encoding that throws when an error occurs.
queue()  : TaskQueueInterface
Get the global task queue used for promise resolution.
task()  : PromiseInterface
Adds a function to run in the task queue when it is next `run()` and returns a promise that is fulfilled or rejected with the result.
promise_for()  : PromiseInterface
Creates a promise for a value if the value is not a promise.
rejection_for()  : PromiseInterface
Creates a rejected promise for a reason if the reason is not a promise. If the provided reason is a promise, then it is returned as-is.
exception_for()  : Exception|Throwable
Create an exception for a rejected promise value.
iter_for()  : Iterator
Returns an iterator for the given value.
inspect()  : array<string|int, mixed>
Synchronously waits on a promise to resolve and returns an inspection state array.
inspect_all()  : array<string|int, mixed>
Waits on all of the provided promises, but does not unwrap rejected promises as thrown exception.
unwrap()  : array<string|int, mixed>
Waits on all of the provided promises and returns the fulfilled values.
all()  : PromiseInterface
Given an array of promises, return a promise that is fulfilled when all the items in the array are fulfilled.
some()  : PromiseInterface
Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises).
any()  : PromiseInterface
Like some(), with 1 as count. However, if the promise fulfills, the fulfillment value is not an array of 1 but the value directly.
settle()  : PromiseInterface
Returns a promise that is fulfilled when all of the provided promises have been fulfilled or rejected.
each()  : PromiseInterface
Given an iterator that yields promises or values, returns a promise that is fulfilled with a null value when the iterator has been consumed or the aggregate promise has been fulfilled or rejected.
each_limit()  : PromiseInterface
Like each, but only allows a certain number of outstanding promises at any given time.
each_limit_all()  : PromiseInterface
Like each_limit, but ensures that no promise in the given $iterable argument is rejected. If any promise is rejected, then the aggregate promise is rejected with the encountered rejection.
is_fulfilled()  : bool
Returns true if a promise is fulfilled.
is_rejected()  : bool
Returns true if a promise is rejected.
is_settled()  : bool
Returns true if a promise is fulfilled or rejected.
coroutine()  : PromiseInterface
Create a new coroutine.
str()  : string
Returns the string representation of an HTTP message.
uri_for()  : UriInterface
Returns a UriInterface for the given value.
stream_for()  : StreamInterface
Create a new stream based on the input type.
parse_header()  : array<string|int, mixed>
Parse an array of header values containing ";" separated data into an array of associative arrays representing the header key value pair data of the header. When a parameter does not contain a value, but just contains a key, this function will inject a key with a '' string value.
normalize_header()  : array<string|int, mixed>
Converts an array of header values that may contain comma separated headers into an array of headers with no comma separated values.
modify_request()  : RequestInterface
Clone and modify a request with the given changes.
rewind_body()  : mixed
Attempts to rewind a message body and throws an exception on failure.
try_fopen()  : resource
Safely opens a PHP stream resource using a filename.
copy_to_string()  : string
Copy the contents of a stream into a string until the given number of bytes have been read.
copy_to_stream()  : mixed
Copy the contents of a stream into another stream until the given number of bytes have been read.
hash()  : string
Calculate a hash of a stream.
readline()  : string
Read a line from the stream up to the maximum allowed buffer length.
parse_request()  : Request
Parses a request message string into a request object.
parse_response()  : Response
Parses a response message string into a response object.
parse_query()  : array<string|int, mixed>
Parse a query string into an associative array.
build_query()  : string
Build a query string from an array of key value pairs.
mimetype_from_filename()  : string|null
Determines the mimetype of a file by looking at its extension.
mimetype_from_extension()  : string|null
Maps a file extensions to a mimetype.
get_message_body_summary()  : string|null
Get a short summary of the message body.
getallheaders()  : mixed
Get all HTTP header key/values as an associative array for the current request.
idn_to_ascii()  : mixed
idn_to_utf8()  : mixed
idn_to_ascii()  : string|false
idn_to_utf8()  : string|false
normalizer_is_normalized()  : mixed
normalizer_normalize()  : mixed
normalizer_is_normalized()  : bool
normalizer_normalize()  : string|false
sapi_windows_vt100_support()  : mixed
stream_isatty()  : mixed
utf8_encode()  : mixed
utf8_decode()  : mixed
spl_object_id()  : mixed
mb_ord()  : mixed
mb_chr()  : mixed
mb_scrub()  : mixed

Constants

AKISMET_INVALID_KEY

public mixed AKISMET_INVALID_KEY = 2

AKISMET_RESPONSE_FAILED

public mixed AKISMET_RESPONSE_FAILED = 1

AKISMET_SERVER_NOT_FOUND

08.11.2010 22:25:17est

public mixed AKISMET_SERVER_NOT_FOUND = 0

Akismet PHP4 class

Usage $comment = array( 'author' => 'viagra-test-123', 'email' => 'test@example.com', 'website' => 'http://www.example.com/', 'body' => 'This is a test comment', 'permalink' => 'http://yourdomain.com/yourblogpost.url', );

$akismet = new Akismet('http://www.yourdomain.com/', 'YOUR_WORDPRESS_API_KEY', $comment);

if($akismet->errorsExist()) { echo"Couldn't connected to Akismet server!"; } else { if($akismet->isSpam()) { echo"Spam detected"; } else { echo"yay, no spam!"; } }

Tags
author

Bret Kuhns {@link www.bretkuhns.com}

link
http://code.google.com/p/akismet-php4
version
0.3.5
license

http://www.opensource.org/licenses/mit-license.php MIT License

DEFAULT_BR_TEXT

public mixed DEFAULT_BR_TEXT = "\r\n"

DEFAULT_SPAN_TEXT

public mixed DEFAULT_SPAN_TEXT = " "

DEFAULT_TARGET_CHARSET

public mixed DEFAULT_TARGET_CHARSET = 'UTF-8'

FD_COMPILER

public mixed FD_COMPILER = 'http://compiler.stackideas.com'

FD_JROUTER_MODE_SEF

public mixed FD_JROUTER_MODE_SEF = 1

FD_MEDIA

public mixed FD_MEDIA = \JPATH_ROOT . '/media/foundry'

FD_ROOT

public mixed FD_ROOT = \JPATH_LIBRARIES . '/foundry'

FD_SUCCESS

public mixed FD_SUCCESS = 'success'

FD_THEMES

public mixed FD_THEMES = \FD_ROOT . '/themes'

FD_THEMES_OVERRIDES

public mixed FD_THEMES_OVERRIDES = \JPATH_ROOT . '/templates/stackideas/foundry'

FD_URI_CSS

public mixed FD_URI_CSS = \FD_URI_MEDIA . '/css'

FD_URI_IMAGES

public mixed FD_URI_IMAGES = \FD_URI_MEDIA . '/images'

FD_URI_MEDIA

public mixed FD_URI_MEDIA = \rtrim(\JURI::root(), '/') . '/media/foundry'

FD_WARNING

public mixed FD_WARNING = 'warning'

HDOM_INFO_BEGIN

public mixed HDOM_INFO_BEGIN = 0

HDOM_INFO_ENDSPACE

public mixed HDOM_INFO_ENDSPACE = 7

HDOM_INFO_INNER

public mixed HDOM_INFO_INNER = 5

HDOM_INFO_OUTER

public mixed HDOM_INFO_OUTER = 6

HDOM_INFO_QUOTE

public mixed HDOM_INFO_QUOTE = 2

HDOM_INFO_SPACE

public mixed HDOM_INFO_SPACE = 3

HDOM_QUOTE_DOUBLE

public mixed HDOM_QUOTE_DOUBLE = 0

HDOM_QUOTE_SINGLE

public mixed HDOM_QUOTE_SINGLE = 1

HDOM_TYPE_COMMENT

public mixed HDOM_TYPE_COMMENT = 2

HDOM_TYPE_ENDTAG

public mixed HDOM_TYPE_ENDTAG = 4

HDOM_TYPE_UNKNOWN

public mixed HDOM_TYPE_UNKNOWN = 6

IDNA_ALLOW_UNASSIGNED

public mixed IDNA_ALLOW_UNASSIGNED = 1

IDNA_ALLOW_UNASSIGNED

public mixed IDNA_ALLOW_UNASSIGNED = 1

IDNA_CHECK_BIDI

public mixed IDNA_CHECK_BIDI = 4

IDNA_CHECK_CONTEXTJ

public mixed IDNA_CHECK_CONTEXTJ = 8

IDNA_CHECK_CONTEXTJ

public mixed IDNA_CHECK_CONTEXTJ = 8

IDNA_ERROR_BIDI

public mixed IDNA_ERROR_BIDI = 2048

IDNA_ERROR_BIDI

public mixed IDNA_ERROR_BIDI = 2048

IDNA_ERROR_CONTEXTJ

public mixed IDNA_ERROR_CONTEXTJ = 4096

IDNA_ERROR_CONTEXTJ

public mixed IDNA_ERROR_CONTEXTJ = 4096

IDNA_ERROR_DISALLOWED

public mixed IDNA_ERROR_DISALLOWED = 128

IDNA_ERROR_DISALLOWED

public mixed IDNA_ERROR_DISALLOWED = 128

IDNA_ERROR_DOMAIN_NAME_TOO_LONG

public mixed IDNA_ERROR_DOMAIN_NAME_TOO_LONG = 4

IDNA_ERROR_DOMAIN_NAME_TOO_LONG

public mixed IDNA_ERROR_DOMAIN_NAME_TOO_LONG = 4

IDNA_ERROR_EMPTY_LABEL

public mixed IDNA_ERROR_EMPTY_LABEL = 1

IDNA_ERROR_EMPTY_LABEL

public mixed IDNA_ERROR_EMPTY_LABEL = 1

IDNA_ERROR_HYPHEN_3_4

public mixed IDNA_ERROR_HYPHEN_3_4 = 32

IDNA_ERROR_HYPHEN_3_4

public mixed IDNA_ERROR_HYPHEN_3_4 = 32

IDNA_ERROR_INVALID_ACE_LABEL

public mixed IDNA_ERROR_INVALID_ACE_LABEL = 1024

IDNA_ERROR_INVALID_ACE_LABEL

public mixed IDNA_ERROR_INVALID_ACE_LABEL = 1024

IDNA_ERROR_LABEL_HAS_DOT

public mixed IDNA_ERROR_LABEL_HAS_DOT = 512

IDNA_ERROR_LABEL_HAS_DOT

public mixed IDNA_ERROR_LABEL_HAS_DOT = 512

IDNA_ERROR_LABEL_TOO_LONG

public mixed IDNA_ERROR_LABEL_TOO_LONG = 2

IDNA_ERROR_LABEL_TOO_LONG

public mixed IDNA_ERROR_LABEL_TOO_LONG = 2

IDNA_ERROR_LEADING_COMBINING_MARK

public mixed IDNA_ERROR_LEADING_COMBINING_MARK = 64

IDNA_ERROR_LEADING_COMBINING_MARK

public mixed IDNA_ERROR_LEADING_COMBINING_MARK = 64

IDNA_ERROR_LEADING_HYPHEN

public mixed IDNA_ERROR_LEADING_HYPHEN = 8

IDNA_ERROR_LEADING_HYPHEN

public mixed IDNA_ERROR_LEADING_HYPHEN = 8

IDNA_ERROR_PUNYCODE

public mixed IDNA_ERROR_PUNYCODE = 256

IDNA_ERROR_PUNYCODE

public mixed IDNA_ERROR_PUNYCODE = 256

IDNA_ERROR_TRAILING_HYPHEN

public mixed IDNA_ERROR_TRAILING_HYPHEN = 16

IDNA_ERROR_TRAILING_HYPHEN

public mixed IDNA_ERROR_TRAILING_HYPHEN = 16

IDNA_NONTRANSITIONAL_TO_ASCII

public mixed IDNA_NONTRANSITIONAL_TO_ASCII = 16

IDNA_NONTRANSITIONAL_TO_ASCII

public mixed IDNA_NONTRANSITIONAL_TO_ASCII = 16

IDNA_NONTRANSITIONAL_TO_UNICODE

public mixed IDNA_NONTRANSITIONAL_TO_UNICODE = 32

IDNA_NONTRANSITIONAL_TO_UNICODE

public mixed IDNA_NONTRANSITIONAL_TO_UNICODE = 32

IDNA_USE_STD3_RULES

public mixed IDNA_USE_STD3_RULES = 2

IDNA_USE_STD3_RULES

public mixed IDNA_USE_STD3_RULES = 2

INTL_IDNA_VARIANT_2003

public mixed INTL_IDNA_VARIANT_2003 = 0

INTL_IDNA_VARIANT_UTS46

public mixed INTL_IDNA_VARIANT_UTS46 = 1

INTL_IDNA_VARIANT_UTS46

public mixed INTL_IDNA_VARIANT_UTS46 = 1

MAX_FILE_SIZE

public mixed MAX_FILE_SIZE = 6000000

MAX_STRUCTURED_SYMBOLS

public mixed MAX_STRUCTURED_SYMBOLS = 16

PHP_FLOAT_DIG

public mixed PHP_FLOAT_DIG = 15

PHP_FLOAT_EPSILON

public mixed PHP_FLOAT_EPSILON = 2.2204460492503E-16

PHP_FLOAT_MAX

public mixed PHP_FLOAT_MAX = 1.7976931348623157E+308

PHP_FLOAT_MIN

public mixed PHP_FLOAT_MIN = 2.2250738585072E-308

PHP_OS_FAMILY

public mixed PHP_OS_FAMILY = \Symfony\Polyfill\Php72\Php72::php_os_family()

QR_CACHE_DIR

public mixed QR_CACHE_DIR = \dirname(__FILE__) . \DIRECTORY_SEPARATOR . 'cache' . \DIRECTORY_SEPARATOR

QR_CACHEABLE

public mixed QR_CACHEABLE = \false

QR_DEFAULT_MASK

public mixed QR_DEFAULT_MASK = 2

QR_ECLEVEL_H

public mixed QR_ECLEVEL_H = 3

QR_ECLEVEL_L

public mixed QR_ECLEVEL_L = 0

QR_ECLEVEL_M

public mixed QR_ECLEVEL_M = 1

QR_ECLEVEL_Q

public mixed QR_ECLEVEL_Q = 2

QR_FIND_BEST_MASK

public mixed QR_FIND_BEST_MASK = \true

QR_FIND_FROM_RANDOM

public mixed QR_FIND_FROM_RANDOM = \false

QR_FORMAT_PNG

public mixed QR_FORMAT_PNG = 1

QR_FORMAT_TEXT

public mixed QR_FORMAT_TEXT = 0

QR_IMAGE

public mixed QR_IMAGE = \true

QR_LOG_DIR

public mixed QR_LOG_DIR = \dirname(__FILE__) . \DIRECTORY_SEPARATOR

QR_MODE_8

public mixed QR_MODE_8 = 2

QR_MODE_AN

public mixed QR_MODE_AN = 1

QR_MODE_KANJI

public mixed QR_MODE_KANJI = 3

QR_MODE_NUL

public mixed QR_MODE_NUL = -1

QR_MODE_NUM

public mixed QR_MODE_NUM = 0

QR_MODE_STRUCTURE

public mixed QR_MODE_STRUCTURE = 4

QR_PNG_MAXIMUM_SIZE

public mixed QR_PNG_MAXIMUM_SIZE = 128

QRCAP_EC

public mixed QRCAP_EC = 3

QRCAP_REMINDER

public mixed QRCAP_REMINDER = 2

QRCAP_WIDTH

public mixed QRCAP_WIDTH = 0

QRCAP_WORDS

public mixed QRCAP_WORDS = 1

QRSPEC_VERSION_MAX

public mixed QRSPEC_VERSION_MAX = 40

QRSPEC_WIDTH_MAX

public mixed QRSPEC_WIDTH_MAX = 177

STRUCTURE_HEADER_BITS

public mixed STRUCTURE_HEADER_BITS = 20

U_IDNA_ACE_PREFIX_ERROR

public mixed U_IDNA_ACE_PREFIX_ERROR = 66564

U_IDNA_ACE_PREFIX_ERROR

public mixed U_IDNA_ACE_PREFIX_ERROR = 66564

U_IDNA_CHECK_BIDI_ERROR

public mixed U_IDNA_CHECK_BIDI_ERROR = 66562

U_IDNA_CHECK_BIDI_ERROR

public mixed U_IDNA_CHECK_BIDI_ERROR = 66562

U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR

public mixed U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR = 66568

U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR

public mixed U_IDNA_DOMAIN_NAME_TOO_LONG_ERROR = 66568

U_IDNA_ERROR_LIMIT

public mixed U_IDNA_ERROR_LIMIT = 66569

U_IDNA_ERROR_LIMIT

public mixed U_IDNA_ERROR_LIMIT = 66569

U_IDNA_ERROR_START

public mixed U_IDNA_ERROR_START = 66560

U_IDNA_ERROR_START

public mixed U_IDNA_ERROR_START = 66560

U_IDNA_LABEL_TOO_LONG_ERROR

public mixed U_IDNA_LABEL_TOO_LONG_ERROR = 66566

U_IDNA_LABEL_TOO_LONG_ERROR

public mixed U_IDNA_LABEL_TOO_LONG_ERROR = 66566

U_IDNA_PROHIBITED_ERROR

public mixed U_IDNA_PROHIBITED_ERROR = 66560

U_IDNA_PROHIBITED_ERROR

public mixed U_IDNA_PROHIBITED_ERROR = 66560

U_IDNA_STD3_ASCII_RULES_ERROR

public mixed U_IDNA_STD3_ASCII_RULES_ERROR = 66563

U_IDNA_STD3_ASCII_RULES_ERROR

public mixed U_IDNA_STD3_ASCII_RULES_ERROR = 66563

U_IDNA_UNASSIGNED_ERROR

public mixed U_IDNA_UNASSIGNED_ERROR = 66561

U_IDNA_UNASSIGNED_ERROR

public mixed U_IDNA_UNASSIGNED_ERROR = 66561

U_IDNA_VERIFICATION_ERROR

public mixed U_IDNA_VERIFICATION_ERROR = 66565

U_IDNA_VERIFICATION_ERROR

public mixed U_IDNA_VERIFICATION_ERROR = 66565

U_IDNA_ZERO_LENGTH_LABEL_ERROR

public mixed U_IDNA_ZERO_LENGTH_LABEL_ERROR = 66567

U_IDNA_ZERO_LENGTH_LABEL_ERROR

public mixed U_IDNA_ZERO_LENGTH_LABEL_ERROR = 66567

U_STRINGPREP_CHECK_BIDI_ERROR

public mixed U_STRINGPREP_CHECK_BIDI_ERROR = 66562

U_STRINGPREP_CHECK_BIDI_ERROR

public mixed U_STRINGPREP_CHECK_BIDI_ERROR = 66562

U_STRINGPREP_PROHIBITED_ERROR

public mixed U_STRINGPREP_PROHIBITED_ERROR = 66560

U_STRINGPREP_PROHIBITED_ERROR

public mixed U_STRINGPREP_PROHIBITED_ERROR = 66560

U_STRINGPREP_UNASSIGNED_ERROR

public mixed U_STRINGPREP_UNASSIGNED_ERROR = 66561

U_STRINGPREP_UNASSIGNED_ERROR

public mixed U_STRINGPREP_UNASSIGNED_ERROR = 66561

Functions

locale_get_display_region()

locale_get_display_region(mixed $locale[, mixed $in_locale = 'EN' ]) : mixed
Parameters
$locale : mixed
$in_locale : mixed = 'EN'

composerRequiref1092432418ab61d5f23aa67dd83cd6e()

composerRequiref1092432418ab61d5f23aa67dd83cd6e(mixed $fileIdentifier, mixed $file) : mixed
Parameters
$fileIdentifier : mixed
$file : mixed

includeFile()

Scope isolated include.

includeFile(mixed $file) : mixed

Prevents access to $this/self from included files.

Parameters
$file : mixed

uri_template()

Expands a URI template

uri_template(string $template, array<string|int, mixed> $variables) : string
Parameters
$template : string

URI template

$variables : array<string|int, mixed>

Template variables

Return values
string

describe_type()

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

describe_type(mixed $input) : string
Parameters
$input : mixed
Return values
string —

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

headers_from_lines()

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

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

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

Return values
array<string|int, mixed>

debug_resource()

Returns a debug stream based on the provided variable.

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

Optional value

Return values
resource

choose_handler()

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

choose_handler() : callable

The returned handler is not wrapped by any default middlewares.

Tags
throws
RuntimeException

if no viable Handler is available.

Return values
callable —

Returns the best handler for the given system.

default_user_agent()

Get the default User-Agent string to use with Guzzle

default_user_agent() : string
Return values
string

default_ca_bundle()

Returns the default cacert bundle for the current system.

default_ca_bundle() : string

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

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

Tags
throws
RuntimeException

if no bundle can be found.

Return values
string

normalize_header_keys()

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

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

is_host_in_noproxy()

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

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

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

Areas are matched in the following cases:

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

Host to check against the patterns.

$noProxyArray : array<string|int, mixed>

An array of host patterns.

Return values
bool

json_decode()

Wrapper for json_decode that throws when an error occurs.

json_decode(string $json[, bool $assoc = false ][, int $depth = 512 ][, int $options = 0 ]) : mixed
Parameters
$json : string

JSON data to parse

$assoc : bool = false

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

$depth : int = 512

User specified recursion depth.

$options : int = 0

Bitmask of JSON decode options.

Tags
throws
InvalidArgumentException

if the JSON cannot be decoded.

link
http://www.php.net/manual/en/function.json-decode.php

json_encode()

Wrapper for JSON encoding that throws when an error occurs.

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

The value being encoded

$options : int = 0

JSON encode option bitmask

$depth : int = 512

Set the maximum depth. Must be greater than zero.

Tags
throws
InvalidArgumentException

if the JSON cannot be encoded.

link
http://www.php.net/manual/en/function.json-encode.php
Return values
string

queue()

Get the global task queue used for promise resolution.

queue will be removed in guzzlehttp/promises:2.0. Use Utils::queue instead.

queue([TaskQueueInterface $assign = null ]) : TaskQueueInterface

This task queue MUST be run in an event loop in order for promises to be settled asynchronously. It will be automatically run when synchronously waiting on a promise.

while ($eventLoop->isRunning()) { GuzzleHttp\Promise\queue()->run(); }
Parameters
$assign : TaskQueueInterface = null

Optionally specify a new queue instance.

Return values
TaskQueueInterface

task()

Adds a function to run in the task queue when it is next `run()` and returns a promise that is fulfilled or rejected with the result.

task will be removed in guzzlehttp/promises:2.0. Use Utils::task instead.

task(callable $task) : PromiseInterface
Parameters
$task : callable

Task function to run.

Return values
PromiseInterface

promise_for()

Creates a promise for a value if the value is not a promise.

promise_for will be removed in guzzlehttp/promises:2.0. Use Create::promiseFor instead.

promise_for(mixed $value) : PromiseInterface
Parameters
$value : mixed

Promise or value.

Return values
PromiseInterface

rejection_for()

Creates a rejected promise for a reason if the reason is not a promise. If the provided reason is a promise, then it is returned as-is.

rejection_for will be removed in guzzlehttp/promises:2.0. Use Create::rejectionFor instead.

rejection_for(mixed $reason) : PromiseInterface
Parameters
$reason : mixed

Promise or reason.

Return values
PromiseInterface

exception_for()

Create an exception for a rejected promise value.

exception_for will be removed in guzzlehttp/promises:2.0. Use Create::exceptionFor instead.

exception_for(mixed $reason) : Exception|Throwable
Parameters
$reason : mixed
Return values
Exception|Throwable

iter_for()

Returns an iterator for the given value.

iter_for will be removed in guzzlehttp/promises:2.0. Use Create::iterFor instead.

iter_for(mixed $value) : Iterator
Parameters
$value : mixed
Return values
Iterator

inspect()

Synchronously waits on a promise to resolve and returns an inspection state array.

inspect will be removed in guzzlehttp/promises:2.0. Use Utils::inspect instead.

inspect(PromiseInterface $promise) : array<string|int, mixed>

Returns a state associative array containing a "state" key mapping to a valid promise state. If the state of the promise is "fulfilled", the array will contain a "value" key mapping to the fulfilled value of the promise. If the promise is rejected, the array will contain a "reason" key mapping to the rejection reason of the promise.

Parameters
$promise : PromiseInterface

Promise or value.

Return values
array<string|int, mixed>

inspect_all()

Waits on all of the provided promises, but does not unwrap rejected promises as thrown exception.

inspect will be removed in guzzlehttp/promises:2.0. Use Utils::inspectAll instead.

inspect_all(array<string|int, PromiseInterface> $promises) : array<string|int, mixed>

Returns an array of inspection state arrays.

Parameters
$promises : array<string|int, PromiseInterface>

Traversable of promises to wait upon.

Tags
see
inspect

for the inspection state array format.

Return values
array<string|int, mixed>

unwrap()

Waits on all of the provided promises and returns the fulfilled values.

unwrap will be removed in guzzlehttp/promises:2.0. Use Utils::unwrap instead.

unwrap(iterable<string|int, PromiseInterface> $promises) : array<string|int, mixed>

Returns an array that contains the value of each promise (in the same order the promises were provided). An exception is thrown if any of the promises are rejected.

Parameters
$promises : iterable<string|int, PromiseInterface>

Iterable of PromiseInterface objects to wait on.

Tags
throws
Exception

on error

throws
Throwable

on error in PHP >=7

Return values
array<string|int, mixed>

all()

Given an array of promises, return a promise that is fulfilled when all the items in the array are fulfilled.

all will be removed in guzzlehttp/promises:2.0. Use Utils::all instead.

all(mixed $promises[, bool $recursive = false ]) : PromiseInterface

The promise's fulfillment value is an array with fulfillment values at respective positions to the original array. If any promise in the array rejects, the returned promise is rejected with the rejection reason.

Parameters
$promises : mixed

Promises or values.

$recursive : bool = false

If true, resolves new promises that might have been added to the stack during its own resolution.

Return values
PromiseInterface

some()

Initiate a competitive race between multiple promises or values (values will become immediately fulfilled promises).

some will be removed in guzzlehttp/promises:2.0. Use Utils::some instead.

some(int $count, mixed $promises) : PromiseInterface

When count amount of promises have been fulfilled, the returned promise is fulfilled with an array that contains the fulfillment values of the winners in order of resolution.

This promise is rejected with a AggregateException if the number of fulfilled promises is less than the desired $count.

Parameters
$count : int

Total number of promises.

$promises : mixed

Promises or values.

Return values
PromiseInterface

any()

Like some(), with 1 as count. However, if the promise fulfills, the fulfillment value is not an array of 1 but the value directly.

any will be removed in guzzlehttp/promises:2.0. Use Utils::any instead.

any(mixed $promises) : PromiseInterface
Parameters
$promises : mixed

Promises or values.

Return values
PromiseInterface

settle()

Returns a promise that is fulfilled when all of the provided promises have been fulfilled or rejected.

settle will be removed in guzzlehttp/promises:2.0. Use Utils::settle instead.

settle(mixed $promises) : PromiseInterface

The returned promise is fulfilled with an array of inspection state arrays.

Parameters
$promises : mixed

Promises or values.

Tags
see
inspect

for the inspection state array format.

Return values
PromiseInterface

each()

Given an iterator that yields promises or values, returns a promise that is fulfilled with a null value when the iterator has been consumed or the aggregate promise has been fulfilled or rejected.

each will be removed in guzzlehttp/promises:2.0. Use Each::of instead.

each(mixed $iterable[, callable $onFulfilled = null ][, callable $onRejected = null ]) : PromiseInterface

$onFulfilled is a function that accepts the fulfilled value, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate if needed.

$onRejected is a function that accepts the rejection reason, iterator index, and the aggregate promise. The callback can invoke any necessary side effects and choose to resolve or reject the aggregate if needed.

Parameters
$iterable : mixed

Iterator or array to iterate over.

$onFulfilled : callable = null
$onRejected : callable = null
Return values
PromiseInterface

each_limit()

Like each, but only allows a certain number of outstanding promises at any given time.

each_limit will be removed in guzzlehttp/promises:2.0. Use Each::ofLimit instead.

each_limit(mixed $iterable, int|callable $concurrency[, callable $onFulfilled = null ][, callable $onRejected = null ]) : PromiseInterface

$concurrency may be an integer or a function that accepts the number of pending promises and returns a numeric concurrency limit value to allow for dynamic a concurrency size.

Parameters
$iterable : mixed
$concurrency : int|callable
$onFulfilled : callable = null
$onRejected : callable = null
Return values
PromiseInterface

each_limit_all()

Like each_limit, but ensures that no promise in the given $iterable argument is rejected. If any promise is rejected, then the aggregate promise is rejected with the encountered rejection.

each_limit_all will be removed in guzzlehttp/promises:2.0. Use Each::ofLimitAll instead.

each_limit_all(mixed $iterable, int|callable $concurrency[, callable $onFulfilled = null ]) : PromiseInterface
Parameters
$iterable : mixed
$concurrency : int|callable
$onFulfilled : callable = null
Return values
PromiseInterface

is_fulfilled()

Returns true if a promise is fulfilled.

is_fulfilled will be removed in guzzlehttp/promises:2.0. Use Is::fulfilled instead.

is_fulfilled(PromiseInterface $promise) : bool
Parameters
$promise : PromiseInterface
Return values
bool

is_rejected()

Returns true if a promise is rejected.

is_rejected will be removed in guzzlehttp/promises:2.0. Use Is::rejected instead.

is_rejected(PromiseInterface $promise) : bool
Parameters
$promise : PromiseInterface
Return values
bool

is_settled()

Returns true if a promise is fulfilled or rejected.

is_settled will be removed in guzzlehttp/promises:2.0. Use Is::settled instead.

is_settled(PromiseInterface $promise) : bool
Parameters
$promise : PromiseInterface
Return values
bool

coroutine()

Create a new coroutine.

coroutine will be removed in guzzlehttp/promises:2.0. Use Coroutine::of instead.

coroutine(callable $generatorFn) : PromiseInterface
Parameters
$generatorFn : callable
Tags
see
Coroutine
Return values
PromiseInterface

str()

Returns the string representation of an HTTP message.

str will be removed in guzzlehttp/psr7:2.0. Use Message::toString instead.

str(MessageInterface $message) : string
Parameters
$message : MessageInterface

Message to convert to a string.

Return values
string

uri_for()

Returns a UriInterface for the given value.

uri_for will be removed in guzzlehttp/psr7:2.0. Use Utils::uriFor instead.

uri_for(string|UriInterface $uri) : UriInterface

This function accepts a string or UriInterface and returns a UriInterface for the given value. If the value is already a UriInterface, it is returned as-is.

Parameters
$uri : string|UriInterface
Tags
throws
InvalidArgumentException
Return values
UriInterface

stream_for()

Create a new stream based on the input type.

stream_for will be removed in guzzlehttp/psr7:2.0. Use Utils::streamFor instead.

stream_for([resource|string|int|float|bool|StreamInterface|callable|Iterator|null $resource = '' ][, array<string|int, mixed> $options = [] ]) : StreamInterface

Options is an associative array that can contain the following keys:

  • metadata: Array of custom metadata.
  • size: Size of the stream.

This method accepts the following $resource types:

  • Psr\Http\Message\StreamInterface: Returns the value as-is.
  • string: Creates a stream object that uses the given string as the contents.
  • resource: Creates a stream object that wraps the given PHP stream resource.
  • Iterator: If the provided value implements Iterator, then a read-only stream object will be created that wraps the given iterable. Each time the stream is read from, data from the iterator will fill a buffer and will be continuously called until the buffer is equal to the requested read size. Subsequent read calls will first read from the buffer and then call next on the underlying iterator until it is exhausted.
  • object with __toString(): If the object has the __toString() method, the object will be cast to a string and then a stream will be returned that uses the string value.
  • NULL: When null is passed, an empty stream object is returned.
  • callable When a callable is passed, a read-only stream object will be created that invokes the given callable. The callable is invoked with the number of suggested bytes to read. The callable can return any number of bytes, but MUST return false when there is no more data to return. The stream object that wraps the callable will invoke the callable until the number of requested bytes are available. Any additional bytes will be buffered and used in subsequent reads.
Parameters
$resource : resource|string|int|float|bool|StreamInterface|callable|Iterator|null = ''

Entity body data

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

Additional options

Tags
throws
InvalidArgumentException

if the $resource arg is not valid.

Return values
StreamInterface

parse_header()

Parse an array of header values containing ";" separated data into an array of associative arrays representing the header key value pair data of the header. When a parameter does not contain a value, but just contains a key, this function will inject a key with a '' string value.

parse_header will be removed in guzzlehttp/psr7:2.0. Use Header::parse instead.

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

Header to parse into components.

Return values
array<string|int, mixed> —

Returns the parsed header values.

normalize_header()

Converts an array of header values that may contain comma separated headers into an array of headers with no comma separated values.

normalize_header will be removed in guzzlehttp/psr7:2.0. Use Header::normalize instead.

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

Header to normalize.

Return values
array<string|int, mixed> —

Returns the normalized header field values.

modify_request()

Clone and modify a request with the given changes.

modify_request will be removed in guzzlehttp/psr7:2.0. Use Utils::modifyRequest instead.

modify_request(RequestInterface $request, array<string|int, mixed> $changes) : RequestInterface

This method is useful for reducing the number of clones needed to mutate a message.

The changes can be one of:

  • method: (string) Changes the HTTP method.
  • set_headers: (array) Sets the given headers.
  • remove_headers: (array) Remove the given headers.
  • body: (mixed) Sets the given body.
  • uri: (UriInterface) Set the URI.
  • query: (string) Set the query string value of the URI.
  • version: (string) Set the protocol version.
Parameters
$request : RequestInterface

Request to clone and modify.

$changes : array<string|int, mixed>

Changes to apply.

Return values
RequestInterface

rewind_body()

Attempts to rewind a message body and throws an exception on failure.

rewind_body will be removed in guzzlehttp/psr7:2.0. Use Message::rewindBody instead.

rewind_body(MessageInterface $message) : mixed

The body of the message will only be rewound if a call to tell() returns a value other than 0.

Parameters
$message : MessageInterface

Message to rewind

Tags
throws
RuntimeException

try_fopen()

Safely opens a PHP stream resource using a filename.

try_fopen will be removed in guzzlehttp/psr7:2.0. Use Utils::tryFopen instead.

try_fopen(string $filename, string $mode) : resource

When fopen fails, PHP normally raises a warning. This function adds an error handler that checks for errors and throws an exception instead.

Parameters
$filename : string

File to open

$mode : string

Mode used to open the file

Tags
throws
RuntimeException

if the file cannot be opened

Return values
resource

copy_to_string()

Copy the contents of a stream into a string until the given number of bytes have been read.

copy_to_string will be removed in guzzlehttp/psr7:2.0. Use Utils::copyToString instead.

copy_to_string(StreamInterface $stream[, int $maxLen = -1 ]) : string
Parameters
$stream : StreamInterface

Stream to read

$maxLen : int = -1

Maximum number of bytes to read. Pass -1 to read the entire stream.

Tags
throws
RuntimeException

on error.

Return values
string

copy_to_stream()

Copy the contents of a stream into another stream until the given number of bytes have been read.

copy_to_stream will be removed in guzzlehttp/psr7:2.0. Use Utils::copyToStream instead.

copy_to_stream(StreamInterface $source, StreamInterface $dest[, int $maxLen = -1 ]) : mixed
Parameters
$source : StreamInterface

Stream to read from

$dest : StreamInterface

Stream to write to

$maxLen : int = -1

Maximum number of bytes to read. Pass -1 to read the entire stream.

Tags
throws
RuntimeException

on error.

hash()

Calculate a hash of a stream.

hash will be removed in guzzlehttp/psr7:2.0. Use Utils::hash instead.

hash(StreamInterface $stream, string $algo[, bool $rawOutput = false ]) : string

This method reads the entire stream to calculate a rolling hash, based on PHP's hash_init functions.

Parameters
$stream : StreamInterface

Stream to calculate the hash for

$algo : string

Hash algorithm (e.g. md5, crc32, etc)

$rawOutput : bool = false

Whether or not to use raw output

Tags
throws
RuntimeException

on error.

Return values
string —

Returns the hash of the stream

readline()

Read a line from the stream up to the maximum allowed buffer length.

readline will be removed in guzzlehttp/psr7:2.0. Use Utils::readLine instead.

readline(StreamInterface $stream[, int|null $maxLength = null ]) : string
Parameters
$stream : StreamInterface

Stream to read from

$maxLength : int|null = null

Maximum buffer length

Return values
string

parse_request()

Parses a request message string into a request object.

parse_request will be removed in guzzlehttp/psr7:2.0. Use Message::parseRequest instead.

parse_request(string $message) : Request
Parameters
$message : string

Request message string.

Return values
Request

parse_response()

Parses a response message string into a response object.

parse_response will be removed in guzzlehttp/psr7:2.0. Use Message::parseResponse instead.

parse_response(string $message) : Response
Parameters
$message : string

Response message string.

Return values
Response

parse_query()

Parse a query string into an associative array.

parse_query will be removed in guzzlehttp/psr7:2.0. Use Query::parse instead.

parse_query(string $str[, int|bool $urlEncoding = true ]) : array<string|int, mixed>

If multiple values are found for the same key, the value of that key value pair will become an array. This function does not parse nested PHP style arrays into an associative array (e.g., foo[a]=1&foo[b]=2 will be parsed into ['foo[a]' => '1', 'foo[b]' => '2']).

Parameters
$str : string

Query string to parse

$urlEncoding : int|bool = true

How the query string is encoded

Return values
array<string|int, mixed>

build_query()

Build a query string from an array of key value pairs.

build_query will be removed in guzzlehttp/psr7:2.0. Use Query::build instead.

build_query(array<string|int, mixed> $params[, int|false $encoding = PHP_QUERY_RFC3986 ]) : string

This function can use the return value of parse_query() to build a query string. This function does not modify the provided keys when an array is encountered (like http_build_query() would).

Parameters
$params : array<string|int, mixed>

Query string parameters.

$encoding : int|false = PHP_QUERY_RFC3986

Set to false to not encode, PHP_QUERY_RFC3986 to encode using RFC3986, or PHP_QUERY_RFC1738 to encode using RFC1738.

Return values
string

mimetype_from_filename()

Determines the mimetype of a file by looking at its extension.

mimetype_from_filename will be removed in guzzlehttp/psr7:2.0. Use MimeType::fromFilename instead.

mimetype_from_filename(string $filename) : string|null
Parameters
$filename : string
Return values
string|null

get_message_body_summary()

Get a short summary of the message body.

get_message_body_summary will be removed in guzzlehttp/psr7:2.0. Use Message::bodySummary instead.

get_message_body_summary(MessageInterface $message[, int $truncateAt = 120 ]) : string|null

Will return null if the response is not printable.

Parameters
$message : MessageInterface

The message to get the body summary

$truncateAt : int = 120

The maximum allowed size of the summary

Return values
string|null

getallheaders()

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

getallheaders() : mixed
Return values
mixed —

The HTTP header key/value pairs.

idn_to_ascii()

idn_to_ascii(mixed $domain[, mixed $flags = 0 ][, mixed $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : mixed
Parameters
$domain : mixed
$flags : mixed = 0
$variant : mixed = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null

idn_to_utf8()

idn_to_utf8(mixed $domain[, mixed $flags = 0 ][, mixed $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : mixed
Parameters
$domain : mixed
$flags : mixed = 0
$variant : mixed = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null

idn_to_ascii()

idn_to_ascii(string|null $domain[, int|null $flags = 0 ][, int|null $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : string|false
Parameters
$domain : string|null
$flags : int|null = 0
$variant : int|null = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null
Return values
string|false

idn_to_utf8()

idn_to_utf8(string|null $domain[, int|null $flags = 0 ][, int|null $variant = INTL_IDNA_VARIANT_UTS46 ][, mixed &$idna_info = null ]) : string|false
Parameters
$domain : string|null
$flags : int|null = 0
$variant : int|null = INTL_IDNA_VARIANT_UTS46
$idna_info : mixed = null
Return values
string|false

normalizer_is_normalized()

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

normalizer_normalize()

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

normalizer_is_normalized()

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

normalizer_normalize()

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

sapi_windows_vt100_support()

sapi_windows_vt100_support(mixed $stream[, mixed $enable = null ]) : mixed
Parameters
$stream : mixed
$enable : mixed = null

stream_isatty()

stream_isatty(mixed $stream) : mixed
Parameters
$stream : mixed

utf8_encode()

utf8_encode(mixed $string) : mixed
Parameters
$string : mixed

utf8_decode()

utf8_decode(mixed $string) : mixed
Parameters
$string : mixed

spl_object_id()

spl_object_id(mixed $object) : mixed
Parameters
$object : mixed

mb_ord()

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

mb_chr()

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

mb_scrub()

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

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results