Differences

This shows you the differences between two versions of the page.

--- newdevs:angularclient:basicadmin [2025/03/28 12:21] – messy first draft sleary
+++ newdevs:angularclient:basicadmin [2025/04/02 15:59] (current) – syntax highlighting sleary
@@ Line 1: / Line 1: @@
 ====== Using the Basic Admin Page Component ======
-* creates a basic grid with editing dialog
+  * creates a basic grid with editing dialog
-* most arguments are pass-throughs for the grid and fieldmapper editor
+  * most arguments are pass-throughs for the grid and fieldmapper editor
-* the recordLabel input is what gets used on the "New $THING" toolbar button / action menu
+  * the recordLabel input is what gets used on the "New $THING" toolbar button / action menu
-* note magic URLs! use them to replace the auto-generated interfaces with your own
+  * note magic URLs! use them to replace the auto-generated interfaces with your own
-* * admin/local/ + schema + class = admin/local/config/copy_alert_type
+    * admin/local/ + schema + class = admin/local/config/copy_alert_type
-* * edit admin/local splash or admin/server splash links as appropriate
+    * edit admin/local splash or admin/server splash links as appropriate
-* you do not need <eg-fm-editor>! You can use your own, but you will have to create a bunch of scaffolding for opening and closing the editing dialog.
+  * you do not need <eg-fm-editor>! You can use your own, but you will have to create a bunch of scaffolding for opening and closing the editing dialog.
-* you will have to create an SQL upgrade file + 950.seed data for your grid settings
+  * you will have to create an SQL upgrade file + 950.seed data for your grid settings
 ===== Using the Fieldmapper Editor =====
@@ Line 16: / Line 16: @@
 To render a combobox, set that field's options to customValues: myComboBoxEntriesArray:
+<code html>
    [fieldOptions]="{
     myFieldName1: {customValues: myComboBoxEntriesArray}
    }"
+</code>
 To render a custom template (with optional context arguments), set:
+<code html>
    [fieldOptions]="{
      myFieldName1: {customTemplate: {template: myTemplateRefHashFor1}},
      myFieldName2: {customTemplate: {template: myTemplateRefHashFor2, context: {letVarName: myFieldName2ContextData}}}
    }"
+</code>
 for example:
+<code html>
    [fieldOptions]="{
       event: {customTemplate: {template: eventTemplate}},
@@ Line 45: / Line 49: @@
     </output>
    </ng-template>
+</code>
 Always use:
@@ Line 56: / Line 61: @@
 Use ''pcrud.retrieve()'' to fetch a row by its primary key:
+<code JavaScript>
    pcrud.retrieve('aou', 1).then( org => console.log(org.shortname()) );
+</code>
 Use ''pcrud.search()'' to do a full query with a WHERE object (the second argument):
+<code JavaScript>
    pcrud.search('aou', {id : [1,2,3]}).then( orgs => console.log(orgs.length) );
+</code>
 Use ''pcrud.search()'' with a third argument to add limit, order_by, and fleshing:
+<code JavaScript>
    pcrud.search('aou', {id : {'!=' : null}}, {limit : 10}).then( orgs => {
      for (const org of orgs) {
@@ Line 71: / Line 79: @@
      }
    } );
+</code>
+  * Note that booleans are given as '''t''' or '''f'''
-  * Note that booleans are given as 't' or 'f'
+  * order_by is an object where the keys are the classnames and the values are strings with the field name, then a space, then the direction (''ASC'' or ''DESC'')
-  * order_by is an object where the keys are the classnames and the values are strings with the field name, then a space, then the direction (ASC or DESC)
 Record notes example:
+<code JavaScript [enable_line_numbers="true"]>
             const where = {
               record: this.recId,
@@ Line 103: / Line 112: @@
                     complete: this.emitNoteCount
                 }));
+</code>
 ==== Fleshing ====
-flesh_fields is an object where the keys are the classnames and the values are arrays of field names.
+''flesh_fields'' is an object where the keys are the classnames and the values are arrays of field names. ''flesh'' is the recursion depth.
+Note that only pcrud is capable of fleshing; cstore is not. This means org unit settings cannot be fleshed! If you need to turn a user or OU ID into a name from settings data, you will need to add some logic to fetch those separately.
+==== IDL vs. Hash ====
+Pcrud returns columns as functions:
+<code JavaScript>
+   org.shortname();
+</code>
+To set a new value, pass the value as an argument:
+<code JavaScript>
+   note.value(new_note_text);
+</code>
+The IDL service has a toHash() method that can make this easier to work with if all you're doing is reading data:
+<code JavaScript>
+  idl.toHash(org_unit);
+  console.debug("Org unit is:", org_unit.shortname);
+</code>
+Note there is an option to flatten the data.
+As of 3.15, there is also a way to go from a hash back to a proper IDL object:
+<code JavaScript>
+  idl.fromHash(some_object, 'aou');
+</code>
+The classname is the second argument. There is an optional third argument to convert booleans from '''t/f''' to ''true/false''