Class ClipitRating

A complete User Rating linked to a published Resource, containing an Overall boolean rating, links to Tag Ratings and Performance item Ratings.

UBItem

ClipitRating

Package: ClipIt\clipit\api
License: Affero General Public License v3
Author: Pablo Llinás Arnaiz <pebs74@gmail.com>, URJC JuxtaLearn Team
Located at ClipitRating.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_target( mixed $id )`
`public static static[]`	# `get_by_target( array $target_array )` Get Ratings by Target Get Ratings by Target Parameters `$target_array` `array` $target_array Array of Target IDs Returns `static[]` Array of [target] => array(Ratings)
`public static ClipitRating\|null`	# `get_user_rating_for_target( integer $user_id, integer $target_id )` Get Ratings made by a User for a Target Get Ratings made by a User for a Target Parameters `$user_id` `integer` $user_id User ID `$target_id` `integer` $target_id Target ID Returns `ClipitRating\|null` Returns a Rating, or null if any.
`public static float`	# `get_average_rating_for_target( integer $target_id )` Get the average overall rating Get the average overall rating Parameters `$target_id` `integer` $target_id ID of target to return overall rating from Returns `float` Average overall rating [0.0-1.0]
`public static`	# `add_tag_ratings( mixed $id, mixed $tag_rating_array )`
`public static`	# `set_tag_ratings( mixed $id, mixed $tag_rating_array )`
`public static`	# `remove_tag_ratings( mixed $id, mixed $tag_rating_array )`
`public static`	# `get_tag_ratings( mixed $id )`
`public static`	# `add_performance_ratings( mixed $id, mixed $performance_rating_array )`
`public static`	# `set_performance_ratings( mixed $id, mixed $performance_rating_array )`
`public static`	# `remove_performance_ratings( mixed $id, mixed $performance_rating_array )`
`public static`	# `get_performance_ratings( 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_RATING_TAGRATING`	`"ClipitRating-ClipitTagRating"`	#
`string`	`REL_RATING_PERFORMANCERATING`	`"ClipitRating-ClipitPerformanceRating"`	#

Constants inherited from UBItem
`REL_PARENT_CLONE, SUBTYPE, TYPE`

Properties summary
`public integer`	`$target`	`0`	# Rating target (ClipitVideo or ClipitStoryboard) Rating target (ClipitVideo or ClipitStoryboard)
`public integer`	`$overall`	`false`	# Overall rating opinion (YES = true, NO = false= Overall rating opinion (YES = true, NO = false=
`public array`	`$tag_rating_array`	`array()`	# Ratings about Tags used Ratings about Tags used
`public array`	`$performance_rating_array`	`array()`	# Ratings about Performance tips used Ratings about Performance tips used

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

Packages

Classes

Class ClipitRating

Parameters

Overrides

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns