HeadAPIΒΆ

public bool isEditMode ()

Returns true if the current renderings happens inside of the rukzuk cms edit mode.

Returns:bool
public bool isPreviewMode ()

Returns true if the current renderings happens inside of the rukzuk cms preview mode.

Returns:bool
public bool isLiveMode ()

Returns true if the current rendering happens on a live server (website is deployed).

Returns:bool
public array getResolutions ()

Returns the resolutions array

Returns:array
public bool isTemplate ()

Returns true when the current rendering task renders a template

Returns:bool
public bool isPage ()

Returns true when the current rendering task renders a page

Returns:bool
public RenderAPIsAPIv1Navigation Navigation getNavigation ()

Returns the navigation object

Returns:RenderAPIsAPIv1Navigation Navigation
public string getColorById (string colorId)

Convert a color id to a rgba() value

Parameters:
  • $colorId (string) –
Returns:

string rgba() value of the given color id

public array getColorScheme ()

Returns the Color Scheme as array map

Returns:array (color-id => color-value)
public RenderAPIsAPIv1MediaItem MediaItem getMediaItem (string mediaId)

Returns the media item with the given media id or null if the image does not exists.

Parameters:
  • $mediaId (string) –
Returns:

RenderAPIsAPIv1MediaItem MediaItem

throws exceptions: MediaItemNotFoundException MediaItemNotFoundException

public string getInterfaceLanguage ()

Returns the language code of the current cms user interface.

Returns:string The language code (examples: en; de; fr)