Tools

Click [Tools] in the main menu bar to access the following useful tools available in PHPMaker.

Synchronization
Extensions
Advanced Settings
Copy Table Settings
Copy Field Settings
Sort Tables Alphabetically
Languages
Locale Settings
Multi-Language Property Editor
Delete Template Cache
Update Template
Menu Editor
Scripts and Stylesheets

 

Synchronization

During the course of project development, it is common that you have altered your database schema. To save the effort of doing the customization from scratch again, PHPMaker provides you with the ability to synchronize your project data with the database. The synchronization process can be invoked in the following situations:


1. When working in PHPMaker

Simply click [Tools]->[Synchronize] or click thebutton on the toolbar to perform the synchronization. PHPMaker will check automatically to see if the database schema has been altered. If there are changes, you will be prompted whether or not to proceed with the synchronization.

2. When opening a project file

When open a project file, PHPMaker will automatically check the database to see if the schema has been altered. You will be prompted to keep or update to the new schema.

Note If the database contains a large number of tables/fields, this auto-synchronization feature may make reloading a project file slow. In that case you can disable this feature by unchecking [Tool]->[Auto Synchronize].

 

Extensions

Click [Tools]->[Extensions] to enable or disable these extensions. Before enabling the extension, make sure you read the notes about the extension first. If the extension has advanced settings (NOT every extension has it), you'll see the [Advanced] tab after selecting the extension. Click the [Advanced] to configure advanced settings for the extension.

In the [Advanced] tab, you may see [Project], [Tables], and [Fields] tabs, depending on extensions. Note that NOT every extension has all 3 tabs, some extensions may have project level settings only, some extensions may have table or field level settings also, e.g.

Note The table or field names in the [Tables] or [Fields] tabs are searchable, to find a table or field, just focus the [Table] or [Field] column by clicking the column first and then type the table or field name.

 

Advanced Settings

Advanced Settings are some advanced general settings for PHPMaker, or some rarely changed settings for the project, or custom defined settings for use during code generation. Click [Tools] -> [Advanced Settings] to change these settings. You

 

General General settings for PHPMaker (for all projects)
Auto-Update values

The comma separated PHP function names for the Auto-Update feature (see Field Setup)

You can add your own functions by putting your functions in the server side Global Code section (see Server Events and Client Scripts) and then add your function name here. The function name must follow the standard rules for naming variables in PHP.

Custom validation functions

The comma separated function names for the Validate feature (see Field Setup)

You can add your own PHP/JavaScript functions for custom server/client-side validation. The function name is used for both PHP and JavaScript, so it must be a valid function name for both languages. You can put your server-side and client-side validation function in the Global Code (see Server Events and Client Scripts) section of server-side and client-side respectively.

UTF-8 output files

If enabled, the output file is in utf-8 encoding. Otherwise, it is ASCII by default.

The template files and output files are in ASCII encoding by default. Since the phrases are separated into XML language files in utf-8 encoding, ASCII encoding will suit most cases as the scripts contain code only. When you customize a template, it is recommended you use the language file also. If you have to put unicode characters directly in the template files, you must always use utf-8 and save the file in utf-8 encoding with the byte order mark (EF BB BF), and enable this setting to make the code generator output files in utf-8 encoding.

PHP (php.exe) path

The installed path of php.exe. For use with Browse after generation and PHP as Testing web server, read Generate Settings.

PHPMaker uses php.exe to run the testing site, it will try to find automatically where php.exe is installed. If not found, enter your path here (including the file name "php.exe"), e.g. C:\Program Files (x86)\PHP\php.exe

PHP web server port

The port to be used by PHP built-in web server. For use with Browse after generation and PHP as Testing web server, read Generate Settings.

PHPMaker will try to find a free port automatically. If you want to specific one explicitly, enter it here.

Update template on start Check and update template on start (for registered users only)
Node.js path Path of Node.js (node.exe). By default PHPMaker uses its own 32-bit node.exe under the "node" subfolder of the installed path, e.g. C:\Program Files (x86)\PHPMaker <version>\node. If you want to use another version of Node.js (e.g. 64-bit version), you can specify your own path, e.g. C:\Program Files\nodejs.
Use project versioning Enable project versioning. If enabled, whenever you save your project, a version of the project will be created. You can click Project -> History to view the versions and revert to any version. See Project File for details.
Project Settings for the current project only
Project name

Project name. See Project File for more info.

Note It is recommended that you use only alphanumerical characters in lowercase in project name.
Node.js max. old space size

Memory limit of Node.js (MB). If your project is large, you may need to increase the memory limit, e.g. you can set it to 2048, 3072, 4096, etc.

Notes

  1. Set the setting according to the available memory of your system,
  2. If you need to use a large setting, you may need 64-bit version of Node.js. If your PC is 64-bit, download the latest 64-bit Windows installer and install it, then set Node.js path (see above) as the installed path, e.g. C:\Program Files\nodejs.
Node.js write file synchronously Write file synchronously. By default, output files are generated asynchronously. Use this setting if writing file synchronously performs better on your system.
Node.js garbage collection Use Node.js garbage collector to clean up memory regularly during generation.
Note Cleaning up memory manually will slow down generation, only enable this setting if you encounter out of memory problem.
Project ID

Unique ID of the project. Do not change the project ID unless absolutely necessary. See Project File for more info.

Debug Show the SQL and runtime error for debugging.
Compress project .css

Compress the project stylesheet (i.e. <project>.css) and output minified .css file.

Compress project .js

Compress the project JavaScript file (i.e. ewp<version>.js) and output minified .js file.

Generate database helper

Generate a database helper named ewdbhelper<version>.php for including in current or other project for simple access to the database and retrieving data.

Disable project CSS styles

Do not generate the the project stylesheet.

Note If you use this setting, there will be no CSS styles generated for the scripts and the HTML will be malformed, make sure you provide your own CSS styles, for example, by specifying your own stylesheet, read HTML Settings.
Character encoding (for Ajax/iconv)

Specify the encoding for Ajax/iconv

Some features such as Ajax require conversion between your encoding and utf-8. If you use non English languages, you may need to set character encoding for these features. By default PHPMaker will setup the encoding automatically based on your project's Charset setting. If that is incorrect, you can specify yours. Make sure either iconv functions or multibyte string functions are enabled and your encoding is supported. See PHP manual for details.

File system encoding

The encoding of the file system of the server.

When saving a file to the server, the file name need to be converted to the file system encoding. If your project charset/encoding is different from the file system encoding and you accepts non alphanumeric file names, enter the file system encoding of the server

MySQL charset (for SET NAMES)

Specify the charset for MySQL SET NAMES statement.

If actually charset encoding of your data is different from the charset of your project, you may need to specify this setting for MySQL to convert between them. Read http://dev.mysql.com/doc/refman/5.0/en/charset-connection.html before using this setting.

Validate NOT NULL fields By default PHPMaker will detect fields declared as NOT NULL in the database (and without default value in database or the project) and force "Required" validation. If for some special reason you need to disable this feature, disable this setting.
Use DOM XML for Language object

Use PHP 5 DOM XML to load language file instead of using PHP XML parser.

By default the scripts use PHP XML parser to load the language file for faster loading. If your PHP setup does not have PHP XML parser installed or you want to manipulate the loaded XML document by DOM XML, enable this setting.

Use JavaScript popup message

Use JavaScript popup message to display messages of the application.

By default the messages are displayed above the main table. This options uses JavaScript to show the message as a popup message on page load.

Disable button on submit

Disable submit buttons when submitting the form.

Enable this setting if you need to prevent user submitting the form more than once (by clicking the submit button) when the browser is submitting the form.

Allow login by URL

Allow passing username and password to the login page as URL parameters.

By default the login page accepts HTTP POST only. If this setting is enabled, it accepts HTTP GET also, then user can login by URL , e.g.

login.php?username=xxx&password=yyy (where "yyy" is a plain text password)

For example, this allows user login by using PHP cURL from your own scripts.

For security, you should pass an encrypted password whenever possible. In fact, usually you can retrieve an encrypted password from other web application only, if it is same as the encrypted password for your project (e.g. Hashed password is enabled in the project, or the project uses the same user table), then you can pass an additional URL parameter encrypted=1 to let the scripts know how to compare the passwords, e.g.

login.php?username=xxx&password=xyz&encrypted=1 (where "xyz" is an encrypted password)

Allow login by session variables

Allow passing username and password to the login page via session variables.

By default the login page accepts HTTP POST only. If this setting is enabled, it accepts session variables also, then user can auto-login by setting some session variables , e.g.

$_SESSION[EW_PROJECT_NAME . "_Username"] = "xxx"; // where EW_PROJECT_NAME is the constant of your project name (see above) and "xxx" is user name
$_SESSION[EW_PROJECT_NAME . "_Password"] = "yyy"; // where "yyy" is a plain text password

For security, you should pass an encrypted password whenever possible. In fact, usually you can retrieve an encrypted password from other web application only, if it is same as the encrypted password for your project (e.g. Hashed password is enabled in the project, or the project uses the same user table), then you can pass an additional session variable to let the scripts know how to compare the passwords, e.g.

$_SESSION[EW_PROJECT_NAME . "_Username"] = "xxx"; // where "xxx" is user name
$_SESSION[EW_PROJECT_NAME . "_Password"] = "xyz"; // where "xyz" is an encrypted password

$_SESSION[EW_PROJECT_NAME . "_Encrypted"] = TRUE;

Remove XSS

Specify if sensitive keywords allowing XSS attack should be removed.

If enabled, all user input string will be checked against an array of sensitive keywords. If discovered, those keywords will be broken by inserting " " to prevent XSS attack. If this behavior is unwanted, you can disable this feature at your own risk. Re-generate and re-upload the ewcfg*.php after changing this setting.

If you just want to allow some sensitive keywords, you can customize the array EW_XSS_ARRAY in ewcfg.php of the template. (Read Customizing Template.)

Check token for form post

Check synchronizer token for forms with method="post".

Synchronizer token is used to prevent Cross-Site Request Forgery (CSRF). If you add your own HTML forms with method="post", you should add the token to your form by a hidden tag, e.g.

<input type="hidden" name="token" value="<?php echo CurrentPage()->Token ?>">

If you post your form by JavaScript, e.g. by jQuery.post(), you should also add the token to the data, the JavaScript variable of the token is EW_TOKEN.

Session timeout period (minutes)

Specify the session time-out period if the user does not refresh or request a page.

PHP has its own settings for session timeout, you can configure them in php.ini, read http://php.net/manual/en/session.configuration.php, but sometimes you may want to control the session period yourself, then you can setup BOTH this setting and the Session keep alive interval (seconds) setting (see below) to a positive value.

Session keep alive interval (seconds)

Specify the interval to send Ajax request to the server for keeping the session alive.

Notes

  1. For this setting to work, this setting MUST be SHORTER than the session.gc_maxlifetime and session.cookie_lifetime in php.ini, otherwise the session will be expired by PHP first. Do not set the interval too short, making requests to the server every 300-600 seconds (5-10 minutes) should be enough.
  2. To enable this feature, this setting must be set to a value larger than 0.
Session time out countdown period (seconds)

Specify the countdown period before session ends.

When the session is about to end, a modal dialog will show up to remind user and let the user choose to continue the session. If the user does not respond after the countdown period, the session will expire.

Composite key separator

The separator between key values of a composite key. Default is ",".

If your primary key values are of string type and contain commas also, the commas will affect parsing of the composite key value in the script and lead to failure of locating a record, you can change the separator to avoid such problem.

Export all time limit Set time limit (seconds) when exporting all records
Export field caption Export field caption instead of field names during export.
Export original values Export original field values instead of looked up values (for fields setup with user values or lookup tables) during export.
Export CSS styles Export HTML/Excel/Word with CSS styles (e.g. for keeping the row color in the exported file)
Format output for XML export

Use formatted XML during export.

By default DOM XML does not output formatted XML (no line breaks and indent between tags), enable this setting to override it.

Export master record

Specify if master record should be exported during exporting master/detail records. (Not applicable to CSV) Default is true.

Export master record for CSV

Specify if master record should be exported during exporting master/detail records to CSV. Default is false.

If master record is exported, the result CSV may not be imported into other application. If you want to export it anyway, enable this setting.

Export detail records in Master/Detail-View

Specify if detail records in View page of master table (in Master/Detail-View) should be exported. Default is true.

Export detail records for CSV in Master/Detail-View

Specify if detail records in View page of master table (in Master/Detail-View) should be exported for CSV. Default is false.

Show vertical master record in List Page

Specify if master record in List page of detail table should be displayed in vertical format. Default is true.

Language files The default language files for a project. (For use with Multi-Language.)
Allow no paging section

Allow no paging section in List page.

If both paging section at top and that at bottom are disabled, users will not be able to go to the second or later pages of the recordset. The scripts will use paging section at bottom by default to make sure paging is possible. If you want to allow no paging section (e.g. you always have all records in one page), enable this setting.

Auto hide paging section if single page

If only one page (i.e. number of records <= page size), hide the paging section automatically.

Auto hide page size selector if single page

If only one page (i.e. number of records <= current page size), hide the page size selector section automatically.

Note Beware that if you auto hide the page size selector, user cannot change page size, even one or more selectable page sizes are smaller than the current number of records.
Use hierarchical User ID

For used with User ID Security. (see Security Settings.)

If enabled, a parent user can view records of child users and grandchild users and so on. If disabled, a parent user can only view records of child users.

Use subquery for master/detail

For used Master/Detail with User ID Security (see Security Settings) . Default is False.

If master table is protected by User ID Security, the detail tables "inherit" the security even they have not the User ID field. This is achieved by checking the master records that the user can access with User ID Security, then limit the detail records to those belonged to the accessible master records. The checking can be done by using subquery but not all databases support subquery, you may want to disable this setting in such cases. On the other hand, if you have large number of detail records and not using subquery makes the SQL too long for your database, then enable this setting if your database supports subquery.

Initiate search panel as collapsed

Specify if the search panel should be initialized as collapse on page load

Blob field byte count for hash value calculation

For use with Check Conflicts (see Table Setup). Specify the number of bytes for calculating the hash value . Default is 200.

Check Conflicts will increase the time required to load the page, for better performance only the first hundreds of bytes of the BLOB fields are processed by default, but there are chances that change of BLOB data is not detected (if the first nth bytes are not changed). You can increase the number of bytes, if you want to process all bytes, enter 0.

Separate permissions for List/View/Search

Specify if the permissions for List, View, and Search are different. Default is true. Note: For use with Dynamic User Levels (see Security Settings) only.

If disabled, the permissions for List/View/Search are the same. That is, if the List page is accessible by an user, then the View page and Advanced Search page are also accessible by the user.

Use ADOdb driver for MySQL Use ADOdb driver if MySQL database is used (by default a lite version ewmysql*.php is used)
Use ADOdb time zone offset By default ADOdb will adjust date/time field value retrieved from database according to the Default time zone setting (above), use this setting to enable or disable the behavior.
Note For Access and MS SQL server only.
Use Microsoft PHP Driver for SQL Server Use Microsoft PHP Driver for SQL Server instead of the Microsoft SQL Server Native Client.

Notes

  1. This new setting is EXPERIMENTAL ONLY, use at your own risk. For the time being only Microsoft SQL Server Native Client (for Windows only) is officially supported.
  2. Requires Microsoft PHP Driver for SQL Server, check system requirements and make sure you have installed the correct version for your PHP and OS.
  3. Check phpinfo, find sqlsrv and make sure the PHP driver is properly enabled.
  4. Requires SQL Server 2005 or newer.
Oracle charset By default the project character is also used for connecting to Oracle. If you need to use a different charset, specify it with this setting.
Oracle compare

For setting Oracle's NLS_COMP parameter. Requires Oracle 10gR2 (or later). Possible values are: BINARY, LINGUISTIC, ANSI.

For example, if you want to do case insensitive search you can select LINGUISTIC.

Oracle sort

For setting Oracle's NLS_SORT parameter. Requires Oracle 10gR2 (or later).

For example, if you want to do case insensitive search you can enter "BINARY_CI" (no double quotes).

Auto-Suggest maximum display entries Specify the number of options to be displayed during Auto-Suggest. Default is 10.
Auto-Suggest for all display fields

Specify if Auto-Suggest should consider Display field #2 to #4.

By default Auto-Suggest only uses Display field #1 and only finds records with Display field #1 STARTS WITH the input characters. It this setting is enabled, Auto-Suggest finds records with Display field #1 to #4 CONTAINS the input characters

Auto-fill original value

For use with Auto-Fill (see Field Setup). By default the looked-up value (if any) will be used to fill the target field, enable this option to use the original (database) value instead.

Lookup filter value separator

For use with Dynamic Selection List. Specify the separator for multiple selected values. Default is ",".

Grid-Add row count

Specify the initial number of blank rows in Grid-Add and Master/Detail-Add mode. Default is 5.

Use View Tag number of decimal digits for edit

To keep the original precision of a decimal number, by default all decimal digits as outputted by the database will be used in Edit page. For example, if a number is 1.23456 in database, the Edit page will also show 1.23456 even you may have specified just 2 decimal digits in View Tag panel (see Field Setup). If you want to show the number as in the View page, you can enable this setting. However, note that after saving the record, the number will be saved as 1.23 only even you have not edited the field value.

Note If you enable this setting, there may be loss of precision after saving the record. Only use this setting when precision is unimportant.
Use jQuery Migrate

Specify if the jQuery Migrate plugin should be used in the project. This plugin can be used to warn about and/or restore APIs and behaviors that have been deprecated and/or removed as of jQuery version 3.0.

Create upload file on copy

Specify if an uploaded file should be copied when copying a record with file upload fields. (For use with file upload to folder.) Default is false.

If the option Delete file on update/delete (see PHP settings) is enabled, the uploaded file will be deleted. If the deleted record is a copied record, deleting the uploaded files will affect the original record. To prevent such possible problem, enable this setting to duplicate the uploaded file when copying a record.

Multiple file upload separator

Specify the file upload separator used to separate the file names. By default, comma is used. If you allow file names with comma, you can enter another separator, e.g. "|".

Upload preview thumbnail width (px)

The width of the thumbnail displayed during the upload process.

Upload preview thumbnail height (px)

The height of the thumbnail displayed during the upload process.

Encrypt file path

Encrypt upload file path if enabled.

File upload type

Specify the file upload method, either "POST" (default) or "PUT".

Note If you use "PUT", make sure your web server allows PUT. If you use AWS S3 as upload path, you must use "PUT".
File upload URL path

Specify the URL path of uploaded files. Default is empty, meaning that the path of the global or field specific upload folder will be used. However, under some rare cases, the URL path cannot be derived from the upload folder, then you can specify it explicitly.

File upload path (absolute) for temporary files

Specify the file upload path (absolute) for temporary files. If this setting is used, the matching File upload URL path (absolute) for temporary files (see below) must also be set.

When working with file upload fields, some temporary files will be created and then deleted in a temporary folder. Default is empty, meaning that the global upload folder will be used. However, under some rare cases, you may want to specify your own. This path must be physical and it must be on accessible by the web server, e.g. /some/real/path/ or D:\some\real\path\, and is accessible by URL (see next).

File upload URL path (absolute) for temporary files

Specify the file upload URL path (absolute) for temporary files, e.g. /my/virtual/path/ (root-relative URL) or //www.mycompany.com/my/virtual/path/ (protocol-relative URL). If File upload path (absolute) for temporary files (see above) is used, this setting must also be set so that the temporary files can be accessed by URL.

Thumbnail default width (px)

For use with image resize.

If a target resize width is <= 0, this default width will be used. If this setting is also 0, the width will be auto-adjusted to keep the aspect ratio.

Thumbnail default height (px)

For use with image resize.

If a target height width is <= 0, this default height will be used. If this setting is also 0, the height will be auto-adjusted to keep the aspect ratio.

Use Colorbox for images Specify if colorbox should be used to displayed full size image on clicking the thumbnail in the List/View page. Default is true.
Reduce image size only (image resize) Do not resize if image is smaller than the resize dimension.
Always keep aspect ratio (image resize)

Keep aspect ratio during image resize.

 

Search keywords in any selected fields (Quick search)

For use with "All words"option of Quick Search, allows searching all keywords in any fields selected for Quick Search.

When searching "All words" with Quick Search (see Table Setup), by default all keywords must be found in the same field. This option provides an alternative searching behavior.

Search multiple value option

Option for searching fields that store multiple values as comma separated string.

Valid values are: (Default is 3)
1 - no multiple value, the whole comma separated string is considered as one string
2 - all multiple values must meet the search criteria (AND condition)
3 - either one of the multiple values must meet the search criteria (OR condition)

Search filter save option

Specify where to save the search filters. Possible values are: Server, Client, None. Default is Client, i.e. save by browser's localStorage.

Note If you choose Server, the Profile field (see Security Settings) must be set up for storage.

 

Replace textarea by text input for search

Replace textarea by textbox in Search page and Extended Search. Default is TRUE.

Use ILIKE operator (PostgreSQL) Use ILIKE instead of LIKE for case-insensitive search (for PostgreSQL only).
Collation for LIKE operator (MySQL) Use the specified COLLATION for the LIKE operator (for MySQL only).
Collation for LIKE operator (Microsoft SQL Server) Use the specified COLLATION for the LIKE operator (for Microsoft SQL Server only).
Minimum password strength

Minimum password strength if check password strength is enabled.

Password length

Password length when generating a random password.

Use password hash

For used with Hashed password (previously MD5 password), see Security Settings. If this setting is enabled, PHP password_hash function will be used to create password hash. By default CRYPT_BLOWFISH algorithm will be used. If this setting is disabled, the old md5 function will be used.

Note Beware that if you enable this setting but the user table is still storing old MD5 passwords, users will NOT be able to login. Since MD5 passwords cannot be decrypted, you MUST reset the passwords for the users first or ask users to reset their passwords themselves.
Add plain text version in HTML email

Add plain text version when sending HTML email.

Max email recipient

For use with Export (Email). (see PHP Settings.) Default is 3.

To avoid abusing the export to email feature, the number of email addresses in the recipient field is limited to the specified value.

Max email sent count per session

For use with Export (Email). (see PHP Settings.) Default is 3.

To avoid abusing the export to email feature, the number of emails can be sent by the user in each session is limited to the specified value.

Use user id for audit trail

Use user id value for audit trail if User ID Security is enabled.

Use responsive layout

Use responsive layout for mobile devices automatically. Default is TRUE.

Note If disabled, there will be NO mobile features, everything will be for desktop only.
Form left column CSS class

Specify the left column CSS class for all forms. Possible values are: col-sm-2, col-sm-3, or col-sm-4. Default is col-sm-2.

This CSS class controls the width of the left column.

Use tabular form for desktop

By default Bootstrap horizontal form is used in Add/Edit/Search/Update/Registration pages, this option makes the scripts use Bootstrap table instead.

Notes

  1. The mobile mode still uses Bootstrap form, NOT table.
  2. The mobile detection is done on the server side for this feature. Unlike other pages, resizing desktop browser will NOT change the page from desktop mode to mobile mode.
Use dropdown for button group in mobile

Use button dropdown instead of button group to save more spaces for data in mobile mode. Default is TRUE.

Use place holder for text box

Add placeholder attribute to form elements automatically. Possible values are:

  • None - no placeholder
  • Caption - use field caption (see Field Setup) as placeholder attribute value (default)
  • Title - use field title (see Field Setup) as placeholder attribute value
Reset layout height

For AdminLTE. Specify whether to reset height of the body to auto if content is wider then screen. Default is true. Read AdminLTE's Layout Plugin for details.

