CSIconChooserService
This file defines the service for the icon chooser.
Tags
Table of Contents
- executeIconChooserIcons() : array<string|int, mixed>
- This method returns all available icons for the defined context (library, size and search string).
- executeIconChooserLibraries() : array<string|int, mixed>
- This method returns all available icon libraries in CONTENTSERV including all the icon sizes contained by the library. The return value has the following format:
Methods
executeIconChooserIcons()
This method returns all available icons for the defined context (library, size and search string).
public
executeIconChooserIcons(mixed $sLibrary, mixed $sSize[, mixed $sSearch = '' ]) : array<string|int, mixed>
The format is defined like this:
array( '#' => array( array( array( 'name' => 'icon name1', 'path' => 'icon path1' ), array( 'name' => 'icon name2', 'path' => 'icon path2' ) ) ), 'A' => array( array( array( 'name' => 'icon name1', 'path' => 'icon path1' ), array( 'name' => 'icon name2', 'path' => 'icon path2' ) ) ), ... );
For every letter in the alphabet an own section is created.
Parameters
- $sLibrary : mixed
- $sSize : mixed
- $sSearch : mixed = ''
Tags
Return values
array<string|int, mixed> —The list of available icons.
executeIconChooserLibraries()
This method returns all available icon libraries in CONTENTSERV including all the icon sizes contained by the library. The return value has the following format:
public
executeIconChooserLibraries() : array<string|int, mixed>
array( 'library_name1' => array( '16x16', '32x32' ), 'library_name2' => array( '32x32', '128x128' ) );
Tags
Return values
array<string|int, mixed> —The list of available icon libraries.