Example: Files

You are here

Examples demonstrating the Drupal File API (and Stream Wrappers).

The File Example module is a part of the Examples for Developers Project and provides various Drupal File API Examples. You can download and experiment with this code at the Examples for Developers project page.

See Drupal File API for handbook documentation on the File API and File summary on api.drupal.org for the function summary.

Functions

Namesort descending Location Description
file_example_check_directory_submit file_example/file_example.module Submit handler to test directory existence.
file_example_create_directory_submit file_example/file_example.module Submit handler for directory creation.
file_example_delete_directory_submit file_example/file_example.module Submit handler for directory deletion.
file_example_delete_submit file_example/file_example.module Submit handler to delete a file.
file_example_file_check_exists_submit file_example/file_example.module Submit handler to check existence of a file.
file_example_get_managed_file file_example/file_example.module Utility function to check for and return a managed file.
file_example_intro file_example/file_example.module A simple introduction to the workings of this module.
file_example_managed_write_submit file_example/file_example.module Submit handler to write a managed file.
file_example_menu file_example/file_example.module Implements hook_menu().
file_example_permission file_example/file_example.module Implements hook_permission().
file_example_readwrite file_example/file_example.module Form builder function.
file_example_read_submit file_example/file_example.module Submit handler for reading a stream wrapper.
file_example_session_contents file_example/file_example.module Show the contents of a session file.
file_example_show_session_contents_submit file_example/file_example.module Utility submit function to show the contents of $_SESSION.
file_example_stream_wrappers file_example/file_example.module Implements hook_stream_wrappers().
file_example_unmanaged_php_submit file_example/file_example.module Submit handler to write an unmanaged file using plain PHP functions.
file_example_unmanaged_write_submit file_example/file_example.module Submit handler to write an unmanaged file.

Classes

Namesort descending Location Description
FileExampleSessionStreamWrapper file_example/file_example_session_streams.inc Example stream wrapper class to handle session:// streams.
FileExampleTest file_example/file_example.test Functional tests for the File Example module.

File

file_example/file_example.module, line 7
Examples demonstrating the Drupal File API (and Stream Wrappers).