Class ClipitGroup

A collection of Students contained inside an Activity. Also links to all Group Resources.

UBItem

ClipitGroup

Package: ClipIt\clipit\api
License: Affero General Public License v3
Author: Pablo Llinás Arnaiz <pebs74@gmail.com>, URJC JuxtaLearn Team
Located at ClipitGroup.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 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`	# `get_from_user_activity( integer $user_id, integer $activity_id )` Returns the Group where a User is taking part in an Activity Returns the Group where a User is taking part in an Activity Parameters `$user_id` `integer` $user_id User ID `$activity_id` `integer` $activity_id Activity ID Returns `boolean\|integer` Returns the Group ID, or false if not found
`public static boolean\|integer`	# `get_activity( integer $id )` Gets the Activity Id in which a Group takes part in. Gets the Activity Id in which a Group takes part in. Parameters `$id` `integer` $id Id from the Group. Returns `boolean\|integer` Returns an Activity Id.
`public static boolean`	# `add_users( integer $id, array $user_array )` Add Users to a Group. Add Users to a Group. Parameters `$id` `integer` $id Id of the Group to add Users to. `$user_array` `array` $user_array Array of User Ids to add to the Group. Returns `boolean` Returns true if added correctly, or false if error.
`public static`	# `set_users( mixed $id, mixed $user_array )`
`public static boolean`	# `remove_users( integer $id, array $user_array )` Remove Users from a Group. Remove Users from a Group. Parameters `$id` `integer` $id Id of the Group to remove Users from. `$user_array` `array` $user_array Array of User Ids to remove from the Group. Returns `boolean` Returns true if removed correctly, or false if error.
`public static boolean`	# `get_users( integer $id )` Get User Ids from a Group. Get User Ids from a Group. Parameters `$id` `integer` $id Id of the Group to get Users from. Returns `boolean` Returns array of User Ids, or false if error.
`public static boolean`	# `add_files( integer $id, array $file_array )` Add Files to a Group. Add Files to a Group. Parameters `$id` `integer` $id Id of the Group to add Files to. `$file_array` `array` $file_array Array of File Ids to add to the Group. Returns `boolean` Returns true if added correctly, or false if error.
`public static`	# `set_files( mixed $id, mixed $file_array )`
`public static boolean`	# `remove_files( integer $id, array $file_array )` Remove Files from a Group. Remove Files from a Group. Parameters `$id` `integer` $id Id of the Group to remove Files from. `$file_array` `array` $file_array Array of File Ids to remove from the Group. Returns `boolean` Returns true if removed correctly, or false if error.
`public static boolean`	# `get_files( integer $id )` Get File Ids from a Group. Get File Ids from a Group. Parameters `$id` `integer` $id Id of the Group to get Files from. Returns `boolean` Returns array of User Ids, or false if error.
`public static boolean`	# `add_storyboards( integer $id, array $storyboard_array )` Add Storyboards to a Group. Add Storyboards to a Group. Parameters `$id` `integer` $id Id of the Group to add Storyboards to. `$storyboard_array` `array` $storyboard_array Array of Storyboard Ids to add to the Group. Returns `boolean` Returns true if added correctly, or false if error.
`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 boolean`	# `add_videos( integer $id, array $video_array )` Add Videos to a Group. Add Videos to a Group. Parameters `$id` `integer` $id Id of the Group to add Videos to. `$video_array` `array` $video_array Array of Video Ids to add to the Group. Returns `boolean` Returns true if added correctly, or false if error.
`public static`	# `set_videos( mixed $id, mixed $video_array )`
`public static boolean`	# `remove_videos( integer $id, array $video_array )` Remove Videos from a Group. Remove Videos from a Group. Parameters `$id` `integer` $id Id of the Group to remove Videos from. `$video_array` `array` $video_array Array of Video Ids to remove from the Group. Returns `boolean` Returns true if removed correctly, or false if error.
`public static boolean`	# `get_videos( integer $id )` Get Video Ids from a Group. Get Video Ids from a Group. Parameters `$id` `integer` $id Id of the Group to get Videos from. Returns `boolean` Returns array of Video Ids, or false if error.
`public static boolean`	# `add_tags( integer $id, array $tag_array )` Add Tags for a Group to work on. Add Tags for a Group to work on. Parameters `$id` `integer` $id Id of the Group to add Tags to. `$tag_array` `array` $tag_array Array of Tag Ids to add to the Group. Returns `boolean` Returns true if added correctly, or false if error.
`public static`	# `set_tags( mixed $id, mixed $tag_array )`
`public static`	# `remove_tags( mixed $id, mixed $tag_array )`
`public static`	# `get_tags( mixed $id )`

Methods inherited from UBItem
`__construct(), copy_to_elgg(), 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_GROUP_USER`	`"ClipitGroup-ClipitUser"`	#
`string`	`REL_GROUP_FILE`	`"ClipitGroup-ClipitFile"`	#
`string`	`REL_GROUP_STORYBOARD`	`"ClipitGroup-ClipitStoryboard"`	#
`string`	`REL_GROUP_VIDEO`	`"ClipitGroup-ClipitVideo"`	#
`string`	`REL_GROUP_TAG`	`"ClipitGroup-ClipitTag"`	#

Constants inherited from UBItem
`REL_PARENT_CLONE, SUBTYPE, TYPE`

Properties summary
`public array`	`$user_array`	`array()`	#
`public array`	`$file_array`	`array()`	#
`public array`	`$storyboard_array`	`array()`	#
`public array`	`$video_array`	`array()`	#
`public array`	`$tag_array`	`array()`	#
`public integer`	`$activity`	`0`	#

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

Packages

Classes

Class ClipitGroup

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns