ApiOpenStudio PHPDoc

Markers

Table of Contents

includes/Cli/Install.php 12
includes/Cli/Script.php 9
includes/Cli/Update.php 24
includes/Core/Api.php 28
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/Normalise.php 20
includes/Core/ProcessorEntity.php 6
includes/Core/ProcessorHelper.php 3
includes/Core/Request.php 3
includes/Core/ResourceValidator.php 8
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 9
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 3
includes/Processor/Cast.php 4
includes/Processor/Collection.php 5
includes/Processor/Concatenate.php 3
includes/Processor/Equation.php 4
includes/Processor/FieldValue.php 3
includes/Processor/Filter.php 11
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/Merge.php 3
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 6
includes/Processor/ResourceExport.php 5
includes/Processor/ResourceImport.php 13
includes/Processor/ResourceRead.php 3
includes/Processor/ResourceSwagger.php 4
includes/Processor/ResourceUpdate.php 6
includes/Processor/RoleCreate.php 3
includes/Processor/RoleDelete.php 4
includes/Processor/RoleRead.php 3
includes/Processor/RoleUpdate.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/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 4
includes/Processor/VarStoreDelete.php 4
includes/Processor/VarStoreRead.php 5
includes/Processor/VarStoreUpdate.php 5
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
public/index.php 4

Install.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
154 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.
568 Assign administrator role.

Script.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
293 Is it an flag? (prefixed with --)
299 is it a flag? (prefixed with -)
304 it is the '=' syntax (-option=value)
308 it is the ' ' syntax (-option value)
317 finally, it is not option, nor flag
322 set defaults if there are any set

Update.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
106 Override the default update directory if option -d is input.
160 '
306 Anonymous functions
312 Exclude Classes
350 Major.
357 Medium.
364 Minor.
371 RC
373 RC version is less than minor version.
377 RC version is greater than ALPHA/BETA.
381 Compare RC versions.
389 Alpha.
391 Alpha is less than minor version
392 && Alpha is less than beta version
393 && Alpha is less than RC version.
397 Compare alpha versions.
405 Beta.
407 Beta is less than minor version
408 && Beta is less than RC version.
412 Beta is greater than alpha version.
416 Compare beta versions.

Api.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
55 false or filename in /yaml/test
101 DB link.
107 '
120 get the request data for processing.
128 validate user access rights for the call.
134 fetch the cache of the call, and process into output if it is not stale
140 set fragments in Meta class
150 process the call
156 store the results in cache for next time
356 traverse through each attribute on the node
358 $value is a processor and has not been calculated yet, add it to the front of $stack
362 We have the first instance of an unprocessed attribute, so re-add $node to the stack
367 $value is an array of values, add to $stack
372 We have the first instance of an unprocessed attribute, so re-add $node to the stack
381 No new attributes have been added to the stack, so we can process the node
383 traverse through each attribute on the node and place values from $results into $node
386 single processor - if value exists in $results,
387 replace value in $node with value from $results
393 array of values - loop through values and if value exists in $results,
394 replace indexed value in $node with value from $results
427 Default response output if no output defined.
431 Test for single output defined.
437 Output format is response, so set the output format from the request header.
444 Return the output to the correct format and return in the response.
447 Process an output item to a remote server.

ApiException.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Cache.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Config.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToArrayTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToBooleanTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToFileTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToFloatTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToHtmlTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToImageTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToIntegerTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToJsonTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
85 Empty string should be returned as double quotes so that it is not returned as null.
88 Wrap in double quotes if not already present.

ConvertToTextTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ConvertToXmlTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
49 ');
65 ');
81 ');
97 apiOpenStudioWrapper');

Curl.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

DataContainer.php

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

DetectTypeTrait.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Entity.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Error.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Hash.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

MonologWrapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
55 Define line formatters.
65 Define handlers.
71 Create the Logger stream with assigned handlers.

Normalise.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
181 ', $str) == 1) {
182 ', '', $str);
184 ', $str) == 1) {
187 ', $str) == 1) {
190 ', $str) == 1) {
193 ', $str) == 1) {
196 ', $str) == 1) {
210 test for array
214 test for JSON
219 test for XML
231 github.com/gaarf/XML-string-to-PHP-array
273 Has attributes but isn't an array
274 Change output into an array.
302 Convert to array
312 Parse XML
313 Convert to stdclass
324 Convert to stdclass

ProcessorEntity.php

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

ProcessorHelper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Request.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ResourceValidator.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
77 Check mandatory elements exists in data.
89 Validate for identical IDs.
92 Validate dictionaries.
250 validate cardinality
252 check for nothing to validate and if that is ok.

Utilities.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
205 ' . $address . (($port == 80) ? '' : ":$port") . $uri;
232 '
247 ' . $a_selfUrl['address'] . $a_selfUrl['uri']);
308 Try to make each directory world writable.
317 Recurse into subdirectories
321 Try to make each file world writable.
344 Nginx or fast CGI.
348 Server-side fix for bug in old Android versions (a nice side-effect of this fix means we don't care about
349 capitalization for Authorization)

Account.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

AccountMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Application.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ApplicationMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ExternalUser.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ExternalUserMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Invite.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

InviteMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Mapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
154 Add filter by keyword.
176 Add order by.
186 Add limit.

Resource.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ResourceMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
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
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

RoleMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

User.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
311 Generate hash.

UserMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

UserRole.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

UserRoleMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

VarStore.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

VarStoreMapper.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

AuthBasic.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

AuthBearerToken.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

AuthCookie.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

AuthDigest.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

AuthOauth.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Url.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
57 phpcs:ignore
94 phpcs:ignore
104 phpcs:ignore
141 get static curl options for this call
153 get auth
158 send request
183 test for array
187 test for JSON
192 test for XML

