object-procs.tcl

Object support for ACS.

Location:
packages/acs-tcl/tcl/object-procs.tcl
Created:
11 Aug 2000
Author:
Jon Salz <jsalz@arsdigita.com>
CVS Identification:
$Id: object-procs.tcl,v 1.16 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

acs_lookup_magic_object (private, deprecated)

 acs_lookup_magic_object name
Deprecated. Invoking this procedure generates a warning.

Non memoized version of acs_magic_object.

Parameters:
name (required)
Returns:
the magic object's object ID
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 acs_lookup_magic_object_no_cache acs_lookup_magic_object_no_cache (private) ad_log_deprecated ad_log_deprecated (public) util_memoize util_memoize (public) acs_lookup_magic_object acs_lookup_magic_object acs_lookup_magic_object->acs_lookup_magic_object_no_cache acs_lookup_magic_object->ad_log_deprecated acs_lookup_magic_object->util_memoize

Testcases:
No testcase defined.

acs_lookup_magic_object_no_cache (private)

 acs_lookup_magic_object_no_cache name

Non memoized version of acs_magic_object.

Parameters:
name (required)
Returns:
the magic object's object ID
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 acs_lookup_magic_object acs_lookup_magic_object (private, deprecated) acs_lookup_magic_object_no_cache acs_lookup_magic_object_no_cache acs_lookup_magic_object->acs_lookup_magic_object_no_cache acs_magic_object acs_magic_object (public) acs_magic_object->acs_lookup_magic_object_no_cache db_string db_string (public) acs_lookup_magic_object_no_cache->db_string

Testcases:
No testcase defined.

acs_magic_object (public)

 acs_magic_object name

Returns the object ID of a magic object.

Parameters:
name (required)
the name of the magic object (as listed in the acs_magic_objects table).
Returns:
the object ID.
Error:
if no object exists with that magic name.

Partial Call Graph (max 5 caller/called nodes):
%3 test_magic_objects magic_objects (test acs-tcl) acs_magic_object acs_magic_object test_magic_objects->acs_magic_object acs_lookup_magic_object_no_cache acs_lookup_magic_object_no_cache (private) acs_magic_object->acs_lookup_magic_object_no_cache acs::test::user::create acs::test::user::create (public) acs::test::user::create->acs_magic_object acs_user::get_user_info_not_cached acs_user::get_user_info_not_cached (private) acs_user::get_user_info_not_cached->acs_magic_object acs_user::site_wide_admin_p acs_user::site_wide_admin_p (public) acs_user::site_wide_admin_p->acs_magic_object apm_mount_core_packages apm_mount_core_packages (private) apm_mount_core_packages->acs_magic_object auth::test::get_admin_user_id auth::test::get_admin_user_id (private) auth::test::get_admin_user_id->acs_magic_object

Testcases:
magic_objects

acs_object::get (public)

 acs_object::get -object_id object_id [ -array array ] \
    [ -element element ]

Gets information about an acs_object. If called without "-element", it returns a dict containing object_id, package_id, object_type, context_id, security_inherit_p, creation_user, creation_date_ansi, creation_ip, last_modified_ansi, modifying_user, modifying_ip, tree_sortkey, object_name. If called with "-element" it returns the denoted element (similar to e.g. "party::get").

Switches:
-object_id (required)
for which the information should be retrieved
-array (optional)
An array in the caller's namespace into which the info should be delivered (upvared)
-element (optional)
to be returned
Error:
when object_id does not exist

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_object_procs_test acs_object_procs_test (test acs-tcl) acs_object::get acs_object::get test_acs_object_procs_test->acs_object::get db_1row db_1row (public) acs_object::get->db_1row acs_object::get_element acs_object::get_element (public) acs_object::get_element->acs_object::get chat_room_get_not_cached chat_room_get_not_cached (private, deprecated) chat_room_get_not_cached->acs_object::get packages/acs-subsite/www/admin/parties/one.tcl packages/acs-subsite/ www/admin/parties/one.tcl packages/acs-subsite/www/admin/parties/one.tcl->acs_object::get packages/acs-subsite/www/permissions/one.tcl packages/acs-subsite/ www/permissions/one.tcl packages/acs-subsite/www/permissions/one.tcl->acs_object::get packages/acs-subsite/www/permissions/perm-include.tcl packages/acs-subsite/ www/permissions/perm-include.tcl packages/acs-subsite/www/permissions/perm-include.tcl->acs_object::get

Testcases:
acs_object_procs_test

acs_object::get_element (public)

 acs_object::get_element -object_id object_id -element element

Gets a specific element from the info returned by acs_object::get.

Switches:
-object_id (required)
the object to get data for
-element (required)
the field to return
Returns:
the value of the specified element
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_object_procs_test acs_object_procs_test (test acs-tcl) acs_object::get_element acs_object::get_element test_acs_object_procs_test->acs_object::get_element test_attachments_name_api attachments_name_api (test attachments) test_attachments_name_api->acs_object::get_element acs_object::get acs_object::get (public) acs_object::get_element->acs_object::get attachments::get_title attachments::get_title (public) attachments::get_title->acs_object::get_element content::item::get_context content::item::get_context (public, deprecated) content::item::get_context->acs_object::get_element fs::do_notifications fs::do_notifications (public) fs::do_notifications->acs_object::get_element permission::write_permission_p permission::write_permission_p (public) permission::write_permission_p->acs_object::get_element

Testcases:
acs_object_procs_test, attachments_name_api

acs_object::is_type_p (private)

 acs_object::is_type_p -object_id object_id -object_types object_types \
    [ -no_hierarchy ]