Notes

  1. This setting is provided for your own customization only, use at your own risk.
  2. PHPMaker template is based on default setting of AdminLTE, i.e. resetHeight = true and the "overflow-x" properties of body and div.wrapper set to "hidden" by AdminLTE. In other words, there is no horizontal scrollbar for the body by design. If you set this setting to false, the resetHeight option will be set to false and the "overflow-x" properties will also be reset to "auto" when the content is wider than the screen (not always) so that the horizontal scrollbar will show. However, this also means you break the default AdminLTE layout and you may need to add your own CSS and/or JavaScript to fulfil your requirements. Nevertheless, this is a good start point for your own customization.
  3. You can also attach your event handler for the "overflow" event (fired when the content is wider than screen) by client side global Client Script to do your customization, see an example in Server Events and Client Scripts.
  4. Do NOT set this setting to false if you use AdminLTE's Fixed or Boxed Layout.
  5. AdminLTE is a third-party tool not written by the author of PHPMaker. NO TECHNICAL SUPPORT WILL BE PROVIDED.
Page title style

Specify the page title style. Possible values are:

  • None - no page title (with Breadcrumbs)
  • Caption - table caption (without Breadcrumbs)
  • Breadcrumbs - table caption (with Breadcrumbs) (default)
  • Title - site title (with Breadcrumbs)
Use css-flip Use Twitter css-flip to convert the generated <project>.css, bootstrap.css and bootstrap-theme.css to RTL version (*-rtl.css) and add dir="rtl" attribute to the BODY tag.

Notes

  1. PHPMaker and Bootstrap 3 does NOT support RTL. This setting is provided for your convenience only.
  2. css-flip just flips the CSS, using it alone cannot make everything perfectly RTL automatically. You'll still to adjust some CSS (and JavaScript) yourself to make your website completely RTL. However, this will be a very good start point for your own customization.
  3. css-flip is not written by the author of PHPMaker. NO TECHNICAL SUPPORT WILL BE PROVIDED.
Authentication mode

Authentication mode: Possible values are: Windows, LDAP. If not specified, no authentication.

Notes

  1. If "Windows" is selected, only the server variable "AUTH_USER" is checked, you can use the function ew_CurrentWindowsUser() to check the current Windows user name and the function IsAuthenticated() to check if the user is an authenticated user.
  2. If "LDAP" is selected, the following three LDAP settings are required.
  3. If User ID and/or User Level Security (see Security Settings) is enabled, after Windows/LDAP authentication, the built-in User ID/Level Security (if enabled) still applies and user table is still required. See User_CustomValidate (see Server Events and Client Scripts) server event for more information on getting User ID/Level from the user table.
LDAP host name LDAP server host name
Note It may not be necessary to include ldap://, test with your LDAP server first.
LDAP port number LDAP server port number, e.g. 389
LDAP distinguished name LDAP distinguished name for login (if the distinguished name requires additional info other than the user-inputted user name), e.g. uid={username},dc=example,dc=com. If no additional info is required, leave this setting empty.
Note The generated script will replace {username} by the user name inputted by user in the login page automatically during login.
LDAP options

PHP array of options, for use with ldap_set_option, e.g. [LDAP_OPT_XXX => "xxx"]. By default the following options are already set:

[LDAP_OPT_PROTOCOL_VERSION => 3, LDAP_OPT_REFERRALS => 0]

Google client ID Enable Google Sign-In. Requires both Google client ID and Google client secret. To create client id and secret, read Creating a Google API Console project and client ID.
Google client secret Enable Google Sign-In. Requires both Google client ID and Google client secret. To create client id and secret, read Creating a Google API Console project and client ID.
Facebook app ID Enable Facebook Login. Requires both Facebook app ID and Facebook app secret. To implement Facebook Login, you need a Facebook App ID before you start, which you can create and retrieve on the App Dashboard. Read Register and Configure an App.
Facebook app secret Enable Facebook Login. Requires both Facebook app id and Facebook app secret. To implement Facebook Login, you need a Facebook App ID before you start, which you can create and retrieve on the App Dashboard. Read Register and Configure an App.

 

Note The settings are defined in the settings.xml located at the "src" folder. If you are an advanced user who customize templates, you can also add your own settings to the "Project" section. Open the settings.xml with a text or XML editor, add a <setting> node under the "Project" section. Make sure you provide an unique id to the setting. Supported data type is "String", "Integer" and "Boolean". If not specified, default is "String". The setting value can be retrieved in the template during code generation (NOT during runtime of the generated script) using the PROJ.GetV(id) method. Also read Template Tags and Object Properties.

 

 

Copy Table Settings

If you use database built-in query/view to make an alternate version of a table, you need to set up the table and field settings again, this tool help you quickly copies table and field settings from the source table to the view. Click [Tools] -> [Copy Table Settings] to open the following form:

 

