Work with CCK Filefield. Insert and display Flash

Sometimes it is necessary to display a file on a site not just by reference, but in some other way. Video and audio files you want to display the player, with the ability to view (listen), swf - immediately displayed on the page. There is an excellent Filefield module for attaching files to materials, but the choice of formatters for it is small. The file can be displayed simply by reference. Other modules slightly expand its functionality, for example Imagefield allows you to display images. I will try to explain in an easy way how to add the ability to display Flash content using the example of the SWFfield module.

^{Further there will be a lot of code, few pictures and in general everything is boring and sad ...}

Start

Create a new directory swffield in the modules directory.
As with any module, we will need a .info file, in our case - swffield.info

Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"

1. Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"
2. Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"
3. Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"
4. Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"
5. Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"
6. Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"
7. Copy Source | Copy HTML name = SwfField description = Flash CCK. dependencies[] = content dependencies[] = filefield package = CCK core = 6.x version = "6.x-1.1"

We also need the swffield.install file .

Copy Source | Copy HTML

1. // hook_install (install module)
2. function swffield_install () {
3. // Load the content module
4. drupal_load ( 'module' , 'content' );
5. // We inform CCK about the installation of a new module
6. content_notify ( 'install' , 'swffield' );
7. }
9. // hook_uninstall (remove the module)
10. function swffield_uninstall () {
11. drupal_load ( 'module' , 'content' );
12. // We inform CCK about the removal of the new module
13. content_notify ( 'uninstall' , 'swffield' );
14. }
16. // hook_enable (enable module)
17. function swffield_enable () {
18. drupal_load ( 'module' , 'content' );
19. // We inform CCK about the inclusion of the new module
20. content_notify ( 'enable' , 'swffield' );
21. }
23. // hook_disable (disable module)
24. function swffield_disable () {
25. drupal_load ( 'module' , 'content' );
26. // We inform CCK about disabling the new module
27. content_notify ( 'disable' , 'swffield' );
28. }

Module

We will create the files swffield.module , swffield.render.inc (we will bring here all the code related to displaying the content to the user) and swffield.widget.inc (displaying the field in the admin panel). In principle, all code can be written in swffield.module - it will work.
')
swffield.module

Copy Source | Copy HTML

1. // Connect the necessary files
2. module_load_include ( 'inc' , 'swffield' , 'swffield.render' );
3. module_load_include ( 'inc' , 'swffield' , 'swffield.widget' );
5. // Initialization. Check if Filefield is there, if not, disable the module.
6. function swffield_init () {
7. if (! module_exists ( 'filefield' )) {
8. module_disable ( array ( 'swffield' ));
9. return ;
10. }
11. }
13. // Set the data entry form of the widget and how it is processed.
14. // Our field is no different from the Filefield field
15. function swffield_elements () {
16. $ filefield_elements = module_invoke ( 'filefield' , 'elements' );
17. $ elements [ 'swffield_widget' ] = $ filefield_elements [ 'filefield_widget' ];
19. return $ elements ;
20. }
22. // Report CCK Formatter Information
23. function swffield_field_formatter_info () {
24. $ formatters = array (
25. 'swffield_flash' => array (
26. 'label' => t ( 'Flash' ),
27. 'field types' => array ( 'filefield' ),
28. 'description' => t ( 'Displays Flash content' ),
29. ),
30. );
31. return $ formatters ;
32. }
34. // Specify the standard field value as Filefield.
35. function swffield_default_value (& $ form , & $ form_state , $ field , $ delta ) {
36. return filefield_default_value ( $ form , $ form_state , $ field , $ delta );
37. }
39. // Specify when the field is considered empty
40. function swffield_content_is_empty ( $ item , $ field ) {
41. return filefield_content_is_empty ( $ item , $ field );
42. }
44. // Add another handler to save the field settings
45. function swffield_form_content_field_overview_form_alter (& $ form , & $ form_state ) {
46. $ form [ '#submit' ] [] = 'swffield_form_content_field_overview_submit' ;
47. }
49. // Handler for saving field settings
50. function swffield_form_content_field_overview_submit (& $ form , & $ form_state ) {
51. // If we add a new field to the material
52. if ( isset ( $ form_state [ 'fields_added' ] [ '_add_new_field' ]) && isset ( $ form [ '#type_name' ])) {
53. // Field Type
54. $ new_field = $ form_state [ 'fields_added' ] [ '_add_new_field' ];
55. // Material type
56. $ node_type = $ form [ '#type_name' ];
57. // Array with field data
58. $ field = content_fields ( $ new_field , $ node_type );
59. // If the field is added by our module
60. if ( $ field [ 'widget' ] [ 'module' ] == 'swffield' ) {
61. foreach ( $ field [ 'display_settings' ] as $ display_type => $ display_settings ) {
62. if ( $ field [ 'display_settings' ] [ $ display_type ] [ 'format' ] == 'default' ) {
63. // Set the display of the "swffield_flash" field
64. $ field [ 'display_settings' ] [ $ display_type ] [ 'format' ] = 'swffield_flash' ;
65. }
66. }
67. // Update the field
68. content_field_instance_update ( $ field );
69. }
70. }
71. }

