Documentation

Miscellaneous parameters

Parameter

Rel

Description

rowcallback

1.0.0

Callback function called on each row. It is useful to add custom link to each row. Optional, default no callback

exit

1.0.0

Page to call when the user click on the 'exit' link. Optional, default the page referrer, if set.

onokhref

1.1.0

Page to call if the add/modify action successed (only add o modify mode).

onaborthref

1.1.0

Page to call if the add/modify action is aborted (only add o modify mode).

showdethref

1.0.0

Should the module show the 'detail' link to switch to 'detail view'. Values: true/false. Optional, default: false

prefix

1.0.0

Prefix to add to the session variables to allow multiple pager istance into the same session.Optional default space

detailmode

1.0.0

Set the table view (if set to false) or the detail view (if set to true). Optional, default false.

languagefile

1.0.0

Set the file that contains the translated text. Optional, default './language.en'

showfirstcallrow

1.0.0

In the first call to this page shuold I shows the first 15 records from the input (TRUE/FALSE). Optional, default: FALSE

showpagenumber

1.1.0

Should the class show the link to pages 1,2,3,.. Optional, default: TRUE

showmovepage

1.1.0

Should the class show the link to the next/previous page? Optional, default: TRUE

mode

1.1.0

Set the mode to start to show the rows. The modes are: DisplayTable (shows the rows as a table, the default), DisplayDetail (display the row detail, it starts from the first), Add (it starts directly into add new row mode), Modify (it starts directly into add new row mode). Optional, default: DisplayTable

BoxClass

1.1.0

Class used to draw an message box. Optional, default: CYapBox

DetailViewClass

1.1.0

Class used to render the row's detail. Optional, default: CYap_DetailView

TableViewClass

1.1.0

As the previous one, but it is used to render the table Optional, default: CYap_TableView

SkipPageClass

1.1.0

Module used to display first, previous, next, last page. Optional, default: CYap_MoveToPage

PageNumberClass

1.1.0

Display the number of the pages before and after the current one. Optional, default: CYap_PageNumber

FormClass

1.1.0

Draw the form to perform the add/modify functions. Optional, default: CYap_Form

pre_1_0_style

1.1.1

Compatibility issue. In detail mode, the 1.1.1 allows to set which columns show. This way requires that the column to show must be listed in $ShowFieldCfg, otherwise the module assumes not to show the column. The previous version, in detail mode, it shows all columns regardless the $ShowFieldCfg parameter. Set this variable to false if you want to gain more control on the field to show in detail mode, or set to true if you prefer the old behaviour. Optional, default: true.

outformats

1.1.1

This parameter allows you to define many custom formats to use to show the values. It is an array indexed by format name. Each element is an array which may contains the following keys:

custom

1.1.1

Formats the output through a custom function. The function must accept one parameter (the value) and return the formatted string

printf

1.1.1

Formats the output according to printf format options. It accepts the same format as the PHP function printf.

date

1.1.1

If the field is a timestamp, it shows the date according to the format. It accepts the same format as the PHP function date.

number

1.1.1

Format the number through the PHP number_format function. Value: decimals,dec_point,thousands_sep

Yap comes with some predefined formats. They are:

  • NUMERIC_IT: numeric number, Italian format x.xxx.xxx
  • NUMERIC_EN: numeric number, English format x,xxx,xxx.xx
  • MONEY_IT : monetary Italian format x.xxx.xxx,xx
  • MONEY_EN : monetary English format x,xxx,xxx.xx
  • DATE_IN : convert timestamps into Italian format date day/month/year
  • DATE_US : convert timestamps into US format date month/day/year

    • This parameter is optional.