OXID eShop CE  6.1.5
OxidEsales\EshopCommunity\Core\Service\ApplicationServerService Class Reference
+ Inheritance diagram for OxidEsales\EshopCommunity\Core\Service\ApplicationServerService:
+ Collaboration diagram for OxidEsales\EshopCommunity\Core\Service\ApplicationServerService:

Public Member Functions

 __construct (\OxidEsales\Eshop\Core\Dao\ApplicationServerDaoInterface $appServerDao, $utilsServer, $currentTime)
 
 loadAppServerList ()
 
 loadAppServer ($id)
 
 deleteAppServerById ($serverId)
 
 saveAppServer ($appServer)
 
 loadActiveAppServerList ()
 
 updateAppServerInformationInAdmin ()
 
 updateAppServerInformationInFrontend ()
 
 updateAppServerInformation ($adminMode)
 

Protected Member Functions

 filterActiveAppServers ($appServerList)
 

Private Member Functions

 cleanupAppServers ()
 
 updateAppServerData ($appServer, $adminMode)
 
 addNewAppServerData ($adminMode)
 

Private Attributes

 $appServerDao
 
 $currentTime = 0
 
 $utilsServer
 

Detailed Description

Manages application server information.

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::__construct ( \OxidEsales\Eshop\Core\Dao\ApplicationServerDaoInterface  $appServerDao,
  $utilsServer,
  $currentTime 
)

ApplicationServerService constructor.

Parameters
\OxidEsales\Eshop\Core\Dao\ApplicationServerDaoInterface$appServerDaoThe Dao of application server.
\OxidEsales\Eshop\Core\UtilsServer$utilsServer
int$currentTimeThe current time - timestamp.

Member Function Documentation

◆ addNewAppServerData()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::addNewAppServerData (   $adminMode)
private

Adds new application server.

Parameters
bool$adminModeThe status of admin mode.

◆ cleanupAppServers()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::cleanupAppServers ( )
private

Deletes all application servers, that are longer not active.

◆ deleteAppServerById()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::deleteAppServerById (   $serverId)

Removes server node information.

Parameters
string$serverIdThe Id of the application server to delete.

◆ filterActiveAppServers()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::filterActiveAppServers (   $appServerList)
protected

Filter only active application servers from given list.

Parameters
array$appServerListThe list of application servers.
Returns
array

◆ loadActiveAppServerList()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::loadActiveAppServerList ( )

Returns an array of all only active application servers.

Returns
array

◆ loadAppServer()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::loadAppServer (   $id)

Load the application server for given id.

Parameters
string$idThe id of the application server to load.
Exceptions

◆ loadAppServerList()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::loadAppServerList ( )

Returns an array of all application servers.

Returns
array

◆ saveAppServer()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::saveAppServer (   $appServer)

Saves application server data.

Parameters
\OxidEsales\Eshop\Core\DataObject\ApplicationServer$appServer

◆ updateAppServerData()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::updateAppServerData (   $appServer,
  $adminMode 
)
private

Updates application server with the newest information.

Parameters
\OxidEsales\Eshop\Core\DataObject\ApplicationServer$appServerThe application server to update.
bool$adminModeThe status of admin mode.

◆ updateAppServerInformation()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::updateAppServerInformation (   $adminMode)

Renews application server information if it is outdated or if it does not exist.

Exceptions

◆ updateAppServerInformationInAdmin()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::updateAppServerInformationInAdmin ( )

Renews application server information when it is call in admin area and if it is outdated or if it does not exist.

◆ updateAppServerInformationInFrontend()

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::updateAppServerInformationInFrontend ( )

Renews application server information when it is call in frontend and if it is outdated or if it does not exist.

Member Data Documentation

◆ $appServerDao

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::$appServerDao
private

◆ $currentTime

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::$currentTime = 0
private

◆ $utilsServer

OxidEsales\EshopCommunity\Core\Service\ApplicationServerService::$utilsServer
private

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