[ PHPXref.com ] [ Generated: Sun Jul 20 19:46:00 2008 ] [ phpMyAdmin 2.9.0.3 ]
[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/libraries/ -> relation.lib.php (summary)

Set of functions used with the relation and pdf feature

File Size: 913 lines (34 kb)
Included or required: 33 times
Referenced: 0 times
Includes or requires: 2 files
 libraries/information_schema_relations.lib.php
 libraries/Table.class.php

Defines 12 functions

  PMA_query_as_cu()
  PMA_getRelationsParam()
  PMA_getForeigners()
  PMA_getDisplayField()
  PMA_getComments()
  PMA_handleSlashes()
  PMA_setComment()
  PMA_setHistory()
  PMA_getHistory()
  PMA_purgeHistory()
  PMA_foreignDropdownBuild()
  PMA_foreignDropdown()

Functions
Functions that are not part of a class:

PMA_query_as_cu($sql, $show_error = true, $options = 0)   X-Ref
Executes a query as controluser if possible, otherwise as normal user

author: Mike Beck <mikebeck@users.sourceforge.net>
param: string    the query to execute
param: boolean   whether to display SQL error messages or not
return: integer   the result id

PMA_getRelationsParam($verbose = false)   X-Ref
Defines the relation parameters for the current user
just a copy of the functions used for relations ;-)
but added some stuff to check what will work

author: Mike Beck <mikebeck@users.sourceforge.net>
param: boolean  whether to check validity of settings or not
return: array    the relation parameters for the current user

PMA_getForeigners($db, $table, $column = '', $source = 'both')   X-Ref
Gets all Relations to foreign tables for a given table or
optionally a given column in a table

author: Mike Beck <mikebeck@users.sourceforge.net> and Marc Delisle
param: string   the name of the db to check for
param: string   the name of the table to check for
param: string   the name of the column to check for
param: string   the source for foreign key information
return: array    db,table,column

PMA_getDisplayField($db, $table)   X-Ref
Gets the display field of a table

author: Mike Beck <mikebeck@users.sourceforge.net>
param: string   the name of the db to check for
param: string   the name of the table to check for
return: string   field name

PMA_getComments($db, $table = '')   X-Ref
Gets the comments for all rows of a table

param: string   the name of the db to check for
param: string   the name of the table to check for
return: array    [field_name] = comment

PMA_handleSlashes($val)   X-Ref
Adds/removes slashes if required

param: string  the string to slash
return: string  the slashed string

PMA_setComment($db, $table, $col, $comment, $removekey = '', $mode='auto')   X-Ref
Set a single comment to a certain value.

param: string   the name of the db
param: string   the name of the table (may be empty in case of a db comment)
param: string   the name of the column
param: string   the value of the column
param: string   (optional) if a column is renamed, this is the name of the former key which will get deleted
param: string   whether we set pmadb comments, native comments or both
return: boolean  true, if comment-query was made.

PMA_setHistory($db, $table, $username, $sqlquery)   X-Ref
Set a SQL history entry

param: string   the name of the db
param: string   the name of the table
param: string   the username
param: string   the sql query
return: boolean  true

PMA_getHistory($username)   X-Ref
Gets a SQL history entry

param: string   the username
return: array    list of history items

PMA_purgeHistory($username)   X-Ref
Set a SQL history entry

param: string   the name of the db
param: string   the name of the table
param: string   the username
param: string   the sql query
return: boolean  true

PMA_foreignDropdownBuild($foreign, $data, $mode)   X-Ref
Prepares the dropdown for one mode

param: array    the keys and values for foreigns
param: string   the current data of the dropdown
param: string   the needed mode
return: array   the <option value=""><option>s

PMA_foreignDropdown($disp, $foreign_field, $foreign_display, $data, $max)   X-Ref
Outputs dropdown with values of foreign fields

param: string   the query of the foreign keys
param: string   the foreign field
param: string   the foreign field to display
param: string   the current data of the dropdown
return: string   the <option value=""><option>s



[ Powered by PHPXref - Served by Debian GNU/Linux ]