ApiOpenStudio PHPDoc

Markers

Table of Contents

includes/Cli/Install.php	14
includes/Cli/Script.php	9
includes/Cli/Update.php	24
includes/Core/Api.php	16
includes/Core/ApiException.php	3
includes/Core/Cache.php	3
includes/Core/Config.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	5
includes/Core/ConvertToTextTrait.php	3
includes/Core/ConvertToXmlTrait.php	7
includes/Core/Curl.php	3
includes/Core/DataContainer.php	4
includes/Core/DetectTypeTrait.php	3
includes/Core/Entity.php	3
includes/Core/Error.php	3
includes/Core/Hash.php	3
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/ProcessorEntity.php	6
includes/Core/ProcessorHelper.php	3
includes/Core/Request.php	3
includes/Core/ResourceValidator.php	8
includes/Core/TreeParser.php	7
includes/Core/Utilities.php	12
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/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/Image.php	4
includes/Output/Json.php	4
includes/Output/OctetStream.php	3
includes/Output/Output.php	3
includes/Output/Plain.php	4
includes/Output/Text.php	4
includes/Output/Xml.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/Cast.php	4
includes/Processor/Concatenate.php	3
includes/Processor/DoWhile.php	4
includes/Processor/FieldValue.php	3
includes/Processor/Filter.php	11
includes/Processor/ForEachItem.php	5
includes/Processor/Fragment.php	3
includes/Processor/GeoPoint.php	4
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/Literal.php	3
includes/Processor/LoginStoreDrupal.php	5
includes/Processor/Math.php	4
includes/Processor/Merge.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	16
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	7
includes/Processor/UserRoleDelete.php	3
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	4
includes/Processor/VarInt.php	3
includes/Processor/VarLooselyTyped.php	4
includes/Processor/VarObject.php	4
includes/Processor/VarPost.php	4
includes/Processor/VarRand.php	4
includes/Processor/VarRequest.php	4
includes/Processor/VarStoreCreate.php	5
includes/Processor/VarStoreDelete.php	4
includes/Processor/VarStoreRead.php	6
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/scripts/install.php	3
includes/scripts/update.php	3
includes/Security/BearerToken.php	4
includes/Security/GenerateToken.php	8
includes/Security/ValidateToken.php	3
includes/Security/ValidateTokenRoles.php	9
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	7
public/index.php	4

Install.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	160	DB link.
	383	Parse the DB table definition array.
	387	Column definitions.
	409	Stop if table create fails.
	415	Add data if required.
	419	Do not create the testing account.
	423	Do not create the testing application.
	427	Do not create the tester user and associated roles.
	566	', $server);
	572	' . $this->config->__get(['api', 'url']) . $uri;
	683	Assign administrator role.

Script.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	292	Is it an flag? (prefixed with --)
	298	is it a flag? (prefixed with -)
	303	it is the '=' syntax (-option=value)
	307	it is the ' ' syntax (-option value)
	316	finally, it is not option, nor flag
	321	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
	103	Override the default update directory if option -d is input.
	154	'
	305	Anonymous functions
	311	Exclude Classes
	349	Major.
	356	Medium.
	363	Minor.
	370	RC
	372	RC version is less than minor version.
	376	RC version is greater than ALPHA/BETA.
	380	Compare RC versions.
	388	Alpha.
	390	Alpha is less than minor version
	391	&& Alpha is less than beta version
	392	&& Alpha is less than RC version.
	396	Compare alpha versions.
	404	Beta.
	406	Beta is less than minor version
	407	&& Beta is less than RC version.
	411	Beta is greater than alpha version.
	415	Compare beta versions.

Api.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	92	DB link.
	98	'
	111	get the request data for processing.
	121	validate user access rights for the call.
	128	fetch the cache of the call, and process into output if it is not stale
	134	set fragments in Meta class
	145	process the call
	152	store the results in cache for next time
	299	Default response output if no output defined.
	303	Test for single output defined.
	309	Output format is response, so set the output format from the request header.
	316	Return the output to the correct format and return in the response.
	319	Process an output item to a remote server.

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

Config.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
	94	Empty string should be returned as double quotes so that it is not returned as null.
	97	Wrap in double quotes if not already present.

ConvertToTextTrait.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
	51	');
	69	');
	87	');
	105	apiOpenStudioWrapper');

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

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

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

ProcessorEntity.php

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

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
	76	Check mandatory elements exists in data.
	88	Validate for identical IDs.
	91	Validate dictionaries.
	253	validate cardinality
	255	check for nothing to validate and if that is ok.

TreeParser.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	178	currentNode is an array, process each item
	218	currentNode is an array, process each item
	234	We have the result of the logic for a conditional processor.
	235	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
	235	' . $address . (($port == 80) ? '' : ":$port") . $uri;
	262	'
	277	' . $a_selfUrl['address'] . $a_selfUrl['uri']);
	338	Try to make each directory world writable.
	347	Recurse into subdirectories
	351	Try to make each file world writable.
	374	Nginx or fast CGI.
	378	Server-side fix for bug in old Android versions (a nice side-effect of this fix means we don't care about
	379	capitalization for Authorization)

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

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
	56	phpcs:ignore
	93	phpcs:ignore
	103	phpcs:ignore
	140	get static curl options for this call
	152	get auth
	157	send request
	182	test for array
	186	test for JSON
	191	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
	77	phpcs:ignore

Html.php

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

Image.php

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

Json.php

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

OctetStream.php

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

Output.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
	61	phpcs:ignore

Text.php

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

Xml.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	68	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
	103	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
	61	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
	69	phpcs:ignore
	79	phpcs:ignore
	156	Filter params.

ApplicationUpdate.php

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

Cast.php

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

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
	87	phpcs:ignore

FieldValue.php

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

Filter.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	57	phpcs:ignore
	76	phpcs:ignore
	86	phpcs:ignore
	116	Nothing to filter.
	121	Test for multiple filters if regex (not allowed because it is inefficient).
	126	Regex filter accepted as a string, convert to array so it is always an array
	148	wpscholar.com/blog/filter-multidimensional-array-php/
	149	www.phptherightway.com/pages/Functional-Programming.html

ForEachItem.php

Type	Line	Description
	12	gitlab.com/john89)
	16	www.apiopenstudio.com/license/.
	17	www.apiopenstudio.com
	45	phpcs:ignore
	114	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

GeoPoint.php

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

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

Literal.php

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

LoginStoreDrupal.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	42	phpcs:ignore
	56	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

OpenapiDefault.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	109	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
	164	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
	121	Extract the accid and appid from the schema.
	153	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
	143	Initial password reset request.
	144	Set the token and send the email.
	196	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
	67	phpcs:ignore
	99	phpcs:ignore
	109	phpcs:ignore
	119	phpcs:ignore
	335	Prevent unauthorised editing of admin resources.
	383	check mandatory elements exists in data
	410	validate for identical IDs
	413	validate dictionaries
	415	check for identical IDs
	542	validate cardinality
	544	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
	280	Validate the application exists.
	289	Validate user has developer role for the application
	305	Validate the resource does not already exist.
	311	Validate the metadada.

ResourceDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	118	Validate resource exists.
	128	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
	102	Validate resource exists.
	113	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
	149	Extract the file contents.
	157	Validate the metadata.
	164	Create the final Resource object for saving into the DB.
	177	OpenApi
	181	Generate default OpenApi fragment.
	240	Only developer role permitted to upload resource.
	269	attempt string extraction as JSON.
	272	attempt string extraction as YAML.
	288	Merge the sections into final metadata.
	315	Validate required keys in the imported file.
	323	Validate TTL in the imported file.
	329	Validate the application exists.
	343	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
	224	Invalid resource.
	231	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
	94	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
	104	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
	40	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
	76	phpcs:ignore

UserRoleCreate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	128	Validate user role attributes exist.
	166	Validate roles that do not need appid or accid
	176	Administrator or Account manager should not be assigned an appid.
	180	Administrator should not be assigned an accid.

UserRoleDelete.php

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

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
	256	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
	49	phpcs:ignore
	59	phpcs:ignore
	78	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
	47	phpcs:ignore

VarInt.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
	47	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
	47	phpcs:ignore

VarStoreCreate.php

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

VarStoreDelete.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	117	Validate access to the existing var's application

VarStoreRead.php

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

VarStoreUpdate.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	55	phpcs:ignore
	60	phpcs:ignore
	167	Validate access to the existing var's application
	184	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
	34	phpcs:ignore
	48	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.

install.php

Type	Line	Description
	10	www.apiopenstudio.com/license/.
	11	gitlab.com/john89)
	13	www.apiopenstudio.com

update.php

Type	Line	Description
	10	www.apiopenstudio.com/license/.
	11	gitlab.com/john89)
	13	www.apiopenstudio.com

BearerToken.php

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

GenerateToken.php

Type	Line	Description
	7	gitlab.com/john89)
	11	www.apiopenstudio.com/license/.
	12	www.apiopenstudio.com
	80	Verify User credentials.
	84	Invalid username or user inactive.
	90	No password hash stored yet.
	96	Invalid password.
	102	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
	52	phpcs:ignore
	62	phpcs:ignore
	89	Get roles and validate the user against them.
	111	Do not validate accid or appid for Administrator role.
	116	Only validate accid for Account manager role.
	120	Validate role, accid, appid

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

index.php

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