Class: Media

Source Location: /classes/media_class.inc

Class Media

Class Overview

The media class sets properties for uploaded files.

Located in /classes/media_class.inc [line 14]

Cache
   |
   --Media

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Cache

Cache::$allowed_html_tags

Cache::$allowed_text_tags

Cache::$cachestatus

Cache::$errorstatus

Cache::$upload_target_url

Inherited From Cache

Cache::cache_file()

writes a file to disk given it's content and the path.

Cache::cache_ram_file()

caches a ram file to disk given a upload target, a year and a month.

Cache::cache_var()

Writes an array or other variable to disk, in a php-readable format

Cache::check_file_path()

this method will check if your filepath is ok (so no .. and stuff like that).

Cache::clean()

adds slashes to a string if get_magic_quotes_runtime isn't set

Cache::cleanup_email()

cleans up an email_address

Cache::cleanup_filename()

cleans up the name of file

Cache::cleanup_html_value()

cleans up a value that is published as html

Cache::cleanup_number()

cleans up a number

Cache::cleanup_pathname()

cleans up the name of a path.

Cache::cleanup_post()

Removes dangerous HTML from data submitted via POST

Cache::cleanup_text_value()

cleans up a value that is allowed to contain limited html (an article submitted as text/plain)

Cache::cleanup_value()

cleans up a value that should not contain any html at all (the normal procedure)

Cache::clear_error_status()

Clears any existing error status

Cache::clear_update_status()

Clears any existing update status

Cache::create_dir_recursive()

creates a directory recursively

Cache::create_upload_dirs()

this will create the directories we move the article and uploaded files to if they don't exist yet

Cache::display_error_status()

displays the error status.

Cache::do_form()

calls the form we want to use in the publish process given it's name and various options.

Cache::dump()

dumps a variable encapsulated in html

Cache::get_allowed_html_tags()

returns $allowed_html_tags

Cache::get_allowed_text_tags()

returns {$link $allowed_text_tags}

Cache::get_antispam_mail()

returns an emailaddress with antispam blocks in.

Cache::get_cached_var()

Retrieve a cached variable from disk

Cache::get_error_status()

returns the $errorstatus

Cache::get_months()

returns an array of months from 01 to 12

Cache::get_update_status()

returns the $cachestatus

Cache::get_years()

returns an array of years for your calendar

Cache::is_error()

Returns true if there is an existing error

Cache::list_directories()

List the directories in the specified path

Cache::list_files()

Lists the files in the specified directory path

Cache::make_checkbox_form()

renders a checkbox form given it's name, an array with options and an option-array to preselect

Cache::make_multiple_form()

renders a multiple given it's name, an array with options and an option-array to preselect

Cache::make_select_form()

renders a select form given it's name, an array with options and an option to preselect

Cache::make_video_thumbnail()

make a "video thumbnail" of a video uploads

Cache::mirror_html()

mirrors your html files.

Cache::mirror_media()

mirrors your media files

Cache::process_file_metadata()

gets metadata from media file headers and stores them

Cache::process_uploads()

process any uploads from a POST

Cache::rel2abs()

Replaces any relative links with absolute links

Cache::rel2absfield()

Like rel2abs, replaces relative links with absolute links

Cache::render_entities()

strips tags and replaces <,> & ' out of a given html string by their htmlentities

Cache::render_protest_date()

This creates the protest-style dates, like J18 given an input date-string.

Cache::render_var()

Renders an array or other variable into php code

Cache::render_yearmonth_link()

returns a file path given a year and month

Cache::replace_rte_tags()

startx: replaces ugly tags from rte editor

Cache::set_allowed_html_tags()

sets $allowed_html_tags

Cache::set_allowed_text_tags()

sets $allowed_text_tags

Cache::set_date_from_smarty()

sets a unix timestamp from a smarty date array

Cache::set_mysql_date_from_smarty()

sets a mysql datetime from a smarty date/time array

Cache::sf_error_log()

logs an error. (don't know how it's used atm)

Cache::update_error_status()

Allows easy access to adding an update string

Cache::update_status()

Allows easy access to adding an update string

Cache::validate_event_post()

does error checking for $_POST data for a posted event.

Cache::validate_post()

does error checking on $_POST data for an article or comment.

Cache::validate_uploads()

error checking for files submitted via POST

[ Top ]

Property Summary

