Component/Data.php

package: Components
property: string $componentId unique componentId of this data
property: string $dbId dbId of this data
property: string $componentClass component class of this data
property: int $id id of this data, excluding parants
property: Kwf_Comonent_Generator_Abstract $generator generator that created this data
property: Kwf_Component_Data $parent parent data
property: string $url url pointing to the page of this data, generated from filename property of parents
property: string $rel rel attribute when url is used in an a-tag
property: string $filename (only if page): the filename of this data, used to generate urls
property: Kwf_Model_Row_Interface $row only if created by table generator: row assigned to this data
property: bool $isPage true if this data represents a page
property: bool $isPseudopage true if this data represents a page
Classes: Kwf_Component_Data

Description

\Kwf_Component_Data
jump to top

package: Components
property: string $componentId unique componentId of this data
property: string $dbId dbId of this data
property: string $componentClass component class of this data
property: int $id id of this data, excluding parants
property: Kwf_Comonent_Generator_Abstract $generator generator that created this data
property: Kwf_Component_Data $parent parent data
property: string $url url pointing to the page of this data, generated from filename property of parents
property: string $rel rel attribute when url is used in an a-tag
property: string $filename (only if page): the filename of this data, used to generate urls
property: Kwf_Model_Row_Interface $row only if created by table generator: row assigned to this data
property: bool $isPage true if this data represents a page
property: bool $isPseudopage true if this data represents a page
Constants: DEVICE_VISIBLE_ALL; DEVICE_VISIBLE_HIDE_ON_MOBILE; DEVICE_VISIBLE_ONLY_SHOW_ON_MOBILE
Methods: __destruct; __get; _getPseudoPageUrl; countChildComponents; getAbsoluteUrl; getBaseProperty; getChildBoxes; getChildComponent; getChildComponents; getChildIds; getChildPage; getChildPageByPath; getChildPages; getChildPseudoPage; getChildPseudoPages; getComponent; getDeviceVisible; getDomain; getExpandedComponentId; getGenerator; getLanguage; getPage; getPageOrRoot; getParentByClass; getParentComponent; getParentComponentId; getParentPage; getParentPageOrRoot; getParentPseudoPage; getParentPseudoPageOrRoot; getPreviewUrl; getPseudoPage; getPseudoPageOrRoot; getRecursiveChildComponent; getRecursiveChildComponents; getSubroot; getTitle; hasContent; isShownInMenu; isVisible; render; trl; trlKwf; trlStaticExecute; trlc; trlcKwf; trlcp; trlcpKwf; trlp; trlpKwf

Description

Constants

DEVICE_VISIBLE_ALL
jump to class

 DEVICE_VISIBLE_ALL = 'all'

Details

value: all

DEVICE_VISIBLE_HIDE_ON_MOBILE
jump to class

 DEVICE_VISIBLE_HIDE_ON_MOBILE = 'hideOnMobile'

Details

value: hideOnMobile

DEVICE_VISIBLE_ONLY_SHOW_ON_MOBILE
jump to class

 DEVICE_VISIBLE_ONLY_SHOW_ON_MOBILE = 'onlyShowOnMobile'

Details

value: onlyShowOnMobile

Methods

__destruct
jump to class

__destruct(
          
          )
        
        :

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
           $var
          )
        
        :

Arguments

$var

Details

visibility: public
final: false
static: false

_getPseudoPageUrl
jump to class

_getPseudoPageUrl(
          
          )
        
        :

Like ->url but also works for pseudoPages

overridden in Data_Home

Details

visibility: protected
final: false
static: false

countChildComponents
jump to class

countChildComponents(
           $select
              =
              array
          )
        
        :
        int

returns the number of child components for a single generator

Only works for a single generator - you have to specify the required generator.

This is much more efficient than count(->getChildComponents()) as it will result in an SELECT COUNT() sql query

Arguments

$select: array|Kwf_Component_Select

Output

int

Details

visibility: public
final: false
static: false

getAbsoluteUrl
jump to class

getAbsoluteUrl(
           $useHttps
              =
              false
          )
        
        :
        string

