SwatObject
└─SiteObject
└─SiteAbstractPage
└─SitePageDecorator
└─SiteUiPage
└─SiteEditPage
public abstract class SiteEditPage
extends SiteUiPage
| Fields inherited from Site.SiteUiPage | |
|---|---|
| ui | |
| Fields inherited from Site.SitePageDecorator | |
|---|---|
| page | |
| Fields inherited from Site.SiteAbstractPage | |
|---|---|
| app, arguments, layout, source | |
| Method Summary | |
|---|---|
| protected void | assignObjectValueToUi(mixed object, mixed name) |
| protected void | assignObjectValuesToUi(mixed object, mixed names) |
| protected void | assignUiValueToObject(mixed object, mixed name) |
| protected void | assignUiValuesToObject(mixed object, mixed names) |
| protected void | authenticate(mixed form) Authenticate a form on the page. |
| protected void | buildForm(mixed form) |
| protected void | |
| protected string | generateShortname(string text) Generates a shortname. |
| protected void | getForms() |
| protected void | getInvalidMessage(mixed form) |
| protected abstract void | isNew(mixed form) |
| protected void | isValid(mixed form) |
| protected abstract void | load(mixed form) |
| void | process() Always runs after SitePage::init() and before SiteLayout::process(). |
| protected void | processForm(mixed form) |
| protected abstract void | relocate(mixed form) |
| protected abstract void | save(mixed form) |
| protected void | validate(mixed form) |
| protected boolean | validateShortname(string shortname) Validates a shortname. |
| Methods inherited from Site.SiteUiPage | |
|---|---|
| build, buildContent, buildInternal, finalize, getUiXml, init, initInternal | |
| Methods inherited from Site.SitePageDecorator | |
|---|---|
| build, buildContent, buildMetaDescription, buildNavBar, buildTitle, finalize, init, process, setLayout, setSource | |
| Methods inherited from Site.SiteAbstractPage | |
|---|---|
| build, finalize, getArgument, getArgumentMap, getSource, init, process, setLayout, setSource | |
protected void assignObjectValueToUi(mixed object, mixed name)
protected void assignObjectValuesToUi(mixed object, mixed names)
protected void assignUiValueToObject(mixed object, mixed name)
protected void assignUiValuesToObject(mixed object, mixed names)
protected void authenticate(mixed form)
Authenticate a form on the page
protected void buildForm(mixed form)
protected void buildInternal()
protected string generateShortname(string text)
Generates a shortname
This method allows edit pages to easily generate a unique shortname by
during their processing phase. The shortname is generated from the
provided text using SwatString::condenseToName() and then
validated with SiteEditPage::validateShortname(). If the initial
shortname is not valid, an integer is appended and incremented until the
shortname is valid. Subclasses should override
validateShortname() to perform whatever checks are
necessary to validate the shortname.
text - the text from which to generate the shortname.protected void getForms()
protected void getInvalidMessage(mixed form)
protected abstract void isNew(mixed form)
protected void isValid(mixed form)
protected abstract void load(mixed form)
public void process()
Always runs after SitePage::init() and before
SiteLayout::process(). This method is intended to process
data entered by the user.
protected void processForm(mixed form)
protected abstract void relocate(mixed form)
protected abstract void save(mixed form)
protected void validate(mixed form)
protected boolean validateShortname(string shortname)
Validates a shortname
This method is called by SiteEditPage::generateShortname() to
validate a generated shortname. By default, all shortnames are considered
valid. Subclasses should override this method to perform the necessary
checks to properly validate the shortname.
shortname - the shortname to validate.
Base class for edit pages