This function used to add links admin area. When you create or develop a plugin you must point links to access or configure plugin pages, in order to make it easier we have created system, an easy system so you can write files dedicated to admin area only. Please read Add Plugin Pages For Admin Area.

Usage

function add_admin_menu($header=’Tool Box’,$name,$link,$plug_folder=false,$is_player_file=false)

Uses

• ClipBucket->AdminMenu

Overview

To create menu in admin area, we will simply pass links to an array $Cbucket->AdminMenu and then we create a loop in admin area html files to render the links accordingly, there are too many functions involved and we will try to document them all one by one

Example

this code

<?php
add_admin_menu("Audio","Audio Configuration",'audio_configurations.php','cb_audio/back_end/');
add_admin_menu("Audio","Audio Manager",'audio_manager.php','cb_audio/back_end/');
add_admin_menu("Audio","Manage Categories",'audio_categories.php','cb_audio/back_end/');
add_admin_menu("Audio","Flagged Audios",'flagged_audios.php','cb_audio/back_end/');
add_admin_menu("Audio","Inactive Audios",'audio_manager.php&search=search&active=no','cb_audio/back_end/');
?>

will generate something like this

Final view of admin menu

This function is used to get thumbnails of a video.

This function will get all video thumbnails and list them in array, you can single thumbnail using incremental number or all thumbnails in an array or just count how many thumbnails are available. This function has few limitations that we will try to cover in upcoming updates.

Usage

get_thumb($vdetails,$num=’default’,$multi=false,$count=false,$return_full_path=true,$return_big=true,$size=Null);

Uses

• default_thumb();
• MyQuery->get_video_details();

paramater marked with * is required

Examples

<?php
	//set your videoid, it can also bevideokey
	$vid = 1236;
	$vdetails = get_video_details($vid);
	$default_thumb = get_thumb($vdetails);
	$second_thumb = get_thumb($vdetails,2);
	$all_thumbs = get_thumb($vdetails,NULL,true);
	$count_thumbs = get_thumb($vdetails,NULL,false,true);
	echo '<pre>';
	var_dump($default_thumb);
	var_dump($second_thumb);
	var_dump($all_thumbs);
	var_dump($count_thumbs);
	echo '</pre>';
?&gt

Usage

{section name=loop_name loop=$array}
	{$array[loop_name].column_name}
{/section}

Let’s break it down. First

{section name=loop_name loop=$array}

We give our section a name, this can be anything you want, like v_list or videoList. Next we provide section the array we going to loop through. Next part is to display the information you want.

{$array[loop_name].column_name}

To display any type of information, we need follow a required syntax. First we write down the variable in which array is stored, in our case $array, then loop_name. Third is mysql database column name. Let’s say we need want to display video title. We will be using following code. List of mysql Database Column Names.

{$video_array[v_list].title}

Below is list of attributes you can use in {section }

How to use {sectionelse}

{sectionelse} is used when provided array is empty. For Example,

{section name=loop_name loop=$array}
	{$array[loop_name].column_name}
{sectionelse}
	Do something here if $array is empty
{/section}

If {section} finds that variable $array is empty, then {sectionelse} is executed. Think of it as PHP if & else conditions.

{section} Variables

A {section} also has its own variables that handle {section} properties. These properties are accessible as:
{$smarty.section.name.property} where “name” is the attribute name. {section} properties are index, iteration, first, last, rownum, total.

.index

index contains the current array index, starting with zero or the start attribute if given. It increments by one or by the step attribute if given.

If the step and start properties are not modified, then this works the same as the iteration property, except it starts at zero instead of one.

Example

{section name=loop_name loop=$array}
	Index of $array is : {$smarty.section.loop_name.index}<br/>
{/section}

Above code will print following,

Index of $array is : 0<br/>
Index of $array is : 1<br/>
Index of $array is : 2<br/>
Index of $array is : 3<br/>

.iteration

iteration contains the current loop iteration and starts at one.

This is not affected by the {section} properties start, step and max, unlike the index property. iteration also starts with one instead of zero unlike index. rownum is an alias to iteration, they are identical.

Example

{section name=loop_name loop=$array}
	$array Iteration is : {$smarty.section.loop_name.iteration}<br/>
{/section}

This will print following:

$array Iteration is : 1<br/>
$array Iteration is : 2<br/>
$array Iteration is : 3<br/>
$array Iteration is : 4<br/>

.first

first is set to TRUE if the current {section} iteration is the initial one.

.last

last is set to TRUE if the current {section} iteration is the final one.

Examples of both .first and .last

{section name=loop_name loop=$array}
    {if $smarty.section.loop_name.first}(This is First) {/if}
    {if $smarty.section.loop_name.last}(This is Last) {/if}
    $array ID is : {$array[loop_name].id}<br/>
{/section}

Above will print following:

(This is First) $array ID is : 25<br/>
$array ID is : 26<br/>
$array ID is : 27<br/>
(This is Last) $array ID is : 28<br/>

.rownum

rownum contains the current loop iteration, starting with one. It is an alias to iteration, they work identically.

.total

total contains the number of iterations that this {section} will loop. This can be used inside or after a {section}.

Example

{section name=loop_name loop=$array}
	loop id is: {$array[loop_name].id}<br/>
{/section}
Number of iterations: {$smarty.section.loop_name.total}

Like mentioned earlier, you can use .total outside {section}. Above code will print following

loop id is: 25 <br/>
loop id is: 26 <br/>
loop id is: 27 <br/>
loop id is: 28 <br/>
Number of iteration: 4

Usage

{FlashPlayer parameters}

It can use following parameters

Examples

Example 1

{FlashPlayer vdetails=$video_array}

The above would simple display video player with all default settings.

Example 2

{FlashPlayer vdetails=$video_array height='300' width='300'}

This code will display player with your custom height & width.

Usage

{show_rating parameters}

It uses following parameters

Usage

{show_flag_form parameters}

It uses following parameters

For styling, this function uses ‘/blocks/flag_form.html‘ file. Above two parameters are required to make flag form work properly. You can pass any new parameter you want. For example

{show_flag_form id=object_id type=object_type new_param='This is new param'}

To access your new_param, Open flag_form.html and use following

{$params.new_param}

Usage

{show_playlist_form parameters}

It uses following parameters

For styling, this function uses ‘/blocks/playlist_form.html‘ file. Above two parameters are required to make playlist form work properly. You can pass any new parameter you want. For example

{show_playlist_form id=object_id type=object_type new_param='This is new param'}

To access your new_param, Open playlist_form.html and use following

{$params.new_param}

Usage

{show_share_form parameters}

It uses following parameters

For styling, this function uses ‘/blocks/share_form.html‘ file. Above two parameters are required to make share form work properly. You can pass any new parameter you want. For example

{show_share_form id=object_id type=object_type new_param='This is new param'}

To access your new_param, Open share_form.html and use following

{$params.new_param}

Usage

{show_video_rating parameters}

It uses following parameters

For styling, this function uses ‘/blocks/rating.html‘ file.

Usage

{assign var="var_name" value="some_value"}

Example

{assign var="variable" value="Some Value Here"}

Some Value Here is now stored inside $variable. To display, simply write {$variable}.