Docs For Class FlickrSilo

Description

Implements interfaces:

MediaSilo

Flickr Silo

version: $Id$
copyright: 2008

Located in /system/plugins/flickrsilo/flickrsilo.plugin.php (line 446)

Pluggable
   |
   --Plugin
      |
      --FlickrSilo

Class Constant Summary

SILO_NAME = 'Flickr'

Variable Summary

static mixed $cache

Method Summary

void action_admin_footer ( $theme)

void action_init ()

void action_plugin_ui (string $plugin_id, string $action)

array filter_plugin_config (array $actions, string $plugin_id)

void info ()

array silo_contents (string $path)

void silo_delete (string $path)

array silo_dir (string $path)

MediaAsset silo_get (string $path, [array $qualities = null])

array silo_highlights ()

void silo_info ()

MediaAsset silo_new (string $path)

array silo_permissions (string $path)

void silo_put (string $path, $filedata, MediaAsset $)

string silo_url (string $path, [array $qualities = null])

Variables

static mixed $cache = array() (line 450)

Inherited Variables

Inherited from Pluggable

Pluggable::$info
Pluggable::$plugin_id

Methods

action_admin_footer (line 831)

access: public

void action_admin_footer ( $theme)

$theme

action_init (line 471)

Initialize some internal values when plugin initializes

access: public

void action_init ()

action_plugin_ui (line 772)

Respond to the user selecting an action on the plugin page

access: public

void action_plugin_ui (string $plugin_id, string $action)

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

filter_plugin_config (line 749)

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

return: The array of actions to attach to the specified $plugin_id
access: public

array filter_plugin_config (array $actions, string $plugin_id)

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

info (line 455)

Provide plugin info to the system

access: public

void info ()

Redefinition of:

Plugin::info(): Returns information about this plugin

silo_contents (line 727)

Return directory contents for the silo path

return: An array of MediaAssets describing the contents of the directory
access: public

array silo_contents (string $path)

string $path: The path to retrieve the contents of

silo_delete (line 697)

Delete the file at the specified path

access: public

void silo_delete (string $path)

string $path: The path of the file to retrieve

Implementation of:

MediaSilo::silo_delete(): Delete the file at the specified path

silo_dir (line 496)

Return directory contents for the silo path

return: An array of MediaAssets describing the contents of the directory
access: public

array silo_dir (string $path)

string $path: The path to retrieve the contents of

Implementation of:

MediaSilo::silo_dir(): Return directory contents for the silo path

silo_get (line 645)

Get the file from the specified path

return: The requested asset
access: public

MediaAsset silo_get (string $path, [array $qualities = null])

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

Implementation of:

MediaSilo::silo_get(): Get the file from the specified path

silo_highlights (line 707)

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

return: An array of MediaAssets to highlihgt from this silo
access: public

array silo_highlights ()

Implementation of:

MediaSilo::silo_highlights(): Retrieve a set of highlights from this silo

silo_info (line 480)

Return basic information about this silo

name- The name of the silo, used as the root directory for media in this silo icon- An icon to represent the silo

access: public

void silo_info ()

Implementation of:

MediaSilo::silo_info(): Return basic information about this silo

silo_new (line 678)

Create a new asset instance for the specified path

return: The requested asset
access: public

MediaAsset silo_new (string $path)

string $path: The path of the new file to create

silo_permissions (line 717)

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

return: An array of permissions constants (MediaSilo::PERM_READ, MediaSilo::PERM_WRITE)
access: public

array silo_permissions (string $path)

string $path: The path to retrieve permissions for

Implementation of:

MediaSilo::silo_permissions(): Retrieve the permissions for the current user to access the specified path

silo_put (line 688)

Store the specified media at the specified path

access: public

void silo_put (string $path, $filedata, MediaAsset $)

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

Implementation of:

MediaSilo::silo_put(): Store the specified media at the specified path

silo_url (line 656)

Get the direct URL of the file of the specified path

return: The requested url
access: public

string silo_url (string $path, [array $qualities = null])

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

Inherited Methods

Inherited From Plugin

Plugin::__construct()
Plugin::add_template()
Plugin::info()
Plugin::_plugin_available_templates()
Plugin::_plugin_include_template_file()

Inherited From Pluggable

Pluggable::__construct()
Pluggable::get_db_schema()
Pluggable::get_file()
Pluggable::get_url()
Pluggable::load()
Pluggable::load_text_domain()
Pluggable::plugin_id()

Class Constants

SILO_NAME = 'Flickr' (line 448)