Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
   eZ Publish 4.x / legacy

eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


The ezpublish.legacy property returns an object of type ParameterBag, which is a container for key/value pairs, and contains additional properties to retrieve/handle legacy information.

ezpublish.legacy.allReturns all the parameters, with all the contained information.
ezpublish.legacy.keysReturns the parameter keys only.
ezpublish.legacy.replaceReplaces the current parameters by a new set.
ezpublish.legacy.addAdds parameters.
ezpublish.legacy.getReturns a parameter by name.
ezpublish.legacy.setSets a parameter by name.ezpublish.legacy.hasReturns true if the parameter is defined.
ezpublish.legacy.removeRemoves a parameter.
ezpublish.legacy.getAlphaReturns the alphabetic characters of the parameter value.
ezpublish.legacy.getAlnumReturns the alphabetic characters and digits of the parameter value.
ezpublish.legacy.getDigitsReturns the digits of the parameter value.
ezpublish.legacy.getIntReturns the parameter value converted to integer.


Listing the available parameters