‪TYPO3CMS  ‪main
TYPO3\CMS\Core\Site\Entity\NullSite Class Reference
Inheritance diagram for TYPO3\CMS\Core\Site\Entity\NullSite:
TYPO3\CMS\Core\Site\Entity\SiteInterface

Public Member Functions

 __construct (array $languages=null, Uri $baseEntryPoint=null)
 
 getIdentifier ()
 
 getBase ()
 
 getRootPageId ()
 
SiteLanguage[] getLanguages ()
 
 getLanguageById (int $languageId)
 
 getDefaultLanguage ()
 
 getAvailableLanguages (BackendUserAuthentication $user, bool $includeAllLanguagesFlag=false, int $pageId=null)
 
 getErrorHandler (int $statusCode)
 

Protected Member Functions

 getLanguageService ()
 

Protected Attributes

int $rootPageId = 0
 
array $languages
 

Detailed Description

Entity representing a site for everything on "pid=0". Mostly used in TYPO3 Backend, not really in use elsewhere.

Definition at line 31 of file NullSite.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Site\Entity\NullSite::__construct ( array  $languages = null,
Uri  $baseEntryPoint = null 
)

Sets up a null site object

Parameters
array | null$languages‪site languages
Uri | null$baseEntryPoint

Definition at line 46 of file NullSite.php.

References TYPO3\CMS\Core\Site\Entity\NullSite\$languages.

Member Function Documentation

◆ getAvailableLanguages()

TYPO3\CMS\Core\Site\Entity\NullSite::getAvailableLanguages ( BackendUserAuthentication  $user,
bool  $includeAllLanguagesFlag = false,
int  $pageId = null 
)

This takes page TSconfig into account (unlike Site interface) to find mod.SHARED.disableLanguages and mod.SHARED.defaultLanguageLabel

Implements TYPO3\CMS\Core\Site\Entity\SiteInterface.

Definition at line 130 of file NullSite.php.

References TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkLanguageAccess(), TYPO3\CMS\Core\Site\Entity\NullSite\getBase(), TYPO3\CMS\Core\Site\Entity\NullSite\getLanguageService(), and TYPO3\CMS\Core\Utility\GeneralUtility\intExplode().

◆ getBase()

TYPO3\CMS\Core\Site\Entity\NullSite::getBase ( )

◆ getDefaultLanguage()

TYPO3\CMS\Core\Site\Entity\NullSite::getDefaultLanguage ( )

Returns the first language that was configured. This is usually language=0

Implements TYPO3\CMS\Core\Site\Entity\SiteInterface.

Definition at line 121 of file NullSite.php.

◆ getErrorHandler()

TYPO3\CMS\Core\Site\Entity\NullSite::getErrorHandler ( int  $statusCode)

Returns a ready-to-use error handler, to be used within the ErrorController

Implements TYPO3\CMS\Core\Site\Entity\SiteInterface.

Definition at line 174 of file NullSite.php.

References TYPO3\CMS\Redirects\Message\$statusCode.

◆ getIdentifier()

TYPO3\CMS\Core\Site\Entity\NullSite::getIdentifier ( )

Returns always #NULL

Implements TYPO3\CMS\Core\Site\Entity\SiteInterface.

Definition at line 74 of file NullSite.php.

Referenced by TYPO3\CMS\Core\Site\Entity\NullSite\getLanguageById().

◆ getLanguageById()

TYPO3\CMS\Core\Site\Entity\NullSite::getLanguageById ( int  $languageId)

Returns a language of this site, given by the sys_language_uid

Exceptions

Implements TYPO3\CMS\Core\Site\Entity\SiteInterface.

Definition at line 110 of file NullSite.php.

References TYPO3\CMS\Core\Site\Entity\NullSite\getIdentifier().

◆ getLanguages()

SiteLanguage [] TYPO3\CMS\Core\Site\Entity\NullSite::getLanguages ( )

Returns all available languages of this installation

Returns
SiteLanguage[]

Implements TYPO3\CMS\Core\Site\Entity\SiteInterface.

Definition at line 100 of file NullSite.php.

References TYPO3\CMS\Core\Site\Entity\NullSite\$languages.

◆ getLanguageService()

TYPO3\CMS\Core\Site\Entity\NullSite::getLanguageService ( )
protected

Definition at line 179 of file NullSite.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Site\Entity\NullSite\getAvailableLanguages().

◆ getRootPageId()

TYPO3\CMS\Core\Site\Entity\NullSite::getRootPageId ( )

Always zero

Implements TYPO3\CMS\Core\Site\Entity\SiteInterface.

Definition at line 90 of file NullSite.php.

Member Data Documentation

◆ $languages

array TYPO3\CMS\Core\Site\Entity\NullSite::$languages
protected

◆ $rootPageId

int TYPO3\CMS\Core\Site\Entity\NullSite::$rootPageId = 0
protected

Definition at line 33 of file NullSite.php.