Select the [Source table] and the [Target table] (e.g. the query/view), click OK to copy the table settings. If a field in the target table has the same name as that in the source table, field settings will also be copied.

Note This feature copies setting without validation. If settings from the source table/field are not applicable to the target table/field, errors may result. Check the settings after copying.

 

 

Copy Field Settings

When you create a Custom View, PHPMaker allows you to copy field settings from the source table. However, when database built-in query/view is used, you need to set up the field settings again, this tool help you quickly copies field settings from the source table to the view. Click [Tools] -> [Copy Field Settings] to open the following form:

 

Select the [Source table] and the [Target table] (e.g. the query/view), the fields of the target table will be listed in the left column, you can then select the respective source fields (from the specified source table) in the right column and click OK to copy the field settings.

 

 

Sort Tables Alphabetically

If you prefer to have the table list displayed in the user interface in alphabetical order, click [Tools] -> [Sort Tables Alphabetically] to do so.

Notes
  1. Re-arranging the table display order by drag-and-drop in the Table Setup page is still supported, so the display order will NOT be re-sorted automatically after synchronizing the project with your database even there are new tables added to the database. Use this tool to sort again if necessary.
  2. Only tables are sorted, the display order of the fields in the user interface or in the generated scripts will NOT be affected by this tool.
  3. The display order of the menu items in the generated scripts is still controlled by the Menu Editor, using this tool will NOT affect the menu items.

 

Languages

If you want to use multi-language project, click [Tools] -> [Languages] to select the languages you want to use in the project. See Multi-Language Project for more details.

 

 

Locale Settings

If you want to edit locale settings, click [Tools] -> [Locale Settings] to select the locale file you want to edit.

Each locale file contains the following settings:

Decimal point character Decimal point character
Thousands separator Thousands separator
International currency symbol International currency symbol
Local currency symbol Local currency symbol (e.g. $)
Monetary decimal point character Monetary decimal point character
Monetary thousands separator Monetary thousands separator
Sign for positive values Sign for positive values
Sign for negative values Sign for negative values
International fractional digits International fractional digits
Local fractional digits Local fractional digits
Currency symbol precedes a positive value 1 if currency_symbol precedes a positive value, 0 if it succeeds one
A space separates currency symbol from a positive value 1 if a space separates currency_symbol from a positive value, 0 otherwise
Currency symbol precedes a negative value 1 if currency_symbol precedes a negative value, 0 if it succeeds one
A space separates currency symbol from a negative value 1 if a space separates currency_symbol from a negative value, 0 otherwise
Positive sign position 0 - Parentheses surround the quantity and currency_symbol
1 - The sign string precedes the quantity and currency_symbol
2 - The sign string succeeds the quantity and currency_symbol
3 - The sign string immediately precedes the currency_symbol
4 - The sign string immediately succeeds the currency_symbol
Negative sign position 0 - Parentheses surround the quantity and currency_symbol
1 - The sign string precedes the quantity and currency_symbol
2 - The sign string succeeds the quantity and currency_symbol
3 - The sign string immediately precedes the currency_symbol
4 - The sign string immediately succeeds the currency_symbol
Date separator Date separator separating year, month and day, default is "/"
Time separator Time separator separating hour. minutes and seconds, default is ":"
Date format Date format. Default is "Ymd". Possible values are:
  • Ymd
  • mdY
  • dmY
  • YmdHis
  • mdYHis
  • dmYHis
  • ymd
  • mdy
  • dmy
  • ymdHis
  • mdyHis
  • dmyHis

where:

  • Y - A full numeric representation of a year, 4 digits
  • y - A two digit representation of a year
  • m - Numeric representation of a month, with leading zeros, 01 through 12
  • d - Day of the month, 2 digits with leading zeros, 01 to 31
  • H - 24-hour format of an hour with leading zeros, 00 through 23
  • i - Minutes with leading zeros, 00 to 59
  • s - Seconds, with leading zeros, 00 through 59
Time zone

Time zone, see List of Supported Timezones. Default is unspecified.

If not specified, the default "GMT" will be used.

Note After editing locale files, remember to re-generate them and upload them to your site. By default the locales files are generated in the "phplocale" folder.

 

Multi-Language Property Editor

Some text properties support Multi-Language. This editor allows you to enter your property values for each language. See Multi-Language Project for details.

 

 

Delete Template Cache

PHPMaker will reuse the pre-processed template scripts to speed up code-generation. We refer to these pre-processed scripts as "template cache", sometimes these template cache may become corrupted resulting from, for example, generating with a corrupted template or badly customized template. In these cases you may want to delete bad template cache and let PHPMaker builds the template cache again. You can do so by either clicking [Tools] -> [Delete Template Cache] or by manually removing the folder for the template under your Documents folder, i.e. <Documents Folder>\PHPMaker\Templates\<TemplateName>\. (Also see Customizing Template.)

 

Update Template (for registered version only)

