Class ClipitTrickyTopic

A main topic to explain through videos, which can be decomposed into tags (Stumbling Blocks).

UBItem

ClipitTrickyTopic

Package: ClipIt\clipit\api
License: Affero General Public License v3
Author: Pablo Llinás Arnaiz <pebs74@gmail.com>, URJC JuxtaLearn Team
Located at ClipitTrickyTopic.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()`
`public 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 boolean\|integer`	# `create_clone( integer $id, boolean $linked = true, boolean $keep_owner = false )` Clones a Tricky Topic, including the contained Stumbling Blocks, teacher Material and Examples Clones a Tricky Topic, including the contained Stumbling Blocks, teacher Material and Examples Parameters `$id` `integer` $id ID of Tricky Topic to clone `$linked` `boolean` $linked Whether the clone will be linked to the parent object `$keep_owner` `boolean` $keep_owner Selects whether the clone will keep the parent item's owner (default: no) Returns `boolean\|integer` ID of new cloned object Throws `InvalidParameterException` if error Overrides `UBItem::create_clone()`
`public static boolean`	# `add_tags( integer $id, array $tag_array )` Adds Tags to a Tricky Topic, referenced by Id. Adds Tags to a Tricky Topic, referenced by Id. Parameters `$id` `integer` $id Id from the Tricky Topic to add Tags to `$tag_array` `array` $tag_array Array of Tag Ids to be added to the Tricky Topic Returns `boolean` Returns true if success, false if error
`public static boolean`	# `set_tags( integer $id, array $tag_array )` Sets Tags to a Tricky Topic, referenced by Id. Sets Tags to a Tricky Topic, referenced by Id. Parameters `$id` `integer` $id Id from the Tricky Topic to set Tags to `$tag_array` `array` $tag_array Array of Tag Ids to be set to the Tricky Topic Returns `boolean` Returns true if success, false if error
`public static boolean`	# `remove_tags( integer $id, array $tag_array )` Remove Tags from a Tricky Topic. Remove Tags from a Tricky Topic. Parameters `$id` `integer` $id Id from Tricky Topic to remove Tags from `$tag_array` `array` $tag_array Array of Tag Ids to remove from Tricky Topic Returns `boolean` Returns true if success, false if error
`public static array\|boolean`	# `get_tags( integer $id )` Get all Tags from a Tricky Topic Get all Tags from a Tricky Topic Parameters `$id` `integer` $id Id of the Tricky Topic to get Tags from Returns `array\|boolean` Returns an array of Tag IDs, or false if error
`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_examples( mixed $id, mixed $example_array )`
`public static`	# `set_examples( mixed $id, mixed $example_array )`
`public static`	# `remove_examples( mixed $id, mixed $example_array )`
`public static`	# `get_examples( mixed $id )`

Methods inherited from UBItem
`__construct(), count_all(), create(), 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_TRICKYTOPIC_TAG`	`"ClipitTrickyTopic-ClipitTag"`	#
`string`	`REL_TRICKYTOPIC_FILE`	`"ClipitTrickyTopic-ClipitFile"`	#
`string`	`REL_TRICKYTOPIC_STORYBOARD`	`"ClipitTrickyTopic-ClipitStoryboard"`	#
`string`	`REL_TRICKYTOPIC_VIDEO`	`"ClipitTrickyTopic-ClipitVideo"`	#
`string`	`REL_TRICKYTOPIC_EXAMPLE`	`"ClipitTrickyTopic-ClipitExample"`	#
`string`	`EDUCATION_LEVEL_PRIMARY`	`"primary"`	#
`string`	`EDUCATION_LEVEL_GCSE`	`"gcse"`	#
`string`	`EDUCATION_LEVEL_ALEVEL`	`"alevel"`	#
`string`	`EDUCATION_LEVEL_VOCATIONAL`	`"vocational"`	#
`string`	`EDUCATION_LEVEL_UNIVERSITY`	`"university"`	#

Constants inherited from UBItem
`REL_PARENT_CLONE, SUBTYPE, TYPE`

Properties summary
`public array`	`$tag_array`	`array()`	#
`public string`	`$subject`	`""`	#
`public string`	`$education_level`	`""`	#
`public array`	`$storyboard_array`	`array()`	#
`public array`	`$video_array`	`array()`	#
`public array`	`$file_array`	`array()`	#
`public array`	`$example_array`	`array()`	#
`public string`	`$ontologylink`	`""`	#

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

Packages

Classes

Class ClipitTrickyTopic

Parameters

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Throws

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns