Fisheye: Tag 1.4.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/tcl/ams-init.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.2.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/tcl/ams-install-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.3.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/tcl/ams-list-procs-postgresql.xql'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.6.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/tcl/ams-list-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: openacs-4/packages/ams/tcl/ams-procs-postgresql.xql
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/tcl/ams-procs-postgresql.xql,v
diff -u -r1.7 -r1.7.2.1
--- openacs-4/packages/ams/tcl/ams-procs-postgresql.xql 27 Feb 2005 17:07:17 -0000 1.7
+++ openacs-4/packages/ams/tcl/ams-procs-postgresql.xql 30 Nov 2005 16:21:53 -0000 1.7.2.1
@@ -1,748 +1,193 @@
-postgresql7.2
-
+
- select ams_attribute_id, required_p
- from ams_list_attribute_map
- where list_id = :list_id
- order by sort_order
+ select pretty_name
+ from ams_attributes
+ where attribute_id = :attribute_id
-
+
- select ams_object_id(:object_id)
+ select pretty_plural
+ from ams_attributes
+ where attribute_id = :attribute_id
-
+
- select ams_object__new(
- :object_id,
- :package_id,
- now(),
- :creation_user,
- :creation_ip
- );
+ select acs_attribute__create_attribute (
+ :object_type,
+ :attribute_name,
+ :datatype,
+ :pretty_name,
+ :pretty_plural,
+ :table_name,
+ :column_name,
+ :default_value,
+ :min_n_values,
+ :max_n_values,
+ :sort_order,
+ :storage,
+ :static_p
+ )
-
+
- select ams_option__new (:ams_attribute_id,:option,:sort_order)
+ select attribute_id
+ from acs_attributes
+ where object_type = :object_type
+ and attribute_name = :attribute_name
-
+
- select ams_option__delete (:option_id)
+ select supertype
+ from acs_object_types
+ where object_type = :object_type
-
-
+
- select ams_option__map (:option_map_id,:option_id)
-
-
-
-
-
- select ams.*,
- acs.attribute_name,
- acs.pretty_name,
- acs.pretty_plural,
- acs.object_type,
- aw.storage_type
- from ams_attributes ams,
- acs_attributes acs,
- ams_widgets aw
- where ams.ams_attribute_id = :ams_attribute_id
- and ams.attribute_id = acs.attribute_id
- and ams.widget_name = aw.widget_name
-
-
-
-
-
- select ac.attribute_name,
- ac.pretty_name,
- ac.object_type,
- aw.widget,
- aw.datatype,
- aw.parameters,
- aw.storage_type
- from ams_attributes aa,
- acs_attributes ac,
- ams_widgets aw
- where aa.ams_attribute_id = :ams_attribute_id
- and aa.attribute_id = ac.attribute_id
- and aa.widget_name = aw.widget_name
-
-
-
-
-
- select option, option_id
- from ams_options
- where ams_attribute_id = :ams_attribute_id
- order by sort_order
-
-
-
-
-
- select '1' from acs_attributes where object_type = :object_type and attribute_name = :attribute_name
-
-
-
-
-
- select ams.ams_attribute_id
- from ams_attributes ams, acs_attributes acs
- where acs.object_type = :object_type
- and acs.attribute_name = :attribute_name
- and acs.attribute_id = ams.attribute_id
-
-
-
-
-
- select ams_attribute__name (:ams_attribute_id)
-
-
-
-
-
- select aw.storage_type
- from ams_widgets aw, ams_attributes aa
- where aa.ams_attribute_id = :ams_attribute_id
- and aw.widget_name = aa.widget_name
-
-
-
-
-
- select ams_attribute__delete (:ams_attribute_id)
-
-
-
-
-
- select aav.*,
- ao.object_id,
- ams_attribute__options_string(option_map_id) as options_string,
- ams_attribute__postal_address_string(address_id) as address_string,
- ams_attribute__telecom_number_string(number_id) as telecom_number_string
- from ams_attribute_values aav, cr_revisions cr, ams_objects ao
- where ao.object_id in ($sql_object_id_list)
- and ao.ams_object_id = cr.item_id
- and cr.revision_id = aav.revision_id
- and aav.superseed_revision_id is null
- order by ao.object_id, aav.ams_attribute_id
-
-
-
-
-
- select ams_attribute_value__new (
- :revision_id,
- :ams_attribute_id,
- :option_map_id,
- :address_id,
- :number_id,
- :time,
- :value,
- :value_mime_type
- )
-
-
-
-
-
-
- select ams_attribute_value__save (
- :revision_id,
- :ams_attribute_id,
- :option_map_id,
- :address_id,
- :number_id,
- :time,
- :value,
- :value_mime_type
- )
-
-
-
-
-
- select acs_object__new (
- null,
- 'telecom_number',
- ( select creation_date from acs_objects where object_id = :revision_id ),
- ( select creation_user from acs_objects where object_id = :revision_id ),
- ( select creation_ip from acs_objects where object_id = :revision_id ),
- :revision_id
- )
-
-
-
-
-
- insert into telecom_numbers (
- number_id,
- itu_id,
- national_number,
- area_city_code,
- subscriber_number,
- extension,
- sms_enabled_p,
- best_contact_time,
- location,
- phone_type_id
- ) values (
- :number_id,
- :itu_id,
- :national_number,
- :area_city_code,
- :subscriber_number,
- :extension,
- :sms_enabled_p,
- :best_contact_time,
- :location,
- :phone_type_id
- )
-
-
-
-
-
- select acs_object__new (
- null,
- 'postal_address',
- ( select creation_date from acs_objects where object_id = :revision_id ),
- ( select creation_user from acs_objects where object_id = :revision_id ),
- ( select creation_ip from acs_objects where object_id = :revision_id ),
- :revision_id
- )
-
-
-
-
-
- insert into postal_addresses (
- address_id,
- delivery_address,
- municipality,
- region,
- postal_code,
- country_code,
- additional_text,
- postal_type
- ) values (
- :address_id,
- :delivery_address,
- :municipality,
- :region,
- :postal_code,
- :country_code,
- :additional_text,
- :postal_type
- )
-
-
-
-
-
insert into ams_attribute_values
- (revision_id,ams_attribute_id,option_map_id,address_id,number_id,time,value,value_mime_type)
- values
- (:revision_id,:ams_attribute_id,:option_map_id,:address_id,:number_id,:time,:value,:value_mime_type)
+ (object_id,attribute_id,value_id)
+ ( select :to,
+ attribute_id,
+ value_id
+ from ams_attribute_values
+ where object_id = :from )
-
+
- update ams_attribute_values
- set superseed_revision_id = :revision_id
- where ams_attribute_id = :ams_attribute_id
- and superseed_revision_id is null
- and revision_id in ( select revision_id
- from cr_revisions
- where item_id = :ams_object_id
- and revision_id <> :revision_id )
+ delete from ams_attribute_values
+ where object_id = :object_id
-
+
select *
- from ams_lists
- where list_id = :list_id
+ from ams_attributes
+ where attribute_id = :attribute_id
-
-
+
- select ams_attribute_id
- from ams_list_attribute_map
- where list_id = :list_id
+ select ams_attribute_id
+ from ams_attributes
+ where attribute_id = :attribute_id
-
-
+
- select '1'
- from ams_lists
- where package_key = :package_key
- and object_type = :object_type
- and list_name = :list_name
+ select ams_attribute_value__save (
+ :object_id,
+ :attribute_id,
+ :value_id
+ )
-
+
- select list_id
- from ams_lists
- where package_key = :package_key
- and object_type = :object_type
- and list_name = :list_name
+ select option
+ from ams_option_types
+ where option_id = :option_id
-
-
+
- select ams_list__attribute_map (
- :list_id,
- :ams_attribute_id,
- :sort_order,
- :required_p,
- :section_heading
- )
+ select alam.attribute_id,
+ alam.required_p,
+ alam.section_heading,
+ aa.attribute_name,
+ aa.pretty_name,
+ aa.widget
+ from ams_list_attribute_map alam,
+ ams_attributes aa
+ where alam.attribute_id = aa.attribute_id
+ and alam.list_id = :list_id
+ order by alam.sort_order
-
+
- select sort_order
- from ams_list_attribute_map
- where list_id = :list_id
- order by sort_order desc
- limit 1
+ select
+ alam.attribute_id,
+ alam.required_p,
+ alam.section_heading,
+ alam.html_options,
+ aa.attribute_name,
+ aa.pretty_name,
+ aa.widget
+ from
+ ams_list_attribute_map alam,
+ ams_attributes aa
+ where
+ alam.attribute_id = aa.attribute_id
+ and alam.list_id in ($list_ids)
+ order by alam.sort_order
-
+
- delete from ams_list_attribute_map
- where list_id = :list_id
- and ams_attribute_id = :ams_attribute_id
+ select aav.*, aa.attribute_name, aa.widget, aa.pretty_name,
+ ams_attribute_value__value(aav.attribute_id,aav.value_id) as value
+ from ams_attribute_values aav,
+ ams_attributes aa
+ where aav.object_id = :object_id
+ and aav.attribute_id = aa.attribute_id
+ and aa.attribute_id in ( select attribute_id from ams_list_attribute_map where list_id = :list_id )
-
+
- update ams_list_attribute_map
- set required_p = 't'
- where list_id = :list_id
- and ams_attribute_id = :ams_attribute_id
+ select alam.attribute_id,
+ alam.section_heading,
+ alam.html_options,
+ aa.attribute_name,
+ aa.pretty_name,
+ aa.widget,
+ av.value
+ from ams_list_attribute_map alam,
+ ams_attributes aa left join (
+ select
+ ams_attribute_values.attribute_id,
+ ams_attribute_value__value(ams_attribute_values.attribute_id,ams_attribute_values.value_id) as value
+ from
+ ams_attribute_values
+ where
+ ams_attribute_values.object_id = :object_id ) av on ( aa.attribute_id = av.attribute_id )
+ where
+ alam.attribute_id = aa.attribute_id
+ and alam.list_id in ($list_ids)
+ order by alam.sort_order
+
+
+
+ select ams_attribute_value__value(av.attribute_id,av.value_id) as value, widget,attribute_name,av.attribute_id
+ from ams_attribute_values av, ams_attributes aa
+ where object_id = :object_id
+ and av.attribute_id = aa.attribute_id
+ $where_clause
+
+
-
-
- update ams_list_attribute_map
- set required_p = 'f'
- where list_id = :list_id
- and ams_attribute_id = :ams_attribute_id
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- select * from postal_addresses where address_id = :address_id
-
-
-
-
-
-
- select telecom_number__new (
- :area_city_code,
- :best_contact_time,
- :extension,
- :itu_id,
- :location,
- :national_number,
- null,
- null,
- null,
- :sms_enabled_p,
- :subscriber_number,
- :creation_user,
- :creation_ip,
- null
- )
-
-
-
-
-
-
- select * from telecom_numbers where number_id = :number_id
-
-
-
-
-
-
- select *
- from contact_attributes ca,
- contact_widgets cw,
- contact_attribute_object_map caom,
- contact_attribute_names can
- where caom.object_id = :object_id
- and ca.ams_attribute_id = can.ams_attribute_id
- and can.locale = :locale
- and caom.ams_attribute_id = ca.ams_attribute_id
- and ca.widget_id = cw.widget_id
- and not ca.depreciated_p
- and acs_permission__permission_p(ca.ams_attribute_id,:user_id,'write')
- order by caom.sort_order
-
-
-
-
-
-
-
- select ca.ams_attribute_id,
- ca.attribute,
- cav.option_map_id,
- cav.address_id,
- cav.number_id,
- to_char(cav.time,'YYYY MM DD') as time,
- cav.value,
- cav.value_format,
- cw.storage_column
- from contact_attributes ca,
- contact_widgets cw,
- contact_attribute_object_map caom left join
- ( select *
- from contact_attribute_values
- where party_id = :party_id
- and not deleted_p ) cav
- on (caom.ams_attribute_id = cav.ams_attribute_id)
- where caom.object_id = '$object_id'
- and caom.ams_attribute_id = ca.ams_attribute_id
- and ca.widget_id = cw.widget_id
- and not ca.depreciated_p
- and (
- cav.option_map_id is not null
- or cav.address_id is not null
- or cav.number_id is not null
- or cav.value is not null
- or cav.time is not null
- or ca.attribute in ($custom_field_sql_list)
- )
- and acs_permission__permission_p(ca.ams_attribute_id,'$user_id','$permission')
- order by caom.sort_order
-
-
-
-
-
-
- select name
- from organizations
- where organization_id = :party_id
-
-
-
-
-
-
- select legal_name
- from organizations
- where organization_id = :party_id
-
-
-
-
-
-
- select reg_number
- from organizations
- where organization_id = :party_id
-
-
-
-
-
-
- select first_names
- from persons
- where person_id = :party_id
-
-
-
-
-
-
- select cao.option_id, cao.option
- from contact_attribute_options cao,
- organization_types ot,
- organization_type_map otm
- where cao.option = ot.type
- and cao.ams_attribute_id = :ams_attribute_id
- and otm.organization_type_id = ot.organization_type_id
- and otm.organization_id = :party_id
-
-
-
-
-
-
- select first_names
- from persons
- where person_id = :party_id
-
-
-
-
-
-
- select last_name
- from persons
- where person_id = :party_id
-
-
-
-
-
-
- select email
- from parties
- where party_id = :party_id
-
-
-
-
-
-
- select url
- from parties
- where party_id = :party_id
-
-
-
-
-
-
- select cao.option, cao.option_id
- from contact_attribute_options cao,
- contact_attribute_option_map caom
- where caom.option_id = cao.option_id
- and caom.option_map_id = :option_map_id
-
-
-
-
-
- select *
- from contact_attributes ca,
- contact_widgets cw,
- contact_attribute_object_map caom,
- contact_attribute_names can
- where caom.object_id = :object_id
- and ca.ams_attribute_id = can.ams_attribute_id
- and can.locale = :locale
- and caom.ams_attribute_id = ca.ams_attribute_id
- and ca.widget_id = cw.widget_id
- and not ca.depreciated_p
- and acs_permission__permission_p(ca.ams_attribute_id,:user_id,'write')
- order by caom.sort_order
-
-
-
-
-
-
- select cav.address_id as old_address_id
- from contact_attribute_values cav,
- postal_addresses pa
- where cav.party_id = :party_id
- and cav.ams_attribute_id = :ams_attribute_id
- and not cav.deleted_p
- and cav.address_id = pa.address_id
- and pa.delivery_address = :delivery_address
- and pa.municipality = :municipality
- and pa.region = :region
- and pa.postal_code = :postal_code
- and pa.country_code = :country_code
-
-
-
-
-
-
- select cav.number_id as old_number_id
- from contact_attribute_values cav,
- telecom_numbers tn
- where cav.party_id = :party_id
- and cav.ams_attribute_id = :ams_attribute_id
- and not cav.deleted_p
- and cav.number_id = tn.number_id
- and tn.subscriber_number = :attribute_value_temp
-
-
-
-
-
-
- select option_map_id
- from contact_attribute_values
- where party_id = :party_id
- and ams_attribute_id = :ams_attribute_id and not deleted_p
-
-
-
-
-
-
- select option_id
- from contact_attribute_option_map
- where option_map_id = :option_map_id
-
-
-
-
-
-
- select nextval('contact_attribute_option_map_id_seq') as option_map_id
-
-
-
-
-
-
- insert into contact_attribute_option_map
- (option_map_id,party_id,option_id)
- values
- (:option_map_id,:party_id,:option_id)
-
-
-
-
-
-
- update parties set email = :attribute_value_temp where party_id = :party_id
-
-
-
-
-
-
- update parties set url = :attribute_value_temp where party_id = :party_id
-
-
-
-
-
-
- update organizations set name = :attribute_value_temp where organization_id = :party_id
-
-
-
-
-
-
- update organizations set legal_name = :attribute_value_temp where organization_id = :party_id
-
-
-
-
-
-
- update organizations set reg_number = :attribute_value_temp where organization_id = :party_id
-
-
-
-
-
-
- delete from organization_type_map where organization_id = :party_id
-
-
-
-
-
-
- select organization_type_id
- from contact_attribute_options cao,
- organization_types ot
- where cao.option = ot.type
- and cao.option_id = :option_id
-
-
-
-
-
-
- insert into organization_type_map
- (organization_id, organization_type_id)
- values
- (:party_id, :organization_type_id)
-
-
-
-
-
-
- update persons set first_names = :attribute_value_temp where person_id = :party_id
-
-
-
-
-
-
- update persons set last_name = :attribute_value_temp where person_id = :party_id
-
-
-
-
Index: openacs-4/packages/ams/tcl/ams-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/tcl/ams-procs.tcl,v
diff -u -r1.7 -r1.7.2.1
--- openacs-4/packages/ams/tcl/ams-procs.tcl 30 Oct 2004 00:23:54 -0000 1.7
+++ openacs-4/packages/ams/tcl/ams-procs.tcl 30 Nov 2005 16:21:53 -0000 1.7.2.1
@@ -1,1326 +1,596 @@
ad_library {
- Support procs for the ams package
+Support procs for the ams package
- @author Matthew Geddert openacs@geddert.com
+@author Matthew Geddert openacs@geddert.com
@creation-date 2004-09-28
@cvs-id $Id$
}
+namespace eval attribute:: {}
+namespace eval ams:: {}
+namespace eval ams::attribute {}
+namespace eval ams::option {}
+namespace eval ams::ad_form {}
+namespace eval ams::util {}
-
-ad_proc -public ams_object_id {
- -object_id:required
+ad_proc -public attribute::pretty_name {
+ {-attribute_id:required}
} {
- @param object_id
- Returns the revision controlled ams_object_id for the given openacs object_id. Cached.
- @return ams_object_id
+ get the pretty_name of an attribute. Cached
} {
- return [util_memoize [list ams_object_id_not_cached -object_id $object_id]]
+ return [lang::util::localize [util_memoize [list ::attribute::pretty_name_not_cached -attribute_id $attribute_id]]]
}
-ad_proc -private ams_object_id_not_cached {
- -object_id:required
+ad_proc -public attribute::pretty_name_not_cached {
+ {-attribute_id:required}
} {
- @param object_id
- Returns the revision controlled ams_object_id for the given openacs object_id.
- @return ams_object_id
+ get the pretty_name of an attribute
} {
- set ams_object_id [db_string select_ams_object_id {} -default {}]
- if { [exists_and_not_null ams_object_id] } {
- return $ams_object_id
- } else {
- set package_id [ams::package_id]
- set creation_user [ad_conn user_id]
- set creation_ip [ad_conn peeraddr]
- return [db_string create_and_select_ams_object_id {}]
- }
+ return [db_string get_pretty_name {} -default {}]
}
-ad_proc -public ams_form {
- -package_key:required
- -object_type:required
- -list_name:required
- -form_name:required
- -object_id:required
- -return_url:required
+ad_proc -public attribute::pretty_plural {
+ {-attribute_id:required}
} {
- TODO DOCUMENTATION
+ get the pretty_plural of an attribute. Cached
} {
-
- set edit_proc "ams::object::attribute::values -vars -object_id $object_id"
- set submit_proc "ams::ad_form::save -package_key $package_key -object_type $object_type -list_name $list_name -form_name $form_name -object_id $object_id"
- set after_submit_proc "ad_returnredirect $return_url"
+ return [lang::util::localize [util_memoize [list ::attribute::pretty_plural_not_cached -attribute_id $attribute_id]]]
+}
- ad_form \
- -name $form_name \
- -form [ams::ad_form::elements -package_key $package_key -object_type $object_type -list_name $list_name -key "object_id"] \
- -edit_request $edit_proc \
- -on_submit $submit_proc \
- -after_submit $after_submit_proc
-
+ad_proc -public attribute::pretty_plural_not_cached {
+ {-attribute_id:required}
+} {
+ get the pretty_plural of an attribute
+} {
+ return [db_string get_pretty_plural {} -default {}]
}
-
-namespace eval ams:: {}
-
-
-ad_proc -public ams::define_list {
- -package_key:required
+ad_proc -public attribute::new {
-object_type:required
- -list_name:required
+ -attribute_name:required
+ -datatype:required
-pretty_name:required
- {-description ""}
- {-description_mime_type ""}
- {-reset_order:boolean}
- {-attributes}
+ -pretty_plural:required
+ {-table_name ""}
+ {-column_name ""}
+ {-default_value ""}
+ {-min_n_values "1"}
+ {-max_n_values "1"}
+ {-sort_order ""}
+ {-storage "generic"}
+ {-static_p "f"}
+ {-if_does_not_exist:boolean}
} {
- TODO: Need Documentation
+ create a new attribute
- @param object_type the acs object_type these attributes are to belong to
- @param attributes An array of attributes, if the attribute exists for this object this proc will make sure a duplicate is not created
-
- @see ams::define_attributes
+ @see ams::attribute::new
} {
-
- # now we check to see if this list already exists
- if { ![ams::list::exists_p -package_key $package_key -object_type $object_type -list_name $list_name] } {
- set list_id [ams::list::new -list_name $list_name \
- -package_key $package_key \
- -object_type $object_type \
- -pretty_name $pretty_name \
- -description $description \
- -description_mime_type $description_mime_type]
-
+ if { $if_does_not_exist_p } {
+ set attribute_id [attribute::id -object_type $object_type -attribute_name $attribute_name]
+ if { [string is false [exists_and_not_null attribute_id]] } {
+ set attribute_id [db_string create_attribute {}]
+ }
} else {
- set list_id [ams::list::get_list_id -package_key $package_key -object_type $object_type -list_name $list_name]
+ set attribute_id [db_string create_attribute {}]
}
- foreach { attribute } $attributes {
- # the attribute follows this order
- # attribute_name widget_name pretty_name pretty_plural extra_args
- set attribute_name [lindex $attribute 0]
- set widget_name [lindex $attribute 1]
- set pretty_name [lindex $attribute 2]
- set pretty_plural [lindex $attribute 3]
- # we set the defaults for values that are required
- set required_p 0
- set default_name {}
- set description {}
- set default_value {}
- set context_id {}
- set options {}
- # we now check for other values
- set i 4
- while { $i < [llength $attribute] } {
- set arg [lindex $attribute $i]
- switch [lindex $arg 0] {
- required { set required_p 1 }
- default { set [lindex $arg 0] [lindex $arg 1] }
- }
- incr i
- }
- set ams_attribute_id [ams::attribute::new -object_type $object_type \
- -attribute_name $attribute_name \
- -widget_name $widget_name \
- -pretty_name $pretty_name \
- -pretty_plural $pretty_plural \
- -default_value $default_value \
- -description $description \
- -context_id $context_id \
- -options $options \
- -no_complain]
-
- if { ![exists_and_not_null ams_attribute_id] && $reset_order_p } {
- set ams_attribute_id [ams::attribute::get_ams_attribute_id -object_type $object_type -attribute_name $attribute_name]
- }
- if { [exists_and_not_null ams_attribute_id] } {
- ams::list::attribute::map -list_id $list_id \
- -ams_attribute_id $ams_attribute_id \
- -required_p $required_p
- }
- }
- ams::list::get_list_id_flush -package_key $package_key -object_type $object_type -list_name $list_name
-
+ # Update the pretty names
+ set pretty_name [lang::util::convert_to_i18n -message_key "ams_attribute_${attribute_id}_pretty_name" -text "$pretty_name"]
+ set pretty_plural [lang::util::convert_to_i18n -message_key "ams_attribute_${attribute_id}_pretty_plural" -text "$pretty_plural"]
+ db_dml update_pretty_names "update acs_attributes set pretty_name = :pretty_name, pretty_plural = :pretty_plural where attribute_id = :attribute_id"
+ return $attribute_id
}
-
-ad_proc -public ams::define_attributes {
+ad_proc -public attribute::id {
-object_type:required
- -attributes:required
+ -attribute_name:required
} {
- TODO: Need Documentation
- TODO: Verify the attributes passed in
-
- @param object_type the acs object_type these attributes are to belong to
- @param attributes An array of attributes, if the attribute exists for this object this proc will make sure a duplicate is not created
-
- @see ams::define_list
-
-
- This Procedure implements a high level declarative syntax for the generation of ams_attributes
- and attribute lists. Those attribute lists can then be used to create ad_form elements, columns
- in a listbuilder array or via your own custom choosing by integrating with an ams generated
- multirow that you can use however you want in your package.
-
-
-
-
-
- Here is an example of the ams::define_list proc used by the contacts package:
-
-
Some form builder datatypes build values that do not directly correspond to database types. When using
- the form builder directly these are converted by calls to datatype::get_property and datatype::acquire.
- When using ad_form, "to_html(property)", "to_sql(property)" and "from_sql(property)" declare the appropriate
- properties to be retrieved or set before calling code blocks that require the converted values. The "to_sql"
- operation is performed before any on_submit, new_data or edit_data block is executed. The "from_sql" operation
- is performed after a select_query or select_query_name query is executed. No automatic conversion is performed
- for edit_request blocks (which manually set form values). The "to_html" operation is performed before execution
- of a confirm template.
-
-
Currently only the date and currency datatypes require these conversion operations.
-
-
In the future the form builder will be enhanced so that ad_form can determine the proper conversion operation
- automatically, freeing the programmer from the need to specify them. When this is implemented the current notation
- will be retained for backwards compatibility.
-
+ return the attribute_id for the specified attribute
} {
- set returner ""
- foreach { attribute } $attributes {
- # the attribute follows this order
- # attribute_name widget_name pretty_name pretty_plural default_value description
-
- ams::attribute::new -object_type $object_type \
- -attribute_name [lindex $attribute 0] \
- -widget_name [lindex $attribute 1] \
- -pretty_name [lindex $attribute 2] \
- -pretty_plural [lindex $attribute 3] \
- -default_value [lindex $attribute 4] \
- -description [lindex $attribute 5] \
- -no_complain
-
- }
- return $returner
+ return [db_string get_attribute_id {} -default {}]
}
-ad_proc -public ams::package_id {} {
-
- TODO: Get the AMS package ID, not the connection package_id
+ad_proc -public ams::package_id {
+} {
+TODO: Get the AMS package ID, not the connection package_id
Get the package_id of the ams instance
- @return package_id
+@return package_id
} {
return [ad_conn package_id]
}
-
-ad_proc -public ams::lang_key_encode {
- {-len "175"}
- -string:required
+ad_proc -public ams::util::edit_lang_key_url {
+ -message:required
+ {-package_key "ams"}
} {
- @param len the default value was chosen because the lang key length must be less than 200 due to a character limit on the lang_messages.message_key column and because ams depends on using some of that length for key definitions.
-
- @return an acs_lang encoded message key string
} {
- # we add the space at the end to prevent ellipsis at the and then remove it with string trim in order to prevent ellipsis
- return [string trim [string_truncate -len [expr $len + 1] -ellipsis " " [ad_urlencode $string]]]
-}
+ if { [regsub "^${package_key}." [string trim $message "\#"] {} message_key] } {
+ set edit_url [export_vars -base "[apm_package_url_from_key "acs-lang"]admin/edit-localized-message" { { locale {[ad_conn locale]} } package_key message_key { return_url [ad_return_url] } }]
+ } else {
+ set edit_url ""
+ }
+ return $edit_url
+ }
+ ad_proc -public ams::util::localize_and_sort_list_of_lists {
+ {-list}
+ {-position "0"}
+ } {
+ localize and sort a list of lists
+ } {
+ set localized_list [ams::util::localize_list_of_lists -list $list]
+ return [ams::util::sort_list_of_lists -list $localized_list -position $position]
+ }
-namespace eval ams::ad_form {}
+ ad_proc -public ams::util::localize_list_of_lists {
+ {-list}
+ } {
+ localize the elements of a list_of_lists
+ } {
+ set list_output [list]
+ foreach item $list {
+ set item_output [list]
+ foreach part $item {
+ lappend item_output [lang::util::localize $part]
+ }
+ lappend list_output $item_output
+ }
+ return $list_output
+ }
-ad_proc -public ams::ad_form::save {
- -package_key:required
- -object_type:required
- -list_name:required
- -form_name:required
- -object_id:required
-} {
- this code saves attributes input in a form
-} {
+ ad_proc -public ams::util::sort_list_of_lists {
+ {-list}
+ {-position "0"}
+ } {
+ sort a list_of_lists
+ } {
+ set sort_output [list]
+ foreach item $list {
+ set sort_key [string toupper [lindex $item $position]]
+ # we need to replace spaces because it prevents
+ # multi word sort keys from recieving curly
+ # brackets during the sort, which skews results
+ regsub -all " " $sort_key "_" sort_key
+ lappend sort_output [list $sort_key $item]
+ }
+ set sort_output [lsort $sort_output]
+ set list_output [list]
+ foreach item $sort_output {
+ lappend list_output [lindex $item 1]
+ }
+ return $list_output
+ }
- set list_id [ams::list::get_list_id -package_key $package_key -object_type $object_type -list_name $list_name]
+ ad_proc -public ams::object_parents {
+ -object_type:required
+ -sql:boolean
+ -hide_current:boolean
+ -show_root:boolean
+ } {
+ @param sql if selected the list will be formatted in a way suitable for inclusion in sql statements
+ @param hide_current hide the current object_type
+ @param show_root show the root object_type (the acs_object object type)
+ @return a list of the parent object_types
+ } {
+ if { [string is false $hide_current_p] } {
+ set object_types [list $object_type]
+ }
+ while { $object_type != "acs_object" } {
+ set object_type [db_string get_supertype {}]
+ if { $object_type != "acs_object" } {
+ lappend object_types $object_type
+ }
+ }
+ if { $show_root_p } {
+ lappend object_types "acs_object"
+ }
+ if { $sql_p } {
+ return "'[join $object_types "','"]'"
+ } else {
+ return $object_types
+ }
+ }
- ams::object::attribute::values -ids -array "oldvalues" -object_id $object_id
- set ams_attribute_ids [ams::list::ams_attribute_ids -list_id $list_id]
- set variables {}
+ ad_proc -public ams::object_copy {
+ -from:required
+ -to:required
+ } {
+ } {
+ db_transaction {
+ db_dml copy_object {}
+ }
+ }
- foreach ams_attribute_id $ams_attribute_ids {
- set storage_type [ams::attribute::storage_type -ams_attribute_id $ams_attribute_id]
- set attribute_name [ams::attribute::name -ams_attribute_id $ams_attribute_id]
- set attribute_value [template::element::get_value $form_name $attribute_name]
- if { $storage_type == "ams_options" } {
- # we always order the options_string in the order of the option_id
- # when doing internal processing
- set attribute_value [lsort [template::element::get_values $form_name $attribute_name]]
- }
- if { [info exists oldvalues($ams_attribute_id)] } {
- if { $attribute_value != $oldvalues($ams_attribute_id) } {
- lappend variables $ams_attribute_id $attribute_value
- }
- } else {
- if { [exists_and_not_null attribute_value] } {
- lappend variables $ams_attribute_id $attribute_value
- }
- }
- }
- if { [exists_and_not_null variables] } {
-# ns_log Notice "$object_id changed vars: $variables"
- db_transaction {
- ams::object::attribute::values_flush -object_id $object_id
- set revision_id [ams::object::revision::new -object_id $object_id]
- set ams_object_id [ams_object_id -object_id $object_id]
- foreach { ams_attribute_id attribute_value } $variables {
- ams::attribute::value::superseed -revision_id $revision_id -ams_attribute_id $ams_attribute_id -ams_object_id $ams_object_id
- if { [exists_and_not_null attribute_value] } {
- ams::attribute::value::new -revision_id $revision_id -ams_attribute_id $ams_attribute_id -attribute_value $attribute_value
- }
- }
- }
- }
- ams::object::attribute::values -object_id $object_id
- return 1
-}
+ ad_proc -public ams::object_delete {
+ {-object_id:required}
+ } {
+ delete and object that uses ams attributes
+ } {
+ return [db_dml delete_object {}]
+ }
-ad_proc -public ams::ad_form::elements {
- -package_key:required
- -object_type:required
- -list_name:required
- {-key ""}
-} {
- this code saves retrieves ad_form elements
-} {
- set list_id [ams::list::get_list_id -package_key $package_key -object_type $object_type -list_name $list_name]
+ ad_proc -public ams::attribute::get {
+ -attribute_id:required
+ -array:required
+ } {
+ Get the info on an ams_attribute
+ } {
+ upvar 1 $array row
+ db_1row select_attribute_info {} -column_array row
+ }
- set element_list ""
- if { [exists_and_not_null key] } {
- lappend element_list "$key\:key"
- }
- db_foreach select_elements {} {
- if { $required_p } {
- lappend element_list [ams::attribute::widget -ams_attribute_id $ams_attribute_id -required]
- } else {
- lappend element_list [ams::attribute::widget -ams_attribute_id $ams_attribute_id]
- }
- }
- return $element_list
-}
+ ad_proc -public ams::attribute::new {
+ -attribute_id:required
+ {-ams_attribute_id ""}
+ -widget:required
+ {-dynamic_p "0"}
+ {-deprecated_p "0"}
+ {-context_id ""}
+ } {
+ create a new ams_attribute
+ @see attribute::new
+ } {
+ set existing_ams_attribute_id [db_string get_existing_ams_attribute_id {} -default {}]
+ if { [exists_and_not_null existing_ams_attribute_id] } {
+ return $existing_ams_attribute_id
+ } else {
+ set extra_vars [ns_set create]
+ oacs_util::vars_to_ns_set -ns_set $extra_vars -var_list {attribute_id ams_attribute_id widget dynamic_p deprecated_p context_id}
+ set ams_attribute_id [package_instantiate_object -extra_vars $extra_vars ams_attribute]
+ return $ams_attribute_id
+ }
+ }
-namespace eval ams::option {}
+ ad_proc -public ams::attribute::value_save {
+ -object_id:required
+ -attribute_id:required
+ -value_id:required
+ } {
+ save and attribute value
+ } {
+ db_exec_plsql attribute_value_save {}
+ }
-ad_proc -public ams::option::new {
- -ams_attribute_id:required
- -option:required
- {-locale ""}
- {-sort_order ""}
-} {
- Create a new ams option for an attribute
+ ad_proc -public ams::option::new {
+ {-option_id ""}
+ -attribute_id:required
+ -option:required
+ {-sort_order ""}
+ {-deprecated_p "0"}
+ {-context_id ""}
+ } {
+ Create a new ams option for an attribute
+ } {
- TODO validate that the attribute is in fact one that accepts options.
- TODO auto input sort order if none is supplied
- TODO validate that option from the the string input from ams::lang_key_encode is equal to a pre-existing ams message if it is we need conflict resolution.
+ set option_id [db_string get_option_id { select option_id from ams_option_types where option = :option and attribute_id = :attribute_id } -default {}]
- @param ams_attribute_id
- @param option This a pretty name option
- @param locale This is the locale the option name is in
- @param sort_order if null, this option will be sorted after last previously entered option for this attribute
+ if { $option_id == "" } {
- @return option_id
-} {
-
- set lang_key "ams.option:[ams::lang_key_encode -string $option]"
- _mr en $lang_key $option
- set option $lang_key
-
- return [db_exec_plsql ams_option_new {}]
+ set option_id [db_nextval acs_object_id_seq]
+ set pretty_name [lang::util::convert_to_i18n -message_key "ams_option_${option_id}" -text "$option"]
+ set extra_vars [ns_set create]
+ oacs_util::vars_to_ns_set -ns_set $extra_vars -var_list {option_id attribute_id option sort_order deprecated_p pretty_name}
+ set option_id [package_instantiate_object -extra_vars $extra_vars ams_option]
+
+ # For whatever the reason it does not insert the pretty_name,
+ # let's do it manually then...
+ db_dml update_pretty_name "update acs_objects set title = :pretty_name where object_id = :option_id"
+ }
+
+ return $option_id
}
-
ad_proc -public ams::option::delete {
-option_id:required
} {
Delete an ams option
- @param option_id
+@param option_id
} {
db_exec_plsql ams_option_delete {}
}
-
-ad_proc -public ams::option::map {
- {-option_map_id ""}
+ad_proc -public ams::option::name {
-option_id:required
} {
- Map an ams option for an attribute to an option_map_id, if no value is supplied for option_map_id a new option_map_id will be created.
+ Delete an ams option
- @param option_map_id
- @param option_id
-
- @return option_map_id
+@param option_id
} {
- return [db_exec_plsql ams_option_map {}]
+ return [lang::util::localize [db_string get_option {} -default {}]]
}
-
-namespace eval ams::attribute {}
-
-ad_proc -public ams::attribute::get {
- -ams_attribute_id:required
- -array:required
+ad_proc -public ams::ad_form::save {
+ -package_key:required
+ -object_type:required
+ -list_name:required
+ -form_name:required
+ -object_id:required
+ {-copy_object_id ""}
} {
- Get the info on an ams_attribute
+ this code saves attributes input in a form
} {
- upvar 1 $array row
- db_1row select_attribute_info {} -column_array row
+ if { [exists_and_not_null copy_object_id] } {
+ ams::object_copy -from $object_id -to $copy_object_id
+ }
+ set list_id [ams::list::get_list_id -package_key $package_key -object_type $object_type -list_name $list_name]
+ db_transaction {
+ db_foreach select_elements {} {
+ set value_id [ams::widget -widget $widget -request "form_save_value" -attribute_name $attribute_name -pretty_name $pretty_name -form_name $form_name -attribute_id $attribute_id]
+ ams::attribute::value_save -object_id $object_id -attribute_id $attribute_id -value_id $value_id
+ }
+ }
}
-ad_proc -public ams::attribute::flush {
- -ams_attribute_id:required
+ad_proc -public ams::ad_form::elements {
+ -package_key:required
+ -object_type:required
+ {-list_name ""}
+ {-list_names ""}
+ {-key ""}
} {
- Get the info on an ams_attribute
-} {
- ams::attribute::get -ams_attribute_id $ams_attribute_id -array attribute_info
+ This code saves retrieves ad_form elements, it recieves list_name or list_names switch, if both are provided
+ then it would use list_names.
- set object_type $attribute_info(object_type)
- set attribute_name $attribute_info(attribute_name)
- ams::attribute::widget_flush -ams_attribute_id $ams_attribute_id
- ams::attribute::exists_p_flush -object_type $object_type -attribute_name $attribute_name
- ams::attribute::get_ams_attribute_id_flush -object_type $object_type -attribute_name $attribute_name
- ams::attribute::name_flush -ams_attribute_id $ams_attribute_id
- ams::attribute::storage_type_flush -ams_attribute_id $ams_attribute_id
-
-}
-
-
-ad_proc -public ams::attribute::widget {
- -ams_attribute_id:required
- {-required:boolean}
+ @param package_key The package_key of the list_id.
+ @param object_type The object_type of the list_id.
+ @param list_name The list_name to get the list_id. Either this or list_names must be provided.
+ @param list_names A list of list_names to get the list_ids from. Either this or list_name must be provided.
+ @param key The key element to use in the form.
} {
- @return an ad_form encoded attribute widget
-} {
- set attribute_widget [ams::attribute::widget_cached -ams_attribute_id $ams_attribute_id]
-
- if { [string is false $required_p] } {
- # we need to add the optional flag
- set optional_attribute_widget ""
- set i "0"
- while { $i < [llength $attribute_widget] } {
- if { $i == "0" } {
- # it is the first element in the list, so we add optional
- lappend optional_attribute_widget "[lindex $attribute_widget $i],optional"
- } else {
- # this is not the first element in the list so we simple add
- # it back to the list
- lappend optional_attribute_widget [lindex $attribute_widget $i]
- }
- incr i
- }
- set attribute_widget $optional_attribute_widget
+ set list_ids [list]
+ if { [empty_string_p $list_names] && [empty_string_p $list_name] } {
+ ad_return_complaint 1 "[_ ams.you_must_provide_list_name]"
+ ad_script_abort
}
- return $attribute_widget
-}
-
-ad_proc -private ams::attribute::widget_not_cached {
- -ams_attribute_id:required
-} {
- Returns an ad_form encoded attribute widget list, as used by other procs.
- @see ams::attribute::widget_cached
-} {
- db_1row select_attribute {}
-
- set attribute_widget "${attribute_name}:${datatype}(${widget})"
-
- lappend attribute_widget [list "label" "\#${pretty_name}\#"]
-
- if { [exists_and_not_null parameters] } {
- # the parameters are already stored in list format
- # in the database so we just add them to the list
- append attribute_widget " ${parameters}"
+ if { [empty_string_p $list_names] && ![empty_string_p $list_name] } {
+ set list_names $list_name
}
- if { $storage_type == "ams_options" } {
- set options {}
- db_foreach select_options {} {
- lappend options [list [_ $option] [lindex $option_id]]
- }
- lappend attribute_widget [list "options" $options]
+ foreach l_name $list_names {
+ set list_id [ams::list::get_list_id -package_key $package_key -object_type $object_type -list_name $l_name]
+ if {![empty_string_p $list_id]} {
+ lappend list_ids $list_id
+ }
}
- return $attribute_widget
-}
-
-ad_proc -private ams::attribute::widget_cached {
- -ams_attribute_id:required
-} {
- Returns an ad_form encoded attribute widget list, as used by other procs. Cached.
- @see ams::attribute::widget_not_cached
-} {
- return [util_memoize [list ams::attribute::widget_not_cached -ams_attribute_id $ams_attribute_id]]
-}
-
-
-ad_proc -private ams::attribute::widget_flush {
- -ams_attribute_id:required
-} {
- Returns an ad_form encoded attribute widget list, as used by other procs. Flush.
- @see ams::attribute::widget_not_cached
-} {
- return [util_memoize_flush [list ams::attribute::widget_not_cached -ams_attribute_id $ams_attribute_id]]
-}
-
-
-
-
-
-
-ad_proc -private ams::attribute::exists_p {
- -object_type:required
- -attribute_name:required
-} {
- does an attribute with this given attribute_name for this object type exists?
-
- @return 1 if the attribute_name exists for this object_type and 0 if the attribute_name does not exist
-} {
- set ams_attribute_id [ams::attribute::get_ams_attribute_id -object_type $object_type -attribute_name $attribute_name]
- if { [exists_and_not_null ams_attribute_id] } {
- return 1
- } else {
- return 0
+ # To use in the query
+ set list_ids [template::util::tcl_to_sql_list $list_ids]
+ set element_list ""
+ if { [exists_and_not_null key] } {
+ lappend element_list "$key\:key"
}
-}
-ad_proc -private ams::attribute::exists_p_flush {
- -object_type:required
- -attribute_name:required
-} {
-
- does an attribute with this given attribute_name for this object type exists? Flush.
+ # Control list to know which attributes are already in the
+ # elements list so we don't en up with duplicates
+ set control_list [list]
- @return ams_attribute_id if none exists then it returns blank
-} {
- return [util_memoize_flush [list ams::attribute::get_ams_attribute_id_not_cached -object_type $object_type -attribute_name $attribute_name]]
-}
+ set all_attributes [db_list_of_lists select_elements " "]
+ foreach attribute $all_attributes {
+ set attribute_id [lindex $attribute 0]
+ if { [string equal [lsearch $control_list $attribute_id] "-1"] } {
+ lappend control_list $attribute_id
+ set required_p [lindex $attribute 1]
+ set section_heading [lindex $attribute 2]
+ set html_options [lindex $attribute 3]
+ set attribute_name [lindex $attribute 4]
+ set pretty_name [lindex $attribute 5]
+ set widget [lindex $attribute 6]
-ad_proc -private ams::attribute::get_ams_attribute_id {
- -object_type:required
- -attribute_name:required
-} {
-
- return the ams_attribute_id for the given ams_attriubte_name belonging to this object_type. Cached.
+ set element [ams::widget \
+ -widget $widget \
+ -request "ad_form_widget" \
+ -attribute_name $attribute_name \
+ -pretty_name $pretty_name \
+ -optional_p [string is false $required_p] \
+ -html_options $html_options \
+ -attribute_id $attribute_id]
- @return ams_attribute_id if none exists then it returns blank
-} {
-
- return [util_memoize [list ams::attribute::get_ams_attribute_id_not_cached -object_type $object_type -attribute_name $attribute_name]]
-}
-
-ad_proc -private ams::attribute::get_ams_attribute_id_not_cached {
- -object_type:required
- -attribute_name:required
-} {
+ if { [exists_and_not_null section_heading] } {
+ lappend element [list section $section_heading]
+ }
+ lappend element_list $element
+ }
+ }
- return the ams_attribute_id for the given ams_attriubte_name belonging to this object_type.
-
- @return ams_attribute_id if none exists then it returns blank
-} {
-
- return [db_string get_ams_attribute_id {} -default {}]
+ return $element_list
}
-ad_proc -private ams::attribute::get_ams_attribute_id_flush {
+ad_proc -public ams::ad_form::values {
+ -package_key:required
-object_type:required
- -attribute_name:required
-} {
-
- return the ams_attribute_id for the given ams_attriubte_name belonging to this object_type. Flush.
-
- @return ams_attribute_id if none exists then it returns blank
-} {
-
- return [util_memoize_flush [list ams::attribute::get_ams_attribute_id_not_cached -object_type $object_type -attribute_name $attribute_name]]
-}
-
-ad_proc -public ams::attribute::new {
- {-ams_attribute_id ""}
- -object_type:required
- -attribute_name:required
- -pretty_name:required
- -pretty_plural:required
- {-default_value ""}
- {-description ""}
- -widget_name:required
- {-deprecated:boolean}
- {-context_id ""}
- {-no_complain:boolean}
- {-options}
-} {
- create a new ams_attribute
-
-
widget_name
-
- This should be a widget_name used by ams. All available widgets can be found at /ams/widgets.
-
-
-
-
- @param context_id defaults to package_id
- @param no_complain silently ignore attributes that already exist.
- @param options a list of options for an ams_object that has the ams_options storage type the options will be ordered in the order of the list
- @return ams_attribute_id
-} {
-
- switch $widget_name {
- textbox { set widget_name "textbox_medium" }
- textarea { set widget_name "textarea_medium" }
- richtext { set widget_name "richtext_medium" }
- address { set widget_name "postal_address" }
- phone { set widget_name "telecom_number" }
- }
- ams::attribute::exists_p_flush -object_type $object_type -attribute_name $attribute_name
- if { [ams::attribute::exists_p -object_type $object_type -attribute_name $attribute_name] } {
- if { !$no_complain_p } {
- error "Attribute $attribute_name Already Exists" "The attribute \"$attribute_name\" already exists for object_type \"$object_type\""
- } else {
- return [ams::attribute::get_ams_attribute_id -object_type $object_type -attribute_name $attribute_name]
- }
- } else {
- set lang_key "ams.$object_type\:$attribute_name\:"
- set pretty_name_key "$lang_key\pretty_name"
- set pretty_plural_key "$lang_key\pretty_plural"
- # register lang messages
- _mr en $pretty_name_key $pretty_name
- _mr en $pretty_plural_key $pretty_plural
-
- set pretty_name $pretty_name_key
- set pretty_plural $pretty_plural_key
-
-
- if { [exists_and_not_null description] } {
- set description_key "$lang_key\description"
- # register lang messages
- _mr en $description_key $description
- set description $description_key
- }
-
-
- if { [empty_string_p $context_id] } {
- set context_id [ams::package_id]
- }
- set extra_vars [ns_set create]
- oacs_util::vars_to_ns_set -ns_set $extra_vars -var_list {ams_attribute_id object_type attribute_name pretty_name pretty_plural default_value description widget_name deprecated_p context_id}
- set ams_attribute_id [package_instantiate_object -extra_vars $extra_vars ams_attribute]
-
- # now we define options for an attribute - if they are provided and the attribute accepts options
- if { [string equal [ams::attribute::storage_type -ams_attribute_id $ams_attribute_id] "ams_options"] && [exists_and_not_null options] } {
- foreach { option } $options {
- ams::option::new -ams_attribute_id $ams_attribute_id -option $option
- }
- }
- return $ams_attribute_id
- }
-}
-
-
-ad_proc -private ams::attribute::name_not_cached {
- -ams_attribute_id:required
-} {
- get the name of an ams_attribute
-
- @return attribute_name
-
- @see ams::attribute::name
- @see ams::attribute::name_flush
-} {
- return [db_string ams_attribute_name {}]
-}
-
-
-ad_proc -public ams::attribute::name {
- -ams_attribute_id:required
-} {
- get the name of an ams_attribute. Cached.
-
- @return attribute pretty_name
-
- @see ams::attribute::name_not_cached
- @see ams::attribute::name_flush
-} {
- return [util_memoize [list ams::attribute::name_not_cached -ams_attribute_id $ams_attribute_id]]
-}
-
-
-ad_proc -private ams::attribute::name_flush {
- -ams_attribute_id:required
-} {
- Flush the storage_type of an ams_attribute.
-
- @return attribute pretty_name
-
- @see ams::attribute::name_not_cached
- @see ams::attribute::name_flush
-} {
- util_memoize_flush [list ams::attribute::name_not_cached -ams_attribute_id $ams_attribute_id]
-}
-
-
-ad_proc -public ams::attribute::delete {
- -ams_attribute_id:required
-} {
- Delete an ams attribute, and all associated attribute values
-
- @param option_id
-} {
- db_exec_plsql ams_attribute_delete {}
-}
-
-
-ad_proc -private ams::attribute::storage_type_not_cached {
- -ams_attribute_id:required
-} {
- get the storage_type of an ams_attribute
-
- @return storage_type
-
- @see ams::attribute::storage_type
- @see ams::attribute::storage_type_flush
-} {
- return [db_string ams_attribute_storage_type {}]
-}
-
-
-ad_proc -public ams::attribute::storage_type {
- -ams_attribute_id:required
-} {
- get the storage_type of an ams_attribute. Cached.
-
- @return attribute pretty_name
-
- @see ams::attribute::storage_type_not_cached
- @see ams::attribute::storage_type_flush
-} {
- return [util_memoize [list ams::attribute::storage_type_not_cached -ams_attribute_id $ams_attribute_id]]
-}
-
-
-ad_proc -private ams::attribute::storage_type_flush {
- -ams_attribute_id:required
-} {
- Flush the storage_type of a cached ams_attribute.
-
- @return attribute pretty_name
-
- @see ams::attribute::storage_type_not_cached
- @see ams::attribute::storage_type_flush
-} {
- util_memoize_flush [list ams::attribute::storage_type_not_cached -ams_attribute_id $ams_attribute_id]
-}
-
-ad_proc -public ams::attribute::value {
+ -list_name:required
+ -form_name:required
-object_id:required
- -ams_attribute_id:required
} {
- this code returns the cached attribute value for a specific ams_attribute
+ this code populates ad_form values
} {
- set attribute_values_and_ids [ams::object::attributes::list_format -object_id $object_id]
- set attribute_value ""
- foreach attribute_value_and_id $attribute_values_and_ids {
- if { [lindex $attribute_value_and_id 0] == $ams_attribute_id } {
- set attribute_value [lindex $attribute_value_and_id 1]
- }
+ set list_id [ams::list::get_list_id -package_key $package_key -object_type $object_type -list_name $list_name]
+ db_foreach select_values {} {
+ ams::widget -widget $widget -request "form_set_value" -attribute_name $attribute_name -pretty_name $pretty_name -form_name $form_name -attribute_id $attribute_id -value $value
}
- return $attribute_value
}
-ad_proc -public ams::attribute::value_from_name {
+ad_proc -public ams::values {
+ -package_key:required
-object_type:required
- -attribute_name:required
+ {-list_name ""}
+ {-list_names ""}
-object_id:required
+ {-format "text"}
+ {-locale ""}
} {
- this code returns the cached attribute value for a specific ams_attribute
+ This returns a list with the first element as the pretty_attribute name
+ and the second the value. Cached
} {
- return [ams::attribute::value -object_id $object_id [ams::attribute::get_ams_attribute_id -object_type $object_type -attribute_name $attribute_name]]
+ return [util_memoize [list ams::values_not_cached \
+ -package_key $package_key \
+ -object_type $object_type \
+ -list_name $list_name \
+ -list_names $list_names \
+ -object_id $object_id \
+ -format $format \
+ -locale $locale]]
}
-namespace eval ams::attribute::value {}
-
-ad_proc -public ams::attribute::value::new {
- -revision_id:required
- -ams_attribute_id:required
- -attribute_value:required
-} {
- this code saves attributes input in a form
-} {
- set storage_type [ams::attribute::storage_type -ams_attribute_id $ams_attribute_id]
- set option_map_id ""
- set address_id ""
- set number_id ""
- set time ""
- set value ""
- set value_mime_type ""
-
- switch $storage_type {
- telecom_number {
- # i'm not using the telecom_number plsql code here
- # since it creates unnecessary permissions by explicitly
- # granting the address creation_user admin rights, This
- # is taken care of the the ams_attribute permissions.
- #
- # plus we want this info to be the bound to the revision_id
- # not the associated address_id so we pull it from the database
- set itu_id [template::util::telecom_number::get_property itu_id $attribute_value]
- set national_number [template::util::telecom_number::get_property national_number $attribute_value]
- set area_city_code [template::util::telecom_number::get_property area_city_code $attribute_value]
- set subscriber_number [template::util::telecom_number::get_property subscriber_number $attribute_value]
- set extension [template::util::telecom_number::get_property extension $attribute_value]
- set sms_enabled_p [template::util::telecom_number::get_property sms_enabled_p $attribute_value]
- set best_contact_time [template::util::telecom_number::get_property best_contact_time $attribute_value]
- set location [template::util::telecom_number::get_property location $attribute_value]
- set phone_type_id [template::util::telecom_number::get_property phone_type_id $attribute_value]
-
- set number_id [db_string create_telecom_number_object {}]
-
- db_dml create_telecom_number {}
-
- }
-
- postal_address {
- # i'm not using the postal_address plsql code here
- # since it creates unnecessary permissions by explicitly
- # granting the address creation_user admin rights, This
- # is taken care of the the ams_attribute permissions.
- #
- # plus we want this info to be the bound to the revision_id
- # not the associated address_id so we pull it from the database
- set delivery_address [template::util::address::get_property delivery_address $attribute_value]
- set postal_code [template::util::address::get_property postal_code $attribute_value]
- set municipality [template::util::address::get_property municipality $attribute_value]
- set region [template::util::address::get_property region $attribute_value]
- set country_code [template::util::address::get_property country_code $attribute_value]
- set additional_text [template::util::address::get_property additional_text $attribute_value]
- set postal_type [template::util::address::get_property postal_type $attribute_value]
-
- set address_id [db_string create_postal_address_object {}]
-
- db_dml create_postal_address {}
- }
-
- ams_options {
- # we need to loop through the values
- # on the first option_map_id the option_map_id
- # will be set.
- foreach { option_id } $attribute_value {
- set option_map_id [ams::option::map -option_map_id $option_map_id -option_id $option_id]
- }
- }
-
- time {
- set value $attribute_value
- }
-
- value {
- set value $attribute_value
- }
-
- value_with_mime_type {
- set value [template::util::richtext::get_property contents $attribute_value]
- set value_mime_type [template::util::richtext::get_property format $attribute_value]
- }
- }
-
- db_dml insert_attribute_value {}
-}
-
-
-ad_proc -public ams::attribute::value::superseed {
- -revision_id:required
- -ams_attribute_id:required
- -ams_object_id:required
-} {
- superseed an attribute value
-} {
- db_dml superseed_attribute_value {}
-}
-
-namespace eval ams::multirow {}
-
-ad_proc -private ams::multirow::extend {
+ad_proc -public ams::values_not_cached {
-package_key:required
-object_type:required
- -list_name:required
- -multirow:required
- -key:required
+ {-list_name ""}
+ {-list_names ""}
+ -object_id:required
+ {-format "text"}
+ {-locale ""}
} {
- append ams_attribute_values to a multirow
+ this returns a list with the first element as the pretty_attribute name and the second the value
} {
- set list_id [ams::list::get_list_id \
- -package_key $package_key \
- -object_type $object_type \
- -list_name $list_name]
-
-
- # first we make sure all the attribute_values are efficiently cached
- # i.e. we only do one trip to the database, instead of one for
- # each object in the multirow
- set object_id_list ""
- template::multirow foreach $multirow {
- lappend object_id_list [set $key]
+ if { $format != "html" } {
+ set format "text"
}
- if { [exists_and_not_null object_id_list] } {
- ams::object::attribute::values_batch_process -object_id_list $object_id_list
+ if { [empty_string_p $list_names] && [empty_string_p $list_name] } {
+ ad_return_complaint 1 "[_ ams.you_must_provide_list_name]"
+ ad_script_abort
}
- # now we extend the multirow with the ams_attribute_names
- set ams_attribute_ids [ams::list::ams_attribute_ids -list_id $list_id]
- set ams_attribute_names {}
- foreach ams_attribute_id $ams_attribute_ids {
- set ams_attribute_name [ams::attribute::name -ams_attribute_id $ams_attribute_id]
- lappend ams_attribute_names $ams_attribute_name
- template::multirow extend $multirow $ams_attribute_name
+ if { [empty_string_p $list_names] && ![empty_string_p $list_name] } {
+ set list_names $list_name
}
- # now we populate the multirow with ams_attribute_values
- template::multirow foreach $multirow {
- # first we set a null value for all ams_attribute_names
- # since the ams::object::attribute::values proc only
- # returns those ams_attribute_values that do not
- # have a null value
- foreach ams_attribute_name ams_attribute_names {
- set [set $ams_attribute_name] {}
- }
- ams::object::attribute::values -vars -object_id [set $key]
+ foreach l_name $list_names {
+ set list_id [ams::list::get_list_id -package_key $package_key -object_type $object_type -list_name $l_name]
+ if {![empty_string_p $list_id]} {
+ lappend list_ids $list_id
+ }
}
-}
+ # To use in the query
+ set list_ids [template::util::tcl_to_sql_list $list_ids]
+ if { [exists_and_not_null list_ids] } {
+ set values [list]
+ set heading ""
+ set html_opt ""
+
+ # Control list to know which attributes are already in the
+ # elements list so we don't en up with duplicates
+ set control_list [list]
+
+ set all_attributes [db_list_of_lists select_values " "]
+
+ foreach attribute $all_attributes {
+ set attribute_id [lindex $attribute 0]
+ if { [string equal [lsearch $control_list $attribute_id] "-1"] } {
+ lappend control_list $attribute_id
+ set section_heading [lindex $attribute 1]
+ set html_options [lindex $attribute 2]
+ set attribute_name [lindex $attribute 3]
+ set pretty_name [lindex $attribute 4]
+ set widget [lindex $attribute 5]
+ set value [lindex $attribute 6]
+
+ set val [list]
+ if { [regexp "\{text/.*\}" $value value_format] } {
+ lappend val [lindex $value_format 0]
+ lappend val [list [string range $value [expr [string length $value_format] + 1] [string length $value]]]
+ } else {
+ set val $value
+ }
+
+ if { [exists_and_not_null section_heading] } {
+ set heading $section_heading
+ }
+
+ if { [exists_and_not_null html_options] } {
+ set html_opt $html_options
+ }
-namespace eval ams::object {}
+ if { [exists_and_not_null value] } {
+ lappend values $heading $attribute_name $pretty_name [ams::widget \
+ -widget $widget \
+ -request "value_${format}" \
+ -attribute_name $attribute_name \
+ -attribute_id $attribute_id \
+ -value $value \
+ -locale $locale] $html_opt
-namespace eval ams::object::attribute {}
+ ns_log Notice "$attribute_name ($attribute_id):: $value"
+ }
-
-
-
-ad_proc -private ams::object::attribute::value_memoize {
- -object_id:required
- -ams_attribute_id:required
- -attribute_value:required
-} {
- memoize an ams::object::attribute::value
-} {
- if { [string is true [util_memoize_cached_p [list ams::object::attribute::values_not_cached -object_id $object_id]]] } {
- array set $object_id [util_memoize [list ams::object::attribute::values_not_cached -object_id $object_id]]
- }
- # if a value previously existed it will be superseeded
- set ${object_id}($ams_attribute_id) $attribute_value
- util_memoize_seed [list ams::object::attribute::values_not_cached -object_id $object_id] [array get ${object_id}]
-}
-
-ad_proc -public ams::object::attribute::value {
- -object_id:required
- -ams_attribute_id:required
-} {
-} {
- ams::object::attribute::values -array $object_id -object_id $object_id
- if { [info exists ${object_id}($ams_attribute_id)] } {
- return ${object_id}($ams_attribute_id)
+ ns_log Notice "$attribute_name ($attribute_id):: $value"
+ }
+ }
+ return $values
} else {
- return {}
+ return [list]
}
}
-ad_proc -public ams::object::attribute::values {
- -object_id:required
- {-ids:boolean}
- {-vars:boolean}
- {-array ""}
-} {
- @param ids - if specified we will return the ams_attribute_id instead of the attribute_name
- @param array - if specified the attribute values are returned in the given array
- @param vars - if sepecified the attribute values vars are returned to the calling environment
- if neither array nor vars are specified then a list is returned
-} {
- set attribute_values_list [util_memoize [list ams::object::attribute::values_not_cached -object_id $object_id]]
- if { !$ids_p } {
- set attribute_values_list_with_names ""
- foreach { key value } $attribute_values_list {
- lappend attribute_values_list_with_names [ams::attribute::name -ams_attribute_id $key]
- lappend attribute_values_list_with_names $value
- }
- set attribute_values_list $attribute_values_list_with_names
- }
- if { [exists_and_not_null array] } {
- upvar $array row
- array set row $attribute_values_list
- } elseif { $vars_p } {
- set attribute_value_info [ns_set create]
- foreach { key value } $attribute_values_list {
- ns_set put $attribute_value_info $key $value
- }
- # Now, set the variables in the caller's environment
- ad_ns_set_to_tcl_vars -level 2 $attribute_value_info
- ns_set free $attribute_value_info
- } else {
- return $attribute_values_list
- }
-}
-
-
-ad_proc -private ams::object::attribute::values_not_cached {
+ad_proc -public ams::value {
-object_id:required
+ {-attribute_id ""}
+ {-attribute_name ""}
+ {-format "html"}
+ {-locale ""}
} {
+ Return the value of an attribute for a certain object. You can
+ provide either the attribute_id or the attribute_name. Cached.
+
+ @param object_id The object for which the value is stored
+ @param attribute_id The attribute_id of the attribute for which the value is retrieved
+ @param attribute_name Alternatively the attribute_name for the attribute
+ @return
+ @error
} {
- ams::object::attribute::values_batch_process -object_id_list $object_id
- if { [string is true [util_memoize_cached_p [list ams::object::attribute::values_not_cached -object_id $object_id]]] } {
- return [util_memoize [list ams::object::attribute::values_not_cached -object_id $object_id]]
- } else {
- return {}
- }
+ return [util_memoize [list ams::value_not_cached \
+ -object_id $object_id \
+ -attribute_id $attribute_id \
+ -attribute_name $attribute_name \
+ -format $format \
+ -locale $locale]]
}
-
-ad_proc -private ams::object::attribute::values_flush {
+ad_proc -public ams::value_not_cached {
-object_id:required
+ -attribute_id
+ -attribute_name
+ {-format "html"}
+ {-locale ""}
} {
+ Return the value of an attribute for a certain object. You can
+ provide either the attribute_id or the attribute_name
+
+ @author Malte Sussdorff (sussdorff@sussdorff.de)
+ @creation-date 2005-07-22
+
+ @param object_id The object for which the value is stored
+
+ @param attribute_id The attribute_id of the attribute for which the value is retrieved
+
+ @param attribute_name Alternatively the attribute_name for the attribute
+
+ @return
+
+ @error
} {
- return [util_memoize_flush [list ams::object::attribute::values_not_cached -object_id $object_id]]
-}
-
-
-ad_proc -private ams::object::attribute::values_batch_process {
- -object_id_list:required
-} {
- @param object_ids a list of object_ids for which to save attributes in their respective caches.
- get these objects attribute values in a list format
-} {
- set objects_to_cache ""
- foreach object_id_from_list $object_id_list {
- if { [string is false [util_memoize_cached_p [list ams::object::attribute::values -object_id $object_id_from_list]]] } {
- lappend objects_to_cache $object_id_from_list
- }
- }
- if { [exists_and_not_null objects_to_cache] } {
- set sql_object_id_list [ams::util::sqlify_list -list $objects_to_cache]
- db_foreach get_attr_values "" {
- switch [ams::attribute::storage_type -ams_attribute_id $ams_attribute_id] {
- telecom_number {
- set attribute_value $telecom_number_string
- }
- postal_address {
- set attribute_value $address_string
- }
- ams_options {
- set attribute_value $options_string
- }
- time {
- set attribute_value $time
- }
- value {
- set attribute_value $value
- }
- value_with_mime_type {
- set attribute_value [list $value $value_mime_type]
- }
- }
- set ${object_id}($ams_attribute_id) $attribute_value
- }
- foreach object_id_from_list $object_id_list {
- util_memoize_seed [list ams::object::attribute::values_not_cached -object_id $object_id_from_list] [array get ${object_id_from_list}]
- }
- }
-}
-
-
-
-namespace eval ams::object::revision {}
-
-
-ad_proc -public ams::object::revision::new {
- {-package_id ""}
- -object_id:required
-} {
- create a new ams_object_revision
-
- @return revision_id
-} {
- if { [empty_string_p $package_id] } {
- set package_id [ams::package_id]
- }
- set extra_vars [ns_set create]
- oacs_util::vars_to_ns_set -ns_set $extra_vars -var_list { object_id package_id }
- set revision_id [package_instantiate_object -extra_vars $extra_vars ams_object_revision]
-
- return $revision_id
-}
-
-
-
-
-
-
-
-
-
-
-
-
-namespace eval ams::list {}
-
-ad_proc -public ams::list::get {
- -list_id:required
- -array:required
-} {
- Get the info on an ams_attribute
-} {
- upvar 1 $array row
- db_1row select_list_info {} -column_array row
-}
-
-ad_proc -private ams::list::ams_attribute_ids_not_cached {
- -list_id:required
-} {
- Get a list of ams_attributes.
-
- @return list of ams_attribute_ids, in the correct order
-
- @see ams::list::ams_attribute_ids
- @see ams::list::ams_attribute_ids_flush
-} {
- return [db_list ams_attribute_ids {}]
-}
-
-ad_proc -private ams::list::ams_attribute_ids {
- -list_id:required
-} {
- get this lists ams_attribute_ids. Cached.
-
- @return list of ams_attribute_ids, in the correct order
-
- @see ams::list::ams_attribute_ids_not_cached
- @see ams::list::ams_attribute_ids_flush
-} {
- return [util_memoize [list ams::list::ams_attribute_ids_not_cached -list_id $list_id]]
-}
-
-ad_proc -private ams::list::ams_attribute_ids_flush {
- -list_id:required
-} {
- Flush this lists ams_attribute_ids cache.
-
- @return list of ams_attribute_ids, in the correct order
-
- @see ams::list::ams_attribute_ids_not_cached
- @see ams::list::ams_attribute_ids
-} {
- return [util_memoize_flush [list ams::list::ams_attribute_ids_not_cached -list_id $list_id]]
-}
-
-
-
-ad_proc -private ams::list::exists_p {
- -package_key:required
- -object_type:required
- -list_name:required
-} {
- does an ams list like this exist?
-
- @return 1 if the list exists for this object_type and package_key and 0 if the does not exist
-} {
- set list_id [ams::list::get_list_id_not_cached -package_key $package_key -object_type $object_type -list_name $list_name]
- if { [exists_and_not_null list_id] } {
- return 1
+ if {[exists_and_not_null attribute_id]} {
+ set where_clause "and aa.attribute_id = :attribute_id"
} else {
- return 0
+ set where_clause "and aa.attribute_name = :attribute_name"
}
-}
-
-ad_proc -private ams::list::flush {
- -package_key:required
- -object_type:required
- -list_name:required
-} {
- flush all inte info we have on an ams_list
-
- @return 1 if the list exists for this object_type and package_key and 0 if the does not exist
-} {
- ams::list::ams_attribute_ids_flush -list_id [ams::list::get_list_id_not_cached -package_key $package_key -object_type $object_type -list_name $list_name]
- ams::list::get_list_id_flush -package_key $package_key -object_type $object_type -list_name $list_name
-}
-
-ad_proc -private ams::list::get_list_id {
- -package_key:required
- -object_type:required
- -list_name:required
-} {
- return the list_id for the given parameters. Chached.
-
- @return list_id if none exists then it returns blank
-} {
- return [util_memoize [list ams::list::get_list_id_not_cached -package_key $package_key -object_type $object_type -list_name $list_name]]
-}
-
-
-ad_proc -private ams::list::get_list_id_not_cached {
- -package_key:required
- -object_type:required
- -list_name:required
-} {
- return the list_id for the given parameters
-
- @return list_id if none exists then it returns blank
-} {
-
- return [db_string get_list_id {} -default {}]
-}
-
-ad_proc -private ams::list::get_list_id_flush {
- -package_key:required
- -object_type:required
- -list_name:required
-} {
-
- flush the memorized list_id for the given parameters.
-
- @return list_id if none exists then it returns blank
-} {
- return [util_memoize_flush [list ams::list::get_list_id_not_cached -package_key $package_key -object_type $object_type -list_name $list_name]]
-}
-
-ad_proc -public ams::list::new {
- {-list_id ""}
- -package_key:required
- -object_type:required
- -list_name:required
- -pretty_name:required
- {-description ""}
- {-description_mime_type "text/plain"}
- {-context_id ""}
-} {
- create a new ams_group
-
- @return group_id
-} {
- if { [empty_string_p $context_id] } {
- set context_id [ams::package_id]
+ if {[db_0or1row select_value {}]} {
+ return [ams::widget -widget $widget -request "value_${format}" -attribute_name $attribute_name -attribute_id $attribute_id -value $value -locale $locale]
+ } else {
+ return ""
}
- if { ![exists_and_not_null description] } {
- set description_mime_type ""
- }
- set lang_key "ams.$package_key\:$object_type\:$list_name"
- _mr en $lang_key $pretty_name
- set pretty_name $lang_key
-
- if { [exists_and_not_null description] } {
- set lang_key "ams.$package_key\:$object_type\:$list_name\:description"
- _mr en $lang_key $description
- set description $lang_key
- }
-
- set extra_vars [ns_set create]
- oacs_util::vars_to_ns_set -ns_set $extra_vars -var_list { list_id package_key object_type list_name pretty_name description description_mime_type }
- set list_id [package_instantiate_object -extra_vars $extra_vars ams_list]
-
- return $list_id
}
-
-namespace eval ams::list::attribute {}
-
-ad_proc -public ams::list::attribute::map {
- -list_id:required
- -ams_attribute_id:required
- {-sort_order ""}
- {-required_p "f"}
- {-section_heading ""}
-} {
- Map an ams option for an attribute to an option_map_id, if no value is supplied for option_map_id a new option_map_id will be created.
-
- @param sort_order if null then the attribute will be placed as the last attribute in this groups sort order
-
- @return option_map_id
-} {
- if { ![exists_and_not_null sort_order] } {
- set sort_order [expr 1 + [db_string get_highest_sort_order {} -default "0"]]
- }
- return [db_exec_plsql ams_list_attribute_map {}]
-}
-
-ad_proc -public ams::list::attribute::unmap {
- -list_id:required
- -ams_attribute_id:required
-} {
- Unmap an ams option from an ams list
-} {
- db_dml ams_list_attribute_unmap {}
-}
-
-ad_proc -public ams::list::attribute::required {
- -list_id:required
- -ams_attribute_id:required
-} {
- Specify and ams_attribute as required in an ams list
-} {
- db_dml ams_list_attribute_required {}
-}
-
-ad_proc -public ams::list::attribute::optional {
- -list_id:required
- -ams_attribute_id:required
-} {
- Specify and ams_attribute as optional in an ams list
-} {
- db_dml ams_list_attribute_optional {}
-}
-
-
-
-
-
-
-
-
-
-
-
-
-namespace eval ams::util {}
-
-
-
-ad_proc -public ams::util::sqlify_list {
- -list:required
-} {
- set output_list {}
- foreach item $list {
- if { [exists_and_not_null output_list] } {
- append output_list ", "
- }
- regsub -all {'} $item {''} item
- append output_list "'$item'"
- }
- return $output_list
-}
Fisheye: Tag 1.2.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/tcl/ams-widget-procs-postgresql.xql'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.15.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/tcl/ams-widget-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.2.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/tcl/recurrence-widget-procs.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: openacs-4/packages/ams/tcl/telecom-number-widget-procs.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/tcl/telecom-number-widget-procs.tcl,v
diff -u -r1.2 -r1.2.2.1
--- openacs-4/packages/ams/tcl/telecom-number-widget-procs.tcl 27 Oct 2004 03:33:25 -0000 1.2
+++ openacs-4/packages/ams/tcl/telecom-number-widget-procs.tcl 30 Nov 2005 16:21:53 -0000 1.2.2.1
@@ -47,8 +47,25 @@
{location {}}
{phone_type_id {}}
} {
- set telecom_number "$national_number $area_city_code-$subscriber_number\x$extension"
- return [ad_text_to_html $telecom_number]
+ set telecom_number ""
+ if { [parameter::get_from_package_key -parameter "ForceCountryCodeOneFormatting" -package_key "ams" -default "0"] } {
+ if { $national_number != "1" } {
+ set telecom_number "[_ ams.international_dial_code]${national_number}-"
+ }
+ } else {
+ set telecom_number ${national_number}
+ if { [exists_and_not_null telecom_number] } { append telecom_number "-" }
+ }
+ append telecom_number $area_city_code
+ if { [exists_and_not_null telecom_number] } { append telecom_number "-" }
+ append telecom_number "$subscriber_number"
+ if { [exists_and_not_null extension] } { append telecom_number " x$extension" }
+ set phone_url [parameter::get_from_package_key -parameter "PhoneURL" -package_key "ams" -default ""]
+ if {[empty_string_p $phone_url]} {
+ return $telecom_number
+ } else {
+ return "$telecom_number"
+ }
}
ad_proc -public template::util::telecom_number::acquire { type { value "" } } {
@@ -93,17 +110,16 @@
set best_contact_time [template::util::telecom_number::get_property best_contact_time $telecom_number_list]
set location [template::util::telecom_number::get_property location $telecom_number_list]
set phone_type_id [template::util::telecom_number::get_property phone_type_id $telecom_number_list]
-
- if { ![parameter::get -parameter "ForceCountryCodeOneFormatting" -default "0"] } {
+ if { ![parameter::get_from_package_key -parameter "ForceCountryCodeOneFormatting" -package_key "ams" -default "0"] } {
# the number is not required to be formatted in a country code one friendly way
# we need to verify that the number does not contain invalid characters
set telecom_number_temp "$itu_id$national_number$area_city_code$subscriber_number$extension$sms_enabled_p$best_contact_time"
regsub -all " " $telecom_number_temp "" telecom_number_temp
ns_log Notice $telecom_number_temp
- if { ![regexp {^([0-9]|x|-|\)|\(){1,}$} $telecom_number_temp match telecom_number_temp] } {
- set message [_ ams.Telecom_numbers_must_only_contain_numbers_dashes_and_x_es_and_rounded_braces]
+ if { ![regexp {^([0-9]|x|-|\+|\)|\(){1,}$} $telecom_number_temp match telecom_number_temp] } {
+ set message [_ ams.lt_Telecom_numbers_must_only_contain]
}
} else {
# we have a number in country code one that must follow certain formatting guidelines
@@ -114,7 +130,7 @@
# users know how they are supposed to format numbers.
if { ![exists_and_not_null area_city_code] || ![exists_and_not_null national_number] } {
- set message [_ ams.Telecom_numbers_in_country_code_one_must_be_formatted_like_AAA-SSS-SSSSxXXXX_out_of_country_like_011-CCC-AAAA-SSSS-SSSxXXXX]
+ set message [_ ams.lt_Telecom_numbers_in_country_code]
}
}
@@ -145,7 +161,7 @@
# we need to seperate out the returned value into individual elements for a single box entry widget
set number [string trim [ns_queryget $element_id.summary_number]]
- if { ![parameter::get -parameter "ForceCountryCodeOneFormatting" -default "0"] } {
+ if { ![parameter::get_from_package_key -parameter "ForceCountryCodeOneFormatting" -package_key "ams" -default "0"] } {
# we need to verify that the number is formatted correctly
# if yes we seperate the number into various elements
set subscriber_number $number
@@ -202,9 +218,9 @@
} {
set itu_id [template::util::telecom_number::get_property itu_id $telecom_number_list]
- set subscriber_number [template::util::telecom_number::get_property subscriber_number $telecom_number_list]
set national_number [template::util::telecom_number::get_property national_number $telecom_number_list]
set area_city_code [template::util::telecom_number::get_property area_city_code $telecom_number_list]
+ set subscriber_number [template::util::telecom_number::get_property subscriber_number $telecom_number_list]
set extension [template::util::telecom_number::get_property extension $telecom_number_list]
set sms_enabled_p [template::util::telecom_number::get_property sms_enabled_p $telecom_number_list]
set best_contact_time [template::util::telecom_number::get_property best_contact_time $telecom_number_list]
@@ -252,12 +268,15 @@
@param what the name of the property. Must be one of:
itu_id (synonyms street_telecom_number, street)
-
subscriber_number (synonyms zip_code, zip)
national_number (synonyms city, town)
area_city_code (synonyms state, province)
+
subscriber_number (synonyms zip_code, zip)
extension (synonym country)
addtional_text (this is not implemented in the default US widget)
best_contact_time (this is not implemented in the default US widget)
+
sms_enabled_p (this is not implemented in the default US widget)
+
location (this is not implemented in the default US widget)
+
phone_type_id (this is not implemented in the default US widget)
html_view - this returns an nice html formatted view of the telecom_number
@param telecom_number_list a telecom_number datatype value, usually created with ad_form.
@@ -301,7 +320,7 @@
set best_contact_time [template::util::telecom_number::get_property best_contact_time $telecom_number_list]
set location [template::util::telecom_number::get_property location $telecom_number_list]
set phone_type_id [template::util::telecom_number::get_property phone_type_id $telecom_number_list]
- return [template::util::telecom_number::html_view $itu_id $subscriber_number $national_number $area_city_code $extension $sms_enabled_p $best_contact_time $location $phone_type_id]
+ return [template::util::telecom_number::html_view $itu_id $national_number $area_city_code $subscriber_number $extension $sms_enabled_p $best_contact_time $location $phone_type_id]
}
default {
error "Parameter supplied to util::telecom_number::get_property 'what' must be one of: 'itu_id', 'subscriber_number', 'national_number', 'area_city_code', 'extension', 'sms_enabled_p', 'best_contact_time', 'location', 'phone_type_id'. You specified: '$what'."
@@ -325,9 +344,9 @@
if { [info exists element(value)] } {
set itu_id [template::util::telecom_number::get_property itu_id $element(value)]
- set subscriber_number [template::util::telecom_number::get_property subscriber_number $element(value)]
set national_number [template::util::telecom_number::get_property national_number $element(value)]
set area_city_code [template::util::telecom_number::get_property area_city_code $element(value)]
+ set subscriber_number [template::util::telecom_number::get_property subscriber_number $element(value)]
set extension [template::util::telecom_number::get_property extension $element(value)]
set sms_enabled_p [template::util::telecom_number::get_property sms_enabled_p $element(value)]
set best_contact_time [template::util::telecom_number::get_property best_contact_time $element(value)]
@@ -376,7 +395,7 @@
} else {
# Display mode
if { [info exists element(value)] } {
- append output [template::util::telecom_number::get_property html_view $element(value)]
+ append output "[template::util::telecom_number::get_property html_view $element(value)]"
append output ""
append output ""
append output ""
Index: openacs-4/packages/ams/www/attribute-add-2.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/attribute-add-2.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/attribute-add-2.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/attribute-add-2.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -16,8 +16,8 @@
acs_object_type::get -object_type $object_type -array "object_info"
-set title "Define Options"
-set context [list [list objects Objects] [list "object?object_type=$object_type" $object_info(pretty_name)] [list "attribute-add?object_type=$object_type" "Add Attribute"] $title]
+set title "[_ ams.Define_Options]"
+set context [list [list objects Objects] [list "object?object_type=$object_type" $object_info(pretty_name)] [list "attribute-add?object_type=$object_type" "[_ ams.Add_Attribute]"] $title]
db_1row select_widget_pretty_and_storage_type { select storage_type from ams_widgets where widget_name = :widget_name }
@@ -28,10 +28,10 @@
if { [exists_and_not_null list_id] } {
set return_url "list-attributes-map?[export_vars -url {ams_attribute_id list_id}]"
- set user_message "AMS Attribute $pretty_name Created and Mapped."
+ set user_message "[_ ams.lt_AMS_Attribute_a_hrefa]"
} else {
set return_url "object?[export_vars -url {object_type}]"
- set user_message "AMS Attribute $pretty_name Created."
+ set user_message "[_ ams.lt_AMS_Attribute_a_hrefa_1]"
}
@@ -59,15 +59,15 @@
{ams_attribute_id:key}
{list_id:integer(hidden)}
{object_type:text(hidden)}
- {widget_name:text(inform) {label "Widget"}}
- {attribute_name:text(inform) {label "Attribute Name"}}
- {pretty_name:text(inform) {label "Pretty Name"}}
- {pretty_plural:text(inform) {label "Pretty Plural"}}
+ {widget_name:text(inform) {label "[_ ams.Widget_1]"}}
+ {attribute_name:text(inform) {label "[_ ams.Attribute_Name]"}}
+ {pretty_name:text(inform) {label "[_ ams.Pretty_Name_1]"}}
+ {pretty_plural:text(inform) {label "[_ ams.Pretty_Plural_1]"}}
}
if { [exists_and_not_null description] } {
ad_form -extend -name attribute_form -form {
- {description:text(inform) {label "Description"}}
+ {description:text(inform) {label "[_ ams.Description]"}}
}
} else {
ad_form -extend -name attribute_form -form {
@@ -76,15 +76,15 @@
}
ad_form -extend -name attribute_form -form {
- {option1:text {label "Option 1"} {html {size 50}}}
- {option2:text,optional {label "Option 2"} {html {size 50}}}
- {option3:text,optional {label "Option 3"} {html {size 50}}}
- {option4:text,optional {label "Option 4"} {html {size 50}}}
- {option5:text,optional {label "Option 5"} {html {size 50}}}
- {option6:text,optional {label "Option 6"} {html {size 50}}}
- {option7:text,optional {label "Option 7"} {html {size 50}}}
- {option8:text,optional {label "Option 8"} {html {size 50}}}
- {option9:text,optional {label "Option 9"} {html {size 50}} {help_text {If you need to add more options you will be able to do so by editing this attributes details}}}
+ {option1:text {label "[_ ams.Option_1]"} {html {size 50}}}
+ {option2:text,optional {label "[_ ams.Option_2]"} {html {size 50}}}
+ {option3:text,optional {label "[_ ams.Option_3]" } {html {size 50}}}
+ {option4:text,optional {label "[_ ams.Option_4]" } {html {size 50}}}
+ {option5:text,optional {label "[_ ams.Option_5]"} {html {size 50}}}
+ {option6:text,optional {label "[_ ams.Option_6]"} {html {size 50}}}
+ {option7:text,optional {label "[_ ams.Option_7]"} {html {size 50}}}
+ {option8:text,optional {label "[_ ams.Option_8]"} {html {size 50}}}
+ {option9:text,optional {label "[_ ams.Option_9]"} {html {size 50}} {help_text {If you need to add more options you will be able to do so by editing this attributes details}}}
} -new_request {
} -edit_request {
} -validate {
Index: openacs-4/packages/ams/www/attribute-add.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/attribute-add.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/attribute-add.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/attribute-add.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -4,44 +4,193 @@
@creation-date 2004-07-28
@cvs-id $Id$
} {
+ {return_url:optional ""}
+ {return_url_label:optional ""}
+ {list_id:optional ""}
{object_type:notnull}
- {list_id:integer}
+ {widget:optional ""}
+ {attribute_name:optional ""}
}
acs_object_type::get -object_type $object_type -array "object_info"
-set title "Add Attribute"
-set context [list [list objects Objects] [list "object?object_type=$object_type" $object_info(pretty_name)] "Add Attribute"]
+set title "[_ ams.Add_Attribute]"
+set context [list [list objects Objects] [list "object?object_type=$object_type" $object_info(pretty_name)] "[_ ams.Add_Attribute]"]
-set widget_options " [db_list_of_lists select_widgets { select widget_name, widget_name from ams_widgets order by widget_name } ]"
-
-
ad_form -name attribute_form -form {
{ams_attribute_id:key}
- {list_id:integer(hidden)}
+ {return_url:text(hidden),optional}
+ {return_url_label:text(hidden),optional}
+ {list_id:integer(hidden),optional}
{object_type:text(hidden)}
- {widget_name:text(multiselect) {label "Widget"} {options $widget_options } {help_text {Widgets descriptions are available}}}
- {attribute_name:text {label "Attribute Name"} {html {size 30 maxlength 100}} {help_text {This name must be lower case, contain only letters and underscores, and contain no spaces}}}
- {pretty_name:text {label "Pretty Name"} {html {size 30 maxlength 100}}}
- {pretty_plural:text {label "Pretty Plural"} {html {size 30 maxlength 100}}}
- {description:text(textarea),optional {label "Description"} {html {cols 55 rows 4}}}
-} -new_request {
-} -edit_request {
-} -validate {
- # i need to add validation that the attribute isn't already in the database
- { attribute_name
- { [::regexp {^([0-9]|[a-z]|\_){1,}$} $attribute_name match attribute_name_validate] }
- "You have used invalid characters."
+ {mode:text(hidden),optional}
+ {widget:text(radio),optional {label "[_ ams.Widget_1]"} {options {[lsort [::ams::widget_list]]}}}
+ {attribute_name:text,optional {label "[_ ams.Attribute_Name]"} {html {size 30 maxlength 100}} {help_text {This name must be lower case, contain only letters and underscores, and contain no spaces. If not specified one will be generated for you.}}}
+ {pretty_name:text,optional {label "[_ ams.Pretty_Name_1]"} {html {size 30 maxlength 100}}}
+ {pretty_plural:text,optional {label "[_ ams.Pretty_Plural_1]"} {html {size 30 maxlength 100}}}
+}
+
+
+#if { [ams::widget_has_options_p -widget $widget] } {
+# foreach elemement [list option1 option2 option3 option4 option4] {
+# ::template::element::set_properties attribute_form $element -widget text
+# }
+#}
+if { [ams::widget_has_options_p -widget $widget] } {
+ set default_number_of_options 5
+ set option_fields_count $default_number_of_options
+ set i 1
+ set elements [list]
+ lappend elements [list option_fields_count:integer(hidden) [list value $option_fields_count]]
+# lappend elements [list options_on_last_screen:integer(hidden),optional]
+ while { $i <= $option_fields_count } {
+ set element [list option${i}:text(text),optional [list label "[_ ams.Option] $i"] [list html [list size 50]]]
+ if { $i == $option_fields_count } {
+ lappend element [list help_text "[_ ams.lt_If_you_need_to_add_mo]"]
+ }
+ if { $i == 1 } {
+ lappend element [list section "[_ ams.Predefined_Options]"]
+ }
+ lappend elements $element
+ incr i
}
- { attribute_name
- { ![::attribute::exists_p $object_type $attribute_name] }
- "Attribute $attribute_name already exists for $object_info(pretty_name)."
+ ad_form -extend -name attribute_form -form $elements
+}
+
+
+
+ad_form -extend -name attribute_form -on_request {
+ set mode "new"
+ if { [::attribute::exists_p -convert_p 0 $object_type $attribute_name] } {
+ # this attribute already exists - so we are in "edit" mode for
+ ::template::element::set_properties attribute_form attribute_name -mode display
+ db_1row get_attr_info { select pretty_name, pretty_plural from acs_attributes where attribute_name = :attribute_name and object_type = :object_type }
+ set mode "edit"
}
+ if { [exists_and_not_null widget] } {
+ if { [string is false [ams::widget_proc_exists_p -widget $widget]] } {
+ ad_return_error "[_ ams.lt_There_was_a_problem_w]" "[_ ams.lt_The_widget_specified_]"
+ }
+ ::template::element::set_properties attribute_form widget -widget select -mode display
+ }
+ set option_on_last_screen 1
+#::template::element set_properties attribute_form pretty_plural -widget hidden
+# foreach field [list attribute_name pretty_name pretty_plural] {
+# ::template::element set_properties attribute_form $field -mode display
+# }
} -on_submit {
-} -new_data {
-} -edit_data {
+ ams::widgets_init
+ if { [exists_and_not_null attribute_name] } {
+ if { [string is false [::regexp {^([0-9]|[a-z]|\_){1,}$} $attribute_name match attribute_name_matcher]] } {
+ ::template::form::set_error attribute_form attribute_name "[_ ams.lt_You_have_used_invalid]"
+ } else {
+ ::template::element::set_properties attribute_form attribute_name -mode display
+ }
+ } else {
+ if { [exists_and_not_null pretty_name] } {
+ set attribute_name [util_text_to_url -replacement "_" -text $pretty_name]
+ set attribute_name_generated_p 1
+ ::template::element::set_value attribute_form attribute_name $attribute_name
+ }
+ }
+ set required_fields [list widget pretty_name pretty_plural]
+ if { [exists_and_not_null option_fields_count] } {
+ lappend required_fields "option1"
+ }
+ foreach required_field $required_fields {
+ if { [string is false [exists_and_not_null ${required_field}]] } {
+ ::template::form::set_error attribute_form $required_field "[::template::element::get_property attribute_form $required_field label] is required"
+ }
+ }
+
+
+ # Replace the pretty_name and pretty_plural with the message key, so it is inserted correctly in the database
+# set pretty_name [lang::util::convert_to_i18n -text $pretty_name -prefix $object_type]
+# set pretty_plural [lang::util::convert_to_i18n -text $pretty_plural -prefix $object_type]
+
+ if { [exists_and_not_null widget] } {
+ ::template::element::set_properties attribute_form widget -widget select -mode display
+ }
+ if { $mode == "new" } {
+ if { [::attribute::exists_p -convert_p 0 $object_type $attribute_name] } {
+ if { [exists_and_not_null attribute_name_generated_p] } {
+ set message "[_ ams.lt_The_attribute_name_au]"
+ } else {
+ set message "[_ ams.lt_This_attribute_name_a]"
+ }
+ ::template::element::set_error attribute_form attribute_name $message
+ ::template::element::set_properties attribute_form attribute_name -mode edit
+ }
+ }
+# ::template::form::set_error attribute_form attribute_name "$mode $attribute_name $object_type"
+
+# element::create attribute_form change_widget -datatype text -widget submit -label "Change Widget"
+# { ![::attribute::exists_p $object_type $attribute_name] }
+# "Attribute $attribute_name already exists for $object_info(pretty_name)."
+
+# if { [exists_and_not_null option_fields_count] } {
+# if { xists_and_not_null options_on_last_screen] && [string is false [exists_and_not_null option1]] } {
+# ::template::form::set_error attribute_form option1 "Option 1 is required"
+# } else {
+# ::template::element::set_value attribute_form options_on_last_screen 1
+# }
+# }
+
+
+ if { [::template::form::is_valid attribute_form] } {
+
+
+ db_transaction {
+ # the form has passed all validation blocks
+# ::template::element::set_error attribute_form attribute_name "valid"
+ if { $mode == "new" } {
+ set attribute_id [attribute::new \
+ -object_type $object_type \
+ -attribute_name $attribute_name \
+ -datatype [::ams::widget -widget $widget -request "widget_datatypes"] \
+ -pretty_name $pretty_name \
+ -pretty_plural $pretty_plural]
+ set dynamic_p 1
+ } else {
+ set attribute_id [attribute::id \
+ -object_type $object_type \
+ -attribute_name $attribute_name]
+ set dynamic_p 0
+ }
+ ams::attribute::new \
+ -attribute_id $attribute_id \
+ -ams_attribute_id $ams_attribute_id \
+ -widget $widget \
+ -dynamic_p $dynamic_p
+
+ if { [ams::widget_has_options_p -widget $widget] && [exists_and_not_null option_fields_count] } {
+ set i 1
+ while { $i <= $option_fields_count } {
+ set option [set "option${i}"]
+ if { [exists_and_not_null option] } {
+ ams::option::new \
+ -attribute_id $attribute_id \
+ -option $option
+ }
+ incr i
+ }
+ }
+ }
+ } else {
+ break
+ }
} -after_submit {
- ad_returnredirect "attribute-add-2?[export_vars -url {ams_attribute_id object_type widget_name attribute_name pretty_name pretty_plural description list_id}]"
+ if { [exists_and_not_null list_id] } {
+ ams::list::attribute::map -list_id $list_id -attribute_id $attribute_id
+ ams::list::get -list_id $list_id -array list_info
+ set list_name $list_info(list_name)
+ set object_type $list_info(object_type)
+ set package_key $list_info(package_key)
+ set return_url [export_vars -base "list" -url {list_name object_type package_key return_url return_url_label}]
+ } else {
+ set return_url [export_vars -base "object" -url {object_type return_url return_url_label}]
+ }
+ ad_returnredirect -message "$pretty_name [_ ams.has_been_added_as_an_attribute_to] $object_type" $return_url
ad_script_abort
}
Index: openacs-4/packages/ams/www/attribute-option-delete.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/attribute-option-delete.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/attribute-option-delete.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/attribute-option-delete.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -9,17 +9,29 @@
} {
option_id:integer,notnull
+ {attribute_id ""}
} -validate {
option_has_no_entries -requires {option_id} {
- if { ![string match [db_string get_count { select count(*) from ams_option_map where option_id = :option_id } -default {0}] {0}] } {
- ad_complain {You cannot delete an option that already has entries on it}
- }
+ if {[empty_string_p $attribute_id]} {
+ if { ![string match [db_string get_count { select count(*) from ams_option_types where option_id = :option_id } -default {0}] {0}] } {
+ ad_complain [_ ams.lt_You_cannot_delete_an_]
+ }
+ }
}
}
-db_1row get_option_info { select * from ams_options where option_id = :option_id }
+if {[empty_string_p $attribute_id]} {
-db_dml delete_option { delete from ams_options where option_id = :option_id }
+ # Delete the option for good
+
+ db_1row get_option_info { select * from ams_options where option_id = :option_id }
+ db_dml delete_option { delete from ams_options where option_id = :option_id }
+} else {
+
+ # Just unmap the option
+
+ db_dml unmap_option { delete from ams_option_types where option_id = :option_id and attribute_id = :attribute_id }
+}
-ad_returnredirect -message "Option Deleted" "attribute?[export_vars -url {ams_attribute_id}]"
+ad_returnredirect -message "[_ ams.Option_Deleted]" "attribute?[export_vars -url {attribute_id}]"
Index: openacs-4/packages/ams/www/attribute-options-update.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/attribute-options-update.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/attribute-options-update.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/attribute-options-update.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -1,51 +1,56 @@
ad_page_contract {
-
Update sort order
@author Matthew Geddert openacs@geddert.com
@creation-date 2004-07-28
@cvs-id $Id$
-
-
} {
option:array
sort_key:array
- ams_attribute_id:integer,notnull
+ attribute_id:integer,notnull
}
-# first we check to see if there are new options.
-# if yes we add them
+
+# first we check to see if there are new options. if yes we add them
+
foreach option_key [list new1 new2 new3] {
set option_string [string trim $option(${option_key})]
- if { [exists_and_not_null option_string] } {
- set option_id [ams::option::new -ams_attribute_id $ams_attribute_id -option $option_string]
+ if {[exists_and_not_null option_string]} {
+
+ set option_id [ams::option::new \
+ -attribute_id $attribute_id \
+ -option $option_string]
+
set sort_key(${option_id}) $sort_key(${option_key})
}
}
-# now that all the options are in the database we get the "old" sort order
-# if not value for sort_key is provided we will keep the same order as before
-set option_ids [db_list get_option_ids { select option_id from ams_options where ams_attribute_id = :ams_attribute_id order by sort_order }]
+# now that all the options are in the database we get the "old" sort
+# order if not value for sort_key is provided we will keep the same
+# order as before
-# first we get the highest sort_order so variables without a sort_order can be given one
+set option_ids [db_list get_option_ids {select option_id from ams_option_types where attribute_id = :attribute_id order by sort_order}]
+
+# first we get the highest sort_order so variables without a
+# sort_order can be given one
+
set highest_sort 0
foreach option_id $option_ids {
- if { $sort_key(${option_id}) > $highest_sort } {
+ if {$sort_key(${option_id}) > $highest_sort} {
set highest_sort $sort_key(${option_id})
- }
+ }
}
-
db_transaction {
foreach option_id $option_ids {
set sort_order $sort_key(${option_id})
incr highest_sort
- db_dml update_sort_order { update ams_options set sort_order = :highest_sort where sort_order = :sort_order and ams_attribute_id = :ams_attribute_id }
- if { ![exists_and_not_null sort_order] } {
+ db_dml update_sort_order {update ams_option_types set sort_order = :highest_sort where sort_order = :sort_order and attribute_id = :attribute_id}
+ if {![exists_and_not_null sort_order]} {
incr highest_sort 1
- set sort_order $highest_sort
+ set sort_order $highest_sort
}
- db_dml update_sort_order { update ams_options set sort_order = :sort_order where option_id = :option_id }
+ db_dml update_sort_order {update ams_option_types set sort_order = :sort_order where option_id = :option_id}
}
}
-ams::attribute::flush -ams_attribute_id $ams_attribute_id
-ad_returnredirect -message "Options Updated" "attribute?[export_vars -url {ams_attribute_id}]"
+ad_returnredirect -message "[_ ams.Options_Updated]" "attribute?[export_vars \
+-url {attribute_id}]"
Index: openacs-4/packages/ams/www/attribute.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/attribute.adp,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/attribute.adp 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/attribute.adp 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -3,10 +3,13 @@
@title@@context@
-
Note: Adding an AMS List here is primarily for demonstration purposes. In order for AMS Lists to be useful you need to integrated them with your package.
+
#ams.Note# Adding an AMS List here is primarily for demonstration purposes. In order for AMS Lists to be useful you need to integrated them with your package.
+
Index: openacs-4/packages/ams/www/list-add.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/list-add.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/list-add.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/list-add.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -6,12 +6,17 @@
} {
{object_type:notnull}
{package_key ""}
+ {list_name ""}
+ {pretty_name ""}
+ {description ""}
+ {return_url ""}
+ {return_url_label ""}
}
acs_object_type::get -object_type $object_type -array "object_info"
-set title "Add List"
-set context [list [list objects Objects] [list "object?object_type=$object_type" $object_info(pretty_name)] "Add List"]
+set title "[_ ams.Add_List]"
+set context [list [list objects Objects] [list "object?object_type=$object_type" $object_info(pretty_name)] "[_ ams.Add_List]"]
set package_options " [db_list_of_lists select_packages { select package_key, package_key from apm_package_types order by package_key } ]"
@@ -21,23 +26,51 @@
ad_form -name list_form -form {
{list_id:key}
- {package_key:text(select) {label "Package Key"} {options $package_options}}
- {object_type:text(inform) {label "Object Type"}}
- {list_name:text {label "List Name"} {html {size 30 maxlength 100}} {help_text {This name must be lower case, contain only letters and underscores, and contain no spaces}}}
- {pretty_name:text {label "Pretty Name"} {html {size 30 maxlength 100}}}
- {pretty_plural:text {label "Pretty Plural"} {html {size 30 maxlength 100}}}
- {description:text(textarea),optional {label "Description"} {html {cols 55 rows 4}}}
+ {package_key:text(select) {label "[_ ams.Package_Key_1]"} {options $package_options}}
+ {object_type:text(inform) {label "[_ ams.Object_Type_1]"}}
+ {list_name:text {label "[_ ams.List_Name_1]"} {html {size 30 maxlength 100}} {help_text {[_ ams.lt_This_name_must_be_low]}}}
+ {pretty_name:text {label "[_ ams.Pretty_Name_1]"} {html {size 30 maxlength 100}}}
+ {description:text(textarea),optional {label "[_ ams.Description]"} {html {cols 55 rows 4}}}
+ return_url:text(hidden),optional
+ return_url_label:text(hidden),optional
} -new_request {
+ set uneditable_attributes [list package_key object_type list_name pretty_name description]
+ set blank_required_attributes [list]
+ foreach attribute $uneditable_attributes {
+ if { [set $attribute] != "" } {
+ template::element::set_properties list_form $attribute mode display
+ } else {
+ if { $attribute != "description" } {
+ lappend blank_required_attributes $attribute
+ }
+ }
+ }
+ # if the only blank attribute is description we can create this list (since all the data was
+ # provided by the request of this page
+ if { [string is false [exists_and_not_null blank_required_attributes]] } {
+ util_user_message -replace
+ ams::list::flush -package_key $package_key -object_type $object_type -list_name $list_name
+ ams::list::new -package_key $package_key \
+ -object_type $object_type \
+ -list_name $list_name \
+ -pretty_name $pretty_name \
+ -description $description \
+ -description_mime_type "text/plain" \
+ -context_id ""
+ ams::list::flush -package_key $package_key -object_type $object_type -list_name $list_name
+ ad_returnredirect "list?[export_vars -url {package_key object_type list_name return_url return_url_label}]"
+ ad_script_abort
+ }
} -edit_request {
} -validate {
# i need to add validation that the attribute isn't already in the database
{ list_name
{ [::regexp {^([0-9]|[a-z]|\_){1,}$} $list_name match list_name_validate] }
- "You have used invalid characters."
+ "[_ ams.lt_You_have_used_invalid]"
}
{ list_name
{ ![::ams::list::exists_p -package_key $package_key -object_type $object_type -list_name $list_name] }
- "List name $list_name already exists for $object_info(pretty_name)."
+ "[_ ams.lt_List_name_a_hrefliste]"
}
} -on_submit {
@@ -57,7 +90,7 @@
} -edit_data {
} -after_submit {
- ad_returnredirect "list?[export_vars -url {package_key object_type list_name}]"
+ ad_returnredirect "list?[export_vars -url {package_key object_type list_name return_url return_url_label}]"
ad_script_abort
}
Fisheye: Tag 1.1.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-attribute-html-options-postgresql.xql'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.1.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-attribute-html-options.adp'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.1.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-attribute-html-options.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.2.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-attribute-section-heading.adp'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.3.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-attribute-section-heading.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: openacs-4/packages/ams/www/list-attributes-map.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/list-attributes-map.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/list-attributes-map.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/list-attributes-map.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -1,17 +1,16 @@
ad_page_contract {
-
@author Matthew Geddert openacs@geddert.com
@creation-date 2004-07-28
@cvs-id $Id$
} {
- {ams_attribute_id:integer,multiple}
+ {attribute_id:integer,multiple}
{list_id:integer,notnull}
}
-foreach ams_attribute_id $ams_attribute_id {
- ams::list::attribute::map -list_id $list_id -ams_attribute_id $ams_attribute_id
+foreach attribute_id $attribute_id {
+ ams::list::attribute::map -list_id $list_id -attribute_id $attribute_id
}
ams::list::get -list_id $list_id -array "list_info"
Index: openacs-4/packages/ams/www/list-attributes-optional.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/list-attributes-optional.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/list-attributes-optional.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/list-attributes-optional.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -6,18 +6,20 @@
@cvs-id $Id$
} {
- {ams_attribute_id:integer,multiple,notnull}
+ {attribute_id:integer,multiple,notnull}
{list_id:integer,notnull}
+ return_url:optional
+ return_url_label:optional
}
-foreach ams_attribute_id $ams_attribute_id {
- ams::list::attribute::optional -list_id $list_id -ams_attribute_id $ams_attribute_id
+foreach attribute_id $attribute_id {
+ ams::list::attribute::optional -list_id $list_id -attribute_id $attribute_id
}
ams::list::get -list_id $list_id -array "list_info"
set package_key $list_info(package_key)
set object_type $list_info(object_type)
set list_name $list_info(list_name)
-ad_returnredirect "list?[export_vars -url {package_key object_type list_name}]"
+ad_returnredirect "list?[export_vars -url {package_key object_type list_name return_url return_url_label}]"
ad_script_abort
Index: openacs-4/packages/ams/www/list-attributes-required.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/list-attributes-required.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/list-attributes-required.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/list-attributes-required.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -6,18 +6,20 @@
@cvs-id $Id$
} {
- {ams_attribute_id:integer,multiple,notnull}
+ {attribute_id:integer,multiple,notnull}
{list_id:integer,notnull}
+ return_url:optional
+ return_url_label:optional
}
-foreach ams_attribute_id $ams_attribute_id {
- ams::list::attribute::required -list_id $list_id -ams_attribute_id $ams_attribute_id
+foreach attribute_id $attribute_id {
+ ams::list::attribute::required -list_id $list_id -attribute_id $attribute_id
}
ams::list::get -list_id $list_id -array "list_info"
set package_key $list_info(package_key)
set object_type $list_info(object_type)
set list_name $list_info(list_name)
-ad_returnredirect "list?[export_vars -url {package_key object_type list_name}]"
+ad_returnredirect "list?[export_vars -url {package_key object_type list_name return_url return_url_label}]"
ad_script_abort
Index: openacs-4/packages/ams/www/list-attributes-unmap.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/list-attributes-unmap.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/list-attributes-unmap.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/list-attributes-unmap.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -5,18 +5,20 @@
@cvs-id $Id$
} {
- {ams_attribute_id:integer,multiple}
+ {attribute_id:integer,multiple}
{list_id:integer,notnull}
+ return_url:optional
+ return_url_label:optional
}
-foreach ams_attribute_id $ams_attribute_id {
- ams::list::attribute::unmap -list_id $list_id -ams_attribute_id $ams_attribute_id
+foreach attribute_id $attribute_id {
+ ams::list::attribute::unmap -list_id $list_id -attribute_id $attribute_id
}
ams::list::get -list_id $list_id -array "list_info"
set package_key $list_info(package_key)
set object_type $list_info(object_type)
set list_name $list_info(list_name)
-ad_returnredirect "list?[export_vars -url {package_key object_type list_name}]"
+ad_returnredirect "list?[export_vars -url {package_key object_type list_name return_url return_url_label}]"
ad_script_abort
Fisheye: Tag 1.4.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-attributes.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.1.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-attributes.xql'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.6.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-code.adp'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.6.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-code.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.2.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-form-preview.adp'.
Fisheye: No comparison available. Pass `N' to diff?
Fisheye: Tag 1.3.2.1 refers to a dead (removed) revision in file `openacs-4/packages/ams/www/list-form-preview.tcl'.
Fisheye: No comparison available. Pass `N' to diff?
Index: openacs-4/packages/ams/www/list-order-update.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/list-order-update.tcl,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/list-order-update.tcl 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/list-order-update.tcl 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -10,31 +10,66 @@
} {
sort_key:array
list_id:integer,notnull
+} -validate {
+ ordering_is_valid -requires {sort_key} {
+ set no_value_supplied [list]
+ set no_integer_supplied [list]
+ set used_sort_orders [list]
+ set doubled_sort_orders [list]
+ foreach {attribute_id sort_order} [array get sort_key] {
+ set sort_order [string trim $sort_order]
+ if { $sort_order == "" } {
+ lappend no_value_supplied $attribute_id
+ } elseif { [string is false [string is integer $sort_order]] } {
+ lappend no_integer_supplied $attribute_id $sort_order
+ } elseif { [info exists order($sort_order)] } {
+ lappend doubled_sort_orders $attribute_id $order($sort_order)
+ } else {
+ set order($sort_order) $attribute_id
+ }
+ }
+ set error_messages [list]
+ if { [llength $no_value_supplied] } {
+ foreach attribute_id $no_value_supplied {
+ lappend error_messages "[_ ams.No_ordering_integer_was_supplied_for] [attribute::pretty_name -attribute_id $attribute_id]"
+ }
+ }
+ if { [llength $no_integer_supplied] } {
+ foreach { attribute_id sort_order } $no_integer_supplied {
+ lappend error_messages "[_ ams.The_ordering_number_is_not_an_integer_for] [attribute::pretty_name -attribute_id $attribute_id]"
+ }
+ }
+ if { [llength $doubled_sort_orders] } {
+ foreach { one_attribute_id two_attribute_id } $doubled_sort_orders {
+ lappend error_messages "[_ ams.The_ordering_number_is_the_same_for] [attribute::pretty_name -attribute_id $one_attribute_id] [_ ams.and] [attribute::pretty_name -attribute_id $two_attribute_id]"
+ }
+ }
+ if { [llength $error_messages] > 0 } {
+ foreach message $error_messages {
+ ad_complain $message
+ }
+ }
+ }
}
-
-set ams_attribute_ids [db_list get_attribute_ids { select ams_attribute_id from ams_list_attribute_map where list_id = :list_id order by sort_order }]
-
-
-# first we get the highest sort_order so variables without a sort_order can be given one
-set highest_sort 0
-set used_sorts [list]
-foreach ams_attribute_id $ams_attribute_ids {
- if { $sort_key(${ams_attribute_id}) > $highest_sort } {
- set highest_sort $sort_key(${ams_attribute_id})
- }
+set attribute_order [list]
+set sort_key_list [array get sort_key]
+foreach {attribute_id sort_order} $sort_key_list {
+ set order($sort_order) $attribute_id
+ lappend attribute_order $sort_order
}
+set ordered_list [lsort -integer $attribute_order]
+set highest_sort [db_string get_highest_sort { select sort_order from ams_list_attribute_map where list_id = :list_id order by sort_order desc limit 1 }]
+incr highest_sort
+set sort_number 1
db_transaction {
- foreach ams_attribute_id $ams_attribute_ids {
- set sort_order $sort_key(${ams_attribute_id})
- incr highest_sort 1
- db_dml update_sort_order { update ams_list_attribute_map set sort_order = :highest_sort where sort_order = :sort_order and list_id = :list_id }
- if { ![exists_and_not_null sort_order] } {
- incr highest_sort 1
- set sort_order $highest_sort
- }
- db_dml update_sort_order { update ams_list_attribute_map set sort_order = :sort_order where ams_attribute_id = :ams_attribute_id and list_id = :list_id }
+ foreach sort_order $ordered_list {
+ set attribute_id $order($sort_order)
+ db_dml update_sort_order { update ams_list_attribute_map set sort_order = :highest_sort where sort_order = :sort_number and list_id = :list_id }
+ db_dml update_sort_order { update ams_list_attribute_map set sort_order = :sort_number where attribute_id = :attribute_id and list_id = :list_id }
+ incr highest_sort
+ incr sort_number
}
}
Index: openacs-4/packages/ams/www/list.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ams/www/list.adp,v
diff -u -r1.1 -r1.1.2.1
--- openacs-4/packages/ams/www/list.adp 30 Oct 2004 00:23:54 -0000 1.1
+++ openacs-4/packages/ams/www/list.adp 30 Nov 2005 16:21:53 -0000 1.1.2.1
@@ -3,19 +3,29 @@
@context@
-
You can create a list by selecting an acs_object. Note that list creation should be done with contracting packages. These lists shows what ams can do for your package.
AMS lets developers (via tcl api) and site wide administrators (via the the ams admin UI) add attributes to acs_object. These attributes can be dynamically added at any time on a live system. AMS then helps you collect attribute information for these defined acs_objects via input forms and helps you present them to users via your website. Whenever AMS stores ams attribute information about an object it keeps track of changes made via the content repository. This way you can see who and when a user changed an object's attributes and are able to revert back to a previous state.
-
-
Defining an Attribute
-
-
Ams attributes can either be defined via the ams admin user interface or via the ams::attribute::new proc. Every ams_attribute has an ams_widget associated with it. ams_widgets define what type of information the attribute contains the information necessary to generate forms and save various funcationally different types of information. View the documentation for ams::attribute::new to see what types of widgets are available. In most cases using the ams::attribute::new proc will be too tedious to do, instead it would be a good idea to use the shorthand as defined in creating and ams_list.
-
-
AMS Lists
-
-
AMS stores attributes in ams_lists. These lists are an ordered collection of attributes and can be called upon a variety of ways. Ams_lists can be used to generate ad_forms, or return attribute information for use with your packages UI. The attributes associated with your acs_object can be returned as named variables in your calling environment, as an array or as a list via the ams::object::attribute::values proc.
-
-
To define an ams_list of the elements you use the ams::define_list. That procedure has extensive documentation about the nuances of defining an ams_list. For example, lets assume that you are developing a package called "contacts" with the object_type of "ct_contact" and you want to define a list to collect information about a contact. You might choose to run the following procedure in when your system restarts:
This will create an ams_list, define any attributes that haven't previously been defined for the ct_contact object and order the list in the order the attributes are specified.
-
-
AMS and ad_form
-
You have two options when dealing with ams and ad_form. Shorthand and detailed.
-
Shorthand
-
Shorthands is a completely simple way of creating forms without many options. These forms must only contain attributes defined in an ams_list. The supplied object_id must already exist in the acs_object table. The shorthand procs is ams_form, which is simply a wrapper for ad_form. For example, to create and ad_form named "contact_person_ae" create a page contacts/www/contact-person-ae.tcl with the following content:
That's it. If this isn't flexible enough you can also go with the detailed method.
-
-
-
Detailed
-
For many application the AMS and ad_form shorthand will be too simplistic. For those situations, you can use ams to interface with ad_form. You need to define ad_from -form elements like this:
-
Note that this procedure returns an ad form appropriate element list. If you intending to define other elements you will need to ad_from -extend -name form_name -form ...
This returns the variables upvared into your page, i.e. the first_names attribute could be returned with a value of "Jane" and the last_name attribute with a value of "Doe"... etc. ad_from looks for all form elements and appropriately pre-fills the form with the given values.
This is how you interface with AMS and ad_form. You may also specify other code in the -form -on_submit and -on_submit blocks.
-
-
AMS and your package's UI
-
-
-
to display attributes you can call ams::object::attribute::values to get the results back as upvared variables, as an array or as a list however you want. So, if on the contact-view page you do, for example to get an array with all attribute_values that are not null represented in.
-
AMS lets developers (via tcl api) and site wide administrators (via the the ams admin UI) add attributes to acs_object. These attributes can be dynamically added at any time on a live system. AMS then helps you collect attribute information for these defined acs_objects via input forms and helps you present them to users via your website. Whenever AMS stores ams attribute information about an object it keeps track of changes made via the content repository. This way you can see who and when a user changed an object's attributes and are able to revert back to a previous state.
+
+
Widgets
+
The following procs associated with it in the tcl files, this is done via tcl so
+people can actually have a "widget" represent a series of widgets in ad_form or template::form
+
+::widget::${widget}::ad_form_widget - returns a string suitable for input into ad_form, it gets: attribute, pretty_name, value
+::widget::${widget}::ad_form_save - saves the input to an ad_form widget and returns a value_id
+::widget::${widget}::ad_form_value - returns a value suitable for input into ad_form, it gets, attribute, attribute_id and value
+::widget::${widget}::template_form_widget - runs a proc suitable for template::form, it gets: pretty_name, attribute, attribute_id, value
+::widget::${widget}::template_form_save - saves the input to an termplate::form widget and returns a value_id
+::widget::${widget}::template_form_value - returns a value suitable for input into ad_form, it gets, attribute, attribute_id and value
+::widget::${widget}::value_text - return the value formatted for text output, value is provided - this in the future will allow for search indexing of this data
+::widget::${widget}::value_html - return the value formatted for html output, value is provided
+::widget::${widget}::csv_value - return the value formatted for csv output, value and attribute are provided
+::widget::${widget}::csv_headers - return the value formatted for csv output, attribute is provided, for example, if returning a postal address we woudl return ${attribute}__country and ${attribute}__city, etc. For something such as gender we would simply return ${attribute}
+::widget::${widget}::csv_save - save the value provided by csv, the input into this proc will be ${attribute}__subitem $value ${attribute}__subitem $value, its assumed that the cvs_headers will all be provided and that if there is no input a blank field will be supplied.
+
+
+
+::widget::${widget}::datatypes
+
+-- ams_widget_datatype_map is simplifies the selection of widgets to associate
+-- with an attribute. This allows us to present an administrator with list of valid
+-- widgets she can select for assocation with a particular datatype.
+
+create table ams_widget_datatype_map (
+ widget varchar(100)
+ constraint ams_widget_datatype_map_fk references ams_widgets(widget)
+ constraint ams_widget_datatype_map_nn not null,
+ datatype varchar(50)
+ constraint ams_widget_datatype_map_datatype_fk references acs_datatypes(datatype)
+ constraint ams_widget_datatype_map_datatype_nn not null
+);
+
+
+
+
+
Defining an Attribute
+
+
Ams attributes can either be defined via the ams admin user interface or via the ams::attribute::new proc. Every ams_attribute has an ams_widget associated with it. ams_widgets define what type of information the attribute contains the information necessary to generate forms and save various funcationally different types of information. View the documentation for ams::attribute::new to see what types of widgets are available. In most cases using the ams::attribute::new proc will be too tedious to do, instead it would be a good idea to use the shorthand as defined in creating and ams_list.
+
+
AMS Lists
+
+
AMS stores attributes in ams_lists. These lists are an ordered collection of attributes and can be called upon a variety of ways. Ams_lists can be used to generate ad_forms, or return attribute information for use with your packages UI. The attributes associated with your acs_object can be returned as named variables in your calling environment, as an array or as a list via the ams::object::attribute::values proc.
+
+
To define an ams_list of the elements you use the ams::define_list. That procedure has extensive documentation about the nuances of defining an ams_list. For example, lets assume that you are developing a package called "contacts" with the object_type of "ct_contact" and you want to define a list to collect information about a contact. You might choose to run the following procedure in when your system restarts:
This will create an ams_list, define any attributes that haven't previously been defined for the ct_contact object and order the list in the order the attributes are specified.
+
+
AMS and ad_form
+
You have two options when dealing with ams and ad_form. Shorthand and detailed.
+
Shorthand
+
Shorthands is a completely simple way of creating forms without many options. These forms must only contain attributes defined in an ams_list. The supplied object_id must already exist in the acs_object table. The shorthand procs is ams_form, which is simply a wrapper for ad_form. For example, to create and ad_form named "contact_person_ae" create a page contacts/www/contact-person-ae.tcl with the following content:
That's it. If this isn't flexible enough you can also go with the detailed method.
+
+
+
Detailed
+
For many application the AMS and ad_form shorthand will be too simplistic. For those situations, you can use ams to interface with ad_form. You need to define ad_from -form elements like this:
+
Note that this procedure returns an ad form appropriate element list. If you intending to define other elements you will need to ad_from -extend -name form_name -form ...
This returns the variables upvared into your page, i.e. the first_names attribute could be returned with a value of "Jane" and the last_name attribute with a value of "Doe"... etc. ad_from looks for all form elements and appropriately pre-fills the form with the given values.
This is how you interface with AMS and ad_form. You may also specify other code in the -form -on_submit and -on_submit blocks.
+
+
AMS and your package's UI
+
+
+
to display attributes you can call ams::object::attribute::values to get the results back as upvared variables, as an array or as a list however you want. So, if on the contact-view page you do, for example to get an array with all attribute_values that are not null represented in.
+
