ApiOpenStudio PHPDoc

Markers

Table of Contents

includes/Cli/HandleExceptionTrait.php	3
includes/Cli/Install.php	14
includes/Cli/Modules.php	3
includes/Cli/Script.php	9
includes/Cli/Update.php	5
includes/Core/Api.php	14
includes/Core/ApiException.php	3
includes/Core/Cache.php	3
includes/Core/CacheMemcached.php	3
includes/Core/CacheRedis.php	3
includes/Core/Config.php	3
includes/Core/ConvertHtml.php	3
includes/Core/ConvertToArrayTrait.php	3
includes/Core/ConvertToBooleanTrait.php	3
includes/Core/ConvertToFileTrait.php	3
includes/Core/ConvertToFloatTrait.php	3
includes/Core/ConvertToHtmlTrait.php	3
includes/Core/ConvertToImageTrait.php	3
includes/Core/ConvertToIntegerTrait.php	3
includes/Core/ConvertToJsonTrait.php	3
includes/Core/ConvertToTextTrait.php	3
includes/Core/ConvertToUndefinedTrait.php	3
includes/Core/ConvertToXmlTrait.php	3
includes/Core/Curl.php	3
includes/Core/DataContainer.php	4
includes/Core/DetectTypeTrait.php	3
includes/Core/Entity.php	6
includes/Core/Error.php	3
includes/Core/Hash.php	3
includes/Core/ListClassesInDirectory.php	7
includes/Core/ModuleHelper.php	2
includes/Core/MonologWrapper.php	6
includes/Core/OpenApi/OpenApiParent20.php	6
includes/Core/OpenApi/OpenApiParent300.php	13
includes/Core/OpenApi/OpenApiParent301.php	3
includes/Core/OpenApi/OpenApiParent302.php	3
includes/Core/OpenApi/OpenApiParent303.php	3
includes/Core/OpenApi/OpenApiParentAbstract.php	3
includes/Core/OpenApi/OpenApiPath20.php	3
includes/Core/OpenApi/OpenApiPath300.php	3
includes/Core/OpenApi/OpenApiPath301.php	3
includes/Core/OpenApi/OpenApiPath302.php	3
includes/Core/OpenApi/OpenApiPath303.php	3
includes/Core/OpenApi/OpenApiPathAbstract.php	3
includes/Core/OutputEntity.php	3
includes/Core/OutputRemote.php	4
includes/Core/OutputResponse.php	3
includes/Core/ProcessorEntity.php	3
includes/Core/ProcessorHelper.php	3
includes/Core/Request.php	3
includes/Core/ResourceValidator.php	7
includes/Core/SortByVersionTrait.php	20
includes/Core/TreeParser.php	8
includes/Core/Utilities.php	17
includes/Db/Account.php	3
includes/Db/AccountMapper.php	3
includes/Db/Application.php	3
includes/Db/ApplicationMapper.php	3
includes/Db/ExternalUser.php	3
includes/Db/ExternalUserMapper.php	3
includes/Db/InstalledVersion.php	3
includes/Db/InstalledVersionMapper.php	3
includes/Db/Invite.php	3
includes/Db/InviteMapper.php	3
includes/Db/Mapper.php	6
includes/Db/Resource.php	3
includes/Db/ResourceMapper.php	10
includes/Db/Role.php	3
includes/Db/RoleMapper.php	3
includes/Db/User.php	4
includes/Db/UserMapper.php	3
includes/Db/UserRole.php	3
includes/Db/UserRoleMapper.php	3
includes/Db/VarStore.php	3
includes/Db/VarStoreMapper.php	3
includes/Endpoint/AuthBasic.php	3
includes/Endpoint/AuthBearerToken.php	3
includes/Endpoint/AuthCookie.php	3
includes/Endpoint/AuthDigest.php	3
includes/Endpoint/AuthOauth.php	3
includes/Endpoint/Url.php	12
includes/Output/Email.php	3
includes/Output/File.php	4
includes/Output/Html.php	4
includes/Output/HtmlRemote.php	4
includes/Output/Image.php	4
includes/Output/ImageRemote.php	4
includes/Output/Json.php	6
includes/Output/JsonRemote.php	6
includes/Output/OctetStream.php	3
includes/Output/Plain.php	4
includes/Output/Text.php	4
includes/Output/TextRemote.php	4
includes/Output/Xml.php	4
includes/Output/XmlRemote.php	4
includes/Processor/AccountCreate.php	3
includes/Processor/AccountDelete.php	4
includes/Processor/AccountRead.php	4
includes/Processor/AccountUpdate.php	3
includes/Processor/ApplicationCreate.php	3
includes/Processor/ApplicationDelete.php	3
includes/Processor/ApplicationRead.php	6
includes/Processor/ApplicationUpdate.php	4
includes/Processor/CacheClear.php	3
includes/Processor/Cast.php	5
includes/Processor/ComposerCommand.php	3
includes/Processor/Concatenate.php	3
includes/Processor/DoWhile.php	4
includes/Processor/FieldValue.php	3
includes/Processor/ForEachItem.php	5
includes/Processor/Fragment.php	3
includes/Processor/IfThenElse.php	3
includes/Processor/InviteAccept.php	3
includes/Processor/InviteCreate.php	3
includes/Processor/InviteDelete.php	3
includes/Processor/InviteRead.php	3
includes/Processor/JsonPath.php	6
includes/Processor/LoginStoreDrupal.php	5
includes/Processor/Math.php	4
includes/Processor/Merge.php	4
includes/Processor/ModulesInstall.php	3
includes/Processor/ModulesRead.php	3
includes/Processor/ModulesUninstall.php	3
includes/Processor/ModulesUpdate.php	3
includes/Processor/OpenapiDefault.php	4
includes/Processor/OpenapiImport.php	5
includes/Processor/OpenapiRead.php	3
includes/Processor/OpenapiUpdate.php	5
includes/Processor/PasswordReset.php	6
includes/Processor/Processors.php	3
includes/Processor/Replace.php	3
includes/Processor/ResourceBase.php	14
includes/Processor/ResourceCreate.php	7
includes/Processor/ResourceDelete.php	5
includes/Processor/ResourceExport.php	5
includes/Processor/ResourceImport.php	13
includes/Processor/ResourceRead.php	3
includes/Processor/ResourceUpdate.php	5
includes/Processor/RoleCreate.php	3
includes/Processor/RoleDelete.php	4
includes/Processor/RoleRead.php	3
includes/Processor/RoleUpdate.php	4
includes/Processor/Sequential.php	4
includes/Processor/Sort.php	4
includes/Processor/UserCreate.php	3
includes/Processor/UserDelete.php	3
includes/Processor/UserRead.php	4
includes/Processor/UserRoleCreate.php	5
includes/Processor/UserRoleDelete.php	4
includes/Processor/UserRoleRead.php	3
includes/Processor/UserUpdate.php	4
includes/Processor/VarBody.php	5
includes/Processor/VarBool.php	3
includes/Processor/VarCollection.php	3
includes/Processor/VarField.php	4
includes/Processor/VarFile.php	8
includes/Processor/VarFloat.php	3
includes/Processor/VarGet.php	5
includes/Processor/VarInt.php	3
includes/Processor/VarLiteral.php	3
includes/Processor/VarLooselyTyped.php	4
includes/Processor/VarObject.php	4
includes/Processor/VarPost.php	5
includes/Processor/VarRand.php	4
includes/Processor/VarRequest.php	5
includes/Processor/VarStoreCreate.php	6
includes/Processor/VarStoreDelete.php	5
includes/Processor/VarStoreRead.php	8
includes/Processor/VarStoreUpdate.php	7
includes/Processor/VarStr.php	3
includes/Processor/VarTemporary.php	5
includes/Processor/VarUri.php	5
includes/Processor/XmlPath.php	7
includes/Security/BearerToken.php	4
includes/Security/GenerateToken.php	8
includes/Security/ValidateToken.php	3
includes/Security/ValidateTokenRoles.php	6
includes/updates/core_updates_v0.0-example.php	4
includes/updates/core_updates_v1.0-alpha.php	13
includes/updates/core_updates_v1.0-beta.php	9
public/index.php	4

HandleExceptionTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Install.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	162	DB link.
	370	Parse the DB table definition array.
	374	Column definitions.
	396	Stop if table create fails.
	402	Add data if required.
	406	Do not create the testing account.
	410	Do not create the testing application.
	414	Do not create the tester user and associated roles.
	553	', $server);
	559	' . $this->config->__get(['api', 'url']) . $uri;
	670	Assign administrator role.

Modules.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Script.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	290	Is it a flag? (prefixed with --)
	296	is it a flag? (prefixed with -)
	301	it is the '=' syntax (-option=value)
	305	it is the ' ' syntax (-option value)
	314	finally, it is not option, nor flag
	319	set defaults if there are any set

Update.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	106	Override the default update directory if option -d is input.
TODO	157	Refactor this function to use InstalledVersionMapper, after the next release.

Api.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	102	get the request data for processing.
	112	validate user access rights for the call.
	119	fetch the cache of the call, and process into output if it is not stale
	126	set fragments in Meta class
	136	process the call
	146	store the results in cache for next time
	266	Default response output if no output defined.
	270	Test for single output defined.
	276	Output format is response, so set the output format from the request header.
	281	Convert the output to the correct format to return it in the response.
	284	Process an output item.

ApiException.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Cache.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

CacheMemcached.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

