Component/Data/Root.php
- package
- Components
- Classes
- Kwf_Component_Data_Root
Description
\Kwf_Component_Data_Root
- Extends from
- \Kwf_Component_Data
- package
- Components
Methods
- freeMemory
- getComponentByClass
- getComponentByDbId
- getComponentById
- getComponentBySameClass
- getComponentsByClass
- getComponentsByDbId
- getComponentsBySameClass
- getExpandedComponentId
- getInstance
- getPageByUrl
- getPageGenerators
- getShowInvisible
Description
Methods
freeMemory
freeMemory(
)
:
Tries to clear all cached data objects and row objects
Usful when processing lot of components to avoid memory issues
Details
- visibility
- public
- final
- false
- static
- false
getComponentByClass
getComponentByClass(
string $class, $select
=
array
)
:
\Kwf_Component_DataReturns component by given component class
If multiple are found you will get an exception, To avoid that pass 'limit'=>1 as select
Arguments
- $class
- string
component class - $select
- array|Kwf_Component_Select
Output
Details
- visibility
- public
- final
- false
- static
- false
- see
- getComponentsByClass
getComponentByDbId
getComponentByDbId(
$dbId, $select
=
array
)
:
\Kwf_Component_DataSearches for a component data by it's dbId
As multiple can have the same dbId you will get an exception if mutiple are found. To avoid that pass 'limit'=>1 as select
Arguments
- $dbId
- string
- $select
- array|Kwf_Component_Select
Output
Details
- visibility
- public
- final
- false
- static
- false
getComponentById
getComponentById(
string $componentId, array|\Kwf_Component_Select $select
=
array
)
:
\Kwf_Component_DataReturns a component data by it's componentId
Arguments
- $componentId
- string
componentId - $select
- array\Kwf_Component_Select
additional contraint
Output
Details
- visibility
- public
- final
- false
- static
- false
getComponentBySameClass
getComponentBySameClass(
string $class, $select
=
array
)
:
\Kwf_Component_DataReturns component by given component class
If multiple are found you will get an exception, To avoid that pass 'limit'=>1 as select
Arguments
- $class
- string
component class - $select
- array|Kwf_Component_Select
Output
Details
- visibility
- public
- final
- false
- static
- false
- see
- getComponentsBySameClass
getComponentsByClass
getComponentsByClass(
string|array $class, $select
=
array
)
:
\Kwf_Component_Data[]Returns all components matching a component class (including classes inheriting that class)
Use with care, this is only efficient if a few components exist.
Arguments
- $class
- stringarray
component class - $select
- array|Kwf_Component_Select
Output
Details
- visibility
- public
- final
- false
- static
- false
- see
- getComponentsBySameClass
getComponentsByDbId
getComponentsByDbId(
$dbId, $select
=
array
)
:
\Kwf_Component_Data[]Searches for component datas by it's dbId
Arguments
- $dbId
- string
- $select
- array|Kwf_Component_Select
Output
Details
- visibility
- public
- final
- false
- static
- false
getComponentsBySameClass
getComponentsBySameClass(
string|array $lookingForChildClasses, $select
=
array
)
:
\Kwf_Component_Data[]Returns all components exactly matching a component class
Use with care, this is only efficient if a few components exist.
Arguments
- $lookingForChildClasses
- stringarray
component class - $select
- array|Kwf_Component_Select
Output
Details
- visibility
- public
- final
- false
- static
- false
- see
- getComponentsByClass
getExpandedComponentId
getExpandedComponentId(
)
:
stringReturns data by fully qualified url
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
getInstance
getInstance(
)
:
\Kwf_Component_Data_RootReturns the root component data instance
Output
Details
- visibility
- public
- final
- false
- static
- true
getPageByUrl
getPageByUrl(
$url, $acceptLanguage, $exactMatch
=
true
)
:
Arguments
- $url
- $acceptLanguage
- $exactMatch
Details
- visibility
- public
- final
- false
- static
- false
getPageGenerators
getPageGenerators(
)
:
\Kwc_Root_Category_Generator[]Returns all Kwc_Root_Category_Generators used.
the name of this method is a bit missleading
Output
- \Kwc_Root_Category_Generator[]
Details
- visibility
- public
- final
- false
- static
- false
getShowInvisible
getShowInvisible(
)
:
boolReturns true if invisible items should be shown, true if app is opened in with preview param
Output
- bool
Details
- visibility
- public
- final
- false
- static
- true