portfolio_format_text Class Reference

Class for plain text format. More...

Inheritance diagram for portfolio_format_text:

Static Public Member Functions
static	conflicts ($format)
	Whether this format conflicts with the given format.
static	file_output ($file, $options=null)
	Given a file, return a snippet of markup in whatever format to link to that file.
static	get_file_directory ()
	For multipart formats, eg html with attachments, we need to have a directory to place associated files from inside the zip file.
static	make_tag ($file, $path, $attributes)
	Create portfolio tag.
static	mimetypes ()
	Return plain text mimetypes.

Detailed Description

Class for plain text format.

Not sure why we would need this yet, but since resource module wants to export it... we can

Copyright

2008 Penny Leach

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

conflicts()

static portfolio_format_text::conflicts ( $format )

static

Whether this format conflicts with the given format.

This is used for the case where an export location "generally" supports something like FORMAT_PLAINHTML but then in a specific export case, must add attachments, which means that FORMAT_RICHHTML is supported in that case, which implies removing support for FORMAT_PLAINHTML. Note that conflicts don't have to be bi-directional (eg FORMAT_PLAINHTML conflicts with FORMAT_RICHHTML but not the other way around) and things within the class hierarchy are resolved automatically anyway. This is really just between subclasses of format_rich and subclasses of format_file.

Parameters

string

$format

one of the FORMAT_XX constants

Return values

bool

Reimplemented from portfolio_format.

file_output()

static portfolio_format_file::file_output ( $file, $options = null )

staticinherited

Given a file, return a snippet of markup in whatever format to link to that file.

Usually involves the path given by get_file_directory. This is not supported in subclasses of portfolio_format_file since they're all just single files.

See also

get_file_directory

Parameters

stored_file	$file	informations object
array	$options	array of options to pass. can contain: attributes => hash of existing html attributes (eg title, height, width, etc)

Reimplemented from portfolio_format.

get_file_directory()

static portfolio_format_file::get_file_directory ( )

staticinherited

For multipart formats, eg html with attachments, we need to have a directory to place associated files from inside the zip file.

This is the name of that directory

Return values

bool

Reimplemented from portfolio_format.

make_tag()

static portfolio_format::make_tag ( $file, $path, $attributes )

staticinherited

Create portfolio tag.

Parameters

stored_file	$file	file information object
string	$path	file path
array	$attributes	portfolio attributes

Return values

string

mimetypes()

static portfolio_format_text::mimetypes ( )

static

Return plain text mimetypes.

Return values

array

Reimplemented from portfolio_format_file.

---

The documentation for this class was generated from the following file:

• lib/portfolio/formats.php