CacheRedis.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Config.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertHtml.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToArrayTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToBooleanTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToFileTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToFloatTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToHtmlTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToImageTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToIntegerTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToJsonTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToTextTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToUndefinedTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ConvertToXmlTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Curl.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

DataContainer.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	24	phpcs:ignore

DetectTypeTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Entity.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	230	undefined input key for this processor type
	242	invalid cardinality
	251	Set data to default if empty.

Error.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Hash.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ListClassesInDirectory.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	github.com/WyriHaximus/php-list-classes-in-directory
	32	github.com/WyriHaximus/php-list-classes-in-directory
	39	github.com/Roave/BetterReflection/blob/396a07c9d276cb9ffba581b24b2dadbb542d542e/demo/parsing-whole-directory/example2.php.
	50	↓ required to autoload parent classes/interface from another directory than /src (e.g. /vendor)
	81	↓ required to autoload parent classes/interface from another directory (e.g. /vendor)

ModuleHelper.php

Type	Line	Description
	97	Get list of modules, with the details array.
	113	Get list of update functions for installed modules.

MonologWrapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	54	Define line formatters.
	64	Define handlers.
	70	Create the Logger stream with assigned handlers.

OpenApiParent20.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	44	www.apiopenstudio.com/license/',
	51	www.apiopenstudio.com/license/',
	159	www.apiopenstudio.com',

OpenApiParent300.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	44	www.apiopenstudio.com/license/',
	52	www.apiopenstudio.com/license/',
	76	$domain/$accountName/$applicationName";
	276	www.apiopenstudio.com',
	290	', $server->url);
	312	', $server->url);
	334	', $server->url);
	349	$domain/$accountName/$applicationName";
	361	', $server->url);
	376	$domain/$accountName/$applicationName";

OpenApiParent301.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiParent302.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiParent303.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiParentAbstract.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiPath20.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiPath300.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiPath301.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiPath302.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiPath303.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenApiPathAbstract.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OutputEntity.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OutputRemote.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	56	phpcs:ignore

OutputResponse.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ProcessorEntity.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ProcessorHelper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Request.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ResourceValidator.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	163	Validate TTL in the imported file.
	169	Validate the application exists.
	191	Check mandatory elements exists in data.
	246	Stack array for parsing for identical IDs.

SortByVersionTrait.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	57	Major.
	64	Medium.
	71	Minor.
	78	RC
	80	RC version is less than minor version.
	84	RC version is greater than ALPHA/BETA.
	88	Compare RC versions.
	96	Alpha.
	98	Alpha is less than minor version
	99	&& Alpha is less than beta version
	100	&& Alpha is less than RC version.
	104	Compare alpha versions.
	112	Beta.
	114	Beta is less than minor version
	115	&& Beta is less than RC version.
	119	Beta is greater than alpha version.
	123	Compare beta versions.

TreeParser.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	202	currentNode is an array, process each item
	230	Check for cached processor result.
	252	currentNode is an array, process each item
	268	We have the result of the logic for a conditional processor.
	269	The process() result is the meta for the branch to follow.

Utilities.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	236	' . $address . (($port == 80) ? '' : ":$port") . $uri;
	263	'
	278	' . $a_selfUrl['address'] . $a_selfUrl['uri']);
	339	Try to make each directory world writable.
	348	Recurse into subdirectories
	352	Try to make each file world writable.
	375	Nginx or fast CGI.
	379	Server-side fix for bug in old Android versions (a nice side-effect of this fix means we don't care about
	380	capitalization for Authorization)
	510	DB link.
	516	'
	554	stackoverflow.com/questions/2197851/function-list-of-php-file
	585	Anonymous functions
	591	Exclude Classes

