1. class
  2. Thelia
  3. Core
  4. Template
  5. Loop
  6. CategoryTree

CategoryTree

class CategoryTree extends BaseI18nLoop implements ArraySearchLoopInterface

Category tree loop, to get a category tree from a given category to a given depth.

  • category is the category id
  • depth is the maximum depth to go, default unlimited
  • visible if true or missing, only visible categories will be displayed. If false, all categories (visible or not) are returned.

Methods

__construct( ContainerInterface $container)

Create a new Loop

from  BaseLoop
mixed
__call( string $name, mixed $arguments)

Provides a getter to loop parameter values

from  BaseLoop
initializeArgs( array $nameValuePairs)

Initialize the loop arguments.

from  BaseLoop
count()

No description

from  BaseLoop
LoopResult
exec( PropelModelPager $pagination)

No description

from  BaseLoop
LoopResult
parseResults( LoopResult $loopResult)

No description

ArgumentCollection
getArgumentCollection()

Get the argument collection

from  BaseLoop
null|String
getLoopName()

Get the loop name

from  BaseLoop
string
getType()

No description

from  BaseLoop
bool
getForceReturn()

No description

from  BaseLoop
bool
getBackendContext()

No description

from  BaseLoop
int
getOffset()

available if countable is true

from  BaseLoop
int
getPage()

available if countable is true

from  BaseLoop
int
getLimit()

available if countable is true

from  BaseLoop
bool
getReturnUrl()

false for disable the generation of urls

from  BaseLoop
ModelCriteria
buildModelCriteria()

No description

from  BaseLoop
array
buildArray()

No description

addSearchInI18nColumn( ModelCriteria $search, string $columnName, string $searchCriteria, string $searchTerm)

Add the search clause for an I18N column, taking care of the back/front context, as defaultlocalei18n is not defined in the backEnd I18N context.

from  BaseI18nLoop
string
getLang()

No description

from  BaseI18nLoop
int
getCategory()

No description

int
getDepth()

No description

bool
getNeedCountChild()

No description

bool|string
getVisible()

No description

Details

in BaseLoop at line 99
__construct( ContainerInterface $container)

Create a new Loop

Parameters

ContainerInterface $container

in BaseLoop at line 210
mixed __call( string $name, mixed $arguments)

Provides a getter to loop parameter values

Parameters

string $name the method name (only getArgname is supported)
mixed $arguments this parameter is ignored

Return Value

mixed the argument value

Exceptions

InvalidArgumentException if the parameter is unknown or the method name is not supported.

in BaseLoop at line 231
initializeArgs( array $nameValuePairs)

Initialize the loop arguments.

Parameters

array $nameValuePairs a array of name => value pairs. The name is the name of the argument.

Exceptions

InvalidArgumentException if some argument values are missing, or invalid

in BaseLoop at line 456
count()

in BaseLoop at line 496
LoopResult exec( PropelModelPager $pagination)

Parameters

PropelModelPager $pagination

Return Value

LoopResult

at line 139
LoopResult parseResults( LoopResult $loopResult)

Parameters

LoopResult $loopResult

Return Value

LoopResult

in BaseLoop at line 744
ArgumentCollection getArgumentCollection()

Get the argument collection

Return Value

ArgumentCollection

in BaseLoop at line 754
null|String getLoopName()

Get the loop name

Return Value

null|String

in BaseLoop at line 52
string getType()

Return Value

string

in BaseLoop at line 52
bool getForceReturn()

Return Value

bool

in BaseLoop at line 52
bool getBackendContext()

Return Value

bool

in BaseLoop at line 52
int getOffset()

available if countable is true

Return Value

int

in BaseLoop at line 52
int getPage()

available if countable is true

Return Value

int

in BaseLoop at line 52
int getLimit()

available if countable is true

Return Value

int

in BaseLoop at line 52
bool getReturnUrl()

false for disable the generation of urls

Return Value

bool

in BaseLoop at line 52
ModelCriteria buildModelCriteria()

Return Value

ModelCriteria

at line 154
array buildArray()

Return Value

array

in BaseI18nLoop at line 89
addSearchInI18nColumn( ModelCriteria $search, string $columnName, string $searchCriteria, string $searchTerm)

Add the search clause for an I18N column, taking care of the back/front context, as defaultlocalei18n is not defined in the backEnd I18N context.

Parameters

ModelCriteria $search
string $columnName the column to search into, such as TITLE
string $searchCriteria the search criteria, such as Criterial::LIKE, Criteria::EQUAL, etc.
string $searchTerm the searched term

in BaseI18nLoop at line 29
string getLang()

Return Value

string

at line 46
int getCategory()

Return Value

int

at line 46
int getDepth()

Return Value

int

at line 46
bool getNeedCountChild()

Return Value

bool

at line 46
bool|string getVisible()

Return Value

bool|string