swffield.widget.inc

Copy Source | Copy HTML

1. // Report CCK Widget Information
2. function swffield_widget_info () {
3. return array (
4. 'swffield_widget' => array (
5. 'label' => t ( 'Flash' ),
6. 'field types' => array ( 'filefield' ),
7. 'multiple values' => CONTENT_HANDLE_CORE,
8. 'callbacks' => array ( 'default value' => CONTENT_CALLBACK_CUSTOM),
9. 'description' => 'Flash content' ,
10. ),
11. );
12. }
14. // This hook will be called every time our field is added to the form
15. function swffield_widget (& $ form , & $ form_state , $ field , $ items , $ delta = 0 ) {
16. $ element = filefield_widget ( $ form , $ form_state , $ field , $ items , $ delta );
18. return $ element ;
19. }
21. // Settings widget (field)
22. function swffield_widget_settings ( $ op , $ widget ) {
23. switch ( $ op ) {
24. case 'form' :
25. Return swffield_widget_settings_form ( $ widget );
26. case 'validate' :
27. Return swffield_widget_settings_validate ( $ widget );
28. case 'save' :
29. Return swffield_widget_settings_save ( $ widget );
30. }
31. }
33. // Form of field settings
34. function swffield_widget_settings_form ( $ widget ) {
35. $ form = module_invoke ( 'filefield' , 'widget_settings' , 'form' , $ widget );
36. // By default, CCK substitutes the txt file type.
37. // Replace it with swf
38. if ( $ form [ 'file_extensions' ] [ '#default_value' ] == 'txt' ) {
39. $ form [ 'file_extensions' ] [ '#default_value' ] = 'swf' ;
40. }
41. // Width field to specify the width of the displayed content
42. $ form [ 'width' ] = array (
43. '#type' => 'textfield' ,
44. '#title' => 'Width' ,
45. '#default_value' => $ widget [ 'width' ]? $ widget [ 'width' ]: 470 ,
46. '#size' => 15 ,
47. '#maxlength' => 5 ,
48. '#description' => 'Flash content width' ,
49. '#weight' => 2 . 1 ,
50. );
51. // Similar to "Height"
52. $ form [ 'height' ] = array (
53. '#type' => 'textfield' ,
54. '#title' => 'Height' ,
55. '#default_value' => $ widget [ 'height' ]? $ widget [ 'height' ]: 350 ,
56. '#size' => 15 ,
57. '#maxlength' => 5 ,
58. '#description' => 'Flash content height' ,
59. '#weight' => 2 . 2 ,
60. );
61. // Alternate text settings if the user has Javascript disabled or the Flash Player isn’t
62. $ form [ 'alt_text' ] = array (
63. '#type' => 'textarea' ,
64. '#title' => 'Alternate Text' ,
65. '#default_value' => $ widget [ 'alt_text' ]? $ widget [ 'alt_text' ]: 'Dear friends! <br /> Due to the fact that the technology of our site requires a pre-installed Adobe Flash Player, we strongly recommend that you install the latest version of the plug-in for your browser from <a href = " http://www.adobe.com/go/getflashplayer">Adobe.com </a>. ' ,
66. '#description' => 'This text will be displayed if the user does not have the Flash player installed' ,
67. '#weight' => 2 . 3 ,
68. );
69. return $ form ;
70. }
72. // Settings form validator
73. function swffield_widget_settings_validate ( $ widget ) {
74. $ extensions = array_filter (explode ( '' , $ widget [ 'file_extensions' ]));
75. $ flash_extensions = array ( 'swf' );
76. // Check the file extension
77. if (count (array_diff ( $ extensions , $ flash_extensions ))) {
78. form_set_error ( 'file_extensions' , 'Only SWF format is supported' );
79. }
80. // Check Width And Height
81. foreach ( array ( 'width' , 'height' ) as $ resolution ) {
82. if ( empty ( $ widget [ $ resolution ]) ||! preg_match ( '/ ^ [0-9] + $ /' , $ widget [ $ resolution ])) {
83. form_set_error ( $ resolution , ' Invalid content size specified.' );
84. }
85. }
86. return module_invoke ( 'filefield' , 'widget_settings' , 'validate' , $ widget );
87. }
89. // Save the field settings
90. function swffield_widget_settings_save ( $ widget ) {
91. $ filefield_settings = module_invoke ( 'filefield' , 'widget_settings' , 'save' , $ widget );
92. return array_merge ( $ filefield_settings , array ( 'width' , 'height' , 'alt_text' ));
93. }

