Documentation

Wrapper
in package

Class \Hoa\Stream\Wrapper.

Manipulate wrappers.

Tags
copyright

Copyright © 2007-2017 Hoa community

license

New BSD License

Table of Contents

Methods

getRegistered()  : array<string|int, mixed>
Get all registered wrapper.
isRegistered()  : bool
Check if a protocol is registered or not.
register()  : bool
Register a wrapper.
restore()  : bool
Restore a previously unregistered build-in wrapper.
unregister()  : bool
Unregister a wrapper.

Methods

getRegistered()

Get all registered wrapper.

public static getRegistered() : array<string|int, mixed>
Return values
array<string|int, mixed>

isRegistered()

Check if a protocol is registered or not.

public static isRegistered(string $protocol) : bool
Parameters
$protocol : string

Protocol name.

Return values
bool

register()

Register a wrapper.

public static register(string $protocol, string $className[, int $flags = 0 ]) : bool
Parameters
$protocol : string

The wrapper name to be registered.

$className : string

Class name which implements the protocol.

$flags : int = 0

Should be set to STREAM_IS_URL if $protocol is a URL protocol. Default is 0, local stream.

Tags
throws
Exception
Return values
bool

restore()

Restore a previously unregistered build-in wrapper.

public static restore(string $protocol) : bool
Parameters
$protocol : string

The wrapper name to be restored.

Return values
bool

unregister()

Unregister a wrapper.

public static unregister(string $protocol) : bool
Parameters
$protocol : string

The wrapper name to be unregistered.

Return values
bool

        
On this page

Search results