Inheritance diagram for ViddlerSilo:

Collaboration diagram for ViddlerSilo:

Public Member Functions
	action_init ()
	silo_info ()
	silo_dir ($path)
	silo_get ($path, $qualities=null)
	silo_url ($path, $qualities=null)
	silo_new ($path)
	silo_put ($path, $filedata)
	silo_delete ($path)
	silo_highlights ()
	controls ()
	silo_upload_form ()
	upload_form ()
	silo_permissions ($path)
	filter_plugin_config ($actions, $plugin_id)
	action_plugin_ui ($plugin_id, $action)
	updated_config ($ui)
	action_admin_header ($theme)
	link_panel ($path, $panel, $title)
	filter_media_controls ($controls, $silo, $path, $panelname)
	filter_media_panels ($panel, $silo, $path, $panelname)
Public Attributes
const	SILO_NAME = 'Viddler'
Protected Attributes
	$cache = array()

Detailed Description

Viddler Silo

Definition at line 555 of file viddlersilo.plugin.php.

Member Function Documentation

ViddlerSilo::action_init ( )

Initialize some internal values when plugin initializes

Definition at line 582 of file viddlersilo.plugin.php.

ViddlerSilo::action_plugin_ui	(	$	plugin_id,
		$	action
	)

Respond to the user selecting an action on the plugin page

Parameters:

	string	$plugin_id The string id of the acted-upon plugin
	string	$action The action string supplied via the filter_plugin_config hook

Definition at line 803 of file viddlersilo.plugin.php.

ViddlerSilo::filter_media_controls	(	$	controls,
		$	silo,
		$	path,
		$	panelname
	)

Provide controls for the media control bar

Parameters:

	array	$controls Incoming controls from other plugins
	MediaSilo	$silo An instance of a MediaSilo
	string	$path The path to get controls for
	string	$panelname The name of the requested panel, if none then emptystring

Returns:: array The altered $controls array with new (or removed) controls

Todo:: This should really use FormUI, but FormUI needs a way to submit forms via ajax

Definition at line 921 of file viddlersilo.plugin.php.

ViddlerSilo::filter_media_panels	(	$	panel,
		$	silo,
		$	path,
		$	panelname
	)

Provide requested media panels for this plugin

Parameters:

	string	$panel The HTML content of the panel to be output in the media bar
	MediaSilo	$silo The silo for which the panel was requested
	string	$path The path within the silo (silo root omitted) for which the panel was requested
	string	$panelname The name of the requested panel

Returns:: string The modified $panel to contain the HTML output for the requested panel

Todo:: Move the uploaded file from the temporary location to the location indicated by the path field.

Definition at line 944 of file viddlersilo.plugin.php.

ViddlerSilo::filter_plugin_config	(	$	actions,
		$	plugin_id
	)

Add actions to the plugin page for this plugin The authorization should probably be done per-user.

Parameters:

	array	$actions An array of actions that apply to this plugin
	string	$plugin_id The string id of a plugin, generated by the system

Returns:: array The array of actions to attach to the specified $plugin_id

Definition at line 785 of file viddlersilo.plugin.php.

ViddlerSilo::link_panel	(	$	path,
		$	panel,
		$	title
	)

Produce a link for the media control bar that causes a specific panel to be displayed

Parameters:

	string	$path The path to pass
	string	$path The panel to display
	string	$title The text to use for the link in the control bar

Returns:: string The link to create

Definition at line 905 of file viddlersilo.plugin.php.

ViddlerSilo::silo_delete ( $ path )

Delete the file at the specified path

Parameters:

string

$path The path of the file to retrieve

Implements MediaSilo.

Definition at line 698 of file viddlersilo.plugin.php.

ViddlerSilo::silo_dir ( $ path )

Return directory contents for the silo path

Parameters:

string

$path The path to retrieve the contents of

Returns:: array An array of MediaAssets describing the contents of the directory

Implements MediaSilo.

Definition at line 609 of file viddlersilo.plugin.php.

ViddlerSilo::silo_get	(	$	path,
		$	qualities = `null`
	)

Get the file from the specified path

Parameters:

	string	$path The path of the file to retrieve
	array	$qualities Qualities that specify the version of the file to retrieve.

Returns:: MediaAsset The requested asset

Implements MediaSilo.

Definition at line 649 of file viddlersilo.plugin.php.

ViddlerSilo::silo_highlights ( )

Retrieve a set of highlights from this silo This would include things like recently uploaded assets, or top downloads

Returns:: array An array of MediaAssets to highlihgt from this silo

Implements MediaSilo.

Definition at line 708 of file viddlersilo.plugin.php.

ViddlerSilo::silo_info ( )

Return basic information about this silo name- The name of the silo, used as the root directory for media in this silo

Implements MediaSilo.

Definition at line 593 of file viddlersilo.plugin.php.

ViddlerSilo::silo_new ( $ path )

Create a new asset instance for the specified path

Parameters:

string

$path The path of the new file to create

Returns:: MediaAsset The requested asset

Definition at line 679 of file viddlersilo.plugin.php.

ViddlerSilo::silo_permissions ( $ path )

Retrieve the permissions for the current user to access the specified path

Parameters:

string

$path The path to retrieve permissions for

Returns:: array An array of permissions constants (MediaSilo::PERM_READ, MediaSilo::PERM_WRITE)

Implements MediaSilo.

Definition at line 773 of file viddlersilo.plugin.php.

ViddlerSilo::silo_put	(	$	path,
		$	filedata
	)

Store the specified media at the specified path

Parameters:

	string	$path The path of the file to retrieve
	MediaAsset	$ The asset to store

Implements MediaSilo.

Definition at line 689 of file viddlersilo.plugin.php.

ViddlerSilo::silo_url	(	$	path,
		$	qualities = `null`
	)

Get the direct URL of the file of the specified path

Parameters:

	string	$path The path of the file to retrieve
	array	$qualities Qualities that specify the version of the file to retrieve.

Returns:: string The requested url

Definition at line 660 of file viddlersilo.plugin.php.

ViddlerSilo::updated_config ( $ ui )

Returns true if plugin config form values defined in action_plugin_ui should be stored in options by Habari

Returns:: boolean True if options should be stored

Definition at line 844 of file viddlersilo.plugin.php.

The documentation for this class was generated from the following file:

system/plugins/viddlersilo/viddlersilo.plugin.php

ViddlerSilo Class Reference

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation