| Property | Type | Description | |
|---|---|---|---|
| $excludePaths | of strings(patterns) | ||
| $restrictAccess | boolean | restrict access to amfphp_admin. | |
| $serviceFolders | paths to folders containing services(relative or absolute). set by plugin. | ||
| $serviceNames2ClassFindInfo | of ClassFindInfo. set by plugin. |
| Method | Description | |
|---|---|---|
| _getMethodRoles ( string $methodName ) : array | get method roles | |
| discover ( ) : array | does the actual collection of data about available services |
| Method | Description | |
|---|---|---|
| getServiceNames ( array $serviceFolders, array $serviceNames2ClassFindInfo ) : array | returns a list of available services | |
| parseMethodComment ( string $comment ) : array{'returns' | extracts - meta data from param tags: 1) type is first word after tag name, name of the variable is second word ($ is removed) 2) example is end of line after 'example: ' | |
| searchFolderForServices ( string $rootPath, string $subFolder ) : array | finds classes in folder. If in subfolders add the relative path to the name. |
| Method | Description | |
|---|---|---|
| formatComment ( type $comment ) : type | gets rid of blocks of 4 spaces and tabs, as well as comment markers. |
| public _getMethodRoles ( string $methodName ) : array | ||
| $methodName | string | |
| return | array | |
| protected parseMethodComment ( string $comment ) : array{'returns' | ||
| $comment | string | |
| return | array{'returns' | |
| public static bool $restrictAccess | ||
| return | boolean | |
| public static $serviceFolders |