array	$accepted_types	an array containing the list of extensions we accept
array	$error	an array containing errors
string	$ext	the extention
string	$file	the file
int	$file_size	the size of the file
string	$file_size_string	textual representation of the filesize
string	$file_type	the file_type a certain extention is associated with
string	$mime_type	the mime_type

[ Top ]

Method Summary

Media	Media()	Class constructor. sets the basic properties.
string	get_ext()	returns $ext
string	get_file()	returns $file
int	get_file_size()	returns $file_size
string	get_file_size_string()	returns $file_size_string
string	get_file_type()	returns $file_type
string	get_mime_type()	returns $mime_type
void	render_file()	gets additional info needed to display the file correctly. will call methods if necessary
void	render_image()	sets additional properties needed for handling images
void	render_mpeg_video()	renders mpeg_video
void	render_quicktime()	renders quicktime video
void	render_real_audio()	sets additional properties needed for handling real_audio files
void	render_real_video()	sets additional properties needed for handling real_video files
void	render_video_preview()	sets additional properties for handlingi video_preview files
void	set_accepted_types()	sets $accepted_types
void	set_ext()	sets $ext
void	set_file()	sets $file
void	set_file_size()	sets $file_size
void	set_file_size_string()	sets $file_size_string
void	set_file_type()	sets $file_type
void	set_mime_type()	sets $mime_type

[ Top ]

Properties

array $accepted_types [line 40]

an array containing the list of extensions we accept

[ Top ]

array $error [line 55]

an array containing errors

[ Top ]

string $ext [line 25]

the extention

[ Top ]

string $file [line 20]

the file

[ Top ]

int $file_size [line 45]

the size of the file

[ Top ]

string $file_size_string [line 50]

textual representation of the filesize

[ Top ]

string $file_type [line 35]

the file_type a certain extention is associated with

[ Top ]

string $mime_type [line 30]

the mime_type

[ Top ]

Methods

Constructor Media [line 63]

Media Media(
string
$file, [string
$forced_mime_type = ''], [bool
$check_existence = 0] 
)

Class constructor. sets the basic properties.

Parameters:

string	$file:
string	$forced_mime_type:
bool	$check_existence:

[ Top ]

get_ext [line 111]

string get_ext(
)

returns $ext

[ Top ]

get_file [line 91]

string get_file(
)

returns $file

[ Top ]

get_file_size [line 249]

int get_file_size(
)

returns $file_size

[ Top ]

get_file_size_string [line 275]

string get_file_size_string(
)

returns $file_size_string

[ Top ]

get_file_type [line 221]

string get_file_type(
)

returns $file_type

[ Top ]

get_mime_type [line 140]

string get_mime_type(
)

returns $mime_type

[ Top ]

render_file [line 228]

void render_file(
)

gets additional info needed to display the file correctly. will call methods if necessary

[ Top ]

render_image [line 282]

void render_image(
)

sets additional properties needed for handling images

[ Top ]

render_mpeg_video [line 329]

void render_mpeg_video(
)

renders mpeg_video

[ Top ]

render_quicktime [line 336]

void render_quicktime(
)

renders quicktime video

[ Top ]

render_real_audio [line 305]

void render_real_audio(
)

sets additional properties needed for handling real_audio files

[ Top ]

render_real_video [line 312]

void render_real_video(
)

sets additional properties needed for handling real_video files

[ Top ]

render_video_preview [line 319]

void render_video_preview(
)

sets additional properties for handlingi video_preview files

[ Top ]

set_accepted_types [line 118]

void set_accepted_types(
)

sets $accepted_types

[ Top ]

set_ext [line 98]

void set_ext(
)

sets $ext

[ Top ]

set_file [line 79]

void set_file(
string
$file 
)

sets $file

Parameters:

string

$file:

[ Top ]

set_file_size [line 239]

void set_file_size(
)

sets $file_size

[ Top ]

set_file_size_string [line 256]

void set_file_size_string(
)

sets $file_size_string

[ Top ]

set_file_type [line 147]

void set_file_type(
)

sets $file_type

[ Top ]

set_mime_type [line 128]

void set_mime_type(
[string
$forced_mime_type = ''] 
)

sets $mime_type

Parameters:

string

$forced_mime_type:

[ Top ]

Documentation generated on Tue, 24 Jun 2008 01:03:41 -0700 by phpDocumentor 1.3.0RC3

	sf-active base_classes

[ class tree: sf-active ] [ index: sf-active ] [ all elements ]