---

Document Class Reference

Inheritance diagram for Document:

List of all members.

Public Member Functions
	title ()
	version ($type=VERSION_TYPE_SHORT)
	logo ()
	theme ()
	header ()
	subheader ()
	about ($type=ABOUT_TYPE_VERSION)
	navigation ($type=null)
	signinout ($type=SIGN_TYPE_WIDE)
	failedSignIn ()
	albums ()
	photo ()
	caption ($photo=null)
	comments ()
	addCommentBox ()

---

Member Function Documentation

Document::about (  $  type = ABOUT_TYPE_VERSION  )

Link to the about page Inserts link to the about page. Link text will be full version string of ImaComm Parameters: constant  $type Type of about text Returns: HTML code for popup link See also: version ABOUT_TYPE_VERSION Definition at line 177 of file Document.php. References popupLink().

Document::addCommentBox (   )

Adds comment adding textarea if allowed. Users can add their own comments by using add a new comment -box. This method adds that box if commenting is allowed by current album/user/globally. Returns: HTML code Definition at line 701 of file Document.php. References album, config, formBegin(), formEnd(), get_albumdata(), getAlbum(), and onPage().

Document::albums (   )

Returns all albums and photos that current album contains. First it generates all albums and then all photos. Format of output is reader from template See also: themeEngine Returns: string HTML code Definition at line 394 of file Document.php. References album, config, genLink(), path, themeEngine, and translate().

Document::caption (  $  photo = null  )

You can give captions to photos. This method returns caption of wanted photo and it can be printed to screen by theme. Parameters: integer  $photo Photo ID string  $photo Photo filename Returns: string Photo's caption Definition at line 587 of file Document.php. References album, config, and get_albumdata().

Document::comments (   )

Prints out data table which contains all comments related to current item. Returns: string HTML code Definition at line 613 of file Document.php. References album, config, genLink(), get_albumdata(), getAlbum(), theme(), themeEngine, and translate().

Document::failedSignIn (   )

Sometimes users do forgot their password. This method returns information text that says nicely: You have forgot your password. This method also gives a link that by clicking it user can send a new password to his/her e-mail. Returns: string HTML code Definition at line 375 of file Document.php. References _SESSION, popupLink(), and translate().

Document::header (   )

Inserts header text of current page, like Photo albums or Photo viewer, etc. Returns: string Header text Reimplemented in SetupDocument. Definition at line 141 of file Document.php.

Document::logo (   )

Inserts logo of ImaComm, readed from theme. If current page is under development, logo will be development logo. Returns: string HTML code for logo image. Definition at line 100 of file Document.php.

Document::navigation (  $  type = null  )

Inserts navigation bar. This object will ganerate correct navigation links to browse next album, photo etc. or to navigate to higher album. Parameters: constant  $type Type of navigation links Returns: string Navigation links. See also: NAVIGATION_STYLE_IMAGES NAVIGATION_STYLE_TEXT NAVIGATION_STYLE_NUMERIC NAVIGATION_TYPE_WIDE NAVIGATION_TYPE_TALL Reimplemented in SetupDocument. Definition at line 201 of file Document.php. References album, config, genLink(), get_albumdata(), NAVIGATION_STYLE_IMAGES, NAVIGATION_STYLE_NUMERIC, NAVIGATION_TYPE_TALL, NAVIGATION_TYPE_WIDE, path, theme(), and translate().

Document::photo (   )

Definition at line 567 of file Document.php. References album, config, and get_albumdata().

Document::signinout (  $  type = SIGN_TYPE_WIDE  )

Insert links to sign in/sign out/modify our settings or administrate ImaComm Server. Parameters: constant  $type Style of sign in Returns: string HTML code of links. See also: SIGN_TYPE_WIDE SIGN_TYPE_TALL Definition at line 301 of file Document.php. References _SESSION, config, formBegin(), formEnd(), genLink(), SIGN_TYPE_TALL, SIGN_TYPE_WIDE, theme(), and translate().

Document::subheader (   )

Definition at line 159 of file Document.php.

Document::theme (   )

Returns current theme, with path and theme name Returns: string Path to the theme Reimplemented in SetupDocument. Definition at line 129 of file Document.php. References _SESSION, and theme().

Document::title (   )

Inserts title of current page. Returns: string Title Reimplemented in SetupDocument. Definition at line 72 of file Document.php.

Document::version (  $  type = VERSION_TYPE_SHORT  )

Inserts current ImaComm version number. Parameters: integer  $type Type of version Returns: string Version string representation See also: VERSION_TYPE_SHORT VERSION_TYPE_LONG Definition at line 87 of file Document.php. Referenced by SetupDocument::header().

---

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

• Document.php

---