subsite-callback-procs.tcl

Procs to support a simple callback mechanism that allows other applications to register callbacks triggered when objects, like groups, in the subsite application are created.

Location:
packages/acs-subsite/tcl/subsite-callback-procs.tcl
Created:
Wed Feb 21 17:10:24 2001
Author:
mbryzek@arsdigita.com
CVS Identification:
$Id: subsite-callback-procs.tcl,v 1.10.2.3 2022/02/13 16:46:47 gustafn Exp $

Procedures in this file

Detailed information

callback::subsite::global_parameter_changed::contract (private)

 callback::subsite::global_parameter_changed::contract \
    -package_key package_key -parameter parameter -value value

Callback for changing the value of a global parameter.

Switches:
-package_key (required)
The package_key of the package the parameter was changed for.
-parameter (required)
The parameter value.
-value (required)
The new value.
See Also:
  • package::set_value

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

Testcases:
No testcase defined.

callback::subsite::parameter_changed::contract (private)

 callback::subsite::parameter_changed::contract -package_id package_id \
    -parameter parameter -value value

Callback for changing the value of an instance parameter.

Switches:
-package_id (required)
The package_id of the package the parameter was changed for.
-parameter (required)
The parameter value.
-value (required)
The new value.
See Also:
  • package::set_value

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

Testcases:
No testcase defined.

callback::subsite::url::contract (private)

 callback::subsite::url::contract -package_id package_id \
    -object_id object_id [ -type type ]

Callback for creating a URL for an object_id. This is usually called in /o.vuh, but you could think of scenarios where using this hook makes sense as well. The type lets you define what kind of URL you are looking for (e.g. admin/edit/display)

Switches:
-package_id (required)
-object_id (required)
-type (optional)

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

Testcases:
No testcase defined.

subsite::callback (public)

 subsite::callback [ -object_type object_type ] event_type object_id

Executes any registered callbacks for this object.

Example: 

    # Execute any callbacks registered for this object type or one of
    # its parent object types
    subsite::callback -object_type $object_type $object_id

Switches:
-object_type (optional)
The object's type. We look this up in the db if not specified
Parameters:
event_type (required)
object_id (required)
Author:
Michael Bryzek <mbryzek@arsdigita.com>
Created:
12/2000

Partial Call Graph (max 5 caller/called nodes):
%3 package_instantiate_object package_instantiate_object (public) subsite::callback subsite::callback package_instantiate_object->subsite::callback subsite_callback subsite_callback (public, deprecated) subsite_callback->subsite::callback ad_conn ad_conn (public) subsite::callback->ad_conn db_foreach db_foreach (public) subsite::callback->db_foreach

Testcases:
No testcase defined.

subsite_callback (public, deprecated)

 subsite_callback [ args... ]
Deprecated. Invoking this procedure generates a warning.

Executes any registered callbacks for this object.

Example: 

    # Execute any callbacks registered for this object type or one of
    # its parent object types
    subsite_callback -object_type $object_type $object_id

Author:
Michael Bryzek <mbryzek@arsdigita.com>
Created:
12/2000
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) subsite::callback subsite::callback (public) subsite_callback subsite_callback subsite_callback->ad_log_deprecated subsite_callback->subsite::callback

Testcases:
No testcase defined.
[ show source ]