Table of Contents

Property | Description
--- | ---
Charting
chartFontPrefix | Tags to prefix chart numbers
chartFontSuffix | Tags to append to chart numbers
chartLens | Fields listed in this lens are displayed as charts
chartParams | Stores charting parameters set when dynamic editing enabled
Colors
colorBackground | Color of the background area outside the grid and detail table
colorEven | Color of even rows in grid
colorFooter | Color of any totals at bottom of grid
colorGroup | Color of any column grouping rows
colorNav | Color of the navigation bar cells
colorNavBorder | Color of background behind captions and navigation bar
colorOdd | Color of odd rows in grid
colorRecNo | Color of background of RecNo column
colorSelect | Color of selected sort column and selected recno
colorSubFooter | Color of subtotals when groupLens enabled
colorTitle | Color of column/field title cell
css | CSS include file.
detailLeftColor | Color of left column of detail grid and edit/new record
detailRightColor | Color of right column of detail grid or edit/new record
filterTopColor | The background color of the top of the search/filter form
Editing, Updating and Creating Records
anchorTags | When saving, detect http://* and www.* and email addresses convert them to links
attrDateTime | Sets tag attributes for date and timestamp input fields
autoGenerateKey | Makes phpLens autogenerate an integer to be stored into keyCol when inserting a new record
bannedTags | Regular expression describing which tags are banned for data entry
canDelete | Show Delete button and allow deletes
canEdit | Show Edit button and allow record updates
canNew | Show New Record button and allow record creation
childLens | Replaces the details grid with an editor to create/edit records
defaultLens | On new record, these are the default values of specified fields
editClick | Set to true to edit a record when you click anywhere in a row
editHiddenTags | Define hidden input tags to be included in edit form
editLens | This lens sets which fields are shown when editing
editMultiple | Allow editing of multiple records in the grid
editNewRadioCheckBoxTD | Control checkbox style and formating in edit/new record form
emptyCharIsNull | If true, then zero length strings are stored as nulls
emptyDatesNull | Date to use when date is empty on Insert/Update
eventPostDeleteSQL | Name of function to call after record is deleted.
eventPostInsertSQL | Name of function to call after New Record is created
eventPostUpdateSQL | Name of function to call after record is changed
eventPreDeleteSQL | Name of function to call before record is deleted.
eventPreInsertField | Name of function to call before every field is processed for new records
eventPreInsertSQL | Name of function to call before New Record is created
eventPreUpdateField | Name of function to call before every field is processed for updates
eventPreUpdateSQL | Name of function to call before record is changed
exportLens | List of fields to export as Excel file or CSV when they click on the export button
exportOptions | Export options for exportLens property
fmtDateInput | The default date input format
fmtDecimalDB | The character that the database uses for decimal places on INSERT/UPDATE
fmtTimeStampInput | Default format of timestamps for data entry
getFieldsFromTables | If sql select statement returns no fields, then we get field info from these tables
gridReadOnlyLens | Sets fields cannot be modified when editMultiple is true
htmlEditLens | Creates a wysiwyg HTML editor for fields when editing records
imageMaxSize | Maximum binary file to upload in bytes
imageUploadFunction | Name of function to call when uploading data in PHP safe mode
inputLens | Allows you to add html/css attributes to input fields
inputTypeLens | When editing, display checkbox, radio or submit buttons for selected fields
keyCol | Primary key of keyTable
keyIsChar | Force primary key to be treated as a char if true, otherwise autodetect
keyTable | The name of the table you are editing and creating records on
keyVariable | Edit a record based on a global variable
mustFill | Indicates fields that must be filled when editing/creating records
mustFillMark | Mark appended to the text label indicating that the field must be filled (for new records)
newHiddenTags | Define hidden input tags to be included in new record form
newLens | This lens sets which fields are shown when creating a new record
newReadOnlyLens | This lens sets which fields cannot be modified on creation, but are editable.
nl2br | Convert newlines to <BR> tags in a field after on saving a record
noAutoNew | Set to true to disable switching to NEW record state when no records are found
numInputLen | Specify the width of <input type=text> tag for numbers
powerEditLens | Allows you to modify default input values when editing records
readOnlyLens | This lens sets fields which are readonly in both edit and new record mode
roInputStyle | Read-only input field CSS style
saveOptions | Additional save options when editing or creating records
searchLookupLens | Dynamically search for record and store results in fields when editing or new record
sectionLens | Creates section breaks for edit/new record forms
showCal | Show popup calendar when editing entries
showCancel | Show cancel button when editing
spDelete | Stored procedure to delete a record
spEdit | Stored procedure to update a record
spNew | Stored procedure to insert a new record
sqlEditNew | Allows you control what fields to display when editing or creating new records
tdEdit | Set TD attributes for input cell when editing or creating records
textAreaHeader | Attributes for <textarea> tag when editing/creating records
textAreaLens | This lens determines which fields use the larger textarea tags for data entry
textInputHeader | Set attributes of <input type=text> tags for editing/creating records
textInputMax | Visual width of <input type=text> tag. You can enter more chars than this!
textInputMin | Minimum visual width of <input type=text> tag
textSizeLens | Determines the size of input text and textarea fields
toUpper | Convert all strings in text boxes to uppercase (when saving and searching)
validation | Javascript or input mask for data and error message on error
versionLockCol | Name of integer column used to implement versioning, so that optimistic locking can be used
Error Handling, Redirects
errHideMessages | Hide warning messages
errorPrefix | Prefix to apply to all error messages displayed
errorSuffix | Suffix to be applied to all error messages displayed
redirectNoData | when no data returned from SQL query, redirect to another page
redirectOnInsert | After successful insert new record, redirect to another page
redirectOnInsertCancel | Redirect if user cancels new record
redirectOnUpdate | After a successful update, redirect to another page
redirectOnUpdateCancel | Redirect if user cancels editing
Essential
dynEdit | Turn on dynamic editing
id | ID to identify this phpLens object
keyCompound | Compound primary key fields
sql | Holds the SQL string sent to the database
Filtering and Searching
allowEmptyFilter | When user performs an empty filter/search, show all records?
filterAllOr | Search clauses are ORed
filterAnyWhere | Determines whether the match anywhere in the filter/search form is visible
filterDefaults | Set the default values for filtering/searching
filterFontPrefix | Tags to prefix to search criteria for filter/search table
filterFontSuffix | Tags to append to search criteria for filter/search table
filterLens | This lens determines which fields are to be used when filtering/searching
filterModifierFn | Allows you to perform special searching on a column
filterParams | Additional settings that are used internally by filterLens
filterRadioCheckBoxTD | Control checkbox style and formating in filter form
filterShowForm | When filtering/searching, show the filterscreen and grid together
filterTableCols | The number of field columns to display
filterUseLike | Determines whether searching strings will match using SQL LIKE
phplensDatabase | Name of the index to $PHPLENS_DATABASES
remoteQuery | Full http path to the phplens_remoteq.php file
showFindMore | Show Find More checkbox in search form if true
sqlFilter | Sets the sql statement when searching/filtering
upperCase | Searches will change in the where clause COL='value' to upper(COL)='value'
Graphic Images
imageAttributes | Attributes in the <img> tag such as WIDTH or HEIGHT
imageCacheSecs | Cache blobs stored in database in the imageTmpDir directory for imageCacheSecs
imageDir | PhpLens icons and javascript are stored here
imageEmpty | Image or text to show when no image is seen
imagePage | URL of web page used to display images
imageTmpDir | Directory to store temporary images and export excel/csv files
imageTmpDirURL | Maps the image cache directory to a URL so that we can generate img tags efficiently
imageType | mime type to return for binary images
Grouping and totaling of rows
avgLens | Display averages in the subtotal and total rows
groupDesc | Use groupLens sorted descending
groupLens | Group rows by this data column
pageBreakRows | Number of rows before issuing a CSS page break for printing
scrollMaxRecordCount | Read-only property that holds number of records in all pages
subTotalFontPrefix | Tags to prefix to subtotal label
subTotalFontSuffix | Tags to append to subtotal label
sumLens | Fields to sum
sumTotal | Array that holds the totals generated by sumLens
totalFontPrefix | Tags to prefix to column total label
totalFontSuffix | Tags to append to column total label
totalNumPrefix | Tags to prefix numeric totals and subtotals
totalNumSuffix | Tags to append to numeric totals and subtotals
Information and Debugging
dataVers | Version number of phpLens internal data format
debug | Debug level. 0=none, 1=show SQL, 2=detailed view
debugDie | Print SQL generated by phpLens and halt execution.
fileSessionPath | For non-applet phpLens objects, store session info in a file instead of in the phpLens table
keyColClear | Clears the keyVariable if it not visible on page
lensVers | Version number of phpLens
Navigation Bar and Menu
hideAnchorName | When true, hides the anchor name that is generated by phpLens so that we scroll down the browser to where the applet is located
menuHide | Menu items in navigation bar to hide
navFontPrefix | Attributes to prefix to menu item text
navFontSuffix | Attributes to append to menu item text
navHeader | Defines the TR attributes for the top and bottom navigation bar
navTableHeader | Attributes table enclosing navigation bar at top and bottom of grid
navTDHeader | Attributes of <td> tag for navigation menu items
navUserButtons | Define additional menu items in navigation bar
scrollBgColor | The background color in the navigation bar for scroll links
scrollFontPrefix | Formatting to apply before an unselected link in the navigation bar
scrollFontSuffix | Formatting tags to apply to end of scroll link in navigation bar
scrollHiliteFontPrefix | The formatting of the current page link selected in the navigation bar
scrollHiliteFontSuffix | The formatting of the current page link selected in the navigation bar
scrollLinks | Display a set of scrolling page links in the navigation bar
scrollTDHeader | Defines the TD attributes for the scroll link cells
Programming
cacheData | Cache data in $ADODB_CACHE_DIR for cacheData seconds
cacheLookups | Cache lookup values for cacheLookups seconds in the $ADODB_CACHE_DIR directory.
compat | Compatibility mode, defaults to 2.0
connection | Holds the ADOdb connection object
connectionLookups | Instead of using the default connection, use this connection for sql lookups
curState | Current phpLens state.
displaySep | The separator used to display the checkbox choices
dynUseSessions | Use dynamic editing settings
errorHandler | Define errorHandler function that is called when errors occur
fields | Holds the data of the current record in VIEW/FILTERVIEW
fieldSep | Seperator between multiple settings for a single column
firstState | Which screen to show on startup and when phpLens is reset
forceType | Change the type of a column
groupSep | Separator between column settings
ignoreSessions | Do not register any session variables
keyColVariable | Mirror the primary key column value in a global variable
keyRecNo | Add primary key to RecNo link
lang | Holds the current language definitions
nameSpace | Changing this property prevents the same applet on different pages from sharing session variables
onlyOrder1Col | Do not allow an ORDER BY on the same column
overrideFunction | Name of function used to modify globally phpLens settings
persist | For internal connections, use persistent connections if true
renderer | Custom PHP class for drawing in grid view.
rs | Holds the adodb recordset
sqlWhere | Allows you to modify SQL where clause without modifying sql property
urlParams | Additional parameters to append to end of links
Security
md5Input | Enables md5 fingerprinting of data entry fields
password | Password protect dynamic editing
securityCheckReferer | Check referer on save record is same as host server
securityEditSeq | keep track of order of updates by storing a seq no for every New/Edit
Table and Grid formating
detailHdr | Attributes of <TR> tag for detail table
detailTableHeader | Attributes of detail <table> tag
detailTitleHeader | Attributes of TD tag for field titles
detailValueHeader | Attributes of TD tag for field values in detail grid
editTableHeader | Attributes of <table> tag used in editing/updating
eventDetailView | Calls PHP function defined here whenever the detail view changes
filterTableHeader | Attributes of filter table
gridHeight | Used to fix the main grid's height to a certain amount
gridTableHeader | Attributes of grid <table> tag
layoutTableHeader | Attributes of (invisible) bounding table surrounding phpLens
newTableHeader | Attributes of <table> tag used in creating new record
pageBreakHTML | HTML used to indicate page break when pageBreakRows>0
rowColorLens | Set the color of rows in the grid dynamically
showDetails | Show detail grid for current row
showGrid | Show main grid
sqlDetail | SQL to use to display fields in the details
Table Cell formating
border0 | Set table borders to 0
cellFontPrefix | Tags to prefix to data cell text
cellFontSuffix | Tags to append to cell data
colorLens | Dynamicly change color of column or cell, and column attributes too.
detailFontPrefix | Tags to prefix to cell data for detail, new and edit tables
detailFontSuffix | Tags to append to cell data for detail, new and edit tables
fmtDateOutput | Default format of dates for display in grid or detail table
fmtDecimal | Decimal character
fmtDecimalPlaces | Number of decimal places to display for numeric data
fmtThousands | Thousands seperator for numbers
fmtTimeStampOutput | Default format of timestamps for display
fmtTimeStampsAsDates | Force all timestamps to appear as dates.
groupFontPrefix | The tags prefixed to the group text
groupFontSuffix | Tags appended to grouped text
htmlLens | Determines which character fields to treat as native HTML/binary (no encoding)
lookupLens | A lens to lookup descriptions of codes and create popups for <select> options
noTrim | Do not trim column data
numberPrefix | HTML tags to prefix to numbers
numberSuffix | HTML tags to append to numbers
overlibInit | Set this to false to disable generation of overlib div tag and javascript include
overlibLens | Uses the overlib library to create a javascript popup in the grid for specific columns
powerLens | Dynamicly change contents of cell
powerPrefix | Prefix powerLens code with the following PHP code
sameRowLens | Controls whether to show 1 or 2 fields per row in new, edit & detail grids.
tdLens | Set the TD attributes of cells
warnLookupOverflow | Warning to display if lookupLens fails
Table Column/Field Titles
detailTitleFontPrefix | Tags to prefix to detail, edit, new, filter table column titles
detailTitleFontSuffix | Tags to append to detail table column titles
fontSelColPrefix | Attributes to prefix currently selected (sort) column title
fontSelColSuffix | Attributes to append to currently selected (sort) column title
nameLens | Sets the field titles for the grid, detail, edit, new record and search/filter screens
showHeaders | Display column headers/titles
showSort | Clicking on column titles will sort columns
showSortCols | The columns or fields that users can click on to sort
titleColor | Sets the color of a span of titles
titleFontPrefix | Tags to prefix column titles
titleFontSuffix | Tags to append to column titles
titleHeader | Attributes for <TH> tag for column titles in grid
titleLevel1 | Adds an additional title row which spans multiple columns to the grid
titleLevel2 | 2nd title row
titleLevel3 | 3rd title row
Table Rows and Columns
columns | Number of columns to display in grid
detailLens | This lens sets which fields are shown in the detail table
evenHeader | Attributes of <TR> tag of even rows of grid
gridLens | This lens sets which fields are shown in the grid
keyRecNoSelect | Selected record is based on primary key and not relative position in grid
oddHeader | Attributes of <TR> tag of odd rows of grid
pageSize | Number of rows per page
showRecNo | 0=hide, 1=show on left of grid, 2=show on right of grid, 3 = hide details and show on left, 4 = hide grid show details, 5 = show details below grid
Templates
includeFooter | Include and run a PHP file after the phpLens html is rendered
includeHeader | Include and run a PHP file before the phpLens html is rendered
templateAssign | Pass additional variables to the template engine
templateBaseDir | Define default location of templates directory.
templateDetail | Define Smarty template for details
templateEdit | Define Smarty template for editing
templateFilter | Template for search form
templateFilterGrid | Smarty template for one row of phpLens grid when filtering
templateGrid | Smarty template for one row of phpLens grid
templateGridHdr | Template of the header row of phpLens grid where all field titles are shown in view state
templateLayout | Template of phpLens in view state
templateLayoutAddFilter | Adds new variable to layout template that holds filter/search form
templateMode | Controls how edit/new templates display input fields
templateNew | Template of phpLens when creating new records
templatePrefix | Prefix that indicates the beginning of a template or powerLens variable
templateSecure | When using new or edit templates the field checksums are used
templateShowErrors | Place error messages within template instead of showing them automatically
templateSuffix | Suffix that indicates the end of a template or powerLens variable