These parameters determine various aspects of how the embedded Flash movie will be displayed, and how the page can interact with it. These are the default settings that will be used if specific settings are not provided when the content is being rendered.
Refer to !technote for more details about each setting.
', array('!technote' => l('Adobe technote 12701', 'http://kb.adobe.com/selfservice/viewContent.do?externalId=tn_12701'))), '#tree' => TRUE, ); $form['swftools_params']['version'] = array( '#type' => 'textfield', '#size' => '8', '#title' => 'Minimum Flash version', '#default_value' => $params['version'], ); $form['swftools_params']['play'] = array( '#type' => 'checkbox', '#title' => t('Play immediately (play)'), '#default_value' => $params['play'], ); $form['swftools_params']['loop'] = array( '#type' => 'checkbox', '#title' => t('Loop movie (loop)'), '#default_value' => $params['loop'], ); $form['swftools_params']['menu'] = array( '#type' => 'checkbox', '#title' => t('Full menu (menu)'), '#default_value' => $params['menu'], ); $form['swftools_params']['allowfullscreen'] = array( '#type' => 'checkbox', '#title' => t('Allow full screen mode (allowfullscreen)'), '#default_value' => $params['allowfullscreen'], ); $form['swftools_params']['swliveconnect'] = array( '#type' => 'checkbox', '#title' => t('Load Java (swliveconnect)'), '#default_value' => $params['swliveconnect'], ); $form['swftools_params']['bgcolor'] = array( '#type' => $colorfield, '#title' => t('Background color (bgcolor)'), '#size' => 7, '#maxlength' => 7, '#default_value' => $params['bgcolor'], '#description' => t('Hexadecimal background color in the form #RRGGBB.'), ); $form['swftools_params']['quality'] = array( '#type' => 'select', '#title' => t('Quality') . ' (quality)', '#default_value' => $params['quality'], '#options' => $swf_options['quality'], ); $form['swftools_params']['scale'] = array( '#type' => 'select', '#title' => t('Scale') . ' (scale)', '#default_value' => $params['scale'], '#options' => $swf_options['scale'], ); $form['swftools_params']['wmode'] = array( '#type' => 'select', '#title' => t('Window mode') . ' (wmode)', '#default_value' => $params['wmode'], '#options' => $swf_options['wmode'], ); $form['swftools_params']['align'] = array( '#type' => 'select', '#title' => t('Align') . ' (align)', '#default_value' => $params['align'], '#options' => $swf_options['align'], ); $form['swftools_params']['salign'] = array( '#type' => 'select', '#title' => t('salign') . ' (salign)', '#default_value' => $params['salign'], '#options' => $swf_options['salign'], ); $form['swftools_params']['allowscriptaccess'] = array( '#type' => 'select', '#options' => $swf_options['allowscriptaccess'], '#title' => t('Allow script access') . ' (allowscriptaccess)', '#default_value' => $params['allowscriptaccess'], ); // Add custom form handler to convert 1/0 to true/false $form['#submit'][] = 'swftools_admin_embed_submit'; } // Add custom form handler to flush cache upon submit $form['#submit'][] = 'swftools_admin_settings_submit'; // Return the form return system_settings_form($form); } function swftools_admin_handling_form() { $form = array(); $form['swftools_files'] = array( '#type' => 'fieldset', '#title' => t('File locations'), '#collapsible' => TRUE, '#collapsed' => TRUE, ); $current_path = variable_get('swftools_media_url', $GLOBALS['base_url'] . '/' . file_create_path('')); // Misname the variable with '_dummy' so that it is not saved! $form['swftools_files']['swftools_media_url_dummy'] = array( '#type' => 'textfield', '#title' => t('Media directory url'), '#default_value' => $current_path, '#disabled' => TRUE, '#description' => t("This helps swftools identify the server where your media files are located. You cannot change it here, as changing it has the potential to break existing content. You can set this on the $conf array in your settings.php file. For example:
$conf = array(
'swftools_media_url' => 'http://anothersite.com/media', // No trailing slashes!
); Leaving this value unset in your settings.php file will
persuade SWF Tools to check for the existence of your
media files, as they are automatically assumed to be
on the local server."),
);
$form['swftools_files']['swftools_check_media'] = array(
'#type' => 'radios',
'#title' => t('File checking'),
'#options' => array(
1 => t('Enabled - check that local files exist.'),
0 => t('Disabled - do not check that local files exist.'),
),
'#default_value' => variable_get('swftools_check_media', TRUE),
'#description' => t('This option will cause SWF Tools to check that requested local
media files exist, and issue a warning if they do not. If this
option is set to do not check then the mark up will be placed on
the page irrespective of whether the file is actually present.'),
);
// Get handling form by calling the profile form with no profile setting
$form += swftools_handling_profile_form();
// Make handlers collapsible
$form['swftools_handlers'] += array(
'#type' => 'fieldset',
'#title' => t('File handling'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#description' => t('Choose how different file types are handled.'),
);
$form['swftools_private'] = array(
'#type' => 'fieldset',
'#title' => t('Private file system'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
// Allow SWF Tools to grant access to non-uploaded files
$form['swftools_private']['swftools_grant_access_to_private_files'] = array(
'#type' => 'radios',
'#title' => t('Access to supported private files'),
'#options' => array(
1 => t('Enabled'),
0 => t('Disabled'),
),
'#default_value' => variable_get('swftools_grant_access_to_private_files', SWFTOOLS_PRIVATE_ACCESS_DENIED),
'#description' => t('If using a private file system then SWF Tools is unable to
access files that are not uploaded via a file module that
supports a private file system. For example, SWF Tools will
be unable to access files that were manually uploaded via FTP.
Enabling this setting will allow SWF Tools to grant access
to files with extensions defined by the next setting.
Note - if another module denies access then access
to the file will not be granted. SWF Tools itself does not
deny access to any file.
'),
);
// Should SWF Tools allow access to private files?
$form['swftools_private']['swftools_grant_access_extensions'] = array(
'#type' => 'textfield',
'#title' => t('Extensions that SWF Tools will allow access to'),
'#default_value' => variable_get('swftools_grant_access_extensions', SWFTOOLS_PRIVATE_ACCESS_ALLOWED_EXTENSIONS),
'#maxlength' => 255,
'#description' => t('Under a private file system SWF Tools will grant access to files
with extensions in this list. Separate extensions with a space
and do not include the leading dot. Although any extension can be
added to this list, only swf flv xml mp3 jpg jpeg and
png will return the correct headers.'),
);
// Get current mime type array
$mime_types = _swftools_mime_types();
// $mime_types are stored as an array where key is the extension, and value is the mime type
$defaults = array();
// Turn each key/value pair in to a string
foreach ($mime_types as $extension => $type) {
$defaults[] = $extension . ' ' . $type;
}
// Implode the resulting array to create a single string for presenation
$defaults = implode("\n", $defaults);
// Put text area on the page
$form['swftools_private']['swftools_mime_types_input'] = array(
'#type' => 'textarea',
'#title' => t('Mime types'),
'#default_value' => $defaults,
'#description' => t('Enter a list of additional extensions that SWF Tools should recognise. Put each extension on a separate line, with the
extension first, followed by a space, and then the mime type for that type of file.'),
);
$form['swftools_advanced'] = array(
'#type' => 'fieldset',
'#title' => t('Advanced settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
// Enable SWF Tools cache?
$form['swftools_advanced']['swftools_cache'] = array(
'#type' => 'radios',
'#title' => t('SWF Tools cache'),
'#options' => array(
CACHE_DISABLED => t('Disabled'),
CACHE_NORMAL => t('Enabled (recommended)'),
),
'#default_value' => variable_get('swftools_cache', CACHE_NORMAL),
'#description' => t('During site development it can be helpful to disable the cache and
force content to be regenerated on every page call. Note that content
being generated via an input filter is always cached by the input filter
itself and disabling the SWF Tools cache will not stop the filter cache.
Even when the SWF Tools cache is disabled it will continue to store content
to allow features such as serving content from %path to function.', array('%path' => base_path() . 'swftools/html/nn')),
);
// Allow SWF Tools to grant access to content from the cache?
$form['swftools_advanced']['swftools_grant_access_to_cache'] = array(
'#type' => 'radios',
'#title' => t('Allow cached content to be served'),
'#options' => array(
0 => t('Disabled'),
1 => t('Enabled'),
),
'#default_value' => variable_get('swftools_grant_access_to_cache', 0),
'#description' => t('SWF Tools stores generated content in its own cache. You can simplify
the use of features like LightBox by allowing access to content directly
from the cache via the path %path, where %cid is the 32 character cid of
the content. SWF Tools will serve a basic page with nothing but the flash
content. The only access control is that the user has the %access permission.
', array('%path' => base_path() . 'swftools/html/nn', '%cid' => 'nn', '%access' => 'access content')),
);
// Where should error messages be written?
$form['swftools_advanced']['swftools_error_output'] = array(
'#type' => 'radios',
'#title' => t('Error messages'),
'#options' => array(
SWFTOOLS_ERROR_NONE => t('None'),
SWFTOOLS_ERROR_WATCHDOG => t('Watchdog'),
SWFTOOLS_ERROR_SCREEN => t('Screen'),
SWFTOOLS_ERROR_WATCHDOG_AND_SCREEN => t('Watchdog and screen'),
),
'#default_value' => variable_get('swftools_error_output', SWFTOOLS_ERROR_WATCHDOG_AND_SCREEN),
'#description' => t('If SWF Tools encounters an error when trying to determine how to embed a piece of content it will generate an error message to help diagnose the problem. These messages can be written to the screen, which is useful when setting a site up, but in a production environment you might prefer to just log them in the watchdog.'),
);
// Get available actions - this is just a list of available actions and descriptions about them
$actions = swftools_get_actions();
// Get the array of actions, keyed on extension
$_extensions = _swftools_actions();
// Turn it around to we are organised by action
foreach ($_extensions as $extension => $action) {
$extensions[$action][] = $extension;
}
// Make extensions an array
$form['swftools_advanced']['swftools_extensions'] = array(
'#tree' => TRUE,
);
// Put each option on the form to let the user assign extensions to each available action
foreach ($actions as $action => $info) {
// Only output single file handlers (list handlers handle collections of single files of the same type)
if(substr($action, -5) != '_list') {
// Place an option on the page
$form['swftools_advanced']['swftools_extensions'][$action] = array(
'#type' => 'textfield',
'#title' => t('Extensions to associate with ' . $info['#type']),
'#default_value' => isset($extensions[$action]) ? implode(' ', $extensions[$action]) : '',
'#description' => t('Enter a list of extensions, separated by spaces, that SWF Tools should associate with ' . $info['#type'] . '.'),
'#weight' => 1 + $info['#weight'] / 10,
);
}
}
// Add custom form handler to flush cache upon submit
$form['#submit'][] = 'swftools_admin_settings_submit';
// Add custom handler to process extension handling
$form['#submit'][] = 'swftools_admin_extensions_submit';
// Add custom handler to process extension handling
$form['#submit'][] = 'swftools_admin_mime_type_submit';
// Return finished form
return system_settings_form($form);
}
function _swftools_admin_file_handling_options($action, $description, $profile = '') {
// Initialise list of methods
$list = array();
// Obtain list of available methods
$methods = swftools_get_methods($action);
if (count($methods)) {
foreach ($methods AS $method => $info) {
if ($info['library'] && !file_exists($info['library'])) {
$list[$method] = $info['title'] . ' - Missing '. $info['library'] .'';
if (isset($info['donwload']) && $info['download']) {
$list[$method] = $list[$method] . ' - ' . l(t('Download here'), $info['download']);
}
}
else {
$list[$method] = $info['title'];
}
}
}
// If there are no handlers reporting then return now
if (!$list) {
return;
}
// Sort the list of methods
asort($list);
// None is always an option so add this at the top of the list, unless 'swf'
if ($action != 'swf') {
$list = array(t('None')) + $list;
}
// Determine the appropriate default based on $action
$default = swftools_get_player($action, $profile);
// swftools_get_player() returns FALSE for nothing configured, change to 0
if (!$default) {
$default = 0;
}
return array(
'#type' => 'radios',
'#title' => t('Default player for ' . $description),
'#default_value' => $default,
'#options' => $list,
);
}
/**
* flashvar and param option arrays. These are used for options settings in the
* configuration screen and also as a lookup (particularly 'bool') to output the correct value for to html.
*
*/
function _swftools_options() {
// cache output each request
static $swf_options = array();
if (!count($swf_options)) {
$swf_options['quality'] = array('low' => 'low', 'autolow' => 'autolow', 'medium' => 'medium', 'high' => 'high', 'autohigh' => 'autohigh', 'best' => 'best', );
$swf_options['wmode'] = array('window' => 'window', 'opaque' => 'opaque', 'transparent' => 'transparent', );
$swf_options['scale'] = array('showall' => 'showall', 'noborder' => 'noborder', 'exactfit' => 'exactfit', );
$swf_options['align'] = array('default' => 'centered', 'l' => 'left', 'r' => 'right', 't' => 'top', 'b' => 'bottom', );
$swf_options['salign'] = array('l' => 'left', 'r' => 'right', 't' => 'top', 'b' => 'bottom', 'tl' => 'top left', 'tr' => 'top right', 'bl' => 'bottom left', 'br' => 'bottom right', );
$swf_options['bool'] = array('default' => 'default', 'true' => 'true', 'false' => 'false');
$swf_options['allowscriptaccess'] = array('always' => 'always', 'sameDomain' => 'sameDomain', 'never' => 'never');
}
return $swf_options;
}
/**
* Menu callback: Settings form for configuring CCK playlist fallbacks.
*/
function swftools_admin_cck_form() {
// Get a list of all content types in use
$content_types = content_types();
// Get a list of all the CCK fields that are in use
$fields = content_fields();
// Get a list of all field types (this contains the list of formatters)
$field_types = _content_field_types();
// Put a description on the page
$form['description'] = array(
'#value' => '' . t('For content that is being formatted as an SWF Tools playlist you can specify an alternate format that should be used if a single file is passed to the playlist function. For example, display a single image as a regular image instead of placing it in a slideshow.') . '
', ); // Initialise an empty array $swftools_types = array(); // Discover what field types are supporting SWF Tools formatters foreach ($field_types as $type => $data) { if (isset($data['formatters']['swftools_playlist'])) { $swftools_types[] = $type; } } // Sort the list of types ready for output asort($swftools_types); // If the array is empty no field type is supporting the playlist formatter if (!$swftools_types) { // Just return an informative message $form['no fields'] = array( '#value' => '' . t('No CCK fields that support SWF Tools playlists have been created.') . '
', ); } else { // Iterate over types that support SWF Tools formatters foreach ($swftools_types as $swftools_type) { // Add descriptive message $form['filefields'] = array( '#value' => '' . t('Content types that contain fields that have been configured to be formatted as an SWF Tools playlist are listed below.') . '
', ); // Initialise an array to hold formatters $options = array(); // Collect all the available formatters foreach ($field_types[$swftools_type]['formatters'] as $formatter_name => $formatter_info) { $options[$formatter_name] = $formatter_info['label']; } // Add hidden as an optional formatter $options['hidden'] = t('