class Type extends ConcreteObject implements ObjectInterface, AssignableObjectInterface (View source)

Traits

Properties

$error from  ConcreteObject
protected $ptDefaultPageTemplateID

Methods

loadError($error)

No description

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

static 
camelcase($file)

No description

static 
uncamelcase($string)

No description

assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

getPageTypeID()

No description

getPageTypeName()

No description

getSiteTypeID()

No description

getSiteTypeObject()

No description

getPageTypeDisplayName($format = 'html')

No description

getPageTypeHandle()

No description

isPageTypeFrequentlyAdded()

No description

getPageTypeDisplayOrder()

No description

setPermissionsToOverride()

No description

isPageTypeInternal()

No description

doesPageTypeLaunchInComposer()

No description

getPackageID()

No description

getPackageHandle()

No description

publish(Page $c, $requestOrDateTime = null)

No description

savePageTypeComposerForm(Page $c) deprecated

No description

static 
getByDefaultsPage(Page $c)

No description

getPageTypePageTemplateDefaultPageObject(Template $template = null)

No description

static 
importTargets($node)

No description

static 
import($node)

No description

static 
importContent($node)

No description

export($nxml)

No description

static 
exportList($xml)

No description

getPageTypeUsageCount()

No description

duplicate($ptHandle, $ptName, $siteType = null)

No description

static Type|mixed|null
add(array $data, bool|Package $pkg = false)

Add a page type.

update($data)

No description

static 
getList($includeInternal = false, $siteType = null)

No description

static 
returnList($ptIDs)

No description

static 
getFrequentlyUsedList($siteType = null)

No description

static 
getInfrequentlyUsedList($siteType = null)

No description

static 
getListByPackage($pkg)

No description

static 
getListByDefaultPageTemplate($templateOrTemplateID)

No description

static 
getByID($ptID)

No description

static 
getByHandle($ptHandle)

No description

delete()

No description

setConfiguredPageTypePublishTargetObject(Configuration $configuredTarget)

No description

addPageTypeComposerFormLayoutSet($ptComposerFormLayoutSetName, $ptComposerFormLayoutSetDescription)

No description

canPublishPageTypeBeneathPage(Page $page)

Returns true if pages of the current type are allowed beneath the passed parent page.

getPageTypeSaverObject()

No description

createDraft(Template $pt, $u = false)

No description

renderComposerOutputForm($page = null, $targetPage = null)

No description

Details

loadError($error)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

Parameters

$string

assignPermissions($userOrGroup, $permissions = [], $accessType = Key::ACCESS_TYPE_INCLUDE, $cascadeToChildren = true)

No description

Parameters

$userOrGroup
$permissions
$accessType
$cascadeToChildren

getPageTypeID()

No description

getPageTypeName()

No description

getSiteTypeID()

No description

getSiteTypeObject()

No description

getPageTypeDisplayName($format = 'html')

No description

Parameters

$format

getPageTypeHandle()

No description

getPageTypePublishTargetTypeID()

No description

getPageTypePublishTargetObject()

No description

getPageTypeAllowedPageTemplates()

No description

getPageTypeDefaultPageTemplateID()

No description

getPageTypeDefaultPageTemplateObject()

No description

getPermissionObjectIdentifier()

No description

isPageTypeFrequentlyAdded()

No description

getPageTypeDisplayOrder()

No description

getPermissionResponseClassName()

No description

getPermissionAssignmentClassName()

No description

getPermissionObjectKeyCategoryHandle()

No description

setChildPermissionsToOverride()

No description

setPermissionsToOverride()

No description

isPageTypeInternal()

No description

doesPageTypeLaunchInComposer()

No description

getPackageID()

No description

getPackageHandle()

No description

protected stripEmptyPageTypeComposerControls(Page $c)

No description

Parameters

Page $c

publish(Page $c, $requestOrDateTime = null)

No description

Parameters

Page $c
$requestOrDateTime

savePageTypeComposerForm(Page $c) deprecated

deprecated

No description

Parameters

Page $c

getPageTypeSelectedPageTemplateObjects()

No description

static getByDefaultsPage(Page $c)

No description

Parameters

Page $c

getPageTypePageTemplateDefaultPageObject(Template $template = null)

No description

Parameters

Template $template

getPageTypePageTemplateObjects()

No description

static importTargets($node)

No description

Parameters

$node

static import($node)

No description

Parameters

$node

static importContent($node)

No description

Parameters

$node

export($nxml)

No description

Parameters

$nxml

static exportList($xml)

No description

Parameters

$xml

rescanPageTypeComposerOutputControlObjects()

No description

getPageTypeUsageCount()

No description

duplicate($ptHandle, $ptName, $siteType = null)

No description

Parameters

$ptHandle
$ptName
$siteType

static Type|mixed|null add(array $data, bool|Package $pkg = false)

Add a page type.

Parameters

array $data

{

@var string          $handle              A string which can be used to identify the page type
@var string          $name                A user friendly display name
@var \PageTemplate   $defaultTemplate     The default template object or handle
@var string          $allowedTemplates    (A|C|X) A for all, C for selected only, X for non-selected only
@var \PageTemplate[] $templates           Array or Iterator of selected templates, see `$allowedTemplates`, or Page Template Handles
@var bool            $internal            Is this an internal only page type? Default: `false`
@var bool            $ptLaunchInComposer  Does this launch in composer? Default: `false`
@var bool            $ptIsFrequentlyAdded Should this always be displayed in the pages panel? Default: `false`

}

bool|Package $pkg

This should be false if the type is not tied to a package, or a package object

Return Value

Type|mixed|null

update($data)

No description

Parameters

$data

protected rescanPageTypePageTemplateDefaultPages()

No description

static getList($includeInternal = false, $siteType = null)

No description

Parameters

$includeInternal
$siteType

static protected returnList($ptIDs)

No description

Parameters

$ptIDs

static getFrequentlyUsedList($siteType = null)

No description

Parameters

$siteType

static getInfrequentlyUsedList($siteType = null)

No description

Parameters

$siteType

static getListByPackage($pkg)

No description

Parameters

$pkg

static getListByDefaultPageTemplate($templateOrTemplateID)

No description

Parameters

$templateOrTemplateID

static getByID($ptID)

No description

Parameters

$ptID

static getByHandle($ptHandle)

No description

Parameters

$ptHandle

delete()

No description

setConfiguredPageTypePublishTargetObject(Configuration $configuredTarget)

No description

Parameters

Configuration $configuredTarget

rescanFormLayoutSetDisplayOrder()

No description

addPageTypeComposerFormLayoutSet($ptComposerFormLayoutSetName, $ptComposerFormLayoutSetDescription)

No description

Parameters

$ptComposerFormLayoutSetName
$ptComposerFormLayoutSetDescription

canPublishPageTypeBeneathPage(Page $page)

Returns true if pages of the current type are allowed beneath the passed parent page.

Parameters

Page $page

ValidatorInterface|null getPageTypeValidatorObject()

No description

Return Value

ValidatorInterface|null

SaverInterface|null getPageTypeSaverObject()

No description

Return Value

SaverInterface|null

createDraft(Template $pt, $u = false)

No description

Parameters

Template $pt
$u

renderComposerOutputForm($page = null, $targetPage = null)

No description

Parameters

$page
$targetPage