vBulletin v6.0.4

vB_DataManager_StyleVarCustom extends vB_DataManager_StyleVar
in package

Application

Abstract class to do data save/delete operations for StyleVar.

Properties

$condition : string: Condition to be used. Can be either ['keyfield' => 'value'] or a valid assertor vB_dB_Query::CONDITIONS_KEY setting.
$datatype : string: Local value telling us what datatype this is; saves the resources of gettype()
$error_handler : string: The error handler for this object
$errors : array<string|int, mixed>: Array to store any errors encountered while building data
$existing : array<string|int, mixed>: Array to store existing data
$info : array<string|int, mixed>: Array to store information
$validfields : array<string|int, mixed>: Array of recognised and required fields for stylevar, and their types

Methods

__construct() : mixed: Constructor - Checks for necessity of registry object
__serialize() : array<string|int, mixed>
__sleep() : array<string|int, mixed>
__unserialize() : void
__wakeup() : void
add_child() : mixed: Adds a child field to the custom stylevar
build() : bool: database build method that builds the data into our value field
check_required() : bool: Checks through the required fields for this object and ensures that all required fields have a value
db_insert() : int: Creates and runs an INSERT query to save the data from the object into the database
db_update() : bool: Creates and runs an UPDATE query to save the data from the object into the database
delete() : int: Deletes the specified data item from the database
do_set() : mixed: Takes valid data and sets it as part of the data to be saved
do_set_child() : mixed: Takes valid data and sets it as part of the child data to be saved
do_unset() : mixed: Unsets a values that has already been set
error() : mixed: Shows an error message and halts execution
fetch_field() : mixed: Fetches info about the current data object - if a new value is set, it returns this, otherwise it will return the existing data
get_child() : mixed
get_errors() : array<string|int, mixed>: Returns the array of errors
get_exception() : mixed
has_errors() : bool: Check if the DM currently has errors. Will kill execution if it does and $die is true.
is_bitfield_set() : bool: Determines if a bitfield value has been set
is_child_field() : mixed
is_field_defined() : mixed
is_field_set() : mixed: Determines if a field is set
post_save_each() : mixed: Additional data to update after a save call (such as denormalized values in other tables).
post_save_once() : mixed: Additional data to update after a save call (such as denormalized values in other tables).
pre_save() : bool: Any checks to run immediately before saving. If returning false, the save will not take place.
save() : mixed: Saves the data from the object into the specified database tables
set() : bool: Sets the supplied data to be part of the data to be saved. Use setr() if a reference to $value is to be passed
set_bitfield() : bool: Sets a bit in a bitfield
set_child() : bool: Sets the supplied data to be part of the data to be build into value.
set_condition() : mixed: Sets the condition to be used in WHERE clauses, based upon the $this->existing data and the $this->condition_constuct condition template.
set_existing() : bool: Sets the existing data
set_info() : mixed: Rather like set(), but sets data into the $this->info array instead. Use setr_info if $value if a reference to value is to be passed
setr() : bool: Sets the supplied data to be part of the data to be saved
setr_info() : mixed: Rather like set(), but sets reference to data into the $this->info array instead
setSkipRebuild() : void: For batch operations we'll skip the style rebuild since it only needs to happen once
verify() : bool: Verifies that the supplied data is one of the fields used by this object
verify_background_position() : mixed
verify_boolean() : mixed
verify_borderstyle() : mixed
verify_child() : bool: Verifies that the supplied child data is one of the fields used by this object
verify_color() : mixed
verify_css_scalar() : mixed: Generic function to validate css values
verify_date_array() : bool: Verifies a date array as a valid unix timestamp
verify_email() : bool: Verifies that an email address is valid
verify_font_size() : mixed
verify_fontfamily() : mixed
verify_fontlist() : mixed
verify_fontstyle() : mixed
verify_fontvariant() : mixed
verify_fontweight() : mixed
verify_gradient_direction() : mixed
verify_gradient_type() : mixed
verify_height() : mixed
verify_image() : mixed
verify_lineheight() : mixed
verify_link() : bool: Verifies that a hyperlink is valid
verify_margin() : mixed
verify_md5() : bool: Verifies that a string is an MD5 string
verify_repeat() : mixed
verify_size() : mixed
verify_stylevar() : mixed
verify_textalign() : mixed
verify_texttransfrom() : mixed
verify_units() : mixed
verify_url() : mixed
verify_username() : bool: Verifies that the provided username is valid, and attempts to correct it if it is not valid
verify_value_inherit_param_color() : mixed
verify_value_stylevar() : mixed
verify_width() : mixed

$condition

Condition to be used. Can be either ['keyfield' => 'value'] or a valid assertor vB_dB_Query::CONDITIONS_KEY setting.


    public
        string
    $condition
     = \null

$datatype

Local value telling us what datatype this is; saves the resources of gettype()


    public
        string
    $datatype
     = 'Custom'

$error_handler

The error handler for this object


    public
        string
    $error_handler
     = \vB_DataManager_Constants::ERRTYPE_STANDARD

$errors

Array to store any errors encountered while building data


    public
        array<string|int, mixed>
    $errors
     = []

$existing

Array to store existing data


    public
        array<string|int, mixed>
    $existing
     = []

$info

Array to store information


    public
        array<string|int, mixed>
    $info
     = []

$validfields

Array of recognised and required fields for stylevar, and their types


    public
        array<string|int, mixed>
    $validfields
     = ['stylevarid' => [\vB_Cleaner::TYPE_STR, \vB_DataManager_Constants::REQ_YES, \vB_DataManager_Constants::VF_METHOD, 'verify_stylevar'], 'styleid' => [\vB_Cleaner::TYPE_INT, \vB_DataManager_Constants::REQ_YES, \vB_DataManager_Constants::VF_METHOD], 'dateline' => [\vB_Cleaner::TYPE_UNIXTIME, \vB_DataManager_Constants::REQ_AUTO], 'username' => [\vB_Cleaner::TYPE_STR, \vB_DataManager_Constants::REQ_NO], 'value' => [\vB_Cleaner::TYPE_ARRAY_STR, \vB_DataManager_Constants::REQ_NO, \vB_DataManager_Constants::VF_METHOD, 'verify_serialized']]

__construct()

Constructor - Checks for necessity of registry object


    public
                    __construct([vB_Registry $registry = NULL ][, int $errtype = NULL ]) : mixed

Note that this method will accept only the $errtype parameter (via some magic checking of the parameters) and this is the preferred way of calling the datamanager functions. The registry object is deprecated and will be created internally for those managers that still need it.

Parameters

$registry : vB_Registry = NULL: -- Instance of the vBulletin data registry object - expected to have the database object as one of its $this->db member.
$errtype : int = NULL: --One of the ERRTYPE_x constants

__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>

__wakeup()


    public
                    __wakeup() : void

add_child()

Adds a child field to the custom stylevar


    public
                    add_child(mixed $key, mixed $descriptor) : mixed

Parameters

$key : mixed
$descriptor : mixed

build()

database build method that builds the data into our value field


    public
                    build() : bool

Return values

bool —

True on success; false if an error occurred

check_required()

Checks through the required fields for this object and ensures that all required fields have a value


    public
                    check_required() : bool

Return values

bool —

Returns true if all required fields have a valid value set

db_insert()

Creates and runs an INSERT query to save the data from the object into the database


    public
                    db_insert(mixed $tableprefix, mixed $table[, mixed $doquery = true ][, mixed $replace = false ]) : int

Parameters

$tableprefix : mixed
$table : mixed
$doquery : mixed = true
$replace : mixed = false

Return values

int —

Returns the ID of the inserted record

db_update()

Creates and runs an UPDATE query to save the data from the object into the database


    public
                    db_update(mixed $tableprefix, mixed $table[, mixed $condition = null ][, mixed $doquery = true ][, mixed $delayed = false ][, mixed $affected_rows = false ]) : bool

Parameters

$tableprefix : mixed
$table : mixed
$condition : mixed = null
$doquery : mixed = true
$delayed : mixed = false
$affected_rows : mixed = false

Return values

bool —

Returns true on success

delete()

Deletes the specified data item from the database


    public
                    delete([mixed $doquery = true ]) : int

Parameters

$doquery : mixed = true

Return values

int —

The number of rows deleted

do_set()

Takes valid data and sets it as part of the data to be saved


    public
                    do_set(mixed $fieldname, mixed &$value[, mixed $table = null ]) : mixed

Parameters

$fieldname : mixed
$value : mixed
$table : mixed = null

do_set_child()

Takes valid data and sets it as part of the child data to be saved


    public
                    do_set_child(mixed $fieldname, mixed &$value[, mixed $table = null ]) : mixed

Parameters

$fieldname : mixed
$value : mixed
$table : mixed = null

do_unset()

Unsets a values that has already been set


    public
                    do_unset(mixed $fieldname[, mixed $table = null ]) : mixed

Parameters

$fieldname : mixed
$table : mixed = null

error()

Shows an error message and halts execution


    public
                    error(mixed $errorphrase) : mixed

Parameters

$errorphrase : mixed

fetch_field()

Fetches info about the current data object - if a new value is set, it returns this, otherwise it will return the existing data


    public
                &    fetch_field(mixed $fieldname[, mixed $table = null ]) : mixed

Parameters

$fieldname : mixed
$table : mixed = null

Return values

mixed —

The requested data

get_child()


    public
                    get_child(mixed $fieldname) : mixed

Parameters

$fieldname : mixed

get_errors()

Returns the array of errors


    public
                    get_errors() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_exception()


    public
                    get_exception() : mixed

has_errors()

Check if the DM currently has errors. Will kill execution if it does and $die is true.


    public
                    has_errors([mixed $die = true ]) : bool

Parameters

$die : mixed = true

Return values

bool —

True if there are errors, false otherwise

is_bitfield_set()

Determines if a bitfield value has been set


    public
                    is_bitfield_set(mixed $fieldname, mixed $bitname) : bool

Parameters

$fieldname : mixed
$bitname : mixed

Return values

bool

is_child_field()


    public
                    is_child_field(mixed $fieldname) : mixed

Parameters

$fieldname : mixed

is_field_defined()


    public
                    is_field_defined(mixed $fieldname) : mixed

Parameters

$fieldname : mixed

is_field_set()

Determines if a field is set


    public
                    is_field_set(mixed $field) : mixed

Parameters

$field : mixed

post_save_each()

Additional data to update after a save call (such as denormalized values in other tables).


    public
                    post_save_each([mixed $doquery = true ]) : mixed

In batch updates, is executed for each record updated.

Parameters

$doquery : mixed = true

post_save_once()

Additional data to update after a save call (such as denormalized values in other tables).


    public
                    post_save_once([mixed $doquery = true ]) : mixed

In batch updates, is executed once after all records are updated.

Parameters

$doquery : mixed = true

pre_save()

Any checks to run immediately before saving. If returning false, the save will not take place.


    public
                    pre_save([mixed $doquery = true ]) : bool

Parameters

$doquery : mixed = true

Return values

bool —

True on success; false if an error occurred

save()

Saves the data from the object into the specified database tables


    public
                    save([mixed $doquery = true ][, mixed $delayed = false ][, mixed $affected_rows = false ][, mixed $replace = false ]) : mixed

Parameters

$doquery : mixed = true
$delayed : mixed = false
$affected_rows : mixed = false
$replace : mixed = false

Return values

mixed —

If this was an INSERT query, the INSERT ID is returned

set()

Sets the supplied data to be part of the data to be saved. Use setr() if a reference to $value is to be passed


    public
                    set(mixed $fieldname, mixed $value[, mixed $clean = true ][, mixed $doverify = true ][, mixed $table = null ]) : bool

Parameters

$fieldname : mixed
$value : mixed
$clean : mixed = true
$doverify : mixed = true
$table : mixed = null

Return values

bool —

Returns false if the data is rejected for whatever reason

set_bitfield()

Sets a bit in a bitfield


    public
                    set_bitfield(mixed $fieldname, mixed $bitname, mixed $onoff) : bool

Parameters

$fieldname : mixed
$bitname : mixed
$onoff : mixed

Return values

bool

set_child()

