TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem Class Reference
Inheritance diagram for TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem:
TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface

Public Member Functions

 __construct ()
 
 checkAccess ()
 
 loadDocsFromUserSession ()
 
 getItem ()
 
 getDropDown ()
 
 getAdditionalAttributes ()
 
 hasDropDown ()
 
 updateNumberOfOpenDocsHook (&$params, $ref)
 
 closeDocument (ServerRequestInterface $request, ResponseInterface $response)
 
 renderMenu (ServerRequestInterface $request, ResponseInterface $response)
 
 getIndex ()
 

Protected Member Functions

 renderMenuEntry ($document, $md5sum, $isRecentDoc=false, $isFirstDoc=false)
 
 getBackendUser ()
 
 getPageRenderer ()
 
 getLanguageService ()
 
 getDatabaseConnection ()
 

Protected Attributes

 $openDocs = []
 
 $recentDocs = []
 
 $iconFactory
 

Detailed Description

Alist of all open documents

Definition at line 29 of file OpendocsToolbarItem.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::__construct ( )

Constructor

Definition at line 49 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getLanguageService(), TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getPageRenderer(), TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\loadDocsFromUserSession(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

◆ checkAccess()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::checkAccess ( )

Checks whether the user has access to this toolbar item

Returns
bool TRUE if user has access, FALSE if not

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 63 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getBackendUser().

◆ closeDocument()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::closeDocument ( ServerRequestInterface  $request,
ResponseInterface  $response 
)

Closes a document in the session and

Parameters
ServerRequestInterface$request
ResponseInterface$response
Returns
ResponseInterface

Definition at line 235 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getBackendUser(), and TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\renderMenu().

◆ getAdditionalAttributes()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getAdditionalAttributes ( )

No additional attributes

Returns
string List item HTML attibutes

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 190 of file OpendocsToolbarItem.php.

◆ getBackendUser()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getBackendUser ( )
protected

Returns the current BE user.

Returns

Definition at line 284 of file OpendocsToolbarItem.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\checkAccess(), TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\closeDocument(), and TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\loadDocsFromUserSession().

◆ getDatabaseConnection()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getDatabaseConnection ( )
protected

Return DatabaseConnection

Returns

Definition at line 314 of file OpendocsToolbarItem.php.

References $GLOBALS.

◆ getDropDown()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getDropDown ( )

Render drop down

Returns
string HTML

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 106 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\$openDocs, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\$recentDocs, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getLanguageService(), and TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\renderMenuEntry().

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\renderMenu().

◆ getIndex()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getIndex ( )

Position relative to others

Returns
int

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 274 of file OpendocsToolbarItem.php.

◆ getItem()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getItem ( )

Render toolbar icon

Returns
string HTML

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 89 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

◆ getLanguageService()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getLanguageService ( )
protected

Returns LanguageService

Returns

Definition at line 304 of file OpendocsToolbarItem.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\__construct(), TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getDropDown(), TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getItem(), and TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\renderMenuEntry().

◆ getPageRenderer()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::getPageRenderer ( )
protected

Returns current PageRenderer

Returns
PageRenderer

Definition at line 294 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\__construct().

◆ hasDropDown()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::hasDropDown ( )

This item has a drop down

Returns
bool

Implements TYPO3\CMS\Backend\Toolbar\ToolbarItemInterface.

Definition at line 200 of file OpendocsToolbarItem.php.

◆ loadDocsFromUserSession()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::loadDocsFromUserSession ( )

Loads the opened and recently opened documents from the user

Returns
void

Definition at line 74 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\$openDocs, and TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getBackendUser().

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\__construct().

◆ renderMenu()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::renderMenu ( ServerRequestInterface  $request,
ResponseInterface  $response 
)

Renders the menu so that it can be returned as response to an AJAX call

Parameters
ServerRequestInterface$request
ResponseInterface$response
Returns
ResponseInterface

Definition at line 262 of file OpendocsToolbarItem.php.

References TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getDropDown().

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\closeDocument().

◆ renderMenuEntry()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::renderMenuEntry (   $document,
  $md5sum,
  $isRecentDoc = false,
  $isFirstDoc = false 
)
protected

Returns the recent documents list as an array

Parameters
array$document
string$md5sum
bool$isRecentDoc
bool$isFirstDoc
Returns
array All recent documents as list-items

Definition at line 147 of file OpendocsToolbarItem.php.

References $uid, TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getDropDown().

◆ updateNumberOfOpenDocsHook()

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::updateNumberOfOpenDocsHook ( &  $params,
  $ref 
)

Called as a hook in ::setUpdateSignal, calls a JS function to change the number of opened documents

Parameters
array$params
unknown_type$ref
Returns
string list item HTML attributes

Definition at line 216 of file OpendocsToolbarItem.php.

References $params.

Member Data Documentation

◆ $iconFactory

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::$iconFactory
protected

Definition at line 44 of file OpendocsToolbarItem.php.

◆ $openDocs

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::$openDocs = []
protected

Definition at line 34 of file OpendocsToolbarItem.php.

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getDropDown(), and TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\loadDocsFromUserSession().

◆ $recentDocs

TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem::$recentDocs = []
protected

Definition at line 39 of file OpendocsToolbarItem.php.

Referenced by TYPO3\CMS\Opendocs\Backend\ToolbarItems\OpendocsToolbarItem\getDropDown().