Go Back   vb.org Archive > vBulletin Article Depository > Read An Article > vBulletin 3 Articles
Reload this Page Create pages for the AdminCP
FAQ Community Calendar Today's Posts Search

Reply
Page 1 of 5 1 23 Last »
 
Thread Tools
Create pages for the AdminCP
Dream's Avatar
Dream
Join Date: Oct 2001
Posts: 2,251

I?m only happy when it rains I?m only happy when it?s complicated And though I know you can?t appreciate it I?m only happy when it rains You know I love it when the news is bad Why it feels so good to feel so sad I?m only happy when it rains

Show Printable Version Email this Page Subscription
Dream Dream is offline 06-14-2005, 10:00 PM
I was going to spend some time researching this, so I figured I could help some people save time by writing it down.

This is not a full tutorial, more of a kick-off, and its aimed at developers.


How to add a link to the AdminCP left side navigation:

Please refer to KirbyDE's [How to] Add entries to AdminCP Navigation Menu (in 3.5) thread.


Basic AdminCP page code:

PHP Code:
<?php
// ######################## SET PHP ENVIRONMENT ###########################
error_reporting(E_ALL & ~E_NOTICE);
@set_time_limit(0);
 
// #################### PRE-CACHE TEMPLATES AND DATA ######################
$phrasegroups = array('style');
$specialtemplates = array('products');
 
// ########################## REQUIRE BACK-END ############################
require_once('./global.php');
require_once(DIR . '/includes/adminfunctions_template.php');
 
print_cp_header();
 
 
 
 
 
 
 
 
 
print_cp_footer();
?>

This is the basic code. Its already password protected, so if you create a myscript.php with that code and upload to the "admincp" folder, you can call it from a browser and it will ask for the admin password.

You can use "ignore_user_abort(true);" as described in this post.

You can use can_administer() to check for admin permissions, 'canadminstyles' in this case:

PHP Code:
 // ######################## CHECK ADMIN PERMISSIONS #######################
if (!can_administer('canadminstyles'))
{
    print_cp_no_permission();
} 
(gonna add the permissions list here)

(to-do: describe print_cp_header() optional parameters title, onload, headinsert, marginwidth and bodyattributes defined in adminfunctions.php)

You can put anything you like inside the html page. vBulletin has a good number of standard functions that builds the html code for you. These functions can be found in "admincp/adminfunctions.php" (thanks Zero Tolerance for pointing it out). Im going to describe them in this how-to as time lets me.



Creating a message box with a "go back" link: example image

PHP Code:
print_cp_message('This is a control panel message box.'); 
Creating a redirection message: example image

In this example the page will be redirected to Google in 10 seconds.
PHP Code:
print_cp_message('This is a control panel message box.', 'http://google.com', 
10); 



Creating a table: example

The standard table has 2 columns.

PHP Code:
print_table_start();
 print_table_header("Table Title");
 
 echo '<tr><td class="alt1" colspan="2">table content</td></tr>';
 
 print_table_footer(2, '', '', 0); 
An empty "print_table_footer" adds a "</form>" after closing the table.


Function "print_table_footer" parameters (from adminfunctions.php)

Quote:
Prints a closing table tag and closes the form tag if it is open

* colspan integer Column span of the optional table row to be printed
* rowhtml string If specified, creates an additional table row with this code as its contents
* tooltip string Tooltip for optional table row
* echoform boolean Whether or not to close the <form> tag

function print_table_footer( colspan, rowhtml, tooltip, echoform )



Creating a form:

vBulletin has standard functions to build forms. You call "print_form_header()", which opens the form and table tags, call a few functions to build the form inputs, and then close the form with a submit button row.

An empty form example

PHP Code:
print_form_header('myscript');
print_table_header('Empty Form');

# table rows

print_submit_row("Submit!"); 
Function "print_form_header" parameters (from adminfunctions.php)

Quote:
Prints the standard form header, setting target script and action to perform

* phpscript string PHP script to which the form will submit (ommit file suffix)
* do string 'do' action for target script
* uploadform boolean Whether or not to include an encoding type for the form (for file uploads)
* addtable boolean Whether or not to add a <table> to give the form structure
* name string Name for the form - <form name="$name" ... >
* width string Width for the <table> - default = '90%'
* target string Value for 'target' attribute of form
* echobr boolean Whether or not to place a <br /> before the opening form tag
* method string Form method (GET / POST)

function print_form_header( phpscript, do, uploadform, addtable, name, width, target, echobr, method )



Input functions for a table:

Here I'll use common examples, but each function has a set of parameters that should be read in "admincp/adminfunctions.php" if you are going to use them.

Text input example

PHP Code:
print_input_row('Type your name', 'inputname'); 
Text area example

PHP Code:
print_textarea_row('This is a textarea row', 'inputname'); 
Yes / No radios example

PHP Code:
print_yes_no_row('Should I finish this how-to', 'radioname'); 
Yes / No / other radios example

PHP Code:
print_yes_no_other_row('What you think', 'inputname', 'maybe'); 
"Yes" radio example

PHP Code:
print_yes_row('Want it', 'inputname', 'nah', 0); 
Multiple radios example

PHP Code:
print_radio_row('This is a radio row', 'inputname', array( 'ya' => 'ya', 
'nah' => 'nah' )); 
Select example

PHP Code:
print_select_row('This is a select row', 'inputname', array(
 'value1' => 'option1', 'value2' => 'option2')); 
Single checkbox example

PHP Code:
print_checkbox_row('This is a checkbox row', 'inputname'); 
Password example

PHP Code:
print_password_row('This is a password row', 'inputname'); 
Date example

PHP Code:
print_time_row('Date'); 


Other functions to use inside tables:

Description row example

PHP Code:
print_description_row('This is a description row', 0, 2, 'thead'); 
Two cell row example

PHP Code:
print_label_row('Left cell content', 'Right cell content'); 
Horizontal rule row example

PHP Code:
print_hr_row(); 
Get next alternating row class (alt1/alt2)

PHP Code:
fetch_row_bgclass(); 


Submit / Reset buttons row:

This closes the form and table tags, so you don't have to use "print_table_footer" with it.

Submit and reset buttons example
PHP Code:
print_submit_row("Submit!"); 
Submit only
PHP Code:
print_submit_row("Submit!", 0); 







seems I underestimated the ammount of work. should I bother finishing this? gotta work on this more later anyway.

trying to keep the second post for myself... nope automerges

not sure the best formatting... playing around...
Attached Images
File Type: gif print_input_row.gif (1.2 KB, 0 views)
File Type: gif print_submit_row.gif (2.0 KB, 0 views)
File Type: gif print_yes_no_row.gif (1.4 KB, 0 views)
File Type: gif print_description_row.gif (2.4 KB, 0 views)
File Type: gif print_label_row.gif (1.1 KB, 0 views)
File Type: gif print_select_row.gif (1.5 KB, 0 views)
File Type: gif print_textarea_row.gif (2.4 KB, 0 views)
File Type: gif print_cp_message.gif (8.3 KB, 0 views)
File Type: gif print_cp_message_redir.gif (5.2 KB, 0 views)
File Type: gif table_complete.gif (3.0 KB, 0 views)
Reply With Quote
  #2  
Old 06-15-2005, 08:17 AM
Marco van Herwaarden Marco van Herwaarden is offline
 
Join Date: Jul 2004
Posts: 25,415
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Thanks,

Just 1 comment, "ignore_user_abort(true);" is not needed/wanted for most scripts.
Reply With Quote
  #3  
Old 06-15-2005, 05:25 PM
Dream's Avatar
Dream Dream is offline
 
Join Date: Oct 2001
Posts: 2,251
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Quote:
Originally Posted by MarcoH64
Thanks,

Just 1 comment, "ignore_user_abort(true);" is not needed/wanted for most scripts.
what does it do?
Reply With Quote
  #4  
Old 06-15-2005, 05:36 PM
Andreas's Avatar
Andreas Andreas is offline
 
Join Date: Jan 2004
Location: Germany
Posts: 6,863
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Quote:
Originally Posted by Dream
what does it do?
http://www.php.net/manual/en/functio...user-abort.php

In other words: If this is set to true the script will continue to run until it's normal end even if the user gets disconnected (network outage, hit stop in browser, etc.)
Reply With Quote
  #5  
Old 06-18-2005, 04:48 AM
Ron1n Ron1n is offline
 
Join Date: Jun 2004
Posts: 373
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
whats the diff between print_cp_message and print_stop_message?
Reply With Quote
  #6  
Old 06-18-2005, 05:41 PM
Dream's Avatar
Dream Dream is offline
 
Join Date: Oct 2001
Posts: 2,251
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
print_stop_message is just to get an error phrase name as parameter and call print_cp_message

from admincp/adminfunctions.php (3.5 beta 2)

Quote:
Halts execution and shows a message based upon a parsed phrase

After the first parameter, this function can take any number of additional
parameters, in order to replace {1}, {2}, {3},... {n} variable place holders
within the given phrase text. The parsed phrase is then passed to print_cp_message()

Note that a redirect can be performed if CP_REDIRECT is defined with a URL

* phrasename string Name of phrase (from the Error phrase group)
* param_2 string 1st variable replacement {1}
* param_3 string 2nd variable replacement {2}
* param_n string Nth variable replacement {n}

function print_stop_message( phrasename )

these images have nothing to do with this post
Attached Images
File Type: gif print_checkbox_row.gif (886 Bytes, 0 views)
File Type: gif print_hr_row.gif (457 Bytes, 0 views)
File Type: gif print_password_row.gif (813 Bytes, 0 views)
File Type: gif print_radio_row.gif (1.2 KB, 0 views)
File Type: gif print_time_row.gif (1.9 KB, 0 views)
File Type: gif print_yes_no_other_row.gif (1.5 KB, 0 views)
File Type: gif print_yes_row.gif (911 Bytes, 0 views)
File Type: gif empty_form.gif (7.1 KB, 0 views)
File Type: gif table.gif (3.1 KB, 0 views)
Reply With Quote
  #7  
Old 02-14-2006, 02:06 PM
Rich's Avatar
Rich Rich is offline
 
Join Date: Mar 2004
Location: U.S.A
Posts: 921
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Edit: Figured it out.
Reply With Quote
  #8  
Old 02-27-2006, 10:12 AM
jim6763nva's Avatar
jim6763nva jim6763nva is offline
 
Join Date: Oct 2005
Location: Virginia
Posts: 204
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Dream,

Thank you very much for taking the time to put this tutorial together! This is a huge help to getting started making custom pages for the admincp. Hopefully you will continue adding more information to this.

Kudos!

Jim
Reply With Quote
  #9  
Old 03-31-2006, 10:21 AM
Antivirus's Avatar
Antivirus Antivirus is offline
 
Join Date: Sep 2004
Location: Black Lagoon
Posts: 1,090
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Dream, this is a huge help, thanks! I am stumped however, on how to include 1 or more wysiwyg inputs in an admincp page. I know this is an unusual request, but for my next hack, it's required to enter content this way. Can you add this info to the tutorial please, or possibly write another tutorial dedicated to the wysiwyg?
Reply With Quote
  #10  
Old 03-31-2006, 05:40 PM
Reven Reven is offline
 
Join Date: Aug 2005
Location: UK
Posts: 113
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
It's great, but a lot of the links to the example images are being parsed as off-site links, such as http://attachment.php?attachmentid=whatever, instead of https://vborg.vbsupport.ru/attachmen...entid=whatever. Really annoying. Other than that, a great tutorial, which I will surely use at some point.
Reply With Quote
Reply
Page 1 of 5 1 23 Last »

