API Documentation
\
phpWTL
LogWriter
DBLW
FLW
Tools

\phpWTLDataRetrievalPolicyHelper

Helper class for data retrieval policies

Summary

Methods
Properties
Constants
existsDataRetrievalPolicy()
getDataRetrievalPolicyNames()
getDataRetrievalPolicyDescription()
getDataRetrievalPolicyAttributeNames()
getDataRetrievalPolicyAttribute()
setDataRetrievalPolicyAttribute()
getDataRetrievalPolicyFlag()
getDataRetrievalPolicyParameter()
setDataRetrievalPolicyFlag()
setDataRetrievalPolicyParameter()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

existsDataRetrievalPolicy()

existsDataRetrievalPolicy(array  $retrievalPolicies, string  $policy_name) : boolean

Check the existence of a specific retrieval policy.

Parameters

array $retrievalPolicies

Array of DataRetrievalPolicy objects.
string $policy_name

Returns

boolean

getDataRetrievalPolicyNames()

getDataRetrievalPolicyNames(array  $retrievalPolicies) : array

Get the names of all retrieval policies.

Parameters

array $retrievalPolicies

Array of DataRetrievalPolicy objects.

Returns

array

getDataRetrievalPolicyDescription()

getDataRetrievalPolicyDescription(array  $retrievalPolicies, string  $policy_name) : object

Get the DataRetrievalPolicy object of a specific retrieval policy.

Parameters

array $retrievalPolicies

Array of DataRetrievalPolicy objects.
string $policy_name

Returns

object

getDataRetrievalPolicyAttributeNames()

getDataRetrievalPolicyAttributeNames(array  $retrievalPolicies) : array

Get the attribute names of an DataRetrievalPolicy object (based on the given array).

Parameters

array $retrievalPolicies

Array of DataRetrievalPolicy objects.

Returns

array

getDataRetrievalPolicyAttribute()

getDataRetrievalPolicyAttribute(array  $retrievalPolicies, string  $policy_name, string  $attribute_name) : string

Parameters

array $retrievalPolicies

Array of DataRetrievalPolicy objects.
string $policy_name

Name of the desired policy.
string $attribute_name

Name of the DataRetrievalPolicy attribute.

Returns

string —

Value of the DataRetrievalPolicy attribute for the desired policy name.

setDataRetrievalPolicyAttribute()

setDataRetrievalPolicyAttribute(array  $retrievalPolicies, string  $policy_name, string  $attribute_name, string  $value)

Parameters

array $retrievalPolicies

Array of DataRetrievalPolicy objects.
string $policy_name

Name of the desired policy.
string $attribute_name

Name of the DataRetrievalPolicy attribute ("name", because it serves as an ID, is immutable).
string $value

Value to assign the DataRetrievalPolicy attribute for the desired policy name.

getDataRetrievalPolicyFlag()

getDataRetrievalPolicyFlag(  $retrievalPolicies,   $policy_name)

Parameters

$retrievalPolicies
$policy_name

getDataRetrievalPolicyParameter()

getDataRetrievalPolicyParameter(  $retrievalPolicies,   $policy_name)

Parameters

$retrievalPolicies
$policy_name

setDataRetrievalPolicyFlag()

setDataRetrievalPolicyFlag(  $retrievalPolicies,   $policy_name,   $value)

Parameters

$retrievalPolicies
$policy_name
$value

setDataRetrievalPolicyParameter()

setDataRetrievalPolicyParameter(  $retrievalPolicies,   $policy_name,   $value)

Parameters

$retrievalPolicies
$policy_name
$value