Member picker

[Mike]

Is it possible to pick a members name
With the search feature in the plugin ui?

[Chris]

You can indeed search for member names to populate your plugin configuration, in fact, the default selection when adding a search control to your UI is a member.

SPOILER: Click to show

You also have access to member search in your coding

pb.member.select();
Read the PBJS API entry for the list of options you can specify when making the API call.

SPOILER: Click to show

[Mike]

Chris
Do have to run it through for loop or
A if statement.

[Chris]

Can pick one or pick one hundred and one, no need for a loop, see documentation

[Mike]

Chris
Please explain Pb.member.sellect() I'm not sure how to use that in code.
I did click on the link but still clueless.

[Chris]

select( [options], callback )

Loads a user search box in a dialog and calls a return function on finish.
Note: Only admins will be able to access this function.

Parameters

• [options] Object Optional
  Additional options:
  • [title] String Optional
    The title of this dialog box.
    Defaults To: User Selection
  • [selected] Array Optional
    An array of user IDs to start selected.
  • [max] Number Optional
    The maximum number of allowed selections; a value of 0 means no maximum.
• callback Function
  Function to call when members have been selected. The first argument is an array of member IDs.

Tip: Parameters surrounded by square brackets signify it is optional (not necessary for the function to work). So in the select( [options], callback ) the "options" argument is optional. The callback function argument you supply is called once the user has made their selection and it is sent an array of the users that were selected (can be an empty array if user made no selection and merely clicked done)

Examples

• Specify a custom dialog title and limit to choosing a max of one user

  pb.member.select({
   title: 'Pick One User Only',
   max: 1
}, function callback(chosen_users_array) {
   console.log(chosen_users_array);
});
  
  
  SPOILER: Click to show
  
  

  Data received in callback function

  [
   {
       "id": 169267,
       "name": "Mike",
       "username": "riccetts",
       "group": "v6 Alpha Tester"
   }
]
  
  
  
  

• Pre-select three members and ask user to select one more (max of 4)

  pb.member.select({
   selected: [1,2, 1480],
   max: 4
}, function callback(chosen_users_array) {
   if(chosen_users_array.length){
console.log(chosen_users_array);
}
});
  

  Note: You'll get an error on this one if the person making the selection is not capable of viewing profiles (such as a guest) since it prepopulates the dialog with micro-profiles.

  
  
  SPOILER: Click to show
  
  

  Data received in callback function

  [
   {
       "id": 1,
       "name": "Patrick Clinger",
       "username": "admin",
       "group": "ProBoards Admin"
   },
   {
       "id": 2,
       "name": "Martyn Dale",
       "username": "martyn",
       "group": "ProBoards Admin"
   },
   {
       "id": 1480,
       "name": "Craig",
       "username": "cmdynasty",
       "group": "Support Helper"
   },
   {
       "id": 169267,
       "name": "Mike",
       "username": "riccetts",
       "group": "v6 Alpha Tester"
   }
]
  
  
  
  

If you need more examples let me know.

[Mike]

Chris
I'm afraid I'm going to need another example.
My code:

