Class ClipitActivity

Contains all elements required to carry out the JuxtaLearn learning method in which Student work in Groups around a selected Tricky Topic.

It contains a list of enrolled/called Students, Groups (that actually participate in the activity), Tasks (set by the teacher/s), support Resources and student Publications.

An Activity can have different statuses: "enroll" state, "active" state and "closed" state, marked by start and end dates which define the current status.

UBItem

ClipitActivity

Package: ClipIt\clipit\api
License: Affero General Public License v3
Author: Pablo Llinás Arnaiz <pebs74@gmail.com>, URJC JuxtaLearn Team
Located at ClipitActivity.php

Methods summary
`protected`	# `copy_from_elgg( ElggEntity $elgg_entity )` Loads object parameters stored in Elgg Loads object parameters stored in Elgg Parameters `$elgg_entity` `ElggEntity` $elgg_entity Elgg Object to load parameters from. Overrides `UBItem::copy_from_elgg()`
`protected`	# `copy_to_elgg( ElggEntity $elgg_entity )` Copy $this object parameters into an Elgg entity. Copy $this object parameters into an Elgg entity. Parameters `$elgg_entity` `ElggEntity` $elgg_entity Elgg object instance to save $this to Overrides `UBItem::copy_to_elgg()`
`protected boolean\|integer`	# `save( boolean $double_save = false )` Saves this instance to the system. Saves this instance to the system. Parameters `$double_save` `boolean` $double_save if $double_save is true, this object is saved twice to ensure that all properties are updated properly. E.g. the time created property can only beset on ElggObjects during an update. Defaults to false! Returns `boolean\|integer` Returns the Id of the saved instance, or false if error Overrides `UBItem::save()`
`public static`	# `get_tricky_topic( mixed $id )`
`public static`	# `set_tricky_topic( mixed $id, mixed $tricky_topic )`
`protected string`	# `get_rand_color( )` Returns a random hex color, from a predefined palette, to assign to an Activity Returns a random hex color, from a predefined palette, to assign to an Activity Returns `string` Hex color.
`public string`	# `get_status( integer $id )` Get the Status for an Activity Get the Status for an Activity Parameters `$id` `integer` $id ID of Activity Returns `string` Status Throws `InvalidParameterException`
`public static static[]`	# `get_from_user( integer $user_id, boolean $joined_only = false )` Returns the Activities where a User has been called in, or has joined. Returns the Activities where a User has been called in, or has joined. Parameters `$user_id` `integer` $user_id ID of the User to get Activities from `$joined_only` `boolean` $joined_only Only return Activities where the User has joined to a Group Returns `static[]` Array of Activities
`public static`	# `get_from_tricky_topic( mixed $tricky_topic_id )`
`public static`	# `add_teachers( mixed $id, mixed $teacher_array )`
`public static`	# `set_teachers( mixed $id, mixed $teacher_array )`
`public static`	# `remove_teachers( mixed $id, mixed $teacher_array )`
`public static`	# `get_teachers( mixed $id )`
`public static`	# `add_students( mixed $id, mixed $user_array )`
`public static`	# `set_students( mixed $id, mixed $user_array )`
`public static`	# `remove_students( mixed $id, mixed $user_array )`
`public static`	# `get_students( mixed $id )`
`public static`	# `add_groups( mixed $id, mixed $group_array )`
`public static`	# `set_groups( mixed $id, mixed $group_array )`
`public static`	# `remove_groups( mixed $id, mixed $group_array )`
`public static`	# `get_groups( mixed $id )`
`public static`	# `add_tasks( mixed $id, mixed $task_array )`
`public static`	# `set_tasks( mixed $id, mixed $task_array )`
`public static`	# `remove_tasks( mixed $id, mixed $task_array )`
`public static`	# `get_tasks( mixed $id )`
`public static`	# `add_storyboards( mixed $id, mixed $storyboard_array )`
`public static`	# `set_storyboards( mixed $id, mixed $storyboard_array )`
`public static`	# `remove_storyboards( mixed $id, mixed $storyboard_array )`
`public static`	# `get_storyboards( mixed $id )`
`public static`	# `add_videos( mixed $id, mixed $video_array )`
`public static`	# `set_videos( mixed $id, mixed $video_array )`
`public static`	# `remove_videos( mixed $id, mixed $video_array )`
`public static`	# `get_videos( mixed $id )`
`public static`	# `add_files( mixed $id, mixed $file_array )`
`public static`	# `set_files( mixed $id, mixed $file_array )`
`public static`	# `remove_files( mixed $id, mixed $file_array )`
`public static`	# `get_files( mixed $id )`
`public static ClipitStoryboard[]`	# `get_published_storyboards( integer $id )` Gets all published Storyboards from the Tasks contained inside an Activity Gets all published Storyboards from the Tasks contained inside an Activity Parameters `$id` `integer` $id Activity ID Returns `ClipitStoryboard[]` Array of Storyboards
`public static ClipitVideo[]`	# `get_published_videos( integer $id )` Gets all published Videos from the Tasks contained inside an Activity Gets all published Videos from the Tasks contained inside an Activity Parameters `$id` `integer` $id Activity ID Returns `ClipitVideo[]` Array of Videos

Methods inherited from UBItem
`__construct(), count_all(), create(), create_clone(), delete_all(), delete_by_id(), get_all(), get_all_parents(), get_by_id(), get_by_owner(), get_clone_tree(), get_cloned_from(), get_clones(), get_events(), get_from_search(), get_properties(), link_parent_clone(), list_properties(), set_properties(), sort_by_date(), sort_by_date_inv(), sort_by_name(), sort_by_name_inv(), sort_numbers(), sort_numbers_inv(), unlink_from_clones(), unlink_from_parent()`

Constants summary
`string`	`REL_ACTIVITY_TRICKYTOPIC`	`"ClipitActivity-ClipitTrickyTopic"`	#
`string`	`REL_ACTIVITY_TEACHER`	`"ClipitActivity-teacher"`	#
`string`	`REL_ACTIVITY_STUDENT`	`"ClipitActivity-student"`	#
`string`	`REL_ACTIVITY_GROUP`	`"ClipitActivity-ClipitGroup"`	#
`string`	`REL_ACTIVITY_TASK`	`"ClipitActivity-ClipitTask"`	#
`string`	`REL_ACTIVITY_STORYBOARD`	`"ClipitActivity-ClipitStoryboard"`	#
`string`	`REL_ACTIVITY_VIDEO`	`"ClipitActivity-ClipitVideo"`	#
`string`	`REL_ACTIVITY_FILE`	`"ClipitActivity-ClipitFile"`	#
`string`	`STATUS_ENROLL`	`"enroll"`	#
`string`	`STATUS_ACTIVE`	`"active"`	#
`string`	`STATUS_CLOSED`	`"closed"`	#
`string`	`GROUP_MODE_TEACHER`	`"teacher"`	#
`string`	`GROUP_MODE_SYSTEM`	`"system"`	#
`string`	`GROUP_MODE_STUDENT`	`"student"`	#

Constants inherited from UBItem
`REL_PARENT_CLONE, SUBTYPE, TYPE`

Properties summary
`public string`	`$color`	`""`	#
`public string`	`$status`	`""`	#
`public integer`	`$tricky_topic`	`0`	#
`public integer`	`$start`	`0`	#
`public integer`	`$end`	`0`	#
`public string`	`$group_mode`	`""`	#
`public integer`	`$max_group_size`	`0`	#
`public array`	`$teacher_array`	`array()`	#
`public array`	`$student_array`	`array()`	#
`public array`	`$group_array`	`array()`	#
`public array`	`$task_array`	`array()`	#
`public array`	`$storyboard_array`	`array()`	#
`public array`	`$video_array`	`array()`	#
`public array`	`$file_array`	`array()`	#

Properties inherited from UBItem
`$clone_array, $cloned_from, $description, $id, $name, $owner_id, $time_created, $url`

Packages

Classes

Class ClipitActivity

Parameters

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns