Tinebase_Frontend_Http

HTTP interface to Tine

ATTENTION all public methods in this class are reachable without tine authentification use $this->checkAuth(); if method requires authentification

Implements:

Tinebase_Frontend_Interface

Extend:

Tinebase_Frontend_Http_Abstract

Methods

Name	Description
cropImage	crops a image identified by an imgageURL and returns a new tempFileImage
downloadPreview	download file
downloadPreviewByTempFile	download preview by temp file
downloadRecordAttachment	download file attachment
downloadTempfile	Download temp file to review
getBlob
getCustomJsFiles	dev mode custom js delivery
getImage	downloads an image/thumbnail at a given size
getJsTranslations	returns javascript of translations for the currently configured locale
getPostalXWindow
getServiceMap	get json-api service map
login	renders the login dialog
loginFromPost	login from HTTP post
mainScreen	display Tine 2.0 main screen
openIDCLogin	openIDCLogin
setupRequired
uploadTempFile	receives file uploads and stores it in the file_uploads db

Inherited methods

Name	Description
__call	magic method for http api

Tinebase_Frontend_Http::cropImage

Description

public cropImage (string $imageurl, int $left, int $top, int $widht, int $height)

crops a image identified by an imgageURL and returns a new tempFileImage

Parameters

• (string) $imageurl : imageURL of the image to be croped
• (int) $left : left position of crop window
• (int) $top : top position of crop window
• (int) $widht : widht of crop window
• (int) $height : heidht of crop window

Return Values

string

imageURL of new temp image

---

Tinebase_Frontend_Http::downloadPreview

Description

public downloadPreview (string $_path, string $_appId, string $_type, int $_num, string $_revision)

download file

Parameters

• (string) $_path
• (string) $_appId
• (string) $_type
• (int) $_num
• (string) $_revision

Return Values

void

---

Tinebase_Frontend_Http::downloadPreviewByTempFile

Description

public downloadPreviewByTempFile ( $_tempFileId,  $_type, int $_num)

download preview by temp file

Parameters

• () $_tempFileId
• () $_type
• (int) $_num

Return Values

void

Throws Exceptions

\Tinebase_Exception_Record_DefinitionFailure

\Tinebase_Exception_Record_Validation

---

Tinebase_Frontend_Http::downloadRecordAttachment

Description

public downloadRecordAttachment (string $nodeId, string $recordId, string $modelName)

download file attachment

Parameters

• (string) $nodeId
• (string) $recordId
• (string) $modelName

Return Values

void

---

Tinebase_Frontend_Http::downloadTempfile

Description

public downloadTempfile ( $tmpfileId)

Download temp file to review

Parameters

• () $tmpfileId

Return Values

void

---

Tinebase_Frontend_Http::getBlob

Description

 getBlob (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Http::getCustomJsFiles

Description

public getCustomJsFiles (void)

dev mode custom js delivery

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Http::getImage

Description

public getImage (mixed $application, string $id, string $location, int $width, int $height, int $ratiomode)

downloads an image/thumbnail at a given size

Parameters

• (mixed) $application
• (string) $id
• (string) $location
• (int) $width
• (int) $height
• (int) $ratiomode

Return Values

void

---

Tinebase_Frontend_Http::getJsTranslations

Description

public getJsTranslations (string $locale, string $app)

returns javascript of translations for the currently configured locale

Parameters

• (string) $locale
• (string) $app

Return Values

string

(javascript)

---

Tinebase_Frontend_Http::getPostalXWindow

Description

 getPostalXWindow (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Http::getServiceMap

Description

public static getServiceMap (void)

get json-api service map

Parameters

This function has no parameters.

Return Values

string

---

Tinebase_Frontend_Http::login

Description

public login (void)

renders the login dialog

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Http::loginFromPost

Description

public loginFromPost (void)

login from HTTP post

redirects the tine main screen if authentication is successful
otherwise redirects back to login url

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Http::mainScreen

Description

public mainScreen (void)

display Tine 2.0 main screen

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Http::openIDCLogin

Description

public openIDCLogin (void)

openIDCLogin

Parameters

This function has no parameters.

Return Values

bool

---

Tinebase_Frontend_Http::setupRequired

Description

 setupRequired (void)

Parameters

This function has no parameters.

Return Values

void

---

Tinebase_Frontend_Http::uploadTempFile

Description

public uploadTempFile (void)

receives file uploads and stores it in the file_uploads db

Parameters

This function has no parameters.

Return Values

void

Throws Exceptions

\Tinebase_Exception_UnexpectedValue

\Tinebase_Exception_NotFound

---