When you start PHPMaker, it will try to check if there is an updated template on the official website and download the new template to replace the existing template on your machine. This feature is only enabled in registered version and your PC must be connected to the internet for this feature to work.

Notes

  1. Only the default template (i.e. phpv<major><minor>.zip, e.g. phpv20170.zip) specified by the Template file setting (see Generate Settings) will be updated. Renamed default template and customized template will not be updated.
  2. If you have customized the default template but kept the file name unchanged, be warned that updating template will overwrite your template if the version number of template is lower than that of the new template. Version number of a template is stored in the zip archive comment.
  3. To disable this feature, uncheck the advanced setting Update template on start (see above).

 

Menu Editor

PHPMaker allow you to modify the menu in the generated site, to open the menu editor, click [Tools] -> [Menu Editor] in the main menu or click the "Menu Editor" icon in the toolbar.

Use the following toolbar buttons to manage your menu items:

Add item Add a new menu item. You can add new menu items and link them to your own URLs. Just click the button to add and then enter your URL. Note that the URL of the List pages of the tables are uneditable, they will be generated by PHPMaker automatically.
Add child item Add a child menu item to the focused menu item. You can also easily drag-and-drop the icon of a menu item to another menu item to create child menu items.
Delete Delete the focused menu item
Edit item Edit the displayed text of the focused menu item. You can also click the text directly to edit.
Post Post the changes you make to the focused menu item
Cancel Cancel the changes you make to the focused menu item
Refresh Refresh the menu items
Move up one level Move the focused menu item up one level
Move down one level Move the focused menu item down one level
Move Up Move the menu item up
Move Down Move the menu item down
Expand all items Expanse all menu items so all menu items of each level are shown
Collapse all items Collapse all menu items so only menu items of the first level are shown
Import items from PHP Report Maker project Import menu items from PHP Report Maker project
Delete imported menu items Delete imported menu items
Multi-Language Show Multi-Language Property Editor for editing unicode menu text
Chart menu items Show/hide the menu items for charts (imported from PHP Report Maker)

 

Your can show/hide the menu items by checking/unchecking the checkboxes beside the menu item text. If a parent menu item is hidden, all the child items will also be hidden.

If your custom menu items requires login, uncheck [Allow Anonymous User]. For other (non custom) menu items, this setting is same as the List permission for Anonymous User in Advanced Security. (See Security Settings.)

After modifying, make sure you click [OK] to save the changes.

By default, the menu is vertical.

Registered user can use the Horizontal Menu extension, click [Tools] -> [Extensions] to enable the extension, then click [Advanced] tab to set the menu options.

 

Group Title is supported. Group Titles are to be set up in the same way as a sub menu. You can check the title menu item in the Group Title column of the Menu Editor:

 

A Group Title will be displayed like:

Notes

  1. If the menu item has sub-items, adding URL to them is also not recommended and will not work properly. If you enable FollowLink for the vertical menu (see Menu_Rendering server event in Server Events and Client Scripts), the URL will work but then you cannot expand the menu item to show the sub-items.
  2. Group Titles are supposed to be titles only, adding URL to them is not recommended and will not work.
  3. Using Group Titles only at the root level for vertical menu is recommended.
  4. Since horizontal menu does not display menu groups like vertical menu, group title should not be enabled at the root level of the horizontal menu. If enabled, they will only be displayed as normal submenus. Since submenu is vertical, you can use group title for menu items in submenus. In general, using group titles for horizontal menu is not recommended.
Scripts and Stylesheets

Manage JavaScripts and stylesheets for your project. These scripts will be included in the header.php. The path(s) can be absolute URL, relative URL or absolute physical path. Absolute/Relative URL is recommended over physical path.

You can enter JavaScript and stylesheet paths in the JavaScripts(Global) and Stylesheets(Global) respectively. One line for each path. A JavaScript or stylesheet may depends on other, you can move them up or down to make sure the sequences are correct.

Notes

  1. Stylesheets are handled in the same way as JavaScript, just change "js" to "css".
  2. After changing, make sure you re-generate scripts and upload the scripts, JavaScripts and stylesheets to your site.
Absolute URL

Absolute URL(s), e.g.

https://host/path/xxx.js (absolute remote URL with protocol)
//host/path/xxx.js (absolute remote URL without protocol)
/path/xxx.js
(absolute local URL)
//host/path/xxx.js|//host2/path2/yyy.js
(more than one paths)

Relative URL

Relative URL(s) (relative to the destination folder), e.g.

bower_components/bootstrap-colorpicker/dist/js/bootstrap-colorpicker.min.js

script

Absolute physical paths, e.g.

D:\path\xxx.js

PHPMaker will bundle these physical scripts as one script (<project>_bundle.js) and output to the "phpjs" folder. This is the least recommended way of specifying the path.

 

 ©2002-2017 e.World Technology Ltd. All rights reserved.