- Publicity: Public Only All
application-group-procs.tcl
Procs to manage application groups
- Location:
- packages/acs-subsite/tcl/application-group-procs.tcl
- Created:
- 2001-02-01
- Author:
- oumi@arsdigita.com
- CVS Identification:
$Id: application-group-procs.tcl,v 1.23.2.3 2022/10/26 14:20:35 gustafn Exp $
Procedures in this file
- application_group::child_application_groups (public, deprecated)
- application_group::closest_ancestor_application_group_id (public)
- application_group::closest_ancestor_application_group_site_node (public)
- application_group::closest_ancestor_element (public)
- application_group::contains_party_p (public)
- application_group::contains_relation_p (public)
- application_group::contains_segment_p (public)
- application_group::delete (public)
- application_group::group_id_from_package_id (public)
- application_group::new (public)
- application_group::package_id_from_group_id (public)
Detailed information
application_group::child_application_groups (public, deprecated)
application_group::child_application_groups -node_id node_id \
[ -package_key package_key ]Deprecated. Invoking this procedure generates a warning.
DEPRECATED: as of 2022-09-12 this API is not used in upstream codebase, and was still undocumented.
- Switches:
- -node_id
(required)- -package_key
(optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
application_group::closest_ancestor_application_group_id (public)
application_group::closest_ancestor_application_group_id [ -url url ] \
[ -node_id node_id ] [ -include_self ]Application group id of the closest ancestor package that has an application group
- Switches:
- -url
(optional)- URL of the node to start searching from.
- -node_id
(optional)- node_id of the node to start searching from (only one of node_id and URL can be specified).
- -include_self
(boolean) (optional)- If true, include the current package in the search
- Returns:
- group_id of the closest ancestor package that has an application group, if any.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- subsite_api
application_group::closest_ancestor_application_group_site_node (public)
application_group::closest_ancestor_application_group_site_node \
[ -url url ] [ -node_id node_id ] [ -include_self ]Starting with the node with the given node_id (or URL), climb up the site map and return the node of the first non null application group
- Switches:
- -url
(optional)- The URL of the node to start from. You must provide either URL or node_id. An empty URL is taken to mean the main site.
- -node_id
(optional)- The id of the node to start from. Takes precedence over any provided URL.
- -include_self
(boolean) (optional)- If true, include the current package in the search
- Returns:
- The node of the first non-null application group in array get format.
- Author:
- Peter Marklund, Dave Bauer
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- subsite_api
application_group::closest_ancestor_element (public)
application_group::closest_ancestor_element [ -node_id node_id ] \
[ -url url ] -element element [ -include_self ]Return one element of the site node for the closest ancestor package that has an application group.
- Switches:
- -node_id
(optional)- node_id of the node to start searching from (only one of node_id and URL can be specified).
- -url
(optional)- URL of the node to start searching from.
- -element
(required)- -include_self
(boolean) (optional)- If true, include the current package in the search
- Returns:
- element The desired element of the appropriate site node.
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- subsite_api
application_group::contains_party_p (public)
application_group::contains_party_p [ -package_id package_id ] \
[ -party_id party_id ] [ -include_self ]Determines whether the party in question (identified by party_id) is contained by the application group identified by package_id. If package_id is not specified, and we have a connection, then the proc will grab the package_id of the current package (i.e., [ad_conn package_id]).
- Switches:
- -package_id
(optional)- -party_id
(optional)- -include_self
(boolean) (optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- subsite_api
application_group::contains_relation_p (public)
application_group::contains_relation_p [ -package_id package_id ] \
[ -rel_id rel_id ]Determines whether the relation in question (identified by rel_id) is contained by the application group identified by package_id. If package_id is not specified, and we have a connection, then the proc will grab the package_id of the current package (i.e., [ad_conn package_id]).
- Switches:
- -package_id
(optional)- -rel_id
(optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
application_group::contains_segment_p (public)
application_group::contains_segment_p [ -package_id package_id ] \
[ -segment_id segment_id ]Determines whether the segment in question (identified by segment_id) "belongs" to the application group identified by package_id. If package_id is not specified, and we have a connection, then the proc will grab the package_id of the current package (i.e., [ad_conn package_id]).
- Switches:
- -package_id
(optional)- -segment_id
(optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
application_group::delete (public)
application_group::delete -group_id group_id
Delete the given application group and all relational segments and constraints dependent on it (handled by the PL/[pg]SQL API
- Switches:
- -group_id
(required)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- acs_subsite_application_group_new
application_group::group_id_from_package_id (public)
application_group::group_id_from_package_id [ -no_complain ] \
[ -package_id package_id ]Get the application_group of a package. By default, if no application group exists, we throw an error. The -no_complain flag will prevent the error from being thrown, in which case you'll just get an empty string if the application group doesn't exist.
- Switches:
- -no_complain
(boolean) (optional)- -package_id
(optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- acs_subsite_expose_bug_1144, subsite_api
application_group::new (public)
application_group::new [ -group_id group_id ] \
[ -group_type group_type ] [ -package_id package_id ] \
[ -group_name group_name ] [ -creation_user creation_user ] \
[ -creation_ip creation_ip ] [ -email email ] [ -url url ]Creates an application group (i.e., group of "users/parties of this application") Returns the group_id of the new application group.
- Switches:
- -group_id
(optional)- -group_type
(defaults to"application_group") (optional)- -package_id
(optional)- -group_name
(optional)- -creation_user
(optional)- -creation_ip
(optional)- -url
(optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- acs_subsite_application_group_new
application_group::package_id_from_group_id (public)
application_group::package_id_from_group_id -group_id group_id
Returns the package_id of a given application group.
- Switches:
- -group_id
(required)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- subsite_api
