Procedural File: lib-admin.php

Source Location: /system/lib-admin.php

Page Details:

This file contains functions used in the admin panels (mostly for the various lists of stories, users, etc.).

DEFAULT_ENTRIES_PER_PAGE [line 50]

DEFAULT_ENTRIES_PER_PAGE = 50

Default number of list entries per page

ADMIN_createMenu [line 587]

string ADMIN_createMenu(
array $menu_arr, string $text, [string $icon = ''])

Creates a menu with an optional icon and optional text below this is used in the admin screens but may be used elsewhere also.

Tags:

return:

HTML output of function

Parameters

array	$menu_arr	array of text & URL of the menu entries
string	$text	instructions to be displayed
string	$icon	icon url of an icon that will be displayed

[ Top ]

ADMIN_getListField_blocks [line 628]

void ADMIN_getListField_blocks(
 $fieldname,  $fieldvalue,  $A,  $icon_arr,  $token)

used for the list of blocks in admin/block.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr
	$token

[ Top ]

ADMIN_getListField_groups [line 707]

void ADMIN_getListField_groups(
 $fieldname,  $fieldvalue,  $A,  $icon_arr, [ $selected = ''])

used for the list of groups and in the group editor in admin/group.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr
	$selected

[ Top ]

ADMIN_getListField_moderation [line 1203]

void ADMIN_getListField_moderation(
 $fieldname,  $fieldvalue,  $A,  $icon_arr)

used for the lists of submissions and draft stories in admin/moderation.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr

[ Top ]

ADMIN_getListField_newplugins [line 1396]

void ADMIN_getListField_newplugins(
 $fieldname,  $fieldvalue,  $A,  $icon_arr, [ $selected = ''])

used to display the entries for the list of uninstalled plugins, in admin/plugins.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr
	$selected

[ Top ]

ADMIN_getListField_plugins [line 1084]

void ADMIN_getListField_plugins(
 $fieldname,  $fieldvalue,  $A,  $icon_arr,  $token)

used for the list of plugins in admin/plugins.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr
	$token

[ Top ]

ADMIN_getListField_stories [line 883]

void ADMIN_getListField_stories(
 $fieldname,  $fieldvalue,  $A,  $icon_arr)

used for the list of stories in admin/story.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr

[ Top ]

ADMIN_getListField_syndication [line 1014]

void ADMIN_getListField_syndication(
 $fieldname,  $fieldvalue,  $A,  $icon_arr,  $token)

used for the list of feeds in admin/syndication.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr
	$token

[ Top ]

ADMIN_getListField_trackback [line 1296]

void ADMIN_getListField_trackback(
 $fieldname,  $fieldvalue,  $A,  $icon_arr,  $token)

used for the list of ping services in admin/trackback.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr
	$token

[ Top ]

ADMIN_getListField_usergroups [line 1348]

void ADMIN_getListField_usergroups(
 $fieldname,  $fieldvalue,  $A,  $icon_arr, [ $selected = ''])

used in the user editor in admin/user.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr
	$selected

[ Top ]

ADMIN_getListField_users [line 800]

void ADMIN_getListField_users(
 $fieldname,  $fieldvalue,  $A,  $icon_arr)

used for the list of users in admin/user.php

Parameters

	$fieldname
	$fieldvalue
	$A
	$icon_arr

[ Top ]

ADMIN_list [line 217]

string ADMIN_list(
string $component, string $fieldfunction, array $header_arr, array $text_arr, array $query_arr, array $defsort_arr, [string $filter = ''], [string $extra = ''], [array $options = ''], [array $form_arr = ''], [bool $showsearch = true])

Creates a list of data with a search, filter, clickable headers etc.

Tags:

return:

HTML output of function

Parameters

string	$component	name of the list
string	$fieldfunction	name of the function that handles special entries
array	$header_arr	array of header fields with sortables and table fields
array	$text_arr	array with different text strings
array	$query_arr	array with sql-options
array	$defsort_arr	default sorting values
string	$filter	additional drop-down filters
string	$extra	additional values passed to fieldfunction
array	$options	array of options - intially just used for the Check-All feature
array	$form_arr	optional extra forms at top or bottom
bool	$showsearch	whether to show the search functionality

[ Top ]

ADMIN_simpleList [line 65]

string ADMIN_simpleList(
string $fieldfunction, array $header_arr, array $text_arr, array $data_arr, [array $options = ''], [array $form_arr = ''])

Common function used in Admin scripts to display a list of items

Tags:

return:

HTML output of function

Parameters

string	$fieldfunction	Name of a function used to display the list item row details
array	$header_arr	array of header fields with sortables and table fields
array	$text_arr	array with different text strings
array	$data_arr	array with sql query data - array of list records
array	$options	array of options - intially just used for the Check-All feature
array	$form_arr	optional extra forms at top or bottom

[ Top ]

Documentation generated on Sat, 11 Feb 2012 02:08:11 -0500 by phpDocumentor 1.4.3