CAnnotationBase Class Reference

Base class with common fucntions and constants. More...

Inheritance diagram for CAnnotationBase:

List of all members.

Public Member Functions
	CAnnotationBase ()
	getTemplate ($tpl)
	setAPIPath ($path)
	getAPIPath ()
	setAPIUrl ($url)
	getAPIUrl ()
	getErrorDescription ($err_code)
	replaceAllLinks ($text, $isshort=1)
Public Attributes
	$api_path
	$api_url
	$ERROR_NONE = 0
	$ERROR_NO_ANNOTATION = 1
	$ERROR_NO_FONTFILE = 2
	$ERROR_CREATING_IMAGE = 3
	$ERROR_PARSING_XML = 4
	$ERROR_NO_GD = 5
	$ERROR_FILENOTFOUND = 6
	$ERROR_NOTJPEG = 7
	$ERROR_JPEGCORRUPTED = 8
	$ERROR_NOHEADERS = 9
	$ERROR_IMAGEDATA = 10
	$ERROR_BIGSEGMENT = 11
	$ERRORS
	$TEMPLATE_DISPLAY_SCRIPTS = 1
	$TEMPLATE_DISPLAY_STYLES = 2
	$TEMPLATE_DISPLAY_CONTAINER = 3
	$TEMPLATE_EDITOR_SCRIPTS = 10
	$TEMPLATE_EDITOR_STYLES = 11
	$TEMPLATE_EDITOR_CONTAINER = 12
	$TEMPLATE_EDITOR_TOOLBAR = 13
	$TEMPLATES

---

Detailed Description

Base class with common fucntions and constants.

Base class with common fucntions and constants

---

Constructor & Destructor Documentation

CAnnotationBase::CAnnotationBase (   )

Initializing object. Error codes, template files etc

---

Member Function Documentation

CAnnotationBase::getAPIPath (   )

Get current API local server path

CAnnotationBase::getAPIUrl (   )

Get current API URL

CAnnotationBase::getErrorDescription (  $  err_code  )

Get error description Parameters: $err_code  Error code

CAnnotationBase::getTemplate (  $  tpl  )

Return requested template content Parameters: $tpl  One of template constants

CAnnotationBase::replaceAllLinks (  $  text, $  isshort = 1 )

Replace all links in string to a href Parameters: $text  Source string $isshort  1 (default) - short link description ([..])

CAnnotationBase::setAPIPath (  $  path  )

Set API local server path Parameters: $path  Local server path to API directory (for example /home/fototagger/site/classes/)

CAnnotationBase::setAPIUrl (  $  url  )

Set API directory URL Parameters: $url  URL to API directory (for example http://www.fototagger.com/classes/)

---

Member Data Documentation

CAnnotationBase::$ERROR_BIGSEGMENT = 11

Error while read image data from jpeg file

CAnnotationBase::$ERROR_CREATING_IMAGE = 3

Error creating image from file, probably the file does not exist

CAnnotationBase::$ERROR_IMAGEDATA = 10

No jpeg headers found

CAnnotationBase::$ERROR_JPEGCORRUPTED = 8

File is not correct Jpeg file

CAnnotationBase::$ERROR_NO_ANNOTATION = 1

Annotations not found

CAnnotationBase::$ERROR_NO_FONTFILE = 2

Font file not found

CAnnotationBase::$ERROR_NO_GD = 5

Image functions not found, GD library requires

CAnnotationBase::$ERROR_NOHEADERS = 9

Jpeg file probably corrupted

CAnnotationBase::$ERROR_NONE = 0

No error

CAnnotationBase::$ERROR_NOTJPEG = 7

IO operations cannot open file for read/write

CAnnotationBase::$ERROR_PARSING_XML = 4

Error parsing XML, perhaps XML is damaged or contains errors

CAnnotationBase::$ERRORS

Jpeg segment is too big to fit in headers

CAnnotationBase::$TEMPLATE_DISPLAY_CONTAINER = 3

Template constant for image and tags container file for CAnnotationDisplay class

CAnnotationBase::$TEMPLATE_DISPLAY_SCRIPTS = 1

Template constant for JavaScripts file for CAnnotationDisplay class

CAnnotationBase::$TEMPLATE_DISPLAY_STYLES = 2

Template constant for CSS Styles file for CAnnotationDisplay class

CAnnotationBase::$TEMPLATE_EDITOR_CONTAINER = 12

Template constant for image and tags container file for CAnnotationEditor class

CAnnotationBase::$TEMPLATE_EDITOR_SCRIPTS = 10

Template constant for JavaScripts file for CAnnotationEditor class

CAnnotationBase::$TEMPLATE_EDITOR_STYLES = 11

Template constant for CSS Styles file for CAnnotationEditor class

CAnnotationBase::$TEMPLATE_EDITOR_TOOLBAR = 13

Template constant for toolbar file for CAnnotationDisplay class

---

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

• package/annotations.php

---