Account.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

AccountMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Application.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ApplicationMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ExternalUser.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ExternalUserMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

InstalledVersion.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

InstalledVersionMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Invite.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

InviteMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Mapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	153	Add filter by keyword.
	175	Add order by.
	187	Add limit.

Resource.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ResourceMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	53	phpcs:ignore
	263	Find Applications for the user role.
	273	Find all resources for the applications the user has rights for.
	275	No further filters, so return the results.
	279	If accid is filter, find all applications for the accid.
	288	Filter by resid.
	297	Filter by appid.

Role.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

RoleMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

User.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	310	Generate hash.

UserMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

UserRole.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

UserRoleMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarStore.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarStoreMapper.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

AuthBasic.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

AuthBearerToken.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

AuthCookie.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

AuthDigest.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

AuthOauth.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Url.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	59	phpcs:ignore
	96	phpcs:ignore
	106	phpcs:ignore
	143	get static curl options for this call
	155	get auth
	160	send request
	185	test for array
	189	test for JSON
	194	test for XML

Email.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

File.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	40	phpcs:ignore

Html.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	40	phpcs:ignore

HtmlRemote.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	62	phpcs:ignore

Image.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	45	phpcs:ignore

ImageRemote.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	67	phpcs:ignore

Json.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	43	phpcs:ignore
	91	Wrap JSON in the wrapper object if required by the settings.
	109	Wrap text values in double quotes so that they are parseable as valid JSON.

JsonRemote.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	65	phpcs:ignore
	115	Wrap JSON in the wrapper object if required by the settings.
	133	Wrap text values in double quotes so that they are parseable as valid JSON.

OctetStream.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Plain.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	32	phpcs:ignore

Text.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	40	phpcs:ignore

TextRemote.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	62	phpcs:ignore

Xml.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	40	phpcs:ignore

XmlRemote.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	62	phpcs:ignore

AccountCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

AccountDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	98	Do not delete if applications are attached to the account.

AccountRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	54	phpcs:ignore

AccountUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ApplicationCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ApplicationDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ApplicationRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	48	phpcs:ignore
	58	phpcs:ignore
	151	Filter params.

ApplicationUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
TODO	255	Validate final schema fragment version against openapi_version in settings.

CacheClear.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Cast.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	40	phpcs:ignore
	84	'file',

ComposerCommand.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Concatenate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

DoWhile.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	89	phpcs:ignore

FieldValue.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ForEachItem.php

Type	Line	Description
	12	gitlab.com/john89)
	16	www.apiopenstudio.com/license/.
	17	www.apiopenstudio.com
	47	phpcs:ignore
	122	Cleanup - the array elements stored in the session are no longer needed.

Fragment.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

IfThenElse.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

InviteAccept.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

InviteCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

InviteDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

InviteRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

JsonPath.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	220	phpcs:ignore
	230	phpcs:ignore
	240	phpcs:ignore

LoginStoreDrupal.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	35	phpcs:ignore
	49	phpcs:ignore

Math.php

Type	Line	Description
	7	gitlab.com/john89)
	12	www.apiopenstudio.com/license/.
	13	www.apiopenstudio.com
	37	phpcs:ignore

Merge.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	67	phpcs:ignore

ModulesInstall.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ModulesRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ModulesUninstall.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ModulesUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenapiDefault.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	104	Only developers for an application can use this processor.

OpenapiImport.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	48	phpcs:ignore
	159	Only developers for an application can use this processor.

OpenapiRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

OpenapiUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	116	Extract the accid and appid from the schema.
	148	Only developers for an application can use this processor.

PasswordReset.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	145	Initial password reset request.
	146	Set the token and send the email.
	198	Final password reset step - we should have a password and token.

Processors.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

Replace.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ResourceBase.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	46	phpcs:ignore
	78	phpcs:ignore
	88	phpcs:ignore
	98	phpcs:ignore
	330	Prevent unauthorised editing of admin resources.
	378	check mandatory elements exists in data
	405	validate for identical IDs
	408	validate dictionaries
	410	check for identical IDs
	537	validate cardinality
	539	check for nothing to validate and if that is ok.

ResourceCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	296	Validate the application exists.
	303	Validate user has developer role for the application
	319	Validate the resource does not already exist.
	325	Validate the metadata.

ResourceDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	113	Validate resource exists.
	123	Validate user has Developer access to its application.

