PHP Class CTTopMenuItem, community-theme-16

Inheritance: extends ObjectModel
Show file Open project: PrestaShop/community-theme-16 Class Usage Examples

Public Properties

Property Type Description
$active boolean
$class string
$definition array Model definition
$entity_id integer
$icon string
$name string
$no_follow boolean
$position integer
$title string
$tree_max_depth integer
$type integer
$url string

Public Methods

Method Description
add ( boolean $autoDate = true, boolean $nullValues = false ) : boolean Inserts new menu item to the database
delete ( ) : boolean Clears menu cache on delete event
getMaxPosition ( integer $id_shop ) : integer Returns max position in the given shop
getMenuItems ( integer $id_lang, integer $id_shop ) : array Returns all menu items for a given shop
update ( boolean $nullValues = false ) : boolean Clears menu cached on update event

Method Details

add() public method

Inserts new menu item to the database
public add ( boolean $autoDate = true, boolean $nullValues = false ) : boolean
$autoDate boolean
$nullValues boolean
return boolean

delete() public method

Clears menu cache on delete event
public delete ( ) : boolean
return boolean

getMaxPosition() public static method

Returns max position in the given shop
public static getMaxPosition ( integer $id_shop ) : integer
$id_shop integer
return integer

getMenuItems() public static method

Returns all menu items for a given shop
public static getMenuItems ( integer $id_lang, integer $id_shop ) : array
$id_lang integer
$id_shop integer
return array

update() public method

Clears menu cached on update event
public update ( boolean $nullValues = false ) : boolean
$nullValues boolean
return boolean

Property Details

$active public property

public bool $active
return boolean

$class public property

public string $class
return string

$definition public static property

Model definition
public static array $definition
return array

$entity_id public property

public int $entity_id
return integer

$icon public property

public string $icon
return string

$name public property

public string $name
return string

$no_follow public property

public bool $no_follow
return boolean

$position public property

public int $position
return integer

$title public property

public string $title
return string

$tree_max_depth public property

public int $tree_max_depth
return integer

$type public property

public int $type
return integer

$url public property

public string $url
return string