PHP Class eZ\Publish\Core\Helper\ContentPreviewHelper

Inheritance: implements eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessAware
Datei anzeigen Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property Type Description
$eventDispatcher Symfony\Component\EventDispatcher\EventDispatcherInterface
$originalSiteAccess eZ\Publish\Core\MVC\Symfony\SiteAccess
$siteAccessRouter eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessRouterInterface

Public Methods

Method Description
__construct ( Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessRouterInterface $siteAccessRouter )
changeConfigScope ( string $siteAccessName ) : SiteAccess Switches configuration scope to $siteAccessName and returns the new SiteAccess to use for preview.
getOriginalSiteAccess ( ) : SiteAccess Return original SiteAccess.
getPreviewedContent ( ) : eZ\Publish\API\Repository\Values\Content\Content
getPreviewedLocation ( ) : eZ\Publish\API\Repository\Values\Content\Location
isPreviewActive ( ) : boolean
restoreConfigScope ( ) : SiteAccess Restores original config scope.
setPreviewActive ( boolean $previewActive )
setPreviewedContent ( eZ\Publish\API\Repository\Values\Content\Content $previewedContent )
setPreviewedLocation ( eZ\Publish\API\Repository\Values\Content\Location $previewedLocation )
setSiteAccess ( SiteAccess $siteAccess = null )

Method Details

__construct() public method

public __construct ( Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessRouterInterface $siteAccessRouter )
$eventDispatcher Symfony\Component\EventDispatcher\EventDispatcherInterface
$siteAccessRouter eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessRouterInterface

changeConfigScope() public method

Switches configuration scope to $siteAccessName and returns the new SiteAccess to use for preview.
public changeConfigScope ( string $siteAccessName ) : SiteAccess
$siteAccessName string
return eZ\Publish\Core\MVC\Symfony\SiteAccess

getOriginalSiteAccess() public method

Return original SiteAccess.
public getOriginalSiteAccess ( ) : SiteAccess
return eZ\Publish\Core\MVC\Symfony\SiteAccess

getPreviewedContent() public method

public getPreviewedContent ( ) : eZ\Publish\API\Repository\Values\Content\Content
return eZ\Publish\API\Repository\Values\Content\Content

getPreviewedLocation() public method

public getPreviewedLocation ( ) : eZ\Publish\API\Repository\Values\Content\Location
return eZ\Publish\API\Repository\Values\Content\Location

isPreviewActive() public method

public isPreviewActive ( ) : boolean
return boolean

restoreConfigScope() public method

Restores original config scope.
public restoreConfigScope ( ) : SiteAccess
return eZ\Publish\Core\MVC\Symfony\SiteAccess

setPreviewActive() public method

public setPreviewActive ( boolean $previewActive )
$previewActive boolean

setPreviewedContent() public method

public setPreviewedContent ( eZ\Publish\API\Repository\Values\Content\Content $previewedContent )
$previewedContent eZ\Publish\API\Repository\Values\Content\Content

setPreviewedLocation() public method

public setPreviewedLocation ( eZ\Publish\API\Repository\Values\Content\Location $previewedLocation )
$previewedLocation eZ\Publish\API\Repository\Values\Content\Location

setSiteAccess() public method

public setSiteAccess ( SiteAccess $siteAccess = null )
$siteAccess eZ\Publish\Core\MVC\Symfony\SiteAccess

Property Details

$eventDispatcher protected_oe property

protected EventDispatcherInterface,Symfony\Component\EventDispatcher $eventDispatcher
return Symfony\Component\EventDispatcher\EventDispatcherInterface

$originalSiteAccess protected_oe property

protected SiteAccess,eZ\Publish\Core\MVC\Symfony $originalSiteAccess
return eZ\Publish\Core\MVC\Symfony\SiteAccess

$siteAccessRouter protected_oe property

protected SiteAccessRouterInterface,eZ\Publish\Core\MVC\Symfony\SiteAccess $siteAccessRouter
return eZ\Publish\Core\MVC\Symfony\SiteAccess\SiteAccessRouterInterface