vB_Api_NodeField
extends vB_Api
in package
Table of Contents
- __serialize() : array<string|int, mixed>
- __sleep() : array<string|int, mixed>
- __unserialize() : void
- __wakeup() : void
- callNamed() : The
- Call the given api function by name with a named arguments list.
- checkApiState() : mixed
- This method checks whether the API method is enabled.
- clearCache() : mixed
- Clears all previously loaded API objects.
- deleteCategory() : mixed
- deleteField() : mixed
- getApiClassName() : mixed
- getCategory() : mixed
- Get a category
- getCategoryList() : array<string|int, mixed>
- Get the list of categories
- getField() : mixed
- getFieldList() : mixed
- getFieldsForChannel() : mixed
- getFieldsForNode() : mixed
- getFieldValuesForDisplay() : array<string|int, mixed>
- Return the values for display.
- instance() : vB_Api
- Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
- instanceInternal() : vB_Api
- Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
- map_vb4_input_to_vb5() : string
- Returns vb5 api method name.
- map_vb5_errors_to_vb4() : mixed
- Alters the error array in any way necessary to interface correctly with vb4.
- map_vb5_output_to_vb4() : mixed
- Alters the output array in any way necessary to interface correctly with vb4.
- saveCategory() : array<string|int, mixed>
- Save a category value.
- saveField() : mixed
Methods
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —__sleep()
public
__sleep() : array<string|int, mixed>
Return values
array<string|int, mixed> —__unserialize()
public
__unserialize(array<string|int, mixed> $serialized) : void
Parameters
- $serialized : array<string|int, mixed>
Return values
void —__wakeup()
public
__wakeup() : void
Return values
void —callNamed()
Call the given api function by name with a named arguments list.
public
callNamed() : The
Used primarily to translate REST requests into API calls.
Return values
The —return of the method or an error if the method doesn't exist, or is static, a constructor or destructor, or otherwise shouldn't be callable as and API method. It is also an error if the value of a paramater is not provided and that parameter doesn't have a default value.
checkApiState()
This method checks whether the API method is enabled.
public
checkApiState(mixed $method) : mixed
For extensions check make sure $controller property is already set.
Parameters
- $method : mixed
Return values
mixed —clearCache()
Clears all previously loaded API objects.
public
static clearCache() : mixed
Intended for use in tests where the loading pattern can cause issues with objects that cache thier own data.
Return values
mixed —deleteCategory()
public
deleteCategory(mixed $categoryid) : mixed
Parameters
- $categoryid : mixed
Return values
mixed —deleteField()
public
deleteField(mixed $fieldid) : mixed
Parameters
- $fieldid : mixed
Return values
mixed —getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —getCategory()
Get a category
public
getCategory(int $categoryid) : mixed
Parameters
- $categoryid : int
Return values
mixed —getCategoryList()
Get the list of categories
public
getCategoryList() : array<string|int, mixed>
Return values
array<string|int, mixed> —-- ['categorylist' => $list]
getField()
public
getField(mixed $fieldid) : mixed
Parameters
- $fieldid : mixed
Return values
mixed —getFieldList()
public
getFieldList([mixed $fieldid = null ]) : mixed
Parameters
- $fieldid : mixed = null
Return values
mixed —getFieldsForChannel()
public
getFieldsForChannel(mixed $channelid) : mixed
Parameters
- $channelid : mixed
Return values
mixed —getFieldsForNode()
public
getFieldsForNode(mixed $nodeid) : mixed
Parameters
- $nodeid : mixed
Return values
mixed —getFieldValuesForDisplay()
Return the values for display.
public
getFieldValuesForDisplay(int $nodeid) : array<string|int, mixed>
Return the values for the node structured by the categories. This differs from getFieldsForNode in that it only returns categories for which the node has saved values. It does not return fields for which the value is blank, nor does it return categories for which all fields are blank.
Parameters
- $nodeid : int
Return values
array<string|int, mixed> —instance()
Returns an instance of the API object which translates exceptions to an array Use this method for API clients.
public
static instance(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_Api —instanceInternal()
Returns an instance of the API object which doesn't handle exceptions This should only be used in other API objects, not for clients of the API
public
static instanceInternal(string $controller[, bool $refresh_cache = false ]) : vB_Api
Parameters
- $controller : string
-
-- name of the API controller to load
- $refresh_cache : bool = false
-
-- true if we want to force the cache to update with a new api object primarily intended for testing
Return values
vB_Api —map_vb4_input_to_vb5()
Returns vb5 api method name.
public
static map_vb4_input_to_vb5(string $method, array<string|int, mixed> &$request) : string
May alter request array.
Parameters
- $method : string
-
-- vb4 method name
- $request : array<string|int, mixed>
-
-- $_REQUEST array for this api request
Return values
string —map_vb5_errors_to_vb4()
Alters the error array in any way necessary to interface correctly with vb4.
public
static map_vb5_errors_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- error array from vb5
Return values
mixed —map_vb5_output_to_vb4()
Alters the output array in any way necessary to interface correctly with vb4.
public
static map_vb5_output_to_vb4(string $method, array<string|int, mixed> &$data) : mixed
Parameters
- $method : string
-
-- vb4 method name
- $data : array<string|int, mixed>
-
-- output array from vb5
Return values
mixed —saveCategory()
Save a category value.
public
saveCategory(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
-- int nodefieldcategoryid -- optional. If provided will update the category string title -- the name of the category
Return values
array<string|int, mixed> —-- ['categoryid' => $id]
saveField()
public
saveField(mixed $data) : mixed
Parameters
- $data : mixed