Email.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

File.php

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

Html.php

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

Image.php

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

Json.php

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

OctetStream.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Output.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Plain.php

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

Text.php

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

Xml.php

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

AccountCreate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

AccountDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
70 Do not delete if applications are attached to the account.

AccountRead.php

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

AccountUpdate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ApplicationCreate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ApplicationDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ApplicationRead.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
62 phpcs:ignore
72 phpcs:ignore
145 Filter params.

ApplicationUpdate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Cast.php

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

Collection.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
67 Convert the container of single type into a container of array.
71 Convert single value into an array container.

Concatenate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Equation.php

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

FieldValue.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Filter.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
58 phpcs:ignore
77 phpcs:ignore
87 phpcs:ignore
117 Nothing to filter.
122 Test for multiple filters if regex (not allowed because it is inefficient).
127 Regex filter accepted as a string, convert to array so it is always an array
149 wpscholar.com/blog/filter-multidimensional-array-php/
150 www.phptherightway.com/pages/Functional-Programming.html

Fragment.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

GeoPoint.php

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

IfThenElse.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

InviteAccept.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

InviteCreate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

InviteDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

InviteRead.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

JsonPath.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
221 phpcs:ignore
231 phpcs:ignore
241 phpcs:ignore

Literal.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

LoginStoreDrupal.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
43 phpcs:ignore
57 phpcs:ignore

Merge.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

PasswordReset.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
142 Initial password reset request.
143 Set the token and send the email.
183 Final password reset step - we should have a password and token.

Processors.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

Replace.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ResourceBase.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
47 phpcs:ignore
79 phpcs:ignore
89 phpcs:ignore
99 phpcs:ignore
301 Prevent unauthorised editing of admin resources.
341 check mandatory elements exists in data
368 validate for identical IDs
371 validate dictionaries
373 check for identical IDs
497 validate cardinality
499 check for nothing to validate and if that is ok.

ResourceCreate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
185 Validate the application exists.
191 Validate application is not core and core not locked.
200 Validate user has developer role for the application
212 Validate the resource does not already exist.

ResourceDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
123 Validate resource exists.
129 Validate user has Developer access to its application.
141 Validate deleting core resource and core resources not locked.

ResourceExport.php

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

ResourceImport.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
151 Only developer role permitted to upload resource.
167 Validate the YAML/JSON.
188 Validate required keys in the imported file.
195 Validate TTL in the imported file.
201 Validate user has developer role for the appid.
217 Validate the application exists.
229 Validate the account exists.
245 Validate the resource does not already exist.
256 Merge the sections into final metadata.
268 Validate the metadata.

ResourceRead.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ResourceSwagger.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
247 strongly typed

ResourceUpdate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
208 Invalid resource.
213 Validate user role access to the resource or the proposed resource.
233 Update to core application and is locked.

RoleCreate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

RoleDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
93 Update to core application and is locked.

RoleRead.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

RoleUpdate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
103 Update to core application and is locked.

Sort.php

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

UserCreate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

UserDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

UserRead.php

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

UserRoleCreate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
128 Validate user role attributes exist.
150 Validate roles that do not need appid or accid
160 Administrator or Account manager should not be assigned an appid.
164 Administrator should not be assigned an accid.

UserRoleDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

UserRoleRead.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

UserUpdate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
253 Non-privileged accounts can only edit their own accounts.

VarBody.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
41 phpcs:ignore
87 input');

VarBool.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

VarField.php

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

VarFile.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
49 phpcs:ignore
59 phpcs:ignore
78 phpcs:ignore
202 todo Add a detectType function.
220 www.php.net/manual/en/features.file-upload.php

VarFloat.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

VarGet.php

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

VarInt.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

VarLooselyTyped.php

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

VarObject.php

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

VarPost.php

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

VarRand.php

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

VarRequest.php

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

VarStoreCreate.php

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

VarStoreDelete.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
110 Validate access to the existing var's application

VarStoreRead.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
44 phpcs:ignore
49 phpcs:ignore

VarStoreUpdate.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
132 Validate access to the existing var's application
145 Validate access to the var's NEW application

VarStr.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

VarTemporary.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
35 phpcs:ignore
67 phpcs:ignore

VarUri.php

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

XmlPath.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
84 bookstore/book[1]/price"
95 bookstore/book[1]/price"
249 phpcs:ignore
446 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
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
35 phpcs:ignore

GenerateToken.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
81 Verify User credentials.
85 Invalid username or user inactive.
91 No password hash stored yet.
97 Invalid password.
103 Get all user roles.

ValidateToken.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com

ValidateTokenRoles.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
53 phpcs:ignore
63 phpcs:ignore
90 Get roles and validate the user against them.
110 Do not validate accid or appid for Administrator role.
115 Only validate accid for Account manager role.
119 Normal user, validate role, accid, appid

core_updates_v0.0-example.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
28 Do Something

core_updates_v1.0-alpha.php

Type Line Description
8 gitlab.com/john89)
12 www.apiopenstudio.com/license/.
13 www.apiopenstudio.com
29 gitlab.com/apiopenstudio/apiopenstudio/-/issues/54
64 gitlab.com/apiopenstudio/apiopenstudio/-/issues/54
76 Find the old Functions processor in the DB.
91 Load the data from the new Processors processor file.
113 Delete the old Functions processor.
121 Insert the new Processors processor.
141 gitlab.com/apiopenstudio/apiopenstudio/-/issues/101
146 Drop the unused token coumns from the user table.
187 gitlab.com/apiopenstudio/apiopenstudio/-/issues/127
191 Update all core resources.

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

Search results