Class story_media

Description

A container class for media item associated with a story. Contains a single piece of media which is associated with this story.

Located in /story-defs.php (line 1686)


	
			
Variable Summary
 mixed $caption
 mixed $catalogitem
 mixed $height
 mixed $justify
 mixed $story_id
 mixed $width
Method Summary
 story_media story_media ([mixed $story_id = false], [mixed $item = false], mixed $id)
 void get_catalogitem (integer $catid)
 void keyinfo ()
Variables
mixed $caption = "" (line 1692)

The caption for this item

mixed $catalogitem (line 1690)

The catalogitem object

mixed $height = 0 (line 1698)

Local override height

mixed $justify = "" (line 1694)

The way to justify this item

mixed $story_id = false (line 1688)

ID of story this media belongs to

mixed $width = 0 (line 1696)

Local override width

Methods
Constructor story_media (line 1707)

Create a new piece of story media. This comprises a catalogitem object, and a set of methods to access it.

story_media story_media ([mixed $story_id = false], [mixed $item = false], mixed $id)
  • mixed $id: Story ID, or false if not known
  • mixed $item: Object catalogitem, or false if initially undefined
get_catalogitem (line 1725)

Define this story media object from the given catalog item key. This will obtain the given piece of catalog media from the database and assign the object variables accordingly.

void get_catalogitem (integer $catid)
  • integer $catid: Catalog item ID to obtain
keyinfo (line 1734)

Return the keyinfo string for this media item. This is encoded

as follows, and is used in select combos: 'cat_id|filepath|width|height|justify'

void keyinfo ()

Documentation generated by phpDocumentor 1.3.0RC3