if (pb.member.select(function(){
     
                    var mem=pb.plugin.get('member_of_the_month').settings.member;
                   motm_div+='<p id="goo"style="color:#'+cot+';">Congradulations!<br>'+mem+'</p>';
  });

Is this even close?
Thanks for patients

[Chris]

May 15, 2022 12:03:59 GMT -8 Mike said:

Chris
I'm afraid I'm going to need another example.
My code:

if (pb.member.select(function(){
     
                    var mem=pb.plugin.get('member_of_the_month').settings.member;
                   motm_div+='<p id="goo"style="color:#'+cot+';">Congradulations!<br>'+mem+'</p>';
  });

Is this even close?
Thanks for patients

i

select( [options], callback )

Loads a user search box in a dialog and calls a return function on finish.

You handle whatever is chosen within the callback function, there is no return value from the pb.member.select call so putting it in an "if" makes no sense.

pb.member.select(function(chosen_users){
   
/*
DO SOMETHING HERE WITH THE USER(S) THAT WERE CHOSEN
THEY ARE IN THE chosen_users VARIABLE PASSED TO YOUR FUNCTION
*/
})

If you want to limit to ONLY ONE USER (MOTM) then you need to add the option to include a "max" of 1

pb.member.select({max:1},function( chosen_users){
   
/*
DO SOMETHING HERE WITH THE USER(S) THAT WERE CHOSEN
THEY ARE IN THE chosen_users VARIABLE PASSED TO YOUR FUNCTION
*/
});

[Mike]

Thanks Chris

[Mike]

Chris
I'm not sure why this wouldn't work.
So I'm showing you the code.

$(document).ready(function(){
   
   var avat=pb.plugin.get('member_of_the_month').settings.image;
   var bgrd=pb.plugin.get('member_of_the_month').settings.background_color;
   var cot=pb.plugin.get('member_of_the_month').settings.motm.color_of_title;
   
               var motm_div='<div id="jump" style="width:185px;float:right;background:#'+bgrd+';text-align:left;">';
                   motm_div+='<div id="bar" style="font-weight:bold;color:#'+cot+';font-size:14px;"> Member of the month</div><br>';
                   motm_div+='<div id="panel" >';
                   motm_div+='<img id="pics" src="'+avat+'" width="183px"><br>';
                  pb.member.select({
   title: 'Pick One User Only',
   max: 1
}, function callback(choose_users) {
   
                   motm_div+='<p id="goo"style="color:#'+cot+';">Congradulations!<br>'+pb.plugin.get('member_of_the_month').settings.choose_users+'</p>';
                  })
                   motm_div+='</div>';
                   motm_div+='</div>';
                   motm_div+='<br>';
               
   $('#motm').html(motm_div);
   
});


It still is not showing up when I save.
I want the users name to show up in the paragraph.

[Chris]

I have no idea what you named anything in your plugin but pb.plugin.get('member_of_the_month').settings.choose_users (if it exists in your plugin setting) would be different than the choose_users variable that gets passed to your callback function. The variable as stated earlier would be an array of user objects (open the spoilers in my examples post to see the structure of the data inside the array sent to your callback function once the user has made a choice)

Also, be aware that the callback function is asynchronous^[1] meaning it is called when the user has made a choice (it could be 3 seconds or 3 days) so you should not be trying to build an HTML string and depending on the asynchronous callback to contribute to that string. The better approach would be to add the paragraph outside of the callback, then in the callback, you can use the id you gave the paragraph to insert the chosen member's name.

//...
motm_div += '<p id="goo" style="color:#' + cot + ';"></p>';
pb.member.select({
   title: 'Pick One User Only',
   max: 1
}, function callback(choose_users) {
   /* choose_users could be an empty array (user clicked done without selecting someone) */
if (choose_users.length) {
/* Since limited to one choice then user at index zero should be the only choice in the array */
/* Grab the chosen user's name and add it to the paragraph with the id of goo */
$('#goo').html('Congradulations!<br>' + choose_users[0].name);
   }
})

//...

You also have to consider persistence if when that next page loads you want the choice that was made to be available and can be displayed until a new choice is made. That's where a plugin keys comes in when your intent is to have everyone vote on the next MOTM then tabulate the results at the end of the month.

---

1.

in "synchronous" systems, things "wait" for other things, while in "asynchronous" systems, things don't "wait"

The lines following your call to pb.member.select would immediately execute since the call is asynchronous (your callback will be called when it is ready to be called) so there will be no wait and your HTML string would not be what you envisioned.

[Mike]

Chris
I got it to work but i was hoping to choose a member from within the plugin ui (like picking a theme for the plugin)
also would like to pick members from a list like the themes.
Is this possible?

[Chris]

Sept 10, 2022 8:03:16 GMT -8 Mike said:

Chris
I got it to work but i was hoping to choose a member from within the plugin ui (like picking a theme for the plugin)
also would like to pick members from a list like the themes.
Is this possible?

[Mike]

Chris
The picker shows up on my home page
I also have that in the ui setup.
I don't want it to show up on the home page.

[Chris]

Mike I'm not understanding what you are asking here.
You were shown both ways to choose a forum user (in the plugin configuration UI or as a dialog presented to the forum member)