PHP Interface Sulu\Component\Category\Request\CategoryRequestHandlerInterface

Datei anzeigen Open project: sulu/sulu Interface Usage Examples

Public Methods

Method	Description
appendCategoryToUrl ( array \| Sulu\Bundle\CategoryBundle\Entity\CategoryInterface $category, string $categoriesParameter = 'categories' ) : string	Extends current URL with given category.
getCategories ( string $categoriesParameter = 'categories' ) : string[]	Determine categories from current request.
removeCategoriesFromUrl ( string $categoriesParameter = 'categories' ) : string	Remove category from current URL.
setCategoryToUrl ( array \| Sulu\Bundle\CategoryBundle\Entity\CategoryInterface $category, string $categoriesParameter = 'categories' ) : string	Set category to current URL.

Method Details

appendCategoryToUrl() public method

Extends current URL with given category.

public appendCategoryToUrl ( array \| Sulu\Bundle\CategoryBundle\Entity\CategoryInterface $category, string $categoriesParameter = 'categories' ) : string
$category	array \| Sulu\Bundle\CategoryBundle\Entity\CategoryInterface	will be included in the URL
$categoriesParameter	string	GET parameter name
return	string

getCategories() public method

Determine categories from current request.

public getCategories ( string $categoriesParameter = 'categories' ) : string[]
$categoriesParameter	string
return	string[]

removeCategoriesFromUrl() public method

Remove category from current URL.

public removeCategoriesFromUrl ( string $categoriesParameter = 'categories' ) : string
$categoriesParameter	string	GET parameter name
return	string

setCategoryToUrl() public method

Set category to current URL.

public setCategoryToUrl ( array \| Sulu\Bundle\CategoryBundle\Entity\CategoryInterface $category, string $categoriesParameter = 'categories' ) : string
$category	array \| Sulu\Bundle\CategoryBundle\Entity\CategoryInterface	will be included in the URL
$categoriesParameter	string	GET parameter name
return	string