swffield.render.inc

Copy Source | Copy HTML

1. // Theme Hook
2. // Set the theme functions for the widget, formatter and site display
3. function swffield_theme () {
4. $ theme = array (
5. 'swffield_widget' => array (
6. 'arguments' => array ( 'element' => NULL),
7. ),
8. 'swffield_formatter_swffield_flash' => array (
9. 'arguments' => array ( 'element' => NULL),
10. ),
11. 'swffield_flash' => array (
12. 'arguments' => array ( 'item' => NULL, 'attributes' => NULL),
13. ),
14. );
15. return $ theme ;
16. }
18. // Theming of the widget is the same as for any element of the form
19. function theme_swffield_widget ( $ element ) {
20. return theme ( 'form_element' , $ element , $ element [ '#children' ]);
21. }
23. // Thematization of the formatter
24. function theme_swffield_formatter_swffield_flash ( $ element ) {
25. // Check if the file is loaded
26. if ( empty ( $ element [ '#item' ] [ 'fid' ])) {
27. return '' ;
28. }
30. $ field = content_fields ( $ element [ '#field_name' ], $ element [ '#node' ] -> type);
31. $ item = $ element [ '#item' ];
33. // Class to display the field
34. $ class = 'swffield swffield-' . $ field [ 'field_name' ];
35. // Return the output using the "swffield_flash" function
36. return theme ( 'swffield_flash' , $ item , array ( 'class' => $ class , 'width' => $ field [ 'widget' ] [ 'width' ], 'height' => $ field [ 'widget' ] [ 'height' ], 'alt' => $ field [ 'widget' ] [ 'alt_text' ]));
37. }
39. // Auxiliary function of themes
40. function theme_swffield_flash ( $ item , $ attributes ) {
41. // Load the library "swfobject.js"
42. drupal_add_js (drupal_get_path ( 'module' , 'swffield' ). "/" . "swfobject.js" );
43. // Generate ID for the displayed item
44. $ id = "swffield-" . rand ( 1 , 10000 );
45. // The path to the file
46. $ file = "/" . $ item [ 'filepath' ];
47. // Ready item
48. return "<div id = '" . $ id . "'class ='" . $ attributes [ 'class' ]. "'>"
49. . $ attributes [ 'alt' ]
50. . "<script type = 'text / javascript'>"
51. . "var flashvars = {};"
52. . "var params = {bgcolor: '# ffffff', allowFullScreen: 'false', allowScriptAccess: 'always', wmode: 'opaque'};"
53. . "new swfobject.embedSWF ('" . $ file . "', '" . $ id . "', '" . $ attributes [ ' width ' ]. "', '" . $ attributes [ ' height ' ]. " ',' 9.0.0 ', false, flashvars, params); "
54. . "</ script>"
55. . "</ div>" ;
56. }

It uses excellent js SWFobject library. The swfobject.js file must be put in the directory with our module.
Another subtle point. For each display of our element on the page, it is necessary to generate a unique ID, by which the content will be inserted later by javascript. I use rand (1, 10000) . If there is a more adequate way, I will be glad to hear it in the comments.

Conclusion

That's all that is needed to add the display of SWF content on the pages of our site. Similarly, you can, for example, add the display "Video Player" for FLV or "Audio Player" for MP3.

Good luck!