Config_file

• objects are configured automatically by AGENCY
• You can refine the configuration of an object by creating a config file
• Changes to a config file will not take effect until you update the engine array
• There are many options you can use in a config file
• Some options apply to the whole object, others to a particular field
• You only have to specify options where you want something other than the default.
• When viewing a record, there are links to view the config file, as well as the [Def_array]

• Most of the options below were configured automatically. The config file for client note is short, and looks like this:

  $engine['client_note']=array(
  'list_fields'=>array('added_at','added_by','note','flag_entry_codes'),
  'fields'=>array(
  'is_front_page'=>array(
  'label'=>'Front Page?',
  'comment'=>'Select "No" to archive this note'."\n".'(i.e. remove from prominent display)'
  ),
  'flag_entry_codes' => array(
  'label'=>'Flag For Entry Notification',
  'lookup_format'=>'checkbox_v',
  'comment'=>'Selecting a location will display note on gatekeeping machine'."\n"
  .'in that location\'s lobby when client\'s card is swiped.'
  )
  )
  );

• These are example of object options: (from client note)

  [object] => client_note
  [table] => client_note
  [add_another_password_cycle] => 10
  [add_link_show] => 1
  [include_info_additional] => 1
  [delete_another_password_cycle] => 10
  [singular] => Client Note
  [plural] => Client Notes
  [multi_records] => 1
  [duplicate_posting_window] => 1
  [id_field] => client_note_id
  [list_columns] => 1
  [list_max] => 50
  [list_position] => 0
  [list_reverse] =>
  [parent_show] => 1
  [post_with_transactions] => 1
  [require_delete_comment] => 1
  [require_password] => 1
  [sel_sql] => SELECT * FROM client_note
  [stamp_adds] => 1
  [stamp_changes] => 1
  [stamp_deletes] => 1
  [table_post] => tbl_client_note
  [verify_on_post] => 1
  [allow_add] => 1
  [allow_delete] =>
  [allow_edit] => 1
  [allow_list] => 1
  [allow_view] => 1
  [allow_download] => 1
  [perm_add] => any
  [title_add] => ucwords("{$action}ing {$def["singular"]}")
  [title_format_add] => bigger(bold($x))
  [perm_edit] => any
  [title_edit] => ucwords("{$action}ing {$def["singular"]}")
  [title_format_edit] => bigger(bold($x))
  [perm_delete] => any
  [title_delete] => ucwords("{$action}ing {$def["singular"]}")
  [title_format_delete] => bigger(bold($x))
  [perm_view] => any
  [title_view] => ucwords("{$action}ing {$def["singular"]}")
  [title_format_view] => bigger(bold($x))
  [perm_list] => any
  [title_list] => ucwords("{$action}ing {$def["singular"]} records")
  [title_format_list] => bigger(bold($x))
  [perm_download] => any
  [title_download] => ucwords("{$action}ing {$def["singular"]}")
  [title_format_download] => bigger(bold($x))
  [list_fields] => Array
  (
  [0] => added_at
  [1] => added_by
  [2] => note
  [3] => flag_entry_codes
  )
  [fn] => Array
  (
  [add_fields] => add_fields_generic
  [auto_close] => auto_close_generic
  [cancel_url] => cancel_url_generic
  [delete] => delete_generic
  [form] => form_generic
  [form_row] => form_generic_row
  [view] => view_generic
  [view_row] => view_generic_row
  [blank] => blank_generic
  [generate_list] => generate_list_generic
  [generate_list_medium] => generate_list_medium_generic
  [generate_list_long] => generate_list_long_generic
  [get] => get_generic
  [get_active] => get_active_generic
  [valid] => valid_generic
  [confirm] => confirm_generic
  [object_merge] => object_merge_generic
  [post] => post_generic
  [process] => process_generic
  [list] => list_generic
  [rec_changed] => rec_changed_generic
  [rec_collision] => rec_collision_generic
  [show_query_row] => show_query_row_generic
  [engine_record_perm] => engine_record_perm_generic
  [title] => title_generic
  [list_title] => list_title_generic
  [process_staff_alert] => process_staff_alert_generic
  [init_form] => init_form_generic
  [form_list_header] => form_list_header_generic
  [form_list_row] => form_list_row_generic
  [view_list_row] => view_list_row_generic
  [form_list] => form_list_generic
  [multi_add_title] => multi_add_title_generic
  [multi_record_passed] => multi_record_passed_generic
  [post_multi_records] => post_multi_records_generic
  [multi_record_allow_common_fields] => multi_record_allow_common_fields_generic
  [view_list] => view_list_generic
  [multi_add_after_post] => multi_add_after_post_generic
  [multi_add_blank] => multi_add_blank_generic
  [multi_hide_fields] => multi_hide_fields_generic
  )
  [multi] => Array
  (
  [info_additional] => Array
  (
  [sub_title] => Additional Information
  [multi_fields] => info_additional_value
  [object] => info_additional
  [field] => info_additional_type_code
  [blank_fn] => blank_generics_add
  [add_fields_fn] => add_generics_fields
  [form_row_fn] => form_generics_row
  [valid_fn] => valid_generics
  [post_fn] => post_generics
  [sel_sql] => SELECT * FROM info_additional_type WHERE 'client_note' = ANY(applicable_tables)
  [allow_none] => 1

• Here is a list of field-level options:

         [client_note_id] => Array
             (
                 [data_type] => integer
                 [length] => 65
                 [null_ok] => t
                 [require_comment_codes] => Array
                     (
                     )
                 [display_add] => hide
                 [comment_show_add] => 1
                 [post_add] => 
                 [value_add] => $x
                 [value_format_add] => $x
                 [label_add] => Client Note Id
                 [label_format_add] => $x
                 [display_edit] => display
                 [comment_show_edit] => 1
                 [post_edit] => 
                 [value_edit] => $x
                 [value_format_edit] => $x
                 [label_edit] => Client Note Id
                 [label_format_edit] => $x
                 [display_delete] => display
                 [comment_show_delete] => 
                 [post_delete] => 
                 [value_delete] => $x
                 [value_format_delete] => $x
                 [label_delete] => Client Note Id
                 [label_format_delete] => $x
                 [display_view] => display
                 [comment_show_view] => 
                 [value_view] => $x
                 [value_format_view] => $x
                 [label_view] => Client Note Id
                 [label_format_view] => $x
                 [display_list] => display
                 [comment_show_list] => 
                 [value_list] => $x
                 [value_format_list] => $x
                 [label_list] => Id
                 [label_format_list] => $x
                 [display_download] => display
                 [comment_show_download] => 
                 [value_download] => $x
                 [value_format_download] => $x
                 [label_download] => Client Note Id
                 [label_format_download] => $x
  

[Category:admin]