Function __global->get_rating_box
Definitions
sources/feedback.php
- Get Tempcode for doing ratings (sits above get_rating_simple_array).
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $content_url | mixed | No | No | required parameter | N/A | N/A | The URL to where the commenting will pass back to (to put into the comment topic header) (URLPATH or Tempcode) |
| $content_title | ?string | No | No | required parameter | N/A | N/A | The title to where the commenting will pass back to (to put into the comment topic header) (null: don't know, but not first post so not important) |
| $feedback_type | ID_TEXT | No | No | required parameter | N/A | N/A | The type (downloads, etc) that this rating is for |
| $content_id | ID_TEXT | No | No | required parameter | N/A | N/A | The ID of the type that this rating is for |
| $allow_rating | boolean | No | No | required parameter | N/A | N/A | Whether this resource allows rating (if not, this function does nothing - but it's nice to move out this common logic into the shared function) |
| $submitter | ?MEMBER | No | No | Null | N/A | N/A | Content owner (null: none) |
Returns
- Tempcode for complete rating box
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get Tempcode for doing ratings (sits above get_rating_simple_array).
*
* @param mixed $content_url The URL to where the commenting will pass back to (to put into the comment topic header) (URLPATH or Tempcode)
* @param ?string $content_title The title to where the commenting will pass back to (to put into the comment topic header) (null: don't know, but not first post so not important)
* @param ID_TEXT $feedback_type The type (downloads, etc) that this rating is for
* @param ID_TEXT $content_id The ID of the type that this rating is for
* @param boolean $allow_rating Whether this resource allows rating (if not, this function does nothing - but it's nice to move out this common logic into the shared function)
* @param ?MEMBER $submitter Content owner (null: none)
* @return Tempcode Tempcode for complete rating box
*/
function get_rating_box($content_url, ?string $content_title, string $feedback_type, string $content_id, bool $allow_rating, ?int $submitter = null) : object
* Get Tempcode for doing ratings (sits above get_rating_simple_array).
*
* @param mixed $content_url The URL to where the commenting will pass back to (to put into the comment topic header) (URLPATH or Tempcode)
* @param ?string $content_title The title to where the commenting will pass back to (to put into the comment topic header) (null: don't know, but not first post so not important)
* @param ID_TEXT $feedback_type The type (downloads, etc) that this rating is for
* @param ID_TEXT $content_id The ID of the type that this rating is for
* @param boolean $allow_rating Whether this resource allows rating (if not, this function does nothing - but it's nice to move out this common logic into the shared function)
* @param ?MEMBER $submitter Content owner (null: none)
* @return Tempcode Tempcode for complete rating box
*/
function get_rating_box($content_url, ?string $content_title, string $feedback_type, string $content_id, bool $allow_rating, ?int $submitter = null) : object