ResourceExport.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	97	Validate resource exists.
	108	Validate user has Developer access to its application.

ResourceImport.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	103	Extract the file contents.
	108	Validate the metadata.
	119	Create the final Resource object for saving into the DB.
	132	OpenApi
	136	Generate default OpenApi fragment.
	197	Only developer role permitted to upload resource.
	226	attempt string extraction as JSON.
	229	attempt string extraction as YAML.
	245	Merge the sections into final metadata.
	278	Validate the resource does not already exist.

ResourceRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ResourceUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	219	Invalid resource.
	226	Generate default OpenApi fragment in the resource is it doesn't already exist.

RoleCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

RoleDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	91	Update to core application and is locked.

RoleRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

RoleUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	101	Update to core application and is locked.

Sequential.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	42	phpcs:ignore

Sort.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	34	phpcs:ignore

UserCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

UserDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

UserRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	72	phpcs:ignore

UserRoleCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	144	Validate current user has access to create roles for the application.
	160	Create the new role.

UserRoleDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	121	Validate current user has access to create roles for the application.

UserRoleRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

UserUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	255	Non-privileged accounts can only edit their own accounts.

VarBody.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	39	phpcs:ignore
	85	input');

VarBool.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarCollection.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarField.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	34	phpcs:ignore

VarFile.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	47	phpcs:ignore
	57	phpcs:ignore
	76	phpcs:ignore
	210	todo Add a detectType function.
	228	www.php.net/manual/en/features.file-upload.php

VarFloat.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarGet.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	36	phpcs:ignore
	50	phpcs:ignore

VarInt.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarLiteral.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarLooselyTyped.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	34	phpcs:ignore

VarObject.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	36	phpcs:ignore

VarPost.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	36	phpcs:ignore
	50	phpcs:ignore

VarRand.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	34	phpcs:ignore

VarRequest.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	36	phpcs:ignore
	50	phpcs:ignore

VarStoreCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	45	phpcs:ignore
	50	phpcs:ignore
	69	phpcs:ignore

VarStoreDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	43	phpcs:ignore
	48	phpcs:ignore

VarStoreRead.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	43	phpcs:ignore
	48	phpcs:ignore
	58	phpcs:ignore
	177	OR logic.
	180	AND logic.

VarStoreUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	41	phpcs:ignore
	46	phpcs:ignore
	165	Validate access to the existing var's application
	182	Validate access to the var's NEW application

VarStr.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

VarTemporary.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	36	phpcs:ignore
	68	phpcs:ignore

VarUri.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	36	phpcs:ignore
	50	phpcs:ignore

XmlPath.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	83	bookstore/book[1]/price"
	94	bookstore/book[1]/price"
	248	phpcs:ignore
	450	gist.github.com/hakre/4761677 for other useful methods.

BearerToken.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	36	phpcs:ignore

GenerateToken.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	83	Verify User credentials.
	87	Invalid username or user inactive.
	93	No password hash stored yet.
	99	Invalid password.
	105	Get all user roles.

ValidateToken.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com

ValidateTokenRoles.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	54	phpcs:ignore
	64	phpcs:ignore
	96	Get roles and validate the user against them.

core_updates_v0.0-example.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	27	Do Something

core_updates_v1.0-alpha.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	28	gitlab.com/apiopenstudio/apiopenstudio/-/issues/54
	63	gitlab.com/apiopenstudio/apiopenstudio/-/issues/54
	75	Find the old Functions processor in the DB.
	90	Load the data from the new Processors processor file.
	112	Delete the old Functions processor.
	120	Insert the new Processors processor.
	140	gitlab.com/apiopenstudio/apiopenstudio/-/issues/101
	145	Drop the unused token coumns from the user table.
	186	gitlab.com/apiopenstudio/apiopenstudio/-/issues/127
	190	Update all core resources.

core_updates_v1.0-beta.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	26	Update all core resources.
	52	gitlab.com/apiopenstudio/apiopenstudio/-/issues/48
	72	phpcs:ignore
	89	phpcs:ignore
	107	gitlab.com/apiopenstudio/apiopenstudio/-/issues/48
	148	gitlab.com/apiopenstudio/apiopenstudio/-/issues/196

index.php

Type	Line	Description
	15	www.apiopenstudio.com/license/.
	16	gitlab.com/john89)
	18	www.apiopenstudio.com
	32	Requests from the same server don't have an HTTP_ORIGIN header