callback::navigation::package_admin::contract (private)

 callback::navigation::package_admin::contract \
    [ -package_id package_id ] [ -user_id user_id ] \
    [ -return_url return_url ]

Defined in packages/acs-tcl/tcl/navigation-callback-procs.tcl

Returns the list of available admin actions for the passed in user on the passed in package_id.

    {
       {LINK url_stub text title_text long_text}
       {SECTION title long_text}
    }

Where LINK and SECTION are the literal strings. For LINK the url and text are required, text and title should be plain text but long_text should be html (and renderers should present it noquote). For SECTION both title and long_text can be blank which for the rendering agent would imply a section break with something like blank space or an <hr> tag. Also keep in mind the rendering agent may be creating dropdown menus which would only display the link text and title or might be rendering in a page in which case all things might be rendered so try to make sure the short "title" and "text" fields are not ambiguous. "title" should be plain text but "long_text" is treated as HTML. url_stub should be relative to the package mountpoint and without a leading / since the link may be prefixed by the full path or by the vhost URL depending on context. The /packages/acs-tcl/lib/actions.adp file is an include which will render admin actions returned by this callback.

Switches:

-package_id (optional)

- the package for which to generate the admin links

-user_id (optional)

- the user_id for whom the list should be generated

-return_url (optional)

- a return_url provided by the rendering agent for those actions which could come back

Returns:

a list with one element, the list of actions {{{LINK url_stub text title_text long_text} ... }}

Author:

Jeff Davis <davis@xarg.net>

See Also:

• callback::package::admin_actions::impl::forums
• /packages/acs-tcl/lib/actions.adp
• /packages/acs-tcl/lib/actions.tcl

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Source code:

            # this is a callback contract which only invokes its arg parser for input validation

XQL Not present:

Generic, PostgreSQL, Oracle