Returns whether an object is of a given object type.

Switches:
-object_id (required)
-object_types (required)
-no_hierarchy (optional, boolean)
Returns:
boolean

Partial Call Graph (max 5 caller/called nodes):
%3 test_is_object_type_p is_object_type_p (test acs-tcl) acs_object::is_type_p acs_object::is_type_p test_is_object_type_p->acs_object::is_type_p acs_object_type acs_object_type (public) acs_object::is_type_p->acs_object_type acs_object_type::supertypes acs_object_type::supertypes (private) acs_object::is_type_p->acs_object_type::supertypes ad_page_contract_filter_proc_object_type ad_page_contract_filter_proc_object_type (public) ad_page_contract_filter_proc_object_type->acs_object::is_type_p packages/acs-subsite/www/shared/ajax/chat.tcl packages/acs-subsite/ www/shared/ajax/chat.tcl packages/acs-subsite/www/shared/ajax/chat.tcl->acs_object::is_type_p

Testcases:
is_object_type_p

acs_object::object_p (public)

 acs_object::object_p -id id
Switches:
-id (required)
ID of the potential acs-object
Returns:
true if object whose id is $id exists
Authors:
Jim Lynch <jim@jam.sessionsnet.org>
Malte Sussdorff
Created:
2007-01-26

Partial Call Graph (max 5 caller/called nodes):
%3 test_object_p object_p (test acs-tcl) acs_object::object_p acs_object::object_p test_object_p->acs_object::object_p db_string db_string (public) acs_object::object_p->db_string acs_mail_lite::inbound_queue_pull acs_mail_lite::inbound_queue_pull (private) acs_mail_lite::inbound_queue_pull->acs_object::object_p acs_mail_lite::load_mails acs_mail_lite::load_mails (public, deprecated) acs_mail_lite::load_mails->acs_object::object_p

Testcases:
object_p

acs_object::package_id (public)

 acs_object::package_id -object_id object_id

Gets the package_id of the object

Switches:
-object_id (required)
the object to get the package_id for
Returns:
package_id of the object. Empty string if the package_id is not stored
Author:
Malte Sussdorff <malte.sussdorff@cognovis.de>
Created:
2006-08-10

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_object__package_id acs_object__package_id (test acs-tcl) acs_object::package_id acs_object::package_id test_acs_object__package_id->acs_object::package_id acs_object::package_id_not_cached acs_object::package_id_not_cached (private) acs_object::package_id->acs_object::package_id_not_cached util_memoize util_memoize (public) acs_object::package_id->util_memoize fs::new_folder fs::new_folder (public) fs::new_folder->acs_object::package_id

Testcases:
acs_object__package_id

acs_object::package_id_not_cached (private)

 acs_object::package_id_not_cached -object_id object_id

Gets the package_id of the object

Switches:
-object_id (required)
the object to get the package_id for
Returns:
package_id of the object. Empty string if the package_id is not stored
Author:
Malte Sussdorff <malte.sussdorff@cognovis.de>
Created:
2006-08-10

Partial Call Graph (max 5 caller/called nodes):
%3 acs_object::package_id acs_object::package_id (public) acs_object::package_id_not_cached acs_object::package_id_not_cached acs_object::package_id->acs_object::package_id_not_cached db_string db_string (public) acs_object::package_id_not_cached->db_string

Testcases:
No testcase defined.

acs_object::set_context_id (public)

 acs_object::set_context_id -object_id object_id -context_id context_id

Sets the context_id of the specified object.

Switches:
-object_id (required)
-context_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_acs_object_procs_test acs_object_procs_test (test acs-tcl) acs_object::set_context_id acs_object::set_context_id test_acs_object_procs_test->acs_object::set_context_id db_dml db_dml (public) acs_object::set_context_id->db_dml

Testcases:
acs_object_procs_test

acs_object_name (public)

 acs_object_name object_id

Returns the name of an object.

Parameters:
object_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_object_name object_name (test acs-tcl) acs_object_name acs_object_name test_object_name->acs_object_name db_string db_string (public) acs_object_name->db_string application_group::group_id_from_package_id application_group::group_id_from_package_id (public) application_group::group_id_from_package_id->acs_object_name category::get_object_context category::get_object_context (public) category::get_object_context->acs_object_name ds_require_permission ds_require_permission (private) ds_require_permission->acs_object_name general_comments_create_link general_comments_create_link (public) general_comments_create_link->acs_object_name packages/acs-subsite/www/admin/parties/new.tcl packages/acs-subsite/ www/admin/parties/new.tcl packages/acs-subsite/www/admin/parties/new.tcl->acs_object_name

Testcases:
object_name

acs_object_type (public)

 acs_object_type object_id

Returns the type of an object.

Parameters:
object_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_attachments_name_api attachments_name_api (test attachments) acs_object_type acs_object_type test_attachments_name_api->acs_object_type test_data_links_with_tag data_links_with_tag (test acs-tcl) test_data_links_with_tag->acs_object_type db_string db_string (public) acs_object_type->db_string acs_object::is_type_p acs_object::is_type_p (private) acs_object::is_type_p->acs_object_type ad_call_method ad_call_method (public, deprecated) ad_call_method->acs_object_type attachments::get_title attachments::get_title (public) attachments::get_title->acs_object_type auth::validate_account_info auth::validate_account_info (private) auth::validate_account_info->acs_object_type etp::revision_datasource etp::revision_datasource (public) etp::revision_datasource->acs_object_type

Testcases:
data_links_with_tag, attachments_name_api
[ show source ]