Docs For Class SloodleLayoutEntry

Description

Stores data for a single entry in a layout profile.

Used with SloodleCourse

Located in /lib/layout_profile.php (line 160)

Variable Summary

mixed $configs

mixed $id

mixed $layout

string $name

mixed $originalconfigs

string $position

string $rotation

Method Summary

SloodleLayoutEntry SloodleLayoutEntry ([ $r = null])

void delete ()

void delete_configs ()

void get_layout ()

array get_layout_entry_configs (integer $layout_entry_id)

void get_layout_entry_configs_as_hidden_fields ( $prefix, $suffix)

void get_layout_entry_configs_as_name_value_hash ()

void insert ()

void load ( $id)

void load_from_row ( $r)

void populate_from_active_object ()

void save_configs ()

void set_config ( $name, $value)

void set_position_xyz (float $x, float $y, float $z)

void set_rotation_xyz (float $x, float $y, float $z)

void update ()

Variables

mixed $configs (line 187)

mixed $id (line 185)

mixed $layout (line 186)

string $name = '' (line 169)

The name of the object this entry represents.

access: public

mixed $originalconfigs (line 188)

string $position = '<0.0,0.0,0.0>' (line 176)

The position of the object, as a 3d vector, in string format "<x,y,z>"

access: public

string $rotation = '<0.0,0.0,0.0>' (line 183)

The rotation of the object, as a 3d vector of Euler angles, in string format "<x,y,z>"

access: public

Methods

Constructor SloodleLayoutEntry (line 190)

SloodleLayoutEntry SloodleLayoutEntry ([ $r = null])

$r

delete (line 370)

void delete ()

delete_configs (line 383)

void delete_configs ()

get_layout (line 245)

void get_layout ()

get_layout_entry_configs (line 263)

Return an array of layout_entry_config objects

return: Array if successful (empty if there are no entries) , or null otherwise

array get_layout_entry_configs (integer $layout_entry_id)

integer $layout_entry_id: The ID of the layout entry

get_layout_entry_configs_as_hidden_fields (line 277)

void get_layout_entry_configs_as_hidden_fields ( $prefix, $suffix)

$prefix
$suffix

get_layout_entry_configs_as_name_value_hash (line 288)

void get_layout_entry_configs_as_name_value_hash ()

insert (line 351)

void insert ()

load (line 218)

void load ( $id)

$id

load_from_row (line 200)

void load_from_row ( $r)

$r

populate_from_active_object (line 226)

void populate_from_active_object ()

save_configs (line 389)

void save_configs ()

set_config (line 325)

void set_config ( $name, $value)

$name
$value

set_position_xyz (line 308)

Sets the position as separate X,Y,Z components

void set_position_xyz (float $x, float $y, float $z)

float $x: The X component to set
float $y: The Y component to set
float $z: The Z component to set

set_rotation_xyz (line 320)

Sets the rotation as separate X,Y,Z components

void set_rotation_xyz (float $x, float $y, float $z)

float $x: The X component to set
float $y: The Y component to set
float $z: The Z component to set

update (line 361)

void update ()