Configuration

Basic Configuration and Quick Start

Upload the folder with application to your local or remote server (by default, it is called "xcrud"). No matter how it will be named later, and where it will be located.

Important:

Do not rename anything in the application folder!

Recommendation:

Use UTF-8 in your project. This will save you from a lot of problems with the encoding and localizations.

Now you need to configure the default connection to the database and set the URL to the application folder.

The configuration file is located in the application folder and is called Xcrud_config.php. This file contains all the basic settings, most of which you can change directly in the application initialization. More information about this you can read in the following sections of this documentation.

class Xcrud_config{
    // default connection
    public static $dbname = 'dbname';
    public static $dbuser = 'dbuser';
    public static $dbpass = 'dbpass';
    public static $dbhost = 'localhost';
    ....
// more settings here... :) 

When everything is set up, you can try to include the main application file, and create a new instance of the application.

include('real_path/xcrud/xcrud.php');
$xcrud = Xcrud::get_instance();
$xcrud->table('my_table');
echo $xcrud->render();

That's it. If done correctly, you should see your table.

Note: If you start with blank file, your result code must look like this

<?php
    include('xcrud/xcrud.php');
    $xcrud = Xcrud::get_instance();
    $xcrud->table('your_table');
?>
<!DOCTYPE HTML>
<html>
<head>
    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
    <title>Some page title</title>
</head>
 
<body>
 
<?php
    echo $xcrud->render();
?>
 
</body>
</html>

Advanced Configuration

The configuration file contains default settings, you can customize the behavior xCRUD to your taste. The configuration file is well commented, you should not have any problems with the editing.

/*xxx... */

#