Documentation

ApiSpecification
in package
implements ArrayAccess Uses LegacyArrayAccess

Tags
implements

ArrayAccess<String, mixed>

Interfaces, Classes and Traits

ArrayAccess

Table of Contents

VISIBILITY_API  = 16
VISIBILITY_DEFAULT  = 7
VISIBILITY_INTERNAL  = 8
VISIBILITY_PRIVATE  = 4
VISIBILITY_PROTECTED  = 2
VISIBILITY_PUBLIC  = 1
$defaultPackageName  : string
$encoding  : string
$examples  : Source|null
$extensions  : array<int, string>
$ignore  : array{paths: \phpDocumentor\Path[]}
$ignoreTags  : array<string|int, string>
$includeSource  : bool
$markers  : array<string|int, string>
$output  : string
$source  : Source
$validate  : bool
$visibility  : array<string|int, string>
calculateVisiblity()  : int
createDefault()  : ApiSpecification
createFromArray()  : self
getIgnoredTags()  : array<string|int, string>
isVisibilityAllowed()  : bool
Checks whether the Project supports the given visibility.
offsetExists()  : bool
offsetGet()  : mixed
offsetSet()  : void
offsetUnset()  : void
setIgnore()  : void
source()  : Source
withSource()  : self
__construct()  : mixed
normalizePropertyName()  : string

Constants

VISIBILITY_DEFAULT

public int VISIBILITY_DEFAULT = 7

by default ignore internal visibility but show others

Properties

Methods

calculateVisiblity()

public calculateVisiblity() : int
Return values
int —

createFromArray()

public static createFromArray(array<string|int, mixed> $api) : self
Parameters
$api : array<string|int, mixed>
Return values
self —

getIgnoredTags()

public getIgnoredTags() : array<string|int, string>
Return values
array<string|int, string> —

isVisibilityAllowed()

Checks whether the Project supports the given visibility.

public isVisibilityAllowed(int $visibility) : bool
Parameters
$visibility : int

One of the VISIBILITY_* constants of the Settings class.

Tags
see
Settings

for a list of the available VISIBILITY_* constants.

Return values
bool —

offsetExists()

public offsetExists(string $offset) : bool
Parameters
$offset : string
Return values
bool —

offsetGet()

public offsetGet(string $offset) : mixed
Parameters
$offset : string
Return values
mixed —

offsetSet()

public offsetSet(string $offset, mixed $value) : void
Parameters
$offset : string
$value : mixed
Return values
void —

offsetUnset()

public offsetUnset(string $offset) : void
Parameters
$offset : string
Return values
void —

setIgnore()

public setIgnore(array<string|int, mixed> $ignore) : void
Parameters
$ignore : array<string|int, mixed>
Return values
void —

__construct()

private __construct(Source $source, string $output, array{paths: \phpDocumentor\Path[]} $ignore, array<int, string> $extensions, array<string|int, string> $visibility, string $defaultPackageName, bool $includeSource, array<string|int, string> $markers, array<string|int, string> $ignoreTags, Source|null $examples, string $encoding, bool $validate) : mixed
Parameters
$source : Source
$output : string
$ignore : array{paths: \phpDocumentor\Path[]}
$extensions : array<int, string>
$visibility : array<string|int, string>
$defaultPackageName : string
$includeSource : bool
$markers : array<string|int, string>
$ignoreTags : array<string|int, string>
$examples : Source|null
$encoding : string
$validate : bool
Return values
mixed —

normalizePropertyName()

private normalizePropertyName(string $offset) : string
Parameters
$offset : string
Return values
string —

Search results