Class ClipitExample

An Example experience in which students have trouble understanding a Stumbling Block (or Tag).

UBItem

ClipitExample

Package: ClipIt\clipit\api
License: Affero General Public License v3
Author: Pablo Llinás Arnaiz <pebs74@gmail.com>, URJC JuxtaLearn Team
Located at ClipitExample.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's parameters into an Elgg entity. Copy $this object's 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 id of saved instance, or false if error. Overrides `UBItem::save()`
`public static`	# `get_by_tags( mixed $tag_array )`
`public static`	# `get_tricky_topic( mixed $id )`
`public static`	# `set_tricky_topic( mixed $id, mixed $tricky_topic_id )`
`public static`	# `get_from_tricky_topic( mixed $tricky_topic_id )`
`public static boolean`	# `add_tags( integer $id, array $tag_array )` Adds Tags to an Example, referenced by Id. Adds Tags to an Example, referenced by Id. Parameters `$id` `integer` $id Id from the Example to add Tags to `$tag_array` `array` $tag_array Array of Tag Ids to be added to the Example Returns `boolean` Returns true if success, false if error
`public static boolean`	# `set_tags( integer $id, array $tag_array )` Sets Tags to an Example, referenced by Id. Sets Tags to an Example, referenced by Id. Parameters `$id` `integer` $id Id from the Example to set Tags to `$tag_array` `array` $tag_array Array of Tag Ids to be set to the Example Returns `boolean` Returns true if success, false if error
`public static boolean`	# `remove_tags( integer $id, array $tag_array )` Remove Tags from an Example. Remove Tags from an Example. Parameters `$id` `integer` $id Id from Example to remove Tags from `$tag_array` `array` $tag_array Array of Tag Ids to remove from Example Returns `boolean` Returns true if success, false if error
`public static array\|boolean`	# `get_tags( integer $id )` Get all Tags from an Example Get all Tags from an Example Parameters `$id` `integer` $id Id of the Example to get Tags from Returns `array\|boolean` Returns an array of Tag IDs, or false if error
`public static boolean`	# `add_example_types( integer $id, array $example_type_array )` Adds Example Types to an Example, referenced by Id. Adds Example Types to an Example, referenced by Id. Parameters `$id` `integer` $id Id from the Example to add Example Types to `$example_type_array` `array` $example_type_array Array of Example Type Ids to be added to the Example Returns `boolean` Returns true if success, false if error
`public static boolean`	# `set_example_types( integer $id, array $example_type_array )` Sets Example Types to an Example, referenced by Id. Sets Example Types to an Example, referenced by Id. Parameters `$id` `integer` $id Id from the Example to set Example Types to `$example_type_array` `array` $example_type_array Array of Example Type Ids to be set to the Example Returns `boolean` Returns true if success, false if error
`public static boolean`	# `remove_example_types( integer $id, array $example_type_array )` Remove Example Types from an Example. Remove Example Types from an Example. Parameters `$id` `integer` $id Id from Example to remove Example Types from `$example_type_array` `array` $example_type_array Array of Example Type Ids to remove from Example Returns `boolean` Returns true if success, false if error
`public static array\|boolean`	# `get_example_types( integer $id )` Get all Example Types from an Example Get all Example Types from an Example Parameters `$id` `integer` $id Id of the Example to get Example Types from Returns `array\|boolean` Returns an array of Example Type IDs, or false if error
`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_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_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 )`

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_EXAMPLE_TAG`	`"ClipitExample-ClipitTag"`	#
`string`	`REL_EXAMPLE_EXAMPLETYPE`	`"ClipitExample-ClipitExampleType"`	#
`string`	`REL_EXAMPLE_STORYBOARD`	`"ClipitExample-ClipitStoryboard"`	#
`string`	`REL_EXAMPLE_VIDEO`	`"ClipitExample-ClipitVideo"`	#
`string`	`REL_EXAMPLE_FILE`	`"ClipitExample-ClipitFile"`	#

Constants inherited from UBItem
`REL_PARENT_CLONE, SUBTYPE, TYPE`

Properties summary
`public integer`	`$tricky_topic`	`0`	#
`public array`	`$tag_array`	`array()`	#
`public array`	`$example_type_array`	`array()`	#
`public string`	`$country`	`""`	#
`public string`	`$location`	`""`	#
`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 ClipitExample

Parameters

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns