Docs For Class Media

Description

Located in /includes/media_class.php (line 34)

GedcomRecord
   |
   --Media

Variable Summary

mixed $disp

mixed $ext

mixed $famlist

mixed $file

mixed $filesize

mixed $height

mixed $indilist

mixed $note

mixed $title

mixed $width

Method Summary

Media Media (string $gedrec)

boolean canDisplayDetails ()

void equals ( &$obj, GedcomRecord $obj)

string getAddTitle ()

string getFilename ()

string getFilesize ()

string getFiletype ()

void &getInstance (string $pid, [ $simple = true])

void getLinkUrl ()

void getNote ()

string getSortableName ()

string getThumbnail ()

string getTitle ()

mixed in_obje_list ( &$obje, Media $obje)

Variables

mixed $disp = true (line 35)

mixed $ext = "" (line 38)

mixed $famlist = null (line 44)

mixed $file = "" (line 37)

mixed $filesize = -1 (line 40)

mixed $height = 0 (line 42)

mixed $indilist = null (line 43)

mixed $note = "" (line 39)

mixed $title = "" (line 36)

mixed $width = 0 (line 41)

Inherited Variables

Inherited from GedcomRecord

GedcomRecord::$changed
GedcomRecord::$gedrec
GedcomRecord::$rfn
GedcomRecord::$type
GedcomRecord::$xref

Methods

Constructor Media (line 50)

Constructor for media object

Media Media (string $gedrec)

string $gedrec: the raw repository gedcom record

canDisplayDetails (line 98)

Check if privacy options allow this record to be displayed

boolean canDisplayDetails ()

Redefinition of:

GedcomRecord::canDisplayDetails(): can the details of this record be shown

equals (line 252)

check if this object is equal to the given object

basically just checks if the IDs are the same

void equals ( &$obj, GedcomRecord $obj)

GedcomRecord $obj
&$obj

Redefinition of:

GedcomRecord::equals(): check if this object is equal to the given object

getAddTitle (line 125)

get the _HEB or ROMN media title

string getAddTitle ()

getFilename (line 153)

get the media file name

string getFilename ()

getFilesize (line 169)

get the media file size

string getFilesize ()

getFiletype (line 178)

get the media file type

string getFiletype ()

getInstance (line 63)

Static function used to get an instance of a media object

void &getInstance (string $pid, [ $simple = true])

string $pid: the ID of the media to retrieve
$simple

Redefinition of:

GedcomRecord::getInstance(): Static function used to get an instance of an object

getLinkUrl (line 200)

get the URL to link to this object

void getLinkUrl ()

Redefinition of:

GedcomRecord::getLinkUrl(): get the URL to link to this record

getNote (line 103)

void getNote ()

getSortableName (line 145)

get the media sortable name

string getSortableName ()

Redefinition of:

GedcomRecord::getSortableName(): get the sortable name

getThumbnail (line 161)

get the thumbnail filename

string getThumbnail ()

getTitle (line 110)

get the media title

string getTitle ()

in_obje_list (line 231)

check if the given Media object is in the objectlist

return: returns the ID for the for the matching media or false if not found

mixed in_obje_list ( &$obje, Media $obje)

Media $obje
&$obje

Inherited Methods

Inherited From GedcomRecord

GedcomRecord::GedcomRecord()
GedcomRecord::canDisplayDetails()
GedcomRecord::equals()
GedcomRecord::getAbsoluteLinkUrl()
GedcomRecord::getChanged()
GedcomRecord::getDateUrl()
GedcomRecord::getGedcomRecord()
GedcomRecord::getInstance()
GedcomRecord::getLastchangeDate()
GedcomRecord::getLastchangeRecord()
GedcomRecord::getLastchangeUser()
GedcomRecord::getLinkTitle()
GedcomRecord::getLinkUrl()
GedcomRecord::getPlaceShort()
GedcomRecord::getPlaceUrl()
GedcomRecord::getSortableLastchangeDate()
GedcomRecord::getSortableName()
GedcomRecord::getType()
GedcomRecord::getXref()
GedcomRecord::isMarkedDeleted()
GedcomRecord::isRemote()
GedcomRecord::setChanged()
GedcomRecord::setGedcomRecord()
GedcomRecord::undoChange()