Sets the supplied data to be part of the data to be build into value.


    public
                    set_child(mixed $fieldname, mixed $value[, mixed $clean = true ][, mixed $doverify = true ][, mixed $table = null ]) : bool

Parameters

$fieldname : mixed
$value : mixed
$clean : mixed = true
$doverify : mixed = true
$table : mixed = null

Return values

bool —

Returns false if the data is rejected for whatever reason

set_condition()

Sets the condition to be used in WHERE clauses, based upon the $this->existing data and the $this->condition_constuct condition template.


    public
                    set_condition([mixed $params = null ]) : mixed

Parameters

$params : mixed = null

set_existing()

Sets the existing data


    public
                    set_existing(mixed $existing) : bool

Parameters

$existing : mixed

Return values

bool —

Returns true if successful

set_info()

Rather like set(), but sets data into the $this->info array instead. Use setr_info if $value if a reference to value is to be passed


    public
                    set_info(mixed $fieldname, mixed $value) : mixed

Parameters

$fieldname : mixed
$value : mixed

setr()

Sets the supplied data to be part of the data to be saved


    public
                    setr(mixed $fieldname, mixed &$value[, mixed $clean = true ][, mixed $doverify = true ]) : bool

Parameters

$fieldname : mixed
$value : mixed
$clean : mixed = true
$doverify : mixed = true

Return values

bool —

Returns false if the data is rejected for whatever reason

setr_info()

Rather like set(), but sets reference to data into the $this->info array instead


    public
                    setr_info(mixed $fieldname, mixed &$value) : mixed

Parameters

$fieldname : mixed
$value : mixed

setSkipRebuild()

For batch operations we'll skip the style rebuild since it only needs to happen once


    public
                    setSkipRebuild(bool $skip) : void

Parameters

$skip : bool

verify()

Verifies that the supplied data is one of the fields used by this object


    public
                    verify(mixed $fieldname, mixed &$value[, mixed $doverify = true ]) : bool

Also ensures that the data is of the correct type, and attempts to correct errors in the supplied data.

Parameters

$fieldname : mixed
$value : mixed
$doverify : mixed = true

Return values

bool —

Returns true if the data is one of the fields used by this object, and is the correct type (or has been successfully corrected to be so)

verify_background_position()


    public
                    verify_background_position(mixed $position) : mixed

Parameters

$position : mixed

verify_boolean()


    public
                    verify_boolean(mixed $testValue) : mixed

Parameters

$testValue : mixed

verify_borderstyle()


    public
                    verify_borderstyle(mixed $style) : mixed

Parameters

$style : mixed

verify_child()

Verifies that the supplied child data is one of the fields used by this object


    public
                    verify_child(mixed $fieldname, mixed &$value[, mixed $doverify = true ]) : bool

Also ensures that the data is of the correct type, and attempts to correct errors in the supplied data.

Parameters

$fieldname : mixed
$value : mixed
$doverify : mixed = true

Return values

bool —

Returns true if the data is one of the fields used by this object, and is the correct type (or has been successfully corrected to be so)

verify_color()


    public
                    verify_color(mixed $color) : mixed

Parameters

$color : mixed

verify_css_scalar()

Generic function to validate css values


    public
                    verify_css_scalar(mixed $value) : mixed

This function encodes some basic hueritics to help avoid css injection via stylevars It's not necesary if the base function validates more tightly -- for instance if we validate against an explicit list then we know unsafe values can't get though.

This is not suitable for calling if the value isn't a scalar, but it can be called for each scalar value in an array (for instance).

If the field doesn't have any other validation, then this function should be called.

Parameters

$value : mixed

verify_date_array()

Verifies a date array as a valid unix timestamp


    public
                    verify_date_array(mixed &$date) : bool

Parameters

$date : mixed

Return values

bool

verify_email()

Verifies that an email address is valid


    public
                    verify_email(mixed &$email) : bool

Parameters

$email : mixed

Return values

bool

verify_font_size()


    public
                    verify_font_size(mixed $size) : mixed

Parameters

$size : mixed

verify_fontfamily()


    public
                    verify_fontfamily(mixed &$family) : mixed

Parameters

$family : mixed

verify_fontlist()


    public
                    verify_fontlist(mixed $fontlist) : mixed

Parameters

$fontlist : mixed

verify_fontstyle()


    public
                    verify_fontstyle(mixed $style) : mixed

Parameters

$style : mixed

verify_fontvariant()


    public
                    verify_fontvariant(mixed $variant) : mixed

Parameters

$variant : mixed

verify_fontweight()


    public
                    verify_fontweight(mixed $weight) : mixed

Parameters

$weight : mixed

verify_gradient_direction()


    public
                    verify_gradient_direction(mixed $direction) : mixed

Parameters

$direction : mixed

verify_gradient_type()


    public
                    verify_gradient_type(mixed $type) : mixed

Parameters

$type : mixed

verify_height()


    public
                    verify_height(mixed $height) : mixed

Parameters

$height : mixed

verify_image()


    public
                    verify_image(mixed $image) : mixed

Parameters

$image : mixed

verify_lineheight()


    public
                    verify_lineheight(mixed $height) : mixed

Parameters

$height : mixed

verify_link()

Verifies that a hyperlink is valid


    public
                    verify_link(mixed &$link[, mixed $strict = false ]) : bool

Parameters

$link : mixed
$strict : mixed = false

Return values

bool

verify_margin()


    public
                    verify_margin(mixed $margin) : mixed

Parameters

$margin : mixed

verify_md5()

Verifies that a string is an MD5 string


    public
                    verify_md5(mixed &$md5) : bool

Parameters

$md5 : mixed

Return values

bool

verify_repeat()


    public
                    verify_repeat(mixed $repeat) : mixed

Parameters

$repeat : mixed

verify_size()


    public
                    verify_size(mixed $variant) : mixed

Parameters

$variant : mixed

verify_stylevar()


    public
                    verify_stylevar(mixed $stylevarid) : mixed

Parameters

$stylevarid : mixed

verify_textalign()


    public
                    verify_textalign(mixed $textalign) : mixed

Parameters

$textalign : mixed

verify_texttransfrom()


    public
                    verify_texttransfrom(mixed $texttransform) : mixed

Parameters

$texttransform : mixed

verify_units()


    public
                    verify_units(mixed $unit) : mixed

Parameters

$unit : mixed

verify_url()


    public
                    verify_url(mixed $url) : mixed

Parameters

$url : mixed

verify_username()

Verifies that the provided username is valid, and attempts to correct it if it is not valid


    public
                    verify_username(mixed &$username) : bool

Parameters

$username : mixed

Return values

bool —

Returns true if the username is valid, or has been corrected to be valid

verify_value_inherit_param_color()


    public
                    verify_value_inherit_param_color(mixed $value) : mixed

Parameters

$value : mixed

verify_value_stylevar()


    public
                    verify_value_stylevar(mixed $stylevar) : mixed

Parameters

$stylevar : mixed

verify_width()


    public
                    verify_width(mixed $width) : mixed

Parameters

$width : mixed

vB_DataManager_StyleVarCustom extends vB_DataManager_StyleVar in package Application

Table of Contents

Properties

Methods

Properties

$condition

$datatype

$error_handler

$errors

$existing

$info

$validfields

Methods

__construct()

Parameters

__serialize()

Return values

__sleep()

Return values

__unserialize()

Parameters

__wakeup()

add_child()

Parameters

build()

Return values

check_required()

Return values

db_insert()

Parameters

Return values

db_update()

Parameters

Return values

delete()

Parameters

Return values

do_set()

Parameters

do_set_child()

Parameters

do_unset()

Parameters

error()

Parameters

fetch_field()

Parameters

Return values

get_child()

Parameters

get_errors()

Return values

get_exception()

has_errors()

Parameters

Return values

is_bitfield_set()

Parameters

Return values

is_child_field()

Parameters

is_field_defined()

Parameters

is_field_set()

Parameters

post_save_each()

Parameters

post_save_once()

Parameters

pre_save()

Parameters

Return values

save()

Parameters

Return values

set()

Parameters

Return values

set_bitfield()

Parameters

vB_DataManager_StyleVarCustom extends vB_DataManager_StyleVar
in package

Application