vB_Api_Stylevar
extends vB_Api
in package
vB_Api_Stylevar
Tags
Table of Contents
- $controller : string
- API Controller
- $db : vB_Database
- Database object.
- $disabled : bool
- Indicates whether the API was disabled
- $disableFalseReturnOnly : array<string|int, mixed>
- Contains white listed methods which return a false response when API is disabled in special scenarios like forum closed, password expiry, ip ban and others.
- $disableWhiteList : array<string|int, mixed>
- Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.
- $cssMappings : mixed
- $instances : mixed
- $instancesRaw : array<string|int, mixed>
- We want API subclasses to access the instances only through getters
- $vb4_input_mappings : mixed
- $wrappers : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- callNamed() : The
- Call the given api function by name with a named arguments list.
- canCustomizeProfile() : mixed
- This is just a public method for calling the hasPermissions method
- canSaveDefault() : bool
- Checkes if the current loged user has admin permisions for administration of styles
- checkApiState() : mixed
- This method checks whether the API method is enabled.
- clearCache() : mixed
- Clears all previously loaded API objects.
- delete() : mixed
- Deletes the listed stylevars for the current user Pass false to delete all the stylevars for the current user
- fetch() : array<string|int, mixed>
- Fetches the stylevar values for the user $userid Pass false for $stylevars to get all the stylevars Pass 0 for userid to retrieve the stylevar for the current user Returns an associative array with keys being the list specified in the $stylevar If any of the stylevars is not customized for the specified user, the value from the default stylevar will be returned instead Pass false for $falback to limit the results to the custom stylevars only
- fetch_default_stylevar() : mixed
- fetch_user_stylevars() : array<string|int, mixed>
- Fetches the stylevar values for the user $userid
- fetchCustomizationPermissions() : array<string|int, mixed>
- Returns all the permissions that the currently logged user has for customizing profile
- get() : array<string|int, mixed>
- Fetches the value of the stylevar for the user $userid Pass 0 for userid to retrieve the stylevar for the current user If the stylevar is not customized for the specified user, the value from the default stylevar will be returned Pass false for $falback to limit the results to the custom stylevar only
- getApiClassName() : mixed
- 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
- isProfileCustomized() : bool
- Check whether the profile page of an user is customized
- 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.
- save() : mixed
- Saves the stylevars specified in the array for the current user
- save_default() : mixed
- Saves the stylevars specified in the array as default style for the whole site
- __construct() : mixed
- checkHasAdminPermission() : none
- Determines if the calling user has the given admin permission, and if not throws an exception
- checkHasPermission() : none
- Determines if the calling user has the given bitfield permission, and if not, throws a 'no_permission' exception.
- checkIsLoggedIn() : mixed
- Determines if the calling user has the given admin permission, and if not throws an exception
- getApiClass() : mixed
- getApiClassNameInternal() : mixed
- hasAdminPermission() : bool
- Determines if the calling user has the given admin permission
- inDebugMode() : mixed
- isDisableFalseReturnOnly() : bool
- Checks if method returns false response only when API is disabled.
- isWhiteListed() : bool
- Checks if method is white listed when API is disabled.
- setController() : mixed
- Set controller
- cms_vb4_to_vb5_method_mapping() : mixed
- default_vb4_to_vb5_method_mapping() : mixed
- hasAdminPermissionInternal() : mixed
- Internal function to power the previous cover functions
- hasPermissions() : bool
- Checks if the currently logged user has permissions for profile style customization
- remove_nulls() : mixed
- wrapLoggerIfNeeded() : mixed
- Wrap the api object with the log wrapper class if needed.
Properties
$controller
API Controller
protected
string
$controller
$db
Database object.
protected
vB_Database
$db
$disabled
Indicates whether the API was disabled
protected
bool
$disabled
= alse
$disableFalseReturnOnly
Contains white listed methods which return a false response when API is disabled in special scenarios like forum closed, password expiry, ip ban and others.
protected
array<string|int, mixed>
$disableFalseReturnOnly
= array()
$disableWhiteList
Contains white listed methods which act as normal when API is disabled no matter of special scenarios like forum closed, password expiry, ip ban and others.
protected
array<string|int, mixed>
$disableWhiteList
= array()
$cssMappings
private
static mixed
$cssMappings
= array(
// Background Stylevars
"profcustom_navbar_background_active" => 'bgimage',
"profcustom_navbar_background" => 'bgimage',
"profcustom_navbarbutton_background" => 'bgimage',
"profile_button_secondary_background" => 'bgimage',
"toolbar_background" => 'bgimage',
"profile_content_background" => 'bgimage',
"profile_section_background" => 'bgimage',
"profilesidebar_button_background" => 'bgimage',
"side_nav_background" => 'bgimage',
"profile_button_primary_background" => 'bgimage',
// Border
"profcustom_navbar_border_active" => 'borders',
"profcustom_navbar_border" => 'borders',
"profcustom_navbarbutton_border" => 'borders',
"side_nav_divider_border" => 'borders',
"profcustom_navbarbuttonsecondary_border" => 'borders',
"profile_content_border" => 'borders',
"profile_content_divider_border" => 'borders',
"profile_section_border" => 'borders',
"form_dropdown_border" => 'borders',
"side_nav_avatar_border" => 'borders',
"side_nav_divider_border" => 'borders',
"profilesidebar_button_border" => 'borders',
"button_primary_border" => 'borders',
// Color
"profcustom_navbar_text_color_active" => 'colors',
"profcustom_navbar_text_color" => 'colors',
"profcustom_navbar_toolbar_text_color" => 'colors',
"profile_section_text_color" => 'colors',
"profcustom_navbarbutton_color" => 'colors',
"profcustom_navbarbuttonsecondary_color" => 'colors',
"profile_content_primarytext" => 'colors',
"profile_content_secondarytext" => 'colors',
"profile_content_linktext" => 'colors',
"profile_userpanel_textcolor" => 'colors',
"profile_userpanel_linkcolor" => 'colors',
"profilesidebar_button_text_color" => 'colors',
"button_primary_text_color" => 'colors',
// Font family
"profile_section_font" => 'fontfamily',
"profile_content_font" => 'fontfamily',
"profile_userpanel_font" => 'fontfamily',
)
$instances
private
static mixed
$instances
$instancesRaw
We want API subclasses to access the instances only through getters
private
static array<string|int, mixed>
$instancesRaw
$vb4_input_mappings
private
static mixed
$vb4_input_mappings
= array(
'blog.post_comment' => array('method' => 'vb4_blog.post_comment'),
'blog.post_postcomment' => array('method' => 'vb4_blog.post_postcomment'),
'blog.post_updateblog' => array('method' => 'vb4_blog.post_updateblog'),
'blog.post_newblog' => array('method' => 'vb4_blog.post_newblog'),
'blog.post_editblog' => array('method' => 'vb4_blog.post_editblog'),
'blog_list' => array('method' => 'vb4_blog.bloglist'),
'api_init' => array('method' => 'api.init'),
'api_cmssectionlist' => array('method' => 'Vb4_Cms.sectionlist'),
'api_cmscategorylist' => array('method' => 'Vb4_Cms.categorylist'),
/*
// These can no longer be mapped directly to vB_Api_User::login/logout
// due to additional processing of devicetoken that may be required
// for mapi calls.
'login_login' => array(
'method' => 'user.login',
'request_mappings' => array(
'vb_login_username' => 'username',
'vb_login_password' => 'password',
'vb_login_md5password' => 'md5password',
'vb_login_md5password_utf' => 'md5passwordutf'
)
),
'login_logout' => array(
'method' => 'user.logout'
),
*/
'get_vbfromfacebook' => array('method' => 'vb4_facebook.getVbfromfacebook'),
)
$wrappers
private
static mixed
$wrappers
Methods
__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —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.
canCustomizeProfile()
This is just a public method for calling the hasPermissions method
public
canCustomizeProfile() : mixed
Return values
mixed —canSaveDefault()
Checkes if the current loged user has admin permisions for administration of styles
public
canSaveDefault() : bool
Return values
bool —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 —delete()
Deletes the listed stylevars for the current user Pass false to delete all the stylevars for the current user
public
delete([array<string|int, mixed>|false $stylevars = array() ]) : mixed
Parameters
- $stylevars : array<string|int, mixed>|false = array()
-
- list of stylevar names to delete
Return values
mixed —fetch()
Fetches the stylevar values for the user $userid Pass false for $stylevars to get all the stylevars Pass 0 for userid to retrieve the stylevar for the current user Returns an associative array with keys being the list specified in the $stylevar If any of the stylevars is not customized for the specified user, the value from the default stylevar will be returned instead Pass false for $falback to limit the results to the custom stylevars only
public
fetch([array<string|int, mixed>|false $stylevars = array() ], int $userid[, bool $fallback = true ]) : array<string|int, mixed>
WARNING: This returns the value as stored in the stylevar. If the stylevar inherits from another stylevar, it WILL NOT return the final, rendered, inherited value that should be used for display. To get the final, inherited value that should be used, use the template runtime fetchStyleVar or fetchCustomStylevar methods, which resolve inheritance.
Parameters
- $stylevars : array<string|int, mixed>|false = array()
- $userid : int
- $fallback : bool = true
Return values
array<string|int, mixed> —fetch_default_stylevar()
public
fetch_default_stylevar([mixed $stylevars = array() ][, mixed $styleid = false ]) : mixed
Parameters
- $stylevars : mixed = array()
- $styleid : mixed = false
Return values
mixed —fetch_user_stylevars()
Fetches the stylevar values for the user $userid
public
fetch_user_stylevars(int $userid) : array<string|int, mixed>
Parameters
- $userid : int
Return values
array<string|int, mixed> —fetchCustomizationPermissions()
Returns all the permissions that the currently logged user has for customizing profile
public
fetchCustomizationPermissions() : array<string|int, mixed>
Return values
array<string|int, mixed> —get()
Fetches the value of the stylevar for the user $userid Pass 0 for userid to retrieve the stylevar for the current user If the stylevar is not customized for the specified user, the value from the default stylevar will be returned Pass false for $falback to limit the results to the custom stylevar only
public
get(mixed $stylevarname, int $userid[, bool $fallback = true ], int $styleid) : array<string|int, mixed>
WARNING: This returns the value as stored in the stylevar. If the stylevar inherits from another stylevar, it WILL NOT return the final, rendered, inherited value that should be used for display. To get the final, inherited value that should be used, use the template runtime fetchStyleVar or fetchCustomStylevar methods, which resolve inheritance.
Parameters
- $stylevarname : mixed
- $userid : int
- $fallback : bool = true
- $styleid : int
Return values
array<string|int, mixed> —valid key should be the value of the $stylevars
getApiClassName()
public
static getApiClassName(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
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 —isProfileCustomized()
Check whether the profile page of an user is customized
public
isProfileCustomized( $userid) : bool
Parameters
Return values
bool —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 —save()
Saves the stylevars specified in the array for the current user
public
save(array<string|int, mixed> $stylevars) : mixed
Parameters
- $stylevars : array<string|int, mixed>
-
- associative array like array('activity_stream_avatar_border_color' => array('color' => '#123456'))
Return values
mixed —save_default()
Saves the stylevars specified in the array as default style for the whole site
public
save_default(array<string|int, mixed> $stylevars) : mixed
Parameters
- $stylevars : array<string|int, mixed>
-
- associative array
Return values
mixed —__construct()
protected
__construct() : mixed
Return values
mixed —checkHasAdminPermission()
Determines if the calling user has the given admin permission, and if not throws an exception
protected
checkHasAdminPermission(string|array<string|int, mixed> $adminPermission) : none
Checks for:
- A valid CP Session
- The passed adminpermission.
Parameters
- $adminPermission : string|array<string|int, mixed>
-
The admin permission to check. If an array then the check passes if the user has any of the permissions given.
Tags
Return values
none —checkHasPermission()
Determines if the calling user has the given bitfield permission, and if not, throws a 'no_permission' exception.
protected
checkHasPermission(string $group, string $permission) : none
Parameters
- $group : string
-
The permission group where the permission is located
- $permission : string
-
The permission to check
Tags
Return values
none —checkIsLoggedIn()
Determines if the calling user has the given admin permission, and if not throws an exception
protected
checkIsLoggedIn() : mixed
Return values
mixed —getApiClass()
protected
static getApiClass(mixed $controller[, mixed $errorCheck = true ]) : mixed
Parameters
- $controller : mixed
- $errorCheck : mixed = true
Return values
mixed —getApiClassNameInternal()
protected
static getApiClassNameInternal(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —hasAdminPermission()
Determines if the calling user has the given admin permission
protected
hasAdminPermission(string|array<string|int, mixed> $adminPermission) : bool
Useful if you need to know if the calling user but do not care why they do not have that permission. Generally useful if there is a behavior difference between admins and non admins, but the call can be processed for either.
Parameters
- $adminPermission : string|array<string|int, mixed>
-
The admin permission to check. If an array then the check passes if the user has any of the permissions given.
Return values
bool —true if checks pass, false otherwise
inDebugMode()
protected
inDebugMode() : mixed
Return values
mixed —isDisableFalseReturnOnly()
Checks if method returns false response only when API is disabled.
protected
isDisableFalseReturnOnly(mixed $method) : bool
Parameters
- $method : mixed
Return values
bool —Indicates whether method returns false response only.
isWhiteListed()
Checks if method is white listed when API is disabled.
protected
isWhiteListed(mixed $method) : bool
Parameters
- $method : mixed
Return values
bool —Indicates whether method is or is not a white list.
setController()
Set controller
protected
setController(mixed $controller) : mixed
Parameters
- $controller : mixed
Return values
mixed —cms_vb4_to_vb5_method_mapping()
private
static cms_vb4_to_vb5_method_mapping(mixed $method, mixed &$request) : mixed
Parameters
- $method : mixed
- $request : mixed
Return values
mixed —default_vb4_to_vb5_method_mapping()
private
static default_vb4_to_vb5_method_mapping(mixed $method) : mixed
Parameters
- $method : mixed
Return values
mixed —hasAdminPermissionInternal()
Internal function to power the previous cover functions
private
hasAdminPermissionInternal(mixed $adminPermission) : mixed
@param string|array $adminPermission The admin permission to check. If an array
then the check passes if the user has any of the permissions given.
Parameters
- $adminPermission : mixed
Return values
mixed —hasPermissions()
Checks if the currently logged user has permissions for profile style customization
private
hasPermissions() : bool
Return values
bool —remove_nulls()
private
static remove_nulls(mixed &$data) : mixed
Parameters
- $data : mixed
Return values
mixed —wrapLoggerIfNeeded()
Wrap the api object with the log wrapper class if needed.
private
static wrapLoggerIfNeeded(mixed $controller, mixed $api_object) : mixed
Parameters
- $controller : mixed
- $api_object : mixed