Tv2 documentation

Overview

Package

Tree

Index

Tv2 documentation

PREV NEXT

FRAMES NO FRAME

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv2-engine
Class tv2Site

pyramidSite
  |
  +--tv2Site

class tv2Site
extends pyramidSite

Abstract class for Tv2 sites

Authors:: Emilis Dambauskas (emilis@gildija.lt)

Version:: $Id: tv2Site.class.php,v 1.6 2003/10/13 03:36:06 lunaticlt Exp $

Copyright:: 2002–2003 Emilis Dambauskas under Artistic license

Change logs

2003-07-27 added methods showXImage(), showXFile() and getImageUrl()

Field Summary
`private object`	`$fh` A helper object for outputing files from Tv2 documents
`private object`	`$xdb` Tv2 X database

Constructor Summary
`object`	`tv2Site()`

Method Summary
`string`	`getDocUrl(string $ident)` Takes document ident and returns an URL for it
`string`	`getImageUrl(string $ident)` Takes image document ident and returns an URL for it
`private void`	`loadFileHelper()` ATTENTION: method coppied from tv2Client::loadFileHelper
`private void`	`loadXdb()` ATTENTION: method coppied from tv2Client::loadXdb
`string`	`showIndex()` Shows index page of the site (shows static document /www/index)
`mixed`	`showXFile(mixed $file)` Shows file from Xdb document
`mixed`	`showXImage(mixed $file)` Shows image from Xdb image document
`string`	`staticPage(mixed $url)` Shows a static page from /www/

Methods inherited from class pyramidSite and not overridden

passthru, setMethod, show, showError, showPage

Field Detail

fh

private object $fh

A helper object for outputing files from Tv2 documents

xdb

private object $xdb

Tv2 X database

Constructor Detail

tv2Site()

object tv2Site()

Returns:: tv2Site object

Uses the global variables:: SITE_URL

Method Detail

getDocUrl()

string getDocUrl(string $ident)

Takes document ident and returns an URL for it

Parameters:: ident - document ident

Returns:: URL

Uses the global variables:: SITE_URL

getImageUrl()

string getImageUrl(string $ident)

Takes image document ident and returns an URL for it

Parameters:: ident - image document ident

Returns:: URL

Uses the global variables:: SITE_URL

Since:: 2003-07-27

loadFileHelper()

private void loadFileHelper()

ATTENTION: method coppied from tv2Client::loadFileHelper

Uses the global variables:: ENGINE_DIR

loadXdb()

private void loadXdb()

ATTENTION: method coppied from tv2Client::loadXdb

Uses the global variables:: $xdb, $config, ENGINE_DIR

showIndex()

string showIndex()

Shows index page of the site (shows static document /www/index)

Returns:: page HTML

showXFile()

mixed showXFile(mixed $file)

Shows file from Xdb document

Parameters:: file - url array

Returns:: NULL on success, error page HTML on failure

Since:: 2003-07-27

showXImage()

mixed showXImage(mixed $file)

Shows image from Xdb image document

Parameters:: file - url array

Returns:: NULL on success, error page HTML on failure

Since:: 2003-07-27

staticPage()

string staticPage(mixed $url)

Shows a static page from /www/

Parameters:: url - URL string / array

Returns:: HTML if the page