« Previous Thread | Next Thread »

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts
BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Forum Jump


All times are GMT. The time now is 10:36 AM.

Contact Us - Archive - Top

Powered by vBulletin® Version 3.8.12 by vBS
Copyright ©2000 - 2024, vBulletin Solutions Inc.
X vBulletin 3.8.12 by vBS Debug Information
  • Page Generation 0.05010 seconds
  • Memory Usage 2,415KB
  • Queries Executed 26 (?)
More Information
Template Usage:
  • (1)SHOWTHREAD
  • (1)ad_footer_end
  • (1)ad_footer_start
  • (1)ad_header_end
  • (1)ad_header_logo
  • (1)ad_navbar_below
  • (1)ad_showthread_beforeqr
  • (22)bbcode_php
  • (5)bbcode_quote
  • (1)footer
  • (1)forumjump
  • (1)forumrules
  • (1)gobutton
  • (1)header
  • (1)headinclude
  • (1)modsystem_article
  • (1)navbar
  • (4)navbar_link
  • (120)option
  • (1)pagenav
  • (1)pagenav_curpage
  • (2)pagenav_pagelink
  • (10)post_thanks_box
  • (2)post_thanks_box_bit
  • (10)post_thanks_button
  • (1)post_thanks_javascript
  • (1)post_thanks_navbar_search
  • (1)post_thanks_postbit
  • (10)post_thanks_postbit_info
  • (9)postbit
  • (19)postbit_attachment
  • (10)postbit_onlinestatus
  • (10)postbit_wrapper
  • (1)spacer_close
  • (1)spacer_open
  • (1)tagbit_wrapper 
Phrase Groups Available:
  • global
  • inlinemod
  • postbit
  • posting
  • reputationlevel
  • showthread
Included Files:
  • ./showthread.php
  • ./global.php
  • ./includes/init.php
  • ./includes/class_core.php
  • ./includes/config.php
  • ./includes/functions.php
  • ./includes/class_hook.php
  • ./includes/modsystem_functions.php
  • ./includes/functions_bigthree.php
  • ./includes/class_postbit.php
  • ./includes/class_bbcode.php
  • ./includes/functions_reputation.php
  • ./includes/functions_post_thanks.php 
Hooks Called:
  • init_startup
  • init_startup_session_setup_start
  • init_startup_session_setup_complete
  • cache_permissions
  • fetch_postinfo_query
  • fetch_postinfo
  • fetch_threadinfo_query
  • fetch_threadinfo
  • fetch_foruminfo
  • style_fetch
  • cache_templates
  • global_start
  • parse_templates
  • global_setup_complete
  • showthread_start
  • showthread_getinfo
  • forumjump
  • showthread_post_start
  • showthread_query_postids
  • showthread_query
  • bbcode_fetch_tags
  • bbcode_create
  • showthread_postbit_create
  • postbit_factory
  • postbit_display_start
  • post_thanks_function_post_thanks_off_start
  • post_thanks_function_post_thanks_off_end
  • post_thanks_function_fetch_thanks_start
  • fetch_musername
  • post_thanks_function_fetch_thanks_end
  • post_thanks_function_thanked_already_start
  • post_thanks_function_thanked_already_end
  • post_thanks_function_fetch_thanks_bit_start
  • post_thanks_function_show_thanks_date_start
  • post_thanks_function_show_thanks_date_end
  • post_thanks_function_fetch_thanks_bit_end
  • post_thanks_function_fetch_post_thanks_template_start
  • post_thanks_function_fetch_post_thanks_template_end
  • postbit_imicons
  • bbcode_parse_start
  • bbcode_parse_complete_precache
  • bbcode_parse_complete
  • postbit_attachment
  • postbit_display_complete
  • post_thanks_function_can_thank_this_post_start
  • pagenav_page
  • pagenav_complete
  • tag_fetchbit_complete
  • forumrules
  • navbits
  • navbits_complete
  • showthread_complete