[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/swftools/ -> swftools.module.orig (summary)

(no description)

File Size: 1925 lines (71 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 36 functions

  swftools_init()
  swftools_menu()
  swftools_perm()
  swf_list()
  swf()
  theme_swftools_embed()
  swftools_methods_available()
  swftools_json_params()
  _swftools_tf()
  swftools_get_action()
  swftools_get_player()
  swftools_get_playlist_path()
  swftools_get_player_path()
  swftools_get_media_path()
  swftools_get_media_url()
  _swftools_get_flashvars_string()
  _swftools_params()
  swftools_get_info()
  swftools_generate_playlist()
  swftools_push_js()
  swftools_prepare_playlist_data()
  swftools_filter_tips()
  swftools_filter()
  _swftools_filter_process_text()
  swftools_get_filter_alias()
  swftools_url_parse()
  swftools_theme()
  swftools_file_download()
  swftools_swftools_embed()
  swftools_admin_form_submit()
  swftools_swftools_methods()
  swftools_strip_base_root()
  swftools_set_size()
  swftools_field_formatter_info()
  theme_swftools_formatter_swftools()
  theme_swftools_formatter_playlist()

Functions
Functions that are not part of a class:

swftools_init()   X-Ref
Implementation of hook_init()
swftools_init() is used to force embedding JavaScript on to all pages


swftools_menu()   X-Ref
Implementation of hook_menu().


swftools_perm()   X-Ref
Implementation of hook_perm().


swf_list($playlist_data, $options = array()   X-Ref
Take an array of play list data and options, and return a markup string.

param: $playlist_data
param: $options
return:

swf($file, $options = array()   X-Ref
Return output, which might be embed markup, or pre-flash markup
that includes the appropriate jQuery added to the <head>

param: $file
param: $options=>$params
param: $options=>$flashvars
param: $options=>$othervars
param: $options=>$methods

theme_swftools_embed($embed_markup, $action, $methods, $vars, $html_alt)   X-Ref
Produce finished markup ready for inserting on the page

param: $embed_markup
param: $action
param: $methods
param: $vars
param: $html_alt
return:

swftools_methods_available($action = NULL, $reset = FALSE)   X-Ref
Collect information from all modules about the players and embedding methods available.

param: $action
param: $reset
return:

swftools_json_params(&$params, $attr = 'swftools')   X-Ref
No description

_swftools_tf($bool)   X-Ref
Returns 'true' or 'false' for JavaScript based the supplied value $bool.

param: $bool
return:

swftools_get_action($file)   X-Ref
Identify the most likely SWF Tools action for a file, based on its extension.

param: $file
return:

swftools_get_player($action)   X-Ref
Identify the currently configured player for the specified action.

param: $action
return:

swftools_get_playlist_path($dir = FALSE)   X-Ref
Returns the playlist path relative to webroot.
This path needs to be writeable, so it is fitting to limit valid
locations to the files directory.


swftools_get_player_path($dir = FALSE)   X-Ref
Returns a flash player path relative to webroot.
The default path is in the modules/swftools/shared directory.
It may suit some sites to store flash players in an alternative location, but
the assumption is the location will be on the same server.
If the path starts with '/', then we can assume is relative to the webroot.
Otherwise we assume it's in the files directory.

param: $dir
return:

swftools_get_media_path()   X-Ref
Returns the media path relative to webroot.
There is a setting called 'swftools_media_url'. If this is set, we assume the
media is on a different server.

return:

swftools_get_media_url($path, $is_file = TRUE)   X-Ref
Resolve a path to a full url, either on the local file system, or at a remote address
if the swftools_media_url variable has been set. If the path describes a file, is local
and the swftools_check_media variable is set then check if the file exists.
The path must be relative to the webroot.

param: $path
param: $is_file
return:

_swftools_get_flashvars_string(&$flashvars)   X-Ref
"flashvars" is a parameter like height and width, which are
passed into the flash player as a=1&b=2&...


_swftools_params()   X-Ref
Return an array of default values to use as the swf parameters.
Parameters are described in the Adobe knowledge base TechNote 12701
http://kb.adobe.com/selfservice/viewContent.do?externalId=tn_12701

return:

swftools_get_info($file)   X-Ref
Attempt to return information for the specified file
Supply the path to the file to be processed, and it return FALSE if no data
was obtained. The return variable, if successful, is an array that may
include width, height, extension, file_size, mime_type.


swftools_generate_playlist(&$playlist_data, $playlist_name, &$method, &$vars)   X-Ref
Saves a playlist (xml file) to the playlist directory ready for the swf player to use.

param: &$playlist_data
param: $playlist_name
param: $method
param: &$vars
return:

swftools_push_js($embed = SWFDEFAULT)   X-Ref
Add to the page any supporting files required by a given embedding method.

param: $embed
return:

swftools_prepare_playlist_data($files, $title = '', $get_action = TRUE, $type_filter = array()   X-Ref
Take an array of filenames and prepare them to be used as a playlist

param: $files
param: $title
param: $get_action
param: $type_filter
param: $stream
return: unknown_type

swftools_filter_tips($delta, $format, $long = false)   X-Ref
No description

swftools_filter($op, $delta = 0, $format = -1, $text = '')   X-Ref
No description

_swftools_filter_process_text($text)   X-Ref
No description

swftools_get_filter_alias($var, $player = FALSE)   X-Ref
No description

swftools_url_parse($string)   X-Ref
No description

swftools_theme()   X-Ref
Implementation of hook_theme


swftools_file_download($file)   X-Ref
Implementation of hook_file_download
Allows SWF Tools to work with a private file system that might include files
upload outside the control of an upload module, e.g. FTP of large video files
If the file is in the playlists directory then return a valid header.
If the file is of a supported type, based on extension, then return a valid header.
Note: if any other module returns -1 for this file then access will be denied
even if SWF Tools tries to allow it. See hook_file_download for details.


swftools_swftools_embed($action = 'add_js', $methods = FALSE, $vars = FALSE, $html_alt = '')   X-Ref
Implementation of swftools_embed hook
Returns the markup for the page.
This method generates standards compliant HTML


swftools_admin_form_submit($form, &$form_state)   X-Ref
No description

swftools_swftools_methods()   X-Ref
Report the methods that are supported by the SWF Tools module.

return:

swftools_strip_base_root($file)   X-Ref
Return a customised file download url that doesn't include the $base_root

param: $file
return:

swftools_set_size(&$vars, $player = array()   X-Ref
Helper function to set the size of the swf content in to $vars->params

param: $vars
param: $player
return:

swftools_field_formatter_info()   X-Ref
Implementation of hook_field_formatter_info().


theme_swftools_formatter_swftools($element)   X-Ref
Theme function to turn CCK filefield in to flash content.

param: $element
return:

theme_swftools_formatter_playlist($element)   X-Ref
Theme function to turn multiple value CCK filefield in to a playlist.

param: $element
return:



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7