Class ClipitTask

An atomic set of work which composes activities.

UBItem

ClipitTask

Package: ClipIt\clipit\api
License: Affero General Public License v3
Author: Pablo Llinás Arnaiz <pebs74@gmail.com>, URJC JuxtaLearn Team
Located at ClipitTask.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 integer`	# `get_activity( integer $id )` Get the Activity in which a Task is contained. Get the Activity in which a Task is contained. Parameters `$id` `integer` $id Id of the Task. Returns `integer` Returns an the Activity Id for the Task.
`public static boolean`	# `set_activity( integer $id, integer $activity_id )` Set the Activity in which a Task is contained. Set the Activity in which a Task is contained. Parameters `$id` `integer` $id Id of the Task. `$activity_id` `integer` $activity_id ID of the Activity. Returns `boolean` Returns true if OK, or false if error.
`public static`	# `set_quiz( mixed $id, mixed $quiz_id )`
`public static`	# `get_quiz( 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`	# `add_performance_items( mixed $id, mixed $performance_item_array )`
`public static`	# `set_performance_items( mixed $id, mixed $performance_item_array )`
`public static`	# `remove_performance_items( mixed $id, mixed $performance_item_array )`
`public static`	# `get_performance_items( mixed $id )`
`public static integer`	# `get_child( integer $id )` Get the Child Task (if any) Get the Child Task (if any) Parameters `$id` `integer` $id ID of Task Returns `integer` ID of Child Task
`public static string`	# `get_status( integer $id )` Get the Status for a Task Get the Status for a Task Parameters `$id` `integer` $id ID of Task Returns `string` Status Throws `InvalidParameterException`
`public static`	# `get_completed_status( mixed $id, mixed $entity_id )`

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`	`TYPE_QUIZ_TAKE`	`"quiz_take"`	#
`string`	`TYPE_RESOURCE_DOWNLOAD`	`"resource_download"`	#
`string`	`TYPE_STORYBOARD_UPLOAD`	`"storyboard_upload"`	#
`string`	`TYPE_STORYBOARD_FEEDBACK`	`"storyboard_feedback"`	#
`string`	`TYPE_VIDEO_UPLOAD`	`"video_upload"`	#
`string`	`TYPE_VIDEO_FEEDBACK`	`"video_feedback"`	#
`string`	`TYPE_OTHER`	`"other"`	#
`string`	`REL_TASK_STORYBOARD`	`"ClipitTask-ClipitStoryboard"`	#
`string`	`REL_TASK_VIDEO`	`"ClipitTask-ClipitVideo"`	#
`string`	`REL_TASK_FILE`	`"ClipitTask-ClipitFile"`	#
`string`	`REL_TASK_QUIZ`	`"ClipitTask-ClipitQuiz"`	#
`string`	`REL_TASK_PERFORMANCE`	`"ClipitTask-ClipitPerformanceItem"`	#
`string`	`STATUS_LOCKED`	`"locked"`	#
`string`	`STATUS_ACTIVE`	`"active"`	#
`string`	`STATUS_FINISHED`	`"finished"`	#

Constants inherited from UBItem
`REL_PARENT_CLONE, SUBTYPE, TYPE`

Properties summary
`public string`	`$task_type`	`""`	#
`public integer`	`$start`	`0`	#
`public integer`	`$end`	`0`	#
`public string`	`$status`	`""`	#
`public integer`	`$parent_task`	`0`	#
`public integer`	`$task_count`	`0`	#
`public integer`	`$activity`	`0`	#
`public integer`	`$quiz`	`0`	#
`public array`	`$storyboard_array`	`array()`	#
`public array`	`$video_array`	`array()`	#
`public array`	`$file_array`	`array()`	#
`public array`	`$performance_item_array`	`array()`	#

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

Packages

Classes

Class ClipitTask

Parameters

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws