PHP Class Devise\Pages\PageVersionManager

Show file Open project: devisephp/cms Class Usage Examples

Public Methods

Method Description
__construct ( UserHelper $UserHelper, DvsPageVersion $PageVersion, DvsField $Field, DvsCollectionInstance $CollectionInstance, PagesRepository $PagesRepository ) Construction depends on PageVersin model and UserHelper to get current user id
copyPageVersion ( $pageVersionId, $name ) : PageVersion Copy page version for given page version id and name
copyPageVersionToAnotherPage ( $fromVersion, $toPage ) : PageVersion Copies a page version to another page this is useful when creating different languages of the same page
createDefaultPageVersion ( Page $page, $startsAt = null ) : PageVersion Create a new default page version for given page
createNewPageVersion ( integer $pageId, string $name, integer $createdByUserId, $startsAt = null, $endsAt = null ) : PageVersion Create a new page version with given parameters
destroyPageVersion ( $pageVersionId ) : mixed Destroys a page version record
togglePageVersionPreviewShare ( integer $pageVersionId ) : boolean Toggle "preview_hash" value between hashed string and null.
updatePageVersionABTestingAmount ( [type] $pageVersionId, [type] $amount ) : [type] Updates the page version ab testing amount
updatePageVersionDates ( integer $pageVersionId, array $input ) : void Update the page version dates
updatePageVersionView ( [type] $pageVersionId, [type] $view ) : [type] Updates the page version view

Protected Methods

Method Description
convertToDatabaseTimestamp ( string $timestamp, string $from = 'm/d/y H:i:s', string $to = 'Y-m-d H:i:s' ) : string Changes the timestamp from human readable to database specific
copyCollectionsFromVersionToVersion ( $oldVersion, $newVersion ) : void Copy all the collections from one page version into another
copyFieldsFromVersionToVersion ( $oldVersion, $newVersion ) : void Copies all the fields from one page version into another page version

Method Details

__construct() public method

Construction depends on PageVersin model and UserHelper to get current user id
public __construct ( UserHelper $UserHelper, DvsPageVersion $PageVersion, DvsField $Field, DvsCollectionInstance $CollectionInstance, PagesRepository $PagesRepository )
$UserHelper Devise\Users\UserHelper
$PageVersion DvsPageVersion
$Field DvsField
$CollectionInstance DvsCollectionInstance
$PagesRepository PagesRepository

convertToDatabaseTimestamp() protected method

Changes the timestamp from human readable to database specific
protected convertToDatabaseTimestamp ( string $timestamp, string $from = 'm/d/y H:i:s', string $to = 'Y-m-d H:i:s' ) : string
$timestamp string
$from string
$to string
return string

copyCollectionsFromVersionToVersion() protected method

Copy all the collections from one page version into another
protected copyCollectionsFromVersionToVersion ( $oldVersion, $newVersion ) : void
$oldVersion
$newVersion
return void

copyFieldsFromVersionToVersion() protected method

Copies all the fields from one page version into another page version
protected copyFieldsFromVersionToVersion ( $oldVersion, $newVersion ) : void
$oldVersion
$newVersion
return void

copyPageVersion() public method

Copy page version for given page version id and name
public copyPageVersion ( $pageVersionId, $name ) : PageVersion
$pageVersionId
$name
return PageVersion

copyPageVersionToAnotherPage() public method

Copies a page version to another page this is useful when creating different languages of the same page
public copyPageVersionToAnotherPage ( $fromVersion, $toPage ) : PageVersion
$fromVersion
$toPage
return PageVersion

createDefaultPageVersion() public method

Create a new default page version for given page
public createDefaultPageVersion ( Page $page, $startsAt = null ) : PageVersion
$page Page
return PageVersion

createNewPageVersion() public method

Create a new page version with given parameters
public createNewPageVersion ( integer $pageId, string $name, integer $createdByUserId, $startsAt = null, $endsAt = null ) : PageVersion
$pageId integer
$name string
$createdByUserId integer
return PageVersion

destroyPageVersion() public method

Destroys a page version record
public destroyPageVersion ( $pageVersionId ) : mixed
$pageVersionId
return mixed

togglePageVersionPreviewShare() public method

The value determines whether preview url is publicly available.
public togglePageVersionPreviewShare ( integer $pageVersionId ) : boolean
$pageVersionId integer
return boolean

updatePageVersionABTestingAmount() public method

Updates the page version ab testing amount
public updatePageVersionABTestingAmount ( [type] $pageVersionId, [type] $amount ) : [type]
$pageVersionId [type]
$amount [type]
return [type]

updatePageVersionDates() public method

Update the page version dates
public updatePageVersionDates ( integer $pageVersionId, array $input ) : void
$pageVersionId integer
$input array
return void

updatePageVersionView() public method

Updates the page version view
public updatePageVersionView ( [type] $pageVersionId, [type] $view ) : [type]
$pageVersionId [type]
$view [type]
return [type]