Back to index

plone3  3.1.7
Public Member Functions
plone.i18n.normalizer.interfaces.IIDNormalizer Class Reference
Inheritance diagram for plone.i18n.normalizer.interfaces.IIDNormalizer:
Inheritance graph
[legend]
Collaboration diagram for plone.i18n.normalizer.interfaces.IIDNormalizer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def normalize

Detailed Description

An ID normalizer can normalize any unicode string and returns a
   version that only contains of ASCII characters allowed in a typical
   scripting or programming language id, such as CSS class names or Python
   variable names for example.

Definition at line 16 of file interfaces.py.


Member Function Documentation

def plone.i18n.normalizer.interfaces.INormalizer.normalize (   text,
  locale = None,
  max_length = None 
) [inherited]
A normalizer can normalize any unicode text string according to a
   specific ruleset implemented in the normalizer itself.
The normalize method takes and input unicode text and an optional
   locale string and returns a normalized version of the text.
   If the locale is not None the ouput might differ dependent on the
   locale. The max_length argument allows you to override the default
   values used by the normalizers on a case-by-case basis.

Definition at line 8 of file interfaces.py.

00008 
00009     def normalize(text, locale=None, max_length=None):
00010         """The normalize method takes and input unicode text and an optional
00011            locale string and returns a normalized version of the text.
00012            If the locale is not None the ouput might differ dependent on the
00013            locale. The max_length argument allows you to override the default
00014            values used by the normalizers on a case-by-case basis.
00015         """

Here is the caller graph for this function:


The documentation for this class was generated from the following file: