Class DBNavigator

Description

This class allows to manage the operation on a MYSQL database, building a graphic interface in automatic manner (a way like to phpMyAdmin) with a * great range of configurations.

Essentially, the data an object DBNavigator can work on, are indicated with a normal query SQL. Throught a testual scanning of the query, are pointed out the involved tables, the data types of the selected fields and the eventual relations between fields of differentes tables (joined by JOIN).

Other information which are not directly locatabled by the databes structure can be pointed out by using setMailField() , setFileField() , setImageField() , setPasswordField(), setNumericStringField() and setMonthYearField() methods.

The HTML contents automatically generated can be graphically personalized by creating your own papers in CSS style and associating the styles using function setTableRowStyle() , setTableCellStyle(), setTableBorderStyles() ,addTableContainer() and setClassForFormInput() .

You can choose to open the AJAX form through the useAjax() method to obtain improvements in the graphic interface related to utilization and speed.

The interaction main functionality with DBNavigator database are:

  • INSERTION/EDITING

    an appropriate form HTML is automatically built including all the necessary validations of the fields both the server side and the client side (javascript).

    It is possible to use DBNavigator simply for a single insertion through go_only_for_form() method (EX: forum registration). Specifying a rescue path, is managed the memorization of generic files or images. Moreover, in the case of image alterations, is automatically shown a preview inside the form. In the case of password, the form will include the additional input for the re-typing. Those passwords will be memorized using the MD5 coding. Gaining access to the objectHTMLForm member of DBNavigator through the method getEditForm(), it is possible to further personalize ulteriormente the form HTML.
    For example you can add to the form a simple anti-hacking verifying code(immagine CAPTCHA)
    otherwise to replace the format HTML of default with another as long as that you will incorporate that format in a class PHP that will extend the abstact class TextEditorContainer (see the method getEditForm() for further details).

    Simultaneus alterations made by some users are blocked through a simple workings of mutua esclusione on the record.

    MYSQL FIEDS ON HTML EDIT INTERFACE

    Here it is a mapping between MySql fields and HTML inputs binded in an automatic way during the building process of edit interface:

    • CHAR/VARCHAR : text input. On this field can be used setMailField() , setFileField() , setImageField() , setPasswordField(), setNumericStringField().
    • DATE : 3 select input (day, month, year). On this field can be used setMonthYearField()
    • INT/BIGINT : text input with validation check about integer number format
    • DOUBLE : text input with validation check about double number format
    • ENUM : radio input or select input if there are many possible values
    • SET : checkboxes or select input with multiple choose if there are many possible values
    • TEXT/TINYTEXT : textarea input
    • MEDIUMTEXT/LONGTEXT : HTML formatter. See getEditForm() to change the default.
    • EXTERNAL KEYS WITH INTEGER TYPE: select input that allow to choose one record of the externat table


  • DISPLAYING

    the subject matter of the selected field is shown through an HTML table or in a way completely definable by the class user. You can choose to enable or not the possibility to insert (canInsert()), alterate (canEdit()) or eliminate elements. In this case the necessary interface is added to the table. Using the standard table visualization, it is possible to add special additional line through functions addDataCol(), addLinkCol(), addFreeCol() and addSwitchCol().
    It is important the function addLinkCol() to allow to link every record to an inside page where are managed data related to that single record. Typical is the example where the inside page uses another DBNavigator to manage data memorized in the database in relation 1 a n. In table form, the web page user can order data in growing or decreasing form for each visualized field. The default disposition has not to be indicated in the query but through the setDefaultOrd() method.

  • SPECIAL ACTIONS

    Through the form canMultipleEditDelete() can be enabled the possibility to make special actions.
    These actions are based on the general table of visualization, which will include the checkbox (checkbox) for an underwhole selection of the visualized elements.

    The elimination of the party allows to eliminate in a single step all the selected.
    The modification sequential allows to alterate one by one the selected elements, without choosing the following one at each modification.
    The modification simultaneous is very special action which allows to alterate only some fields selected by the user. The alteration of these fields is made on the elements previously selected.

  • DATA SEARCHS

    The class owns a mechanism which allows to define some fields such as searching fields using the method setSearchField().

    Using the information proceeds from the textual scanning of the initial query, is automatically set up the graphic interface in the way to let the user make a search with the suitable checks, based on the type of the field to be searched.

    For researches on textual fields, the search field is furnished with a useful system of automatic auto-finishing based on Ajax (AJAX based auto-complete suggestions).
    this way are suggested the texts limited in the database to make researches easier and faster. *

    Another additional functionality is related to the exportation of data which can be applied to the entire set of data or to an underwhole locked up by researching criteria.
    Data can be exported in CSV format simple or in format XML compatible with the browsing by Microsoft Excel ed OpenOffice Calc.



REQUIRED METHODS

The class is started up with the method go() or with go_only_for_form()

The compulsory and necessary method to be recalled is setPrimaryTable().
For the method go() is compulsory to recall also methods setDefaultOrd() and setRowName().
Besides if you use methods setImageField() and/or setFileField() is compulsory to recall setFilePath().



MIND OUT! ________________________________________________________________
The class need a PHP version 5 configurated within magic_quotes_gpc = On.
If you can't have it, try

  1. ini_set("magic_quotes_gpc" "On");
in every script that is expected to do some database modification using DBNavigator.
________________________________________________________________________________




*************************** ITALIAN DOC.***************************

Questa classe consente di gestire le operazioni su di un database MYSQL, costruendo un'intefaccia grafica in modo automatico (in modo simile a phpMyAdmin) con una vasta gamma di configurazioni.

Fondamentalmente, i dati su cui può lavorare un oggetto DBNavigator, vengono indicati tramite una normale query SQL. Attraverso una scansione testuale della query, vengono rilevate le tabelle coinvolte, i tipi dei dati dei campi selezionati e le eventuali relazioni tra i campi di tabelle diverse (unite da un JOIN).

Altre informazioni non reperibili direttamente dalla struttura del database possono essere indicate tramite i metodi setMailField() , setFileField() , setImageField() , setPasswordField(), setNumericStringField() e setMonthYearField().

I contenuti HTML generati automaticamente possono essere personalizzati graficamente tramite creando i propri fogli di stile CSS ed associando gli stili tramite le funzioni setTableRowStyle() , setTableCellStyle(), setTableBorderStyles() ,addTableContainer() e setClassForFormInput() .

Si può scegliere di attivare la modalità AJAX attraverso il metodo useAjax() per ottenere miglioramenti dell'interfaccia grafica in termini di usabilità e velocità.

Le funzionalità principali di interazione con il database di DBNavigator sono:

  • INSERIMENTO/MODIFICA

    viene costruito automaticamente un form HTML appropriato con incluse le necessarie validazioni dei campi sia lato server che lato client (javascript).

    E' possibile usare DBNavigator semplicemente per un inserimento singolo attraverso il metodo go_only_for_form() (ES: registrazione ad un forum).

    Specificando un path di salvataggio, viene gestita la memorizzazione di file generici o immagini. Inoltre nel caso di modifiche ad immagini, viene automaticamente mostrata una preview all'interno del form.

    Nel caso di password, il form conterrà l'input aggiuntivo per la ri-digitazione. Tali passord verranno memorizzate utilizzando la codifica MD5.

    Accedendo all'oggetto HTMLForm membro di DBNavigator tramite il metodo getEditForm(), è possibile personalizzare ulteriormente il form HTML.
    Ad esempio si può aggiungere al form un semplice codice di verifica anti-hacking (immagine CAPTCHA)
    oppure sostituire il formattatore HTML di default con un altro a patto che si inglobi tale formattatore in una classe PHP che estenda la classe astratta TextEditorContainer (si veda il metodo getEditForm() per ulteriori dettagli).

    Modifiche simultanee da parte di più utenti vengono bloccate attraverso un semplice meccanismo di mutua esclusione sui record.

    CAMPI MYSQL SU INTERFACCIA HTML DI MODIFICA

    Ecco una corrispondenza tra i campi MySql ed i controlli HTML automaticamente associati nella costruzione dell'interfaccia di modifica:

    • CHAR/VARCHAR : text input. Su questo tipo di campo è possibile usare setMailField() , setFileField() , setImageField() , setPasswordField(), setNumericStringField().
    • DATE : 3 select input (giorno,mese,anno). Su questo tipo di campo è possibile usare setMonthYearField()
    • INT/BIGINT : text input con validazione di controllo per il formato numero intero
    • DOUBLE : text input con validazione di controllo per il formato numero con virgola
    • ENUM : radio input oppure select input se i valori possibili sono molti
    • SET : checkboxes oppure select input a scelta multipla se i valori possibili sono molti
    • TEXT/TINYTEXT : textarea input
    • MEDIUMTEXT/LONGTEXT : formattatore HTML. Vedere getEditForm() per cambiare qullo di default
    • CHIAVI ESTERNE DI TIPO NUMERICO: select input che consentira di scegliere uno dei record della tabella esterna


  • VISUALIZZAZIONE

    Viene mostrato il contenuto dei campi selezionati attraverso una tabella HTML oppure in maniera completamente definibile dall'utente della classe.

    Si può scegliere di abilitare o meno la possibilità di inserire (canInsert()), modificare(canEdit()) o eliminare (canDelete()) elementi. In questo caso viene aggiunta alla tabella l'interfaccia necessaria.

    Usando la visualizzazione tabellare standard, è possibile aggiungere delle colonne speciali aggiuntive tramite le funzioni addDataCol(), addLinkCol(), addFreeCol() e addSwitchCol().
    E' importante la funzione addLinkCol() per permettere di linkare ogni record ad una pagina interna in cui si gestiscono dati relativi a quel singolo record. Tipico è esempio in cui la pagina interna usa un altro DBNavigator per poter gestire dati memorizzati nel database in relazione 1 a n.

    In modalità tabellare, l'utente della pagina web ha la possibilità di ordinare i dati in modalità crescente o decescente per ogni campo visualizzato. L'ordinamento di default non deve essere indicato nella query ma attraverso il metodo setDefaultOrd()

  • AZIONI SPECIALI

    Tramite il metodo canMultipleEditDelete() può essere abilitata la possibilità di compiere azioni di speciali.
    Queste azioni si basano sulla tabella generale di visualizzazione, che conterrà delle caselle di scelta (checkbox) per la selezione di un sottoinsieme degli elementi visualizzati.

    L' eliminazione di gruppo permette di eliminare in solo passo tutti gli elementi selezionati.
    La modifica sequenziale permette di modificare uno alla volta gli elementi selezionati, senza dover scegliere il successivo ad ogni modifica.
    Lamodifica simultanea è un'azione molto particolare che permette di modificare solo alcuni campi scelti dall'utente. La modifica di questi campi viene effettuata sugli elementi selezionati in precedenza.

  • RICERCHE TRA I DATI

    La classe possiede un meccanismo che permette di definire alcuni campi come campi di ricerca utilizzando il metodo setSearchField().

    Utilizzando le informazioni ricavate dalla scansione testuale della query iniziale, viene predisposta automaticamente l'interfaccia grafica in modo tale da consentire all'utente di effettuare una ricerca con gli adeguati controlli, in base al tipo di campo da ricercare.

    Per ricerche su campi testuali, il campo di ricerca viene corredato da un'utile sistema di auto-completamento automatico basato su Ajax (AJAX based auto-complete suggestions).
    Vengono così suggeriti i testi che sono contenuti nel database per facilitare e velocizzare le ricerche. *

    Un'altra funzionalità aggiuntiva riguarda l'esportazione dei dati che può essere applicata all'intero set di dati oppure ad un sottoinsieme vincolato da parametri di ricerca.
    I dati possono essere esportati in formato CSV semplice oppure in formato XML compatibile per la lettura da parte di Microsoft Excel ed OpenOffice Calc.



METODI NECESSARI

La classe viene attivata col metodo go() oppure con go_only_for_form()

Il metodo obbligatoriamente necessario da richiamare è setPrimaryTable().
Per il metodo go() è obbligario richiamare anche i metodi setDefaultOrd() e setRowName().
Inoltre se si usano i metodi setImageField() e/o setFileField() è obbligatorio richiamare setFilePath().



NOTA IMPORTANTE ____________________________________________________________
La classe ha bisogno di PHP versione 5 configurata con magic_quotes_gpc = On.
If you can't have it, try

  1. ini_set("magic_quotes_gpc" "On");
in every script that is expected to do some database modification using DBNavigator. _________________________________________________________________________________


Located in /DBNavigator.php (line 285)


	
			
Method Summary
 static string addHavingConditionToQuery (string $query, [string $cond = ""])
 static string addWhereConditionToQuery (string $query, [string $cond = ""])
 DBNavigator DBNavigator (string $query)
 void addDataCol (string $colName, string $query, string $type)
 void addFreeCol (string $colName, string $content)
 void addLinkCol (string $colName, string $arg, string $image, [boolean $keepGet = ''], [boolean $newWindow = false], [mixed $page = ''], [string $condition = ""], [array $fieldToLink = false])
 void addSwitchCol (string $colName, string $image1, string $image2)
 void addTableContainer (string $cssclass)
 void canDelete (mixed $boolean_or_id_array)
 void canEdit (mixed $boolean_or_id_array)
 void canEditDelete (boolean $boolean)
 void canExport (boolean $boolean)
 void canInsert (boolean $boolean)
 void canMultipleEditDelete (boolean $apply)
 void canViewForPrint (boolean $boolean)
 string getDeleteLink (int $id)
 void getEditForm ()
 string getEditLink (int $id)
 string getFullQuery ()
 string getPrimaryTable ()
 int get_rowsNum ()
 void go ([function $after_query_function = ""], [boolean $PageNavigator_on_top = false], [function $viewing_data_function = ""], [array $replace_array = null])
 void go_only_for_form (int $id, [string $successMsg = "Inserimento/modifiche effettuato/e"], [function $after_query_function = ""], [array $replace_array = null])
 void hidePrimaryKey (boolean $boolean)
 string printAddRowButton ([mixed $image = true], [mixed $heading = true])
 string printCsvDownloadButton ([mixed $image = true], [mixed $heading = true])
 string printExcelXmlDownloadButton ([mixed $image = true], [mixed $heading = true])
 void removeInput (string $inputName)
 void removeMultipleEditingInput (string $inputName)
 string search_form ([boolean $new_line = false])
 void setActionColumnHeader (string $str)
 void setAlertOnDelete (string $alert)
 void setCheckboxesSettings (int $maxCheckboxes, int $multipleSelectSize)
 void setClassForFormInput (string $forInputs, [string $forButtons = ""], [string $forTareas = ""])
 void setConfirmFormMsg (string $m)
 void setDatasetName (String $val)
 void setDateInterval (int $bottom, int $top)
 void setDefaultOrd (string $defaultOrd)
 void setDeleteColHeading (string $heading)
 void setDeleteRecursive (string $chiave_collegata_a_se_stessa, [DBNavigator $DBNavigator_esterno = false], [string $alert = ""])
 void setEditColHeading (string $heading)
 void setExtraDeletingFunction (function $function)
 void setFieldStatusIndicator (string $field, string $on,  $off)
 void setFileField (mixed $field)
 void setFileNameCriteria (string $path)
 void setFilePath (string $path)
 void setFormHeading (string $heading, [string $backLink = ""])
 void setFormWidth (int $w1, int $w2)
 void setHighlighting (string $condition, string $TDAttributes)
 void setHTMLTextareaParams (mixed $arr)
 void setImageField (mixed $field, [mixed $resizeImg = false], [boolean $keepOriginal = false])
 void setImagesAndScriptsPath (string $path)
 void setImageScaleDimension (int $val)
 void setInsertNewHeading (string $heading)
 void setLanguage (string $lang)
 void setMailField (string $field)
 void setMonthYearField (string $field)
 void setMultipleEditDeleteHeading ( $ifSelected,  $selectAll,  $unselectAll,  $alertOnDelete)
 void setNoResultString (string $str)
 void setNumericStringField (string $field)
 void setPageBrowsing (boolean $byselect, boolean $bylink, boolean $selectrpp)
 void setPageBrowsingConfig (bool $bylink, bool $byselect, bool $selectrpp, [string $navigationPanelCSS = ''])
 void setPasswordField (string $field)
 void setPhotoField ( $field, [ $resizeImg = false], [ $keepOriginal = false])
 void setPrimaryTable (string $primaryTable)
 void setPrintColHeading (string $heading)
 void setRadioSettings (int $maxOptions, [int $maxOptionsInOneLine = 3])
 void setResultsPerPage (int $rpp)
 void setRowName (string $rowName)
 void setSearchField ()
 void setSearchHeading (string $searchHeading)
 void setTableBorderStyles (string $topsx, string $top, string $topdx, string $dx, string $botdx, string $bot, string $botsx, string $sx)
 void setTableCellPadding (int $CS)
 void setTableCellSpacing (int $CS)
 void setTableCellStyle (string $TD, string $editDeleteTD, string $headerTD, [string $fieldLink = ""])
 void setTableRowStyle (string $val1, string $val2)
 void setTableStyle ( $TD,  $editDeleteTD,  $headerTD, [ $fieldLink = ""])
 void setTextCutLength ([int $cutLength = 150])
 void setViewAllSearchOptions (boolean $bool)
 void setViewResultWithoutSearch (boolean $bool)
 void showAllElements ([boolean $all = true])
 string status ()
 void useAjax (boolean $bool)
Methods
static addHavingConditionToQuery (line 2091)
  • return: la query originaria con la condizione $cond aggiunta tra le clausola HAVING della query $query

    ITALIAN:
    the originary query with the condition $cond added between the clause HAVING of the query $query
string addHavingConditionToQuery (string $query, [string $cond = ""])
  • string $query: an SQL query

    ITALIAN:
    una query SQL
  • string $cond: an SQL boolean

    ITALIAN:
    una condizione booleana SQL
static addWhereConditionToQuery (line 2050)
  • return: la query originaria con la condizione $cond aggiunta tra le clausola WHERE della query $query

    ITALIAN:
    the originary query with the condition $cond added between the clause WHERE of the query $query
string addWhereConditionToQuery (string $query, [string $cond = ""])
  • string $query: an SQL query

    ITALIAN:
    una query SQL
  • string $cond: an SQL boolean

    ITALIAN:
    una condizione booleana SQL
Constructor DBNavigator (line 1603)

Accepts a query of construction of the object that must contain all necessary join with which will make the following elaborations.

Besides creates a table called 'busy_records' which serves to manage the conflicts of mutual exclusion in the simultaneous record modifications.
That table is used for all instances DBNavigator.

On edit mode, if the query have some join, an input will be added to associate one of the external table records. The first field of the external table in the construction query will be displayied in the form for the the selection of one external record.



ITALIAN:
Accetta una query di costruzione dell'oggetto che deve comprendere tutti i join necessari con cui si faranno le successive elaborazioni.
Inoltre crea una tabella chiamata 'busy_records' che serve a gestire i conflitti di mutua esclusione sulle modifiche simultanee ai record.
Tale tabella è usata per tutte le istanze di DBNavigator.

In modalità di modifica, se la query di costruzione presenta dei join, verrà inserito in input che permetta di associare uno dei record della tabella esterna. Il campo visualizzato nel form per la selezione di quest'ultimo sarà il primo campo della tabella esterna presente nella query di costruzione.

DBNavigator DBNavigator (string $query)
  • string $query:

    Main query.
    WARNING, is assumed that the main query contains ALL the key words SQL in capital (SELECT,FROM,WHERE,HAVING,AS...) while in the internal subqueries (subqueries), if present, the key words must be all small letters.
    besides is assumed that the query doesn't contain the clause ORDER BY, the regulation field must be set up trough the apposite method setDefaultOrd()



    ITALIAN:
    query principale.
    ATTENZIONE, si assume che la query principale contenga TUTTE le parole chiave SQL in maiuscolo (SELECT,FROM,WHERE,HAVING,AS...) mentre nelle sotto-query (subqueries) interne, se presenti, le parole chiave dovranno essere tutte minuscole. Inoltre si assume che la query non contenga la clausola ORDER BY, il campo di ordinamento dovrà essere impostato tramite l'apposito metodo setDefaultOrd()

addDataCol (line 1478)

Adds a column named $colName at the data general visualization table.

That column will contain the data got executing the query $query where will have to be present the string '%current_row_id%' indicating the id of the current record. That query could be the type defined as $type. Available types are:

  • LINKED_RECORDS simply performs the query which will tipically apply the join with other
tables, unically visualizing the first selected field for each resulting string (lines separated by a back return)

  • RECURSIVE will execute the query in the resorting way through the method query_ricorsiva() counting the number
of record resortively selected and visualizing that numeric value in the column.
This type of query is tipically used to count elements memorized in tree structures.

  • CALCULATION asks that the subject query is an array.
In particular each element of that array will have to be an array of two elements with key 'operand' and 'query'. operand is a string of a character containing a mathematic operator of PHP (+,-,*,/), query is the query that will have to have a numeric field as first field (also here %current_row_id% will be replaced with the current id). The class will find the way to execute all the query contained in the array and to link together with their own operand operator. Visualizing the final result Notice: you can obtain the same result applying sub-queries (subqueries) to the select of initail query.



ITALIAN:

Aggiunge una colonna nominata $colName alla tabella della visualizzazione generale dei dati. Tale colonna conterrà dei dati ottenuti eseguendo la query $query in cui dovrà essere presente la stringa '%current_row_id%' indicante l'id del record corrente. Tale query potrà essere del tipo definito in $type. I tipi disponibili sono:

  • LINKED_RECORDS esegue semplicemente la query che tipicamente applicherà dei join con altre
tabelle, visualizzando unicamente il primo campo selezionato per ogni riga risultante (righe separate da un ritorno a capo)

  • RECURSIVE eseguira la query in modo ricorsivo tramite il metodo query_ricorsiva() contando il numero
di record ricorsivamente selezionati e visualizzando tale valore numerico nella colonna.
Questo tipo di query è tipicamente usato per contare elementi memorizzati in strutture ad albero.

  • CALCULATION richiede che l'argomento query sia un array.
In particolare ogni elemento di tale array dovrà essere a sua volta una array di due elementi con chiavi 'operand' e 'query'. operand è una stringa di un carattere contenente un'operatore matematico di PHP (+,-,*,/), query è la query che dovra avere un campo numerico come primo campo (anche qui %current_row_id% sarà sostituito dall'id corrente). La classe fara in modo di eseguire tutte le query contenute nell'array e concatenarle con il loro operatore operand. Visualizzando il risultato finale Nota: si può ottenere lo stesso risultato applicando delle sotto-query (subqueries) alla select della query iniziale.

void addDataCol (string $colName, string $query, string $type)
  • string $colName: heading of the column

    ITALIAN:
    intestazione della colonna
  • string $query: query containing the string %current_row_id% which is replaced with the id of each record

    ITALIAN:
    query contenente la stringa %current_row_id% che viene sostituita dall'id di ogni record
  • string $type: query type

    ITALIAN:
    tipo della query
addFreeCol (line 1426)

Adds a column named $colName at the data general visualization table.

That column will have as contents the HTML contained in the parameter $content in which you'll can refer to the current id with the string '%current_row_id%'.



ITALIAN:
Aggiunge una colonna nominata $colName alla tabella della visualizzazione generale dei dati. Tale colonna avrà come contenuto l'HTML contenuto nel paramentro $content in cui ci si potrà riferire all'id corrente con la stringa '%current_row_id%'.

void addFreeCol (string $colName, string $content)
  • string $colName: heading of the column

    ITALIAN:
    intestazione della colonna
  • string $content: HTML code (with eventual Javascript) of each cell. %current_row_id% is replaced with the id of each record

    ITALIAN:
    codice HTML (con eventuale Javascript) di ogni cella. %current_row_id% viene sostituito dall'id di ogni record
addLinkCol (line 1362)

Aggiunge una colonna nominata $colName alla tabella della visualizzazione generale dei dati.

Tale colonna avrà come icona $image e linkerà alla pagina corrente se non specificato il parametro $page.



ITALIAN:
Adds a column named $colName at data general visualization table. That column will have as icon $image and will link at the current page if not specified the parameter $page.

void addLinkCol (string $colName, string $arg, string $image, [boolean $keepGet = ''], [boolean $newWindow = false], [mixed $page = ''], [string $condition = ""], [array $fieldToLink = false])
  • string $colName: intestazione della colonna

    ITALIAN:
    heading of the column
  • string $arg: name of the GET parameter to which will be assigned the id of each record

    ITALIAN:
    nome del parametro GET a cui sarà assegnato l'id di ogni record
  • string $image: path of the icon image

    ITALIAN:
    percorso dell'immagine icona
  • boolean $keepGet: indicates if the linked page will have to keep the sunbjects GET of the page

    ITALIAN:
    indica se la pagina linkata dovrà mantenere gli argomenti GET della pagina.
  • boolean $newWindow: indicates if the linking page will have to open up in a new window.

    ITALIAN:
    indica se la pagina linkata dovrà aprirsi in una nuova finestra.
  • mixed $page: string that indicates the linking page. false value indicates the current page

    ITALIAN:
    stringa indicante la pagina linkata. il valore false indica la pagina corrente
  • string $condition: contains a booleana expression PHP that will be evalueted as condition of the visualization link. Works as setHighlighting()

    ITALIAN:
    contiene un'espressione booleana PHP che sarà valutata come condizione di visualizzazione del link. Funziona come setHighlighting()
  • array $fieldToLink: contains all field names of the selection SQL where to apply the link in the visualization table.

    ITALIAN:
    contiene tutti i nomi dei campi della selezione SQL a cui applicare il link nella tabella di visualizzazione.
addSwitchCol (line 1385)

Adds a column named $colName at data general visualization table.

The column corresponds to an attribute in two possible values and the interface will contain the link that will allow to change the value The link will be active on the image that is shown and that corresponds to the current value of the attribute



ITALIAN:
Aggiunge una colonna nominata $colName alla tabella della visualizzazione generale dei dati. La colonna corrisponde ad un attributo a due possibili valori e l'interfaccia conterrà un link che permetterà di cambiarne il valore. Il link sarà attivo sull'immagine che viene mostrata e che corrisponde al valore corrente dell'attributo

void addSwitchCol (string $colName, string $image1, string $image2)
  • string $colName: name of the field of two values

    ITALIAN:
    nome del campo a due valori
  • string $image1: path of the image corresponding to the first value of the attribute

    ITALIAN:
    path dell'immagine corrispondente al primo valore dell'attributo
  • string $image2: path of the image corresponding to the second value of the attribute

    ITALIAN:
    path dell'immagine corrispondente al secondo valore dell'attributo
addTableContainer (line 744)

Adds a div container for the table of general data visualization.

This container can be added to beauty purposes to apply with properties CSS.



ITALIAN:
Aggiunge un div contenitore per la tabella di visualizzazione generali dei dati. Questo contenitore può essere aggiunto per finalità estetiche da applicare con proprietà CSS.

void addTableContainer (string $cssclass)
  • string $cssclass: the name of the CSS class to combine to div container.

    ITALIAN:
    il nome della classe CSS da abbinare al div contenitore.
canDelete (line 2005)
void canDelete (mixed $boolean_or_id_array)
  • mixed $boolean_or_id_array: Indicates if is allowed to eliminate record from the table (true/false) or you can give an array of numeric id for which is allowed that action.

    ITALIAN:
    Indica se e' consentito eliminare record dalla tabella (true/false) oppure si può fornire un array di id numerici per i quali è consentita tale azione.
canEdit (line 2014)
void canEdit (mixed $boolean_or_id_array)
  • mixed $boolean_or_id_array: Indicates if is allowed to modify record from the table (true/false) or you can give an array of numeric id for which is allowed that action.

    ITALIAN:
    Indica se e' consentito modificare record dalla tabella (true/false) oppure si può fornire un array di id numerici per i quali è consentita tale azione.
canEditDelete (line 2028)
void canEditDelete (boolean $boolean)
  • boolean $boolean: Indicates if is allowed to eliminate and midify record from the table (true/false)

    ITALIAN:
    Indica se e' consentito eliminare e modificare record dalla tabella (true/false)
canExport (line 2034)
void canExport (boolean $boolean)
  • boolean $boolean: Indicates if is allowed the exportation of data in format CSV and XML for Excel/OpenOffice

    ITALIAN:
    Indica se e' consentita l'esportazione dei dati in formato CSV ed XML per Excel/OpenOffice
canInsert (line 2021)
void canInsert (boolean $boolean)
  • boolean $boolean: Indicates if is allowed to insert record from the table (true/false)

    ITALIAN:
    Indica se e' consentito inserire record dalla tabella (true/false)
canMultipleEditDelete (line 1489)
void canMultipleEditDelete (boolean $apply)
  • boolean $apply: Enables/closes down the possibility of multiple modifications/eliminations and contemporary modifications.
    That set is effectively relevant if the modification and elimination is enabled trough canEdit() e canDelete()

    ITALIAN:
    Abilita/disabilita la possibilità di modifiche/eliminazioni multiple e modifiche contemporanee.
    Tale impostazione ha effettivamente rilevanza se è abilitata la modificazione ed eliminazione tramite canEdit() e canDelete()
canViewForPrint (line 2042)
void canViewForPrint (boolean $boolean)
  • boolean $boolean: Indicates if is allowed to singly visualize record of the table for printing

    ITALIAN:
    Indica se e' consentito visualizzare singolarmente i record dalla tabella per la stampa
clearSearchFields (line 1312)

Removes all fields set up like researching fields



ITALIAN:
Rimuove tutti i campi impostati come campi di ricerca

void clearSearchFields ()
getDeleteLink (line 3954)
  • return: the HTML code of the button/link relative to starting of the element elimination procedure

    ITALIAN:
    il codice HTML del tasto/link relativo all'attivazione della procedura di eliminazione dell'elemento
  • see: DBNavigator::go()
string getDeleteLink (int $id)
  • int $id: id of a record

    ITALIAN:
    id di un record
getEditForm (line 683)

Comes back the class that builds the form HTML.

This method can be used to modify the behaviour of that object.
For example you can add a CAPCTHA code

  1.  $DBNavigator->getEditForm()->addVerificationCode().

or modify the class wich builds the test format
  1.  $DBNavigator->getEditForm()->setHTMLtextEditor(new MY_HTML_FORMATTER_CLASS()).

MY_HTML_FORMATTER_CLASS must upgrade the interface TextEditorContainer



ITALIAN:
Ritorna la classe che costruisce il form HTML.
Questo metodo può essere usato per modificare il comportamento di tale oggetto.
Ad esempio si può aggiungere un codice CAPCTHA:

  1.  $DBNavigator->getEditForm()->addVerificationCode().

  • modificare la classe che costruisce il formattatore testi HTML :
    1.  $DBNavigator->getEditForm()->setHTMLtextEditor(new MY_HTML_FORMATTER_CLASS()).

MY_HTML_FORMATTER_CLASS deve implementare l'interfaccia TextEditorContainer

void getEditForm ()
getEditLink (line 3934)
  • return: the HTML code of the button/link relative to the interface starting of element modification

    ITALIAN:
    il codice HTML del tasto/link relativo all'attivazione dell'interfaccia di modifica dell'elemento
  • see: DBNavigator::go()
string getEditLink (int $id)
  • int $id: id of a record

    ITALIAN:
    id di un record
getFullQuery (line 3840)
  • return: the construction query of the object with the actual research parameters

    ITALIAN:
    la query di costruzione dell'oggetto con gli attuali parametri di ricerca.
string getFullQuery ()
getPrimaryTable (line 638)
  • return: the name of the table definded as primary

    ITALIAN:
    il nome della tabella definita come primaria
string getPrimaryTable ()
get_rowsNum (line 3831)
  • return: the number of rows resulting from the construction query of the object with the actual research parameters

    ITALIAN:
    il numero di righe risultante dalla chiamata alla query di costruzione dell'oggetto con gli attuali parametri di ricerca.
int get_rowsNum ()
go (line 3091)

This is the special function that runs the execution of DBNavigator in full mode.

It must be recalled after the methods of configuration set...and arouses the visualization af the whole interface of research, modification, insertion, ecc. and the automatic management of all the correspondent actions.



ITALIAN:
Questa è la speciale funzione che avvia l'esecuzione di DBNavigator in modalità di singolo inserimento o singola modifica.

Deve essere richiamata dopo i metodi di configurazione set... e provoca la visualizzazione di tutta l'interfaccia di ricerca, modifica, inserimento ecc. e la gestione automatica di tutte le azioni corrispondenti.

void go ([function $after_query_function = ""], [boolean $PageNavigator_on_top = false], [function $viewing_data_function = ""], [array $replace_array = null])
  • function $after_query_function: name of a function php without paramenters that is recalled after the insertion or the modification (empty string if you don't want to use any function).
    The use of this functionality has an impact similar to the one of a trigger SQL of type AFTER UPDATE/INSERT.


    ITALIAN:
    nome di una funzione php senza paramentri che viene richiamata dopo l'inserimento o la modifica (stringa vuota se non si vuole usare alcuna funzione).
    L'uso di questa funzionalità ha un effetto simile a quello di un trigger SQL di tipo AFTER UPDATE/INSERT.
  • boolean $PageNavigator_on_top: indicates if to print the navigation interface even over the table between the pages where are divided records. By default that interface is printed just under the table of elements visualization.

    ITALIAN:
    indica se stampare anche sopra la tabella l'interfaccia di navigazione tra le pagine su cui sono suddivisi i record. Di default tale interfaccia è stampata solo sotto la tabella di visualizzazione elementi.
  • function $viewing_data_function: name of a functione to be used for data visualization. If you specify that function, that will be used to show the data instead of the default table.
    The function must accept a paramenter that represents the set of data gived by mysql_query(). The set of data already contains just the elements to visualize on the current page therefore you don't have to worry about paging elements on many HTML pages, which is anyway automatically managed by the class. Inside the function it is possible to tell as global the instance variable of DBNavigator object and invoke on that methods getEditLink() and getDeleteLink() that allow you to get HTML code about links of insertion/modification on each record of data set.

    ITALIAN:
    nome di una funzione da usare per la visualizzazione dei dati. Se si specifica tale funzione, essa verrà usata per mostrare i dati invece della tabella di default.
    La funzione deve accettare un parametro che rappresenta il set di dati restituito da mysql_query(). Il set di dati contiene già i soli elementi da visualizzare sulla pagina corrente quindi non ci si deve preoccupare della paginazione degli elementi sulle varie pagine HTML, questo verrà comunque gestita automaticamente dalla classe. All'interno della funzione è possibile dichiarare come global la variabile di istanza dell'oggetto DBNavigator e richiamare su di essa i metodi getEditLink() e getDeleteLink() che permettono di ottenere il codice HTML relativo ai link di inserimento/modifica su ogni record del set di dati.
  • array $replace_array: makes up a data structure which serves to make substitutions in the code HTML generated by the class.
    The array must be associative: each element has KEY equal to the text to be replaced and equal VALUE to the text of replacement.
    Like key you can also use a text which will contain a regular expression causing the substitution of text parts in match with the expression ( parsed by preg_replace() ).

    ITALIAN:
    costituisce una struttura dati che serve ad effettuare delle sostituzioni nel codice HTML generato dalla classe.
    L'array deve essere associativo: ogni elemento ha CHIAVE uguale al testo da sostituire e VALORE uguale al testo di rimpiazzo.
    Come chiave si può anche usare un testo che contenga una regular espression causando la sostituzione delle parti di testo in match con l'espressione ( valutata dalla funzione preg_replace() ).
go_only_for_form (line 2868)

This is the special function that runs the execution of DBNavigator in the way of sinlge insertion or single modification.

It must be recalled after the methods of configuration set...and that arouses the printing of the adeguate form HTML.

Storing data/files at the moment of the form completion by the user, is managed automatically reproducing a confirmation page.



ITALIAN:
Questa è la speciale funzione che avvia l'esecuzione di DBNavigator in modalità di singolo inserimento o singola modifica.

Deve essere richiamata dopo i metodi di configurazione set... e provoca la stampa dell'adeguato form HTML. Il salvataggio dei dati/files al momento del completamento del form da parte dell'utente, viene gestito automaticamente riportando una pagina di conferma.

void go_only_for_form (int $id, [string $successMsg = "Inserimento/modifiche effettuato/e"], [function $after_query_function = ""], [array $replace_array = null])
  • int $id: the numeric id of the record to be modified or zero (false) if that is an insertion

    ITALIAN:
    l'id numerico del record da modificare oppure zero (false) se si tratta di un inserimento
  • string $successMsg: the text HTML to visualize in the confirmation page following the form completion

    ITALIAN:
    il testo HTML da visualizzare nella pagina di conferma successiva al completamento del form
  • function $after_query_function: name of a function php without paramenters that is recalled after the insertion or the modification (empty string if you don't want to use any function).
    The use of this functionality has an impact similar to the one of a trigger SQL of type AFTER UPDATE/INSERT.


    ITALIAN:
    nome di una funzione php senza paramentri che viene richiamata dopo l'inserimento o la modifica (stringa vuota se non si vuole usare alcuna funzione).
    L'uso di questa funzionalità ha un effetto simile a quello di un trigger SQL di tipo AFTER UPDATE/INSERT.
  • array $replace_array: makes up a data structure which serves to make substitutions in the code HTML generated by the class.
    The array must be associative: each element has KEY equal to the text to be replaced and equal VALUE to the text of replacement.
    Like key you can also use a text which will contain a regular expression causing the substitution of text parts in match with the expression ( parsed by preg_replace() ).

    ITALIAN:
    costituisce una struttura dati che serve ad effettuare delle sostituzioni nel codice HTML generato dalla classe.
    L'array deve essere associativo: ogni elemento ha CHIAVE uguale al testo da sostituire e VALORE uguale al testo di rimpiazzo.
    Come chiave si può anche usare un testo che contenga una regular espression causando la sostituzione delle parti di testo in match con l'espressione ( valutata dalla funzione preg_replace() ).
hidePrimaryKey (line 1798)
void hidePrimaryKey (boolean $boolean)
  • boolean $boolean: indicates if to show or not the primary key of the main table in the data visualization table.

    ITALIAN:
    Indica se mostrare o meno la chiave primaria della tabella principale nella tabella di visualizzazione dei dati.
printAddRowButton (line 2127)
  • return: the HTML code which includes the insertion button of a new element (made by an image and an heading)

    ITALIAN:
    il codice HTML che comprende il tasto di inserimento di un nuovo elemento (costituito da immagine più didascalia)
string printAddRowButton ([mixed $image = true], [mixed $heading = true])
  • mixed $image: the value true indicates if to insert the default image or is possible to indicate the path of another image

    ITALIAN:
    il valore true indica se inserire l'immagine di default altrimenti è possibile indicare il path di un'altra immagine
  • mixed $heading: the value true indicates if to use the default text as heading or is possible to indicate another text

    ITALIAN:
    il valore true indica se usare il testo di default come intestazione altrimenti è possibile indicare un altro testo
printCsvDownloadButton (line 2157)
  • return: the HTML code which includes the exportation button in CSV format (made by an image and an heading)

    ITALIAN:
    il codice HTML che comprende il tasto di esportazione dati in formato CSV (costituito da immagine più didascalia)
string printCsvDownloadButton ([mixed $image = true], [mixed $heading = true])
  • mixed $image: the value true indicates if to insert the default image or is possible to indicate the path of another image

    ITALIAN:
    il valore true indica se inserire l'immagine di default altrimenti è possibile indicare il path di un'altra immagine
  • mixed $heading: the value true indicates if to use the default text as heading or is possible to indicate another text

    ITALIAN:
    il valore true indica se usare il testo di default come intestazione altrimenti è possibile indicare un altro testo
printExcelXmlDownloadButton (line 2187)
  • return: the HTML code which includes the exportation button in XML format (made by an image and an heading)

    ITALIAN:
    il codice HTML che comprende il tasto di esportazione dati in formato XML (costituito da immagine più didascalia)
string printExcelXmlDownloadButton ([mixed $image = true], [mixed $heading = true])
  • mixed $image: the value true indicates if to insert the default image or is possible to indicate the path of another image

    ITALIAN:
    il valore true indica se inserire l'immagine di default altrimenti è possibile indicare il path di un'altra immagine
  • mixed $heading: the value true indicates if to use the default text as heading or is possible to indicate another text

    ITALIAN:
    il valore true indica se usare il testo di default come intestazione altrimenti è possibile indicare un altro testo
removeDisplaying (line 1170)

Sets up the fields of the table which musn't be shown in the general data visualization specifying the names.
This method accepts a VARIABLE NUMBER OF ARGUMENTS.



ITALIAN:
Imposta i campi della tabella che non devono essere mostrati nella visualizzazione generale dei dati specificandone i nomi.
Questo metodo accetta un NUMERO VARIABILE DI ARGOMENTI.

void removeDisplaying ()
removeInput (line 1160)
void removeInput (string $inputName)
  • string $inputName: name of the field that won't be published in the form of insertion/modification

    ITALIAN:
    nome del campo che non potrà essere editato nel form di inserimento/modifica.
removeMultipleEditingInput (line 1181)
void removeMultipleEditingInput (string $inputName)
  • string $inputName: name of the field that won't be published in the form multiple modification

    ITALIAN:
    nome del campo che non potrà essere editato nel form di modifica multipla. .
search_form (line 3364)

This method allows to obtain the code HTML relative to the form of elements research.
The form is automatically printed at the recall of function go() while if you recall this method the automatic print won't be executed.

Naturally the form can be obtained if there are defined the searching fields through the method setSearchField().



ITALIAN:
Questo metodo permette di ottenere il codice HTML relativo al form di ricerca elementi.
Il form viene automaticamente stampato al richiamo della funzione go() mentre se si richiama questo metodo la stampa automatica non viene eseguita.

Naturalmente il form può essere ottenuto se sono stati definiti dei campi di ricerca tramite il metodo setSearchField().

  • return: the HTML code relative to the form of elements research.

    ITALIAN:
    il codice HTML relativo al form di ricerca elementi.
string search_form ([boolean $new_line = false])
  • boolean $new_line: indicates if to print the heading fields of the form over the checks instead of beside

    ITALIAN:
    indica se stampare le intestazioni dei campi del form sopra i controlli invece che a fianco
setActionColumnHeader (line 993)
void setActionColumnHeader (string $str)
  • string $str: text of heading for the action of selection in the table of data visualization

    ITALIAN:
    testo di intestazione per l'azione di selezione nella tabella di visualizzazione dei dati
setAlertOnDelete (line 1049)
void setAlertOnDelete (string $alert)
  • string $alert: alert message of confirmation for a record elimination

    ITALIAN:
    messaggio alert di conferma per l'eliminazione di un record
setCheckboxesSettings (line 1560)

Sets up the maximum number of checkbox for a multiple choice field (SET) as a first parameter, and the dimension (number of elements) that will have the multiple choice select if the number of elements of the field exceeds the first parameter.



ITALIAN:
Imposta il numero massimo di checkbox per un campo a scelta multipla (SET) come primo parametro, e la dimensione (numero di elementi) che dovrà avere la select a scelta multipla se il numero di elementi del campo supera il primo paramentro.

void setCheckboxesSettings (int $maxCheckboxes, int $multipleSelectSize)
  • int $maxCheckboxes: maximum number of checkbox that can have a multiple choice field

    ITALIAN:
    numero massimo di checkbox che può avere un campo a scelta multipla
  • int $multipleSelectSize: dimension (number of elements) that will have the multiple choice select which replaces the checkbox in the case of excess

    ITALIAN:
    dimensione (numero di elementi) che dovrà avere la select a scelta multipla che rimpiazza le checkbox in caso di eccedenza
setClassForFormInput (line 1990)
void setClassForFormInput (string $forInputs, [string $forButtons = ""], [string $forTareas = ""])
  • string $forInputs: name of the class CSS to apply to input of the form (tag INPUT).

    ITALIAN:
    nome della classe CSS da applicare agli input dei form (tag INPUT).
  • string $forButtons: name of the class CSS to apply to form buttons.

    ITALIAN:
    nome della classe CSS da applicare ai pulsanti dei form.
  • string $forTareas: name of the class CSS to apply to the simple textarea of the form

    ITALIAN:
    nome della classe CSS da applicare alle textarea semplici dei form (tag TEXTAREA).
setConfirmFormMsg (line 1038)
void setConfirmFormMsg (string $m)
  • string $m: text of the 'submit' key present in the formof insertion/modification
setDatasetName (line 781)

Sets up a name which identify the data set considered.

That value is actually used to build the PageNavigator embedded object.



ITALIAN:
Imposta un nome identificativo del set di dati considerato. Tale valore è attualmente utilizzato per la costruzione dell'oggetto interno PageNavigator.

void setDatasetName (String $val)
  • String $val: name to identify, and for example students, products, invoices, books, etc.

    ITALIAN:
    nome identificativo, ed esempio studenti, prodotti, fatture, libri ecc.
setDateInterval (line 1003)

Sets up the break of selectionable dates in the form of insertion/modification for the fields defined DATE in the table of database

ITALIAN:
Imposta l'intervallo di date selezionabili nel form di inserimento/modifica per i campi definiti DATE nella tabella del database

void setDateInterval (int $bottom, int $top)
  • int $bottom: The lowest date which you want to make available

    ITALIAN:
    La data più bassa che si vuole rendere disponibile
  • int $top: The higher date you want to make available

    ITALIAN:
    La data più alta che si vuole rendere disponibile
setDefaultOrd (line 1785)
void setDefaultOrd (string $defaultOrd)
  • string $defaultOrd: contents of the clause ORDER BY to be added at the main query to order data

    ITALIAN:
    contenuto della clausola ORDER BY da aggiungere alla query principale per ordinare i dati
setDeleteColHeading (line 963)
void setDeleteColHeading (string $heading)
  • string $heading: text of heading for the action of 'delete record' in the table of data visualization

    ITALIAN:
    testo di intestazione per l'azione di 'elimina record' nella tabella di visualizzazione dei dati
setDeleteRecursive (line 1150)

sets up a linked and/or recursive deletion for records.

His effect can be equivalent to the integrity constraint ON DELETE CASCADE but this method will also delete files, stored in the server, wich are related to the deleted records.



ITALIAN:
Imposta la cancellazione linkata e/o ricorsiva dei record.

Il suo effetto può essere ecquivalente al vincolo di integrità referenziale ON DELETE CASCADE ma questo metodo eliminerà anche i file, memorizzati sul server, che sono collegati ai record eliminati.

void setDeleteRecursive (string $chiave_collegata_a_se_stessa, [DBNavigator $DBNavigator_esterno = false], [string $alert = ""])
  • string $chiave_collegata_a_se_stessa: name of the field with which is considered the autojoin of the main table on itself.

    ITALIAN:
    nome del campo con cui si considera l'autojoin della tabella principale su se stessa.
  • DBNavigator $DBNavigator_esterno: DBNavigator object where is a join between its own main table and the main table of DBNavigator on which is recalled this method. For join is meant a join in the costruction query.

    ITALIAN:
    oggetto DBNavigator in cui c'è un join tra la propria tabella principale. e la tabella principale del DBNavigator su cui si richiama questo metodo. Per join si intende un join nelle query di costruzione.
  • string $alert: warning message to be visualized when you want to eliminate a record that will cause the cancellation of other records because of the application of this method.

    ITALIAN:
    messaggio di avvertimento da visualizzare quando si vuole eliminare un record che provocherà la cancellazione di altri record a causa dell'applicazione di questo metodo.
setEditColHeading (line 959)
void setEditColHeading (string $heading)
  • string $heading: text of heading for the action of 'record modify' in thye table of data visualization

    ITALIAN:
    testo di intestazione per l'azione di 'modifica record' nella tabella di visualizzazione dei dati
setExtraDeletingFunction (line 807)
void setExtraDeletingFunction (function $function)
  • function $function: the name of a function to be performed at the record cancellation and applied on the same record This way to act is equivalent to a trigger SQL of type ON DELETE.
    The function must accept a parameter conaining an associative array (obtained from mysql_fetch_array()) containing the record fields to be deleted.

    ITALIAN:
    il nome di una funzione da eseguire alla cancellazione di un record e applicata sul record stesso.
    Questo modo di agire è acquivalente ad un trigger SQL di tipo ON DELETE.
    La funzione deve accettare un parametro contenente un array associativo (ricavato da mysql_fetch_array()) contenente i campi del record da cancellare.
setFieldStatusIndicator (line 1407)

Avoids to show the contents of the field $field in the general visualization table.
At the place of the contents, is shown a state flage that is an image which simply indicates if the field is empty or not.

The application in fields set up like images causes the not visualization of the preview.



ITALIAN:
Evita di mostrare il contenuto del campo $field nella tabella di visualizzazione generale.
Al posto del contenuto, viene mostrato un indicatore di stato ovvero una immagine che segnala semplicemente se il campo è vuoto oppure no. L'Applicazione a campi impostati come immagini ne causa la non visualizzazione della preview.

void setFieldStatusIndicator (string $field, string $on,  $off)
  • string $field: the path containing the image that indicates on the field there's an image (the field is full)

    ITALIAN:
    il path contenente l'immagine che indica che sul campo è presente una immagine (il campo è pieno)
  • string $on: the path containing the image that indicates on the field there's not an image (the field is empty)

    ITALIAN:
    il path contenente l'immagine che indica che sul campo non è presente una immagine (il campo è vuoto)
  • $off
setFileField (line 1880)
void setFileField (mixed $field)
  • mixed $field: name of a field or array of field names in tables where are memorized file names, present in the filesystem of the server.
    In the modification/insertion form will be build the appropriate interface ( FILE input ).


    ITALIAN:
    nome di un campo o array di nomi di campo di tabelle in cui sono memorizzati nomi di file, presenti nel filesystem del server.
    Nei form di modifica/inserimento verrà costruita l'interfaccia appropriata ( FILE input ).
setFileNameCriteria (line 1936)
void setFileNameCriteria (string $path)
  • string $path:

    A symbolic string that represent the format to be used for file names while saving them into the server. Symbols are:
    *tb* Main table name.
    *pk* Primary key name in the main table.
    *cn* Name of the field binded to the file to save.
    *fn* Name of the original uploaded file.
    *ext* Extension of the original uploaded file.

    Default is *tb*_*pk*_*cn*.*ext* which allow to upload as many file as you want without name conflicts.
    Alternatively, to hold the original file name, use *fn*.*ext*



    ITALIAN:
    una stringa simbolica che rappresenta il formato del nome del file da salvare. I simboli sono:
    *tb* nome della tabella principale.
    *pk* nome della chiave primaria nella tabella principale.
    *cn* nome della campo della tabella principale associato al file da salvare.
    *fn* nome del file originale.
    *ext* estensione del file originale.

    L'impostazione di default è *tb*_*pk*_*cn*.*ext* in modo che non possano mai avvenire conflitti sui nomi dei file.
    Alternativamente, per mantenere l'esatto nome originale del file, usare *fn*.*ext*

setFilePath (line 1906)

Use this function is right just if there are specified the fields that refer to the files trough the functions setFileField() and setImageField()



ITALIAN:
Usare questa funzione ha senso solo se si sono specificati i campi che si riferiscono ai file tramite le funzioni setFileField() e setImageField()

void setFilePath (string $path)
  • string $path: the saving path of all files managed by theinside of the filesystem of the server.

    ITALIAN:
    il path di salvataggio di tutti i file gestiti all'interno del filesystem del server.
setFormHeading (line 1118)
void setFormHeading (string $heading, [string $backLink = ""])
  • string $heading: heading of the insert/modification form

    ITALIAN:
    intestazione del form di inserimento/modifica
  • string $backLink: text of the link on the way back to the table of general data visualization

    ITALIAN:
    testo del link di ritorno alla tabella di visualizzazione generale dei dati
setFormWidth (line 1034)

Sets up the two dimension in lenght percentual of the form of record insertion/modification .
The sum of the two values must be 100(%)



ITALIAN:
Imposta le 2 dimensioni in percentuale di larghezza del form di inserimento/modifica record.
La somma dei due valori deve essere 100(%)

void setFormWidth (int $w1, int $w2)
  • int $w1
  • int $w2
setHighlighting (line 955)

Sets up a state which stated lined must be highlighted



ITALIAN:
Imposta una condizione per cui determinate righe devono evidenziarsi

void setHighlighting (string $condition, string $TDAttributes)
  • string $condition:

    boolean PHP expression which will be valuted through eval().
    In the expression you can refer to the field X of every record with {{{X}}}. For example "{{{status}}}=='active'"



    ITALIAN:
    espressione booleana PHP che sarà valutata tramite eval().
    Nell'espressione ci si può riferire al campo X di ogni record con {{{X}}}. Ad esempio "{{{status}}}=='active'" This parameter is for example of type: 'class="foo" style="color:#F00"'

  • string $TDAttributes:

    string containing the definition of the cells tag (their attributes) which containing data of the element founded to be highlighted in the table of data general visualization



    ITALIAN:
    stringa contenente la definizione dei tag delle celle (i loro attributi) che contengono i dati dell'elemento rilevato come da evidenziare nella tabella di visualizzazione genrale. Questo paramentro è ad esempio del tipo: 'class="foo" style="color:#F00"'

setHTMLTextareaParams (line 825)

Sets up the parameters to go to class TextEditorContainer.



ITALIAN:
Imposta i parametri da passare alla classe TextEditorContainer (textarea HTML)

void setHTMLTextareaParams (mixed $arr)
setImageField (line 1849)
void setImageField (mixed $field, [mixed $resizeImg = false], [boolean $keepOriginal = false])
  • mixed $field: names of a field or an array of field names of tables where are memorized images names present in the filesystem of the server.
    In the modification/insertion form will be build an appropriate interface ( FILE input + image preview).
    The validation will allow the insertion of file of image type for the web ( GIF, JPEG, PNG ).

    ITALIAN:
    nome di un campo o array di nomi di campo di tabelle in cui sono memorizzati nomi di immagini, presenti nel filesystem del server.
    Nei form di modifica/inserimento verrà costruita l'interfaccia appropriata ( FILE input + image preview).
    La validazione consentirà l'inserimento di file di tipo immagine per il web ( GIF, JPEG, PNG ).
  • mixed $resizeImg: the value false indicates that the image will not be reduced.
    A numeric value indicates the size in pixel for which will happen the reduction.

    ITALIAN:
    il valore false indica che l'immagine non verrà ridimensionata.
    Un valore numerico indica la dimensione in pixel per cui avverrà il redimensionamento.
  • boolean $keepOriginal: Indicates if the original image sent must be saved

    ITALIAN:
    Indica se l'immagine originale inviata deve essere salvata.
setImagesAndScriptsPath (line 1517)
void setImagesAndScriptsPath (string $path)
  • string $path: path where you can find all the script and images requires from the class. The path is searched automatically in pre-defined runs at the moment of an object installation of the class but if files are not in those paths, is necessary to recall this method.

    ITALIAN:
    path in cui si trovano tutti gli script ed immagini richieste dalla classe. Il path viene cercato automaticamente in dei percorsi predefiniti al momento dell'instanziazione di un oggetto della classe (nel costruttore) ma se i file non si trovano in tali path, è necessario richiamare questo metodo.
setImageScaleDimension (line 794)
void setImageScaleDimension (int $val)
  • int $val:

    represents the maxim pixel dimension with which an image is shownin preview in the table of visualization of general data
    The image is therefore visualized in the way to be contained in a square box of this dimension:
    The biggest dimension of the image takes up the indicated value while the other one is proportionally browsed.



    ITALIAN:
    rappresenta la massima dimensione in pixel con cui una immagine viene mostrata in preview nella tabella visualizzazione generale dei dati.
    L'immagine viene quindi visualizzata in modo da essere contenuta in un box quadrato di questa dimensione:
    la dimensione più grande dell'immagine assume il valore indicato mentre l'altra viene scalata in modo proporzionale.

setInsertNewHeading (line 971)
void setInsertNewHeading (string $heading)
  • string $heading: text of heading for the action of 'record insertion'

    ITALIAN:
    testo di intestazione per l'azione di 'insermento record
setLanguage (line 838)
void setLanguage (string $lang)
  • string $lang: Name of the language to be used for the file texts shown by the class.
    italian and english texts are availavable. Values to be used are 'english' or 'italian'

    ITALIAN:
    Nome della lingua da usare per i di testo mostrati dalla classe.
    sono disponibili testi in italiano e inglese. I valori da usare sono 'english' o 'italian'.
setMailField (line 1807)
void setMailField (string $field)
  • string $field:

    name of the field of the main table considered as containing an email address.
    In the modification/insertion form will be apply a validation that verifies the right format of the typed values.



    ITALIAN:
    nome del campo della tabella principale considerato come contenente un indirizzo email.
    Nei form di modifica/inserimento verrà applicata una validazione che verifica il formato corretto dei valori digitati.

setMonthYearField (line 1818)
void setMonthYearField (string $field)
  • string $field: name of the field in the main table considered as containing an information month-year.
    In the modification/insertion form will be created an interface that will allow to insert month and year trough selection cells.
    The indicated field must be like type DATE and the information on the day will be ignored.

    ITALIAN:
    nome del campo della tabella principale considerato come contenente un'informazione mese-anno.
    Nei form di modifica/inserimento verrà creata una interfaccia che permetta di inserire mese ed anno tramite caselle di selezione.
    Il campo indicato deve essere di tipo DATE e l'informazione sul giorno verrà ignorata.
setMultipleEditDeleteHeading (line 983)

Sets up the heading keys of modification/elimination multiple of records in the table of data visualization



ITALIAN:
Imposta le intestazione dei tasti di modifica/eliminazione multipla dei record nella tabella di visualizzazione dei dati

void setMultipleEditDeleteHeading ( $ifSelected,  $selectAll,  $unselectAll,  $alertOnDelete)
  • $ifSelected
  • $selectAll
  • $unselectAll
  • $alertOnDelete
setNoResultString (line 979)
void setNoResultString (string $str)
  • string $str: entry text shown when the research doesn't get results

    ITALIAN:
    testo sentinella mostrato quando la ricerca non produce risultati
setNumericStringField (line 1827)
void setNumericStringField (string $field)
  • string $field: name of the field of the main table considered as containing numeric strings In the modification/insertion form will be apply then a validation that will allow to type just numbers

    ITALIAN:
    nome del campo della tabella principale considerato come contenente stringhe numeriche. Nei form di modifica/inserimento verrà quindi applicata una validazione che consente la digitazione di soli numeri.
setPageBrowsing (line 763)

Enables or closes down the visualization of elements which compose the navigation interface related to the breakdown into pages of the elements



ITALIAN:
Abilita o disabilita la visualizzazione degli elementi che compongono l'interfaccia di navigazione relativa alla suddivisione in pagine degli elementi.

void setPageBrowsing (boolean $byselect, boolean $bylink, boolean $selectrpp)
  • boolean $byselect: enables/closes down the visualization of page choice through link

    ITALIAN:
    abilita/disabilita la visualizzazione della scelta pagine tramite link
  • boolean $bylink: enables/closes down the visualization of page choice through a selection square

    ITALIAN:
    abilita/disabilita la visualizzazione della scelta pagine tramite casella di selezione
  • boolean $selectrpp: enables/closes down the visualization of the choice of the number of results for page

    ITALIAN:
    abilita/disabilita la visualizzazione della scelta del numero di risultati per pagina
setPageBrowsingConfig (line 658)

Enables or closes down the visualization of the elements belonging to the interface of navigation between pages



ITALIAN:
Abilita o disabilità la visualizzazione degli elementi appartenenti all'interfaccia di navigazione tra pagine.

void setPageBrowsingConfig (bool $bylink, bool $byselect, bool $selectrpp, [string $navigationPanelCSS = ''])
  • bool $bylink: enables the navigation between pages like a link for each page

    ITALIAN:
    abilita la navigazione tra pagine sotto forma di link per ogni pagina
  • bool $byselect: enables the navigation between pages like a square of selection containing all the pages to jump to

    ITALIAN:
    abilita la navigazione tra pagine sotto forma di una casella di selezione contenente tutte le pagine a cui saltare
  • bool $selectrpp: if true enables the selection of results for pages

    ITALIAN:
    abilita la selezione di risultati per pagine
  • string $navigationPanelCSS: is the name of the class CSS for the container of all navigation checks

    ITALIAN:
    nome della classe CSS per il contenitore di tutti i controlli di navigazione
setPasswordField (line 1110)
void setPasswordField (string $field)
  • string $field:

    name of the field set up as a password.
    The field will be published with two fields during the insertion phase (password repeat password) and 3 fields during the modification phase (old password, new password, repeat new password).
    Besides all this data will be memorized usig the MD5 coding.



    ITALIAN:
    nome del campo impostato come una password.
    Il campo sarà editabile con 2 campi in fase di inserimento (password,ripeti password) e 3 campi in fase di modifica (vecchia password,nuova password,ripeti nuova password).
    Inoltre questi dati saranno memorizzati usando la codifica MD5.

setPhotoField (line 1868)
void setPhotoField ( $field, [ $resizeImg = false], [ $keepOriginal = false])
  • $field
  • $resizeImg
  • $keepOriginal
setPrimaryTable (line 1678)
void setPrimaryTable (string $primaryTable)
  • string $primaryTable: name of a database table to be considered as the main between the present ones in the construction query of the object

    ITALIAN:
    nome di una tabella del database da considerarsi come principale tra quelle presenti nella query di costruzione dell'oggetto
setPrintColHeading (line 967)
void setPrintColHeading (string $heading)
  • string $heading: text of heading for the action of 'print visualization' in the table of data visualization

    ITALIAN:
    testo di intestazione per l'azione di 'visualizzazione per la stampa' nella tabella di visualizzazione dei dati
setRadioSettings (line 1538)

Sets up the maximum number of radio options that can have a fixed choice field as first paramenter, and the maximum number of radio options that can have in just one line, as second.

A field which has a number of elements greater than the fisrt parameter, will be published with a select input (instead of radio). A field which has a number of elements greater than the second parameter, will be visualized with a radio option for each line.



ITALIAN:
Imposta il numero massimo di opzioni radio che può avere un campo a scelta fissa come primo parametro, e il numero massimo di opzioni radio che può avere su una sola riga, come secondo. Un campo che ha un numero di elementi maggiore del primo parametro, sarà editabile con una select input (anziche dei radio). Un campo che ha un numero di elementi maggiore del secondo parametro, sarà visualizzato con una opzione radio per riga.

void setRadioSettings (int $maxOptions, [int $maxOptionsInOneLine = 3])
  • int $maxOptions: maximum number of options that can have a fixed choice field

    ITALIAN:
    numero massimo di opzioni che può avere un campo a scelta fissa
  • int $maxOptionsInOneLine: maximum number of options that can have an input radio in just one line

    ITALIAN:
    numero massimo di opzioni che può avere un input radio su una sola riga
setResultsPerPage (line 830)
void setResultsPerPage (int $rpp)
  • int $rpp: number of default of elements for page to print in the data visualization

    ITALIAN:
    numero di default di elementi per pagina da stampare nella visualizzazione dati
setRowName (line 1790)
void setRowName (string $rowName)
  • string $rowName: generic name with which to refer to record.
    Example: insert new BOOK, modify BOOK.

    ITALIAN:
    nome generico con cui ci si riferisce ai record.
    Esempio: Inserisci nuovo LIBRO, Modifica LIBRO.
setSearchField (line 1207)

Set up fields to be search fields, giving their names.

The first parameter is a string like "tablename.fieldname" while the second (optional or to be left blank) is a string that specifies the name to be visualized in the search form of search fot that field. If indicated without the name of the table, the field will be considered relative to an aggregation sql like COUNT(*) AS fieldname and in researches will be insert between HAVING clauses.

This method accept a VARIABLE NUMBER OF ARGUMENTS: the two topics can be repeated in pair setSearchField(F1a,F1b,F2a,F2b,F3a,....)



ITALIAN:
Imposta i campi come campi di ricerca specificandone i nomi.

Il primo parametro è una stringa del tipo "nometabella.nomecampo" mentre il secondo (opzionale o da lasciare vuoto) è una stringa che specifica il nome da visualizzare nel form di ricerca per tale campo il campo. Se indicato senza il nome della tabella, il campo sarà considerato relativo ad una di aggregazione sql come COUNT(*) AS nomecampo e nelle ricerche sarà inserito tra le clausole HAVING.

Questo metodo accetta un NUMERO VARIABILE DI ARGOMENTI: i due argomenti possono essere ripetuti a coppie setSearchField(F1a,F1b,F2a,F2b,F3a,....)

void setSearchField ()
setSearchHeading (line 975)
void setSearchHeading (string $searchHeading)
  • string $searchHeading: text of heading for the box of data research

    ITALIAN:
    testo di intestazione per il box di ricerca dati
setTableBorderStyles (line 720)

Sets up the names of CSS classes to combine to outside cells of the table of data visualization.

This allows to realize a border graphically elaborated to the general table of data.



ITALIAN:
Imposta i nomi delle classi css da abbinare alle celle esterne della tabella di visualizzazione dati. Questo consente di realizzare un bordo graficamente elaborato alla tabella generale dei dati.

void setTableBorderStyles (string $topsx, string $top, string $topdx, string $dx, string $botdx, string $bot, string $botsx, string $sx)
  • string $topsx: CSS class for the left superior corner cell of the table of data visualization

    ITALIAN:
    classe CSS per la cella dell' angolo superiore sinistro della tabella di visualizzazione dati.
  • string $top: CSS class for cells of the superior corner of the table of data visualization

    ITALIAN:
    classe CSS per le celle del bordo superiore della tabella di visualizzazione dati.
  • string $topdx: CSS class for the right superior corner cell of the table of data visualization

    ITALIAN:
    per la cella dell' angolo superiore destro della tabella di visualizzazione dati.
  • string $dx: CSS class for right border cells of the table of data visualization

    ITALIAN:
    per le celle del bordo destro della tabella di visualizzazione dati.
  • string $botdx: CSS class for the right inferior corner cell of the table of data visualization

    ITALIAN:
    per la cella dell' angolo inferiore destro della tabella di visualizzazione dati.
  • string $bot: CSS class for inferior berder cells of the table of data visualization

    ITALIAN:
    per le celle del bordo inferiore della tabella di visualizzazione dati.
  • string $botsx: CSS class for the left inferior border cell of the table of data visualization

    ITALIAN:
    per la cella dell' angolo inferiore sinistro della tabella di visualizzazione dati.
  • string $sx: CSS class for left border cells of the table of data visualization

    ITALIAN:
    per le celle del bordo sinistro della tabella di visualizzazione dati.
setTableCellPadding (line 1956)
void setTableCellPadding (int $CS)
  • int $CS: the 'cellpadding' of the data visualization table

    ITALIAN:
    il 'cellpadding' della tabella di visualizzazione dei dati
setTableCellSpacing (line 1953)
void setTableCellSpacing (int $CS)
  • int $CS: the 'cellspacing' of the data visualization table

    ITALIAN:
    il 'cellspacing' della tabella di visualizzazione dei dati
setTableCellStyle (line 1971)
void setTableCellStyle (string $TD, string $editDeleteTD, string $headerTD, [string $fieldLink = ""])
  • string $TD: name of the class CSS to apply to intern cells (tag TD) of the data visualization table

    ITALIAN:
    nome della classe CSS da applicare alle celle interne (tag TD) della tabella di visualizzazione dei dati
  • string $editDeleteTD: name of the class CSS to apply to cells (tag TD) of the table which contains the buttons related to actions on each line

    ITALIAN:
    nome della classe CSS da applicare alle celle (tag TD) della tabella che contengono i pulsanti relativi alle azioni su ogni riga
  • string $headerTD: name of the class CSS to apply to heading cells (tag TD) of the data visualization table

    ITALIAN:
    nome della classe CSS da applicare alle celle di intestazione (tag TD) della tabella di visualizzazione dei dati
  • string $fieldLink: name of the class CSS to apply to links which are added inside the table, through the method addLinkCol()

    ITALIAN:
    nome della classe CSS da applicare ai link, che vengono aggiunti all'interno della tabella, tramite il metodo addLinkCol()
setTableRowStyle (line 1946)
void setTableRowStyle (string $val1, string $val2)
  • string $val1: name of the CSS class to apply to the heading lines (tag TR) of the data visualization table

    ITALIAN:
    nome della classe CSS da applicare alle righe (tag TR) di intestazione della tabella di visualizzazione dei dati
  • string $val2: name of the CSS class to apply to the internal lines in the data visualization table

    ITALIAN:
    nome della classe CSS da applicare alle righe interne della tabella di visualizzazione dei dati
setTableStyle (line 1981)
void setTableStyle ( $TD,  $editDeleteTD,  $headerTD, [ $fieldLink = ""])
  • $TD
  • $editDeleteTD
  • $headerTD
  • $fieldLink
setTextCutLength (line 1493)
void setTextCutLength ([int $cutLength = 150])
  • int $cutLength: number of the maximum characters to be visualized for each field in the general visualization table

    ITALIAN:
    numero di caratteri massimi da visualizzare per ogni campo nella tabella di visualizzazione generale
setViewAllSearchOptions (line 1507)
void setViewAllSearchOptions (boolean $bool)
  • boolean $bool: indicates if visualize all the possible options in the input SELECT of the researching form independently from the presence of the record database with those values or without

    ITALIAN:
    indica se visualizzare tutte le opzioni possibile negli input SELECT dei form di ricerca indipendentemente dalla presenza del database di record con quei valori o meno
setViewResultWithoutSearch (line 1499)
void setViewResultWithoutSearch (boolean $bool)
  • boolean $bool: indicates if the record visualization must happen even without any research. Default is true.

    ITALIAN:
    indica se la visualizzazione dei record deve avvenire anche senza effettuare alcuna ricerca. Di default è true
showAllElements (line 1114)
void showAllElements ([boolean $all = true])
  • boolean $all: means if in the visualization table must be visualized all records without paging

    ITALIAN:
    indica se nella tabella di visualizzazione devono essere visualizzati TUTTI i record senza paginazione
status (line 1068)

Used to obtain a string which describes the actual state of the class This can be useful to make printing actions or other ones in regard to the actual state of the class For example

  1.  if ($OBJ->status=='inserting'echo 'inserting user message';



ITALIAN:
Serve ad ottenere una stringa che descrive lo stato attuale della classe.
Questo può essere utile per poter effettuare azioni di stampa o altro rispetto allo stato attuale della classe.
Ad esempio

  1.  if ($OBJ->status=='inserting'echo 'inserting user message';

  • return: String containing one of these values: inserting, editing, deleting, editingMany, viewing

    ITALIAN:
    Stringa contenente uno di questi valori: inserting, editing, deleting, editingMany, viewing
string status ()
useAjax (line 812)
void useAjax (boolean $bool)
  • boolean $bool: Enable or disable the using of Ajax technology for data browsing

    ITALIAN:
    Abilita o meno l'utilizzo della tecnologia AJAX per la navigazione tra i dati

Documentation generated on Fri, 25 Sep 2009 17:43:29 +0200 by phpDocumentor 1.4.1