Returns absolute url including domain and protocol (http://)

Arguments

$useHttps

Output

string

Details

visibility: public
final: false
static: false

getBaseProperty
jump to class

getBaseProperty(
          string $propertyName
          )
        
        :
        string

Retrieves a base Property for a component

Any component can add a flag called 'hasBaseProperties' and implement getBaseProperties($propertyName) to return a property specific for this component and all child components (e.g. language, domain, id for analytics...) It's also possible to specify the returned property by adding an array "baseProperties" to the settings. This may help some to exclude components to be asked for base Properties which they actually don't return.

Arguments

$propertyName: string

Output

string: Property

Details

visibility: public
final: false
static: false

getChildBoxes
jump to class

getChildBoxes(
           $select
              =
              array
          )
        
        :
        \Kwf_Component_Data[]

Returns child boxes matching the given select

Not only direct children will be returned, also boxes created by child components.

Arguments

$select: array|Kwf_Component_Select

Output

\Kwf_Component_Data[]

Details

visibility: public
final: false
static: false

getChildComponent
jump to class

getChildComponent(
           $select
              =
              array
          )
        
        :
        \Kwf_Component_Data

Returns a single direct child component

Arguments

$select

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false
see: getChildComponents

getChildComponents
jump to class

getChildComponents(
           $select
              =
              array
          )
        
        :
        \Kwf_Component_Data[]

Returns child components matching the given select

Arguments

$select: array|Kwf_Component_Select

Output

\Kwf_Component_Data[]

Details

visibility: public
final: false
static: false

getChildIds
jump to class

getChildIds(
           $select
              =
              array
          )
        
        :
        \int[]

Returns child ids for a single generator

Only works for a single generator - you have to specify the required generator.

This is much more efficient than getChildComponents as no rows or data objects will be created.

Arguments

$select: array|Kwf_Component_Select

Output

\int[]

Details

visibility: public
final: false
static: false

getChildPage
jump to class

getChildPage(
           $select
              =
              array,  $childSelect
              =
              array
          )
        
        :
        \Kwf_Component_Data

Returns a single child page

Arguments

$select
$childSelect

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false
see: getChildPages

getChildPageByPath
jump to class

getChildPageByPath(
           $path
          )
        
        :
        \Kwf_Component_Data

Searches for a child page by a given path

Should only be used to resolve incoming paths

Arguments

$path: string

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getChildPages
jump to class

getChildPages(
          array|\Kwf_Component_Select $select
              =
              array, array|\Kwf_Component_Select $childSelect
              =
              array
          )
        
        :
        \Kwf_Component_Data[]

Returns child pages matching the given select

Not only direct children will be returned, also pages created by child components.

Arguments

$select: array\Kwf_Component_Select
additional constraints
$childSelect: array\Kwf_Component_Select
constraints on how deep indirect child pages will be returned

Output

\Kwf_Component_Data[]

Details

visibility: public
final: false
static: false

getChildPseudoPage
jump to class

getChildPseudoPage(
           $select
              =
              array
          )
        
        :
        \Kwf_Component_Data

Returns a single child pseudo page

Arguments

$select

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false
see: getChildPseudoPages

getChildPseudoPages
jump to class

getChildPseudoPages(
          array|\Kwf_Component_Select $select
              =
              array, array|\Kwf_Component_Select $childSelect
              =
              array
          )
        
        :
        \Kwf_Component_Data[]

Returns child pseudo pages matching the given select

Not only direct children will be returned, also pseudo pages created by child components.

Arguments

$select: array\Kwf_Component_Select
additional constraints
$childSelect: array\Kwf_Component_Select
constraints on how deep indirect child pseudo pages will be returned

Output

\Kwf_Component_Data[]

Details

visibility: public
final: false
static: false

getComponent
jump to class

getComponent(
          
          )
        
        :
        \Kwc_Abstract

Returns the Component object of to this data

Output

\Kwc_Abstract

Details

visibility: public
final: false
static: false

getDeviceVisible
jump to class

getDeviceVisible(
          
          )
        
        :

Returns on which devices this page should be visible

DEVICE_VISIBLE_* constants are returned. Implement getDeviceVisible in generator to change behaviour.

Details

visibility: public
final: true
static: false

getDomain
jump to class

getDomain(
          
          )
        
        :
        string

Returns domain for current component

Output

string

Details

visibility: public
final: false
static: false

getExpandedComponentId
jump to class

getExpandedComponentId(
          
          )
        
        :
        string

Returns component_id with seperate entries from every page in tree

Output

string

Details

visibility: public
final: false
static: false
example: root |-1 |-2 |-3 componentId: 3, expandedComponentId: root-1_2_3

getGenerator
jump to class

getGenerator(
          string $key
          )
        
        :
        \Kwf_Component_Generator_Abstract

Returns a generator of this data

shortcut for Kwf_Component_Generator_Abstract::getInstance($data->componentClass, $key);

Arguments

$key: string
generator key

Output

\Kwf_Component_Generator_Abstract

Details

visibility: public
final: false
static: false

getLanguage
jump to class

getLanguage(
          
          )
        
        :
        string

Returns the language used by this data

Output

string

Details

visibility: public
final: false
static: false

getPage
jump to class

getPage(
          
          )
        
        :
        \Kwf_Component_Data

Returns the page this data belongs to (might be a page itself)

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getPageOrRoot
jump to class

getPageOrRoot(
          
          )
        
        :
        \Kwf_Component_Data

Returns the page this data belongs to (might be a page itself) OR (if there is no page) the root component

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getParentByClass
jump to class

getParentByClass(
          string|array $cls
          )
        
        :
        \Kwf_Component_Data

Returns the parent matching a given component class

Arguments

$cls: stringarray
component class or array of component classes

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getParentComponent
jump to class

getParentComponent(
          int $numParent
              =
              1
          )
        
        :
        \Kwf_Component_Data

Returns a parent component from a given depth

more efficient than getting ->parent multiple times (only if data was unserialized)

Arguments

$numParent: int
levels to go up

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getParentComponentId
jump to class

getParentComponentId(
          int $numParent
              =
              1
          )
        
        :
        \Kwf_Component_Data

Returns a parent component id from a given depth

more efficient than getting ->parent multiple times (only if data was unserialized)

Arguments

$numParent: int
levels to go up

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getParentPage
jump to class

getParentPage(
          
          )
        
        :
        \Kwf_Component_Data

Returns the parent page of this data

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getParentPageOrRoot
jump to class

getParentPageOrRoot(
          
          )
        
        :
        \Kwf_Component_Data

Returns the parent page OR (if there is no none) the root component

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getParentPseudoPage
jump to class

getParentPseudoPage(
          
          )
        
        :
        \Kwf_Component_Data

Returns the parent pseudo page of this data

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getParentPseudoPageOrRoot
jump to class

getParentPseudoPageOrRoot(
          
          )
        
        :
        \Kwf_Component_Data

Returns the parent pseudo page OR (if there is no none) the root component

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getPreviewUrl
jump to class

getPreviewUrl(
          
          )
        
        :
        string

Returns preview url

Output

string

Details

visibility: public
final: false
static: false

getPseudoPage
jump to class

getPseudoPage(
          
          )
        
        :
        \Kwf_Component_Data

Returns the pseudo page this data belongs to (might be a pseudo page itself)

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getPseudoPageOrRoot
jump to class

getPseudoPageOrRoot(
          
          )
        
        :
        \Kwf_Component_Data

Returns the psuedo page or pagethis data belongs to (might be a page itself) OR (if there is no page) the root component

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false

getRecursiveChildComponent
jump to class

getRecursiveChildComponent(
           $select
              =
              array,  $childSelect
              =
              array
          )
        
        :
        \Kwf_Component_Data

Returns a single child component

Arguments

$select
$childSelect

Output

\Kwf_Component_Data

Details

visibility: public
final: false
static: false
see: getRecursiveChildComponents

getRecursiveChildComponents
jump to class

getRecursiveChildComponents(
          \Kwf_Component_Select|array $select
              =
              array, \Kwf_Component_Select|array $childSelect
              =
              array
          )
        
        :
        \array(Kwf_Component_Data)

Returns child components recursively

This method usually is very efficient and tries to create as less data objects as possible. It is still a complex operation thus should not get called too often.

Arguments

$select: \Kwf_Component_Selectarray
what to search for
$childSelect: \Kwf_Component_Selectarray
how deep to search

Output

\array(Kwf_Component_Data)

Details

visibility: public
final: false
static: false

getSubroot
jump to class

getSubroot(
          
          )
        
        :

Details

visibility: public
final: false
static: false

getTitle
jump to class

getTitle(
          
          )
        
        :
        string

Returns the title of the page

Can be overridden to customize.

By default names of parent pages will be used

Output

string

Details

visibility: public
final: false
static: false

hasContent
jump to class

hasContent(
          
          )
        
        :
        bool

Returns if the component has content

Shortcut for $this->getComponent()->hasContent()

Output

bool

Details

visibility: public
final: false
static: false

isShownInMenu
jump to class

isShownInMenu(
          
          )
        
        :
        bool

Returns if this page should be shown in menus

Category_Generators can change that dynamically using the hide column, other generators have a 'showInMenu' setting (defaults to false)

Output

bool

Details

visibility: public
final: false
static: false

isVisible
jump to class

isVisible(
          
          )
        
        :
        bool

Returns if this component is visible

A component is visible if all parents are visible.

Output

bool

Details

visibility: public
final: false
static: false

render
jump to class

render(
          bool $enableCache
              =
              null, bool $renderMaster
              =
              false,  $hasDynamicParts
              =
              false
          )
        
        :
        string

Render the component

Usually only used internally or for debugging

Arguments

$enableCache: bool
if view cache should be used, if null config setting will be used
$renderMaster: bool
if master should be rendered
$hasDynamicParts

Output

string

Details

visibility: public
final: false
static: false

trl
jump to class

trl(
           $string,  $text
              =
              array
          )
        
        :

Arguments

$string
$text

Details

visibility: public
final: false
static: false

trlKwf
jump to class

trlKwf(
           $string,  $text
              =
              array
          )
        
        :

Arguments

$string
$text

Details

visibility: public
final: false
static: false

trlStaticExecute
jump to class

trlStaticExecute(
           $trlStaticData
          )
        
        :

Arguments

$trlStaticData

Details

visibility: public
final: false
static: false

trlc
jump to class

trlc(
           $context,  $string,  $text
              =
              array
          )
        
        :

Arguments

$context
$string
$text

Details

visibility: public
final: false
static: false

trlcKwf
jump to class

trlcKwf(
           $context,  $string,  $text
              =
              array
          )
        
        :

Arguments

$context
$string
$text

Details

visibility: public
final: false
static: false

trlcp
jump to class

trlcp(
           $context,  $single,  $plural,  $text
              =
              array
          )
        
        :

Arguments

$context
$single
$plural
$text

Details

visibility: public
final: false
static: false

trlcpKwf
jump to class

trlcpKwf(
           $context,  $single,  $plural,  $text
              =
              array
          )
        
        :

Arguments

$context
$single
$plural
$text

Details

visibility: public
final: false
static: false

trlp
jump to class

trlp(
           $single,  $plural,  $text
              =
              array
          )
        
        :

Arguments

$single
$plural
$text

Details

visibility: public
final: false
static: false

trlpKwf
jump to class

trlpKwf(
           $single,  $plural,  $text
              =
              array
          )
        
        :

Arguments

$single
$plural
$text

Details

visibility: public
final: false
static: false

Component/Data.php

Description

\Kwf_Component_Datajump to top

Description

Constants

DEVICE_VISIBLE_ALLjump to class

Details

DEVICE_VISIBLE_HIDE_ON_MOBILEjump to class

Details

DEVICE_VISIBLE_ONLY_SHOW_ON_MOBILEjump to class

Details

Methods

__destructjump to class

Details

__getjump to class

Arguments

Details

_getPseudoPageUrljump to class

Details

countChildComponentsjump to class

Arguments

Output

Details

getAbsoluteUrljump to class

Arguments

Output

Details

getBasePropertyjump to class

Arguments

Output

Details

getChildBoxesjump to class

Arguments

Output

Details

getChildComponentjump to class

Arguments

Output

Details

getChildComponentsjump to class

Arguments

Output

Details

getChildIdsjump to class

Arguments

Output

Details

getChildPagejump to class

Arguments

Output

Details

getChildPageByPathjump to class

Arguments

Output

Details

getChildPagesjump to class

Arguments

Output

Details

getChildPseudoPagejump to class

Arguments

Output

Details

getChildPseudoPagesjump to class

Arguments

Output

Details

getComponentjump to class

Output

Details

getDeviceVisiblejump to class

Details

getDomainjump to class

Output

Details

getExpandedComponentIdjump to class

Output

Details

getGeneratorjump to class

Arguments

\Kwf_Component_Data
jump to top

DEVICE_VISIBLE_ALL
jump to class

DEVICE_VISIBLE_HIDE_ON_MOBILE
jump to class

DEVICE_VISIBLE_ONLY_SHOW_ON_MOBILE
jump to class

__destruct
jump to class

__get
jump to class

_getPseudoPageUrl
jump to class

countChildComponents
jump to class

getAbsoluteUrl
jump to class

getBaseProperty
jump to class

getChildBoxes
jump to class

getChildComponent
jump to class

getChildComponents
jump to class

getChildIds
jump to class

getChildPage
jump to class

getChildPageByPath
jump to class

getChildPages
jump to class

getChildPseudoPage
jump to class

getChildPseudoPages
jump to class

getComponent
jump to class

getDeviceVisible
jump to class

getDomain
jump to class

getExpandedComponentId
jump to class

getGenerator
jump to class

getLanguage
jump to class

getPage
jump to class

getPageOrRoot
jump to class

getParentByClass
jump to class

getParentComponent
jump to class

getParentComponentId
jump to class

getParentPage
jump to class

getParentPageOrRoot
jump to class

getParentPseudoPage
jump to class

getParentPseudoPageOrRoot
jump to class

getPreviewUrl
jump to class

getPseudoPage
jump to class

getPseudoPageOrRoot
jump to class

getRecursiveChildComponent
jump to class

getRecursiveChildComponents
jump to class

getSubroot
jump to class

getTitle
jump to class

hasContent
jump to class

isShownInMenu
jump to class

isVisible
jump to class

render
jump to class