Thank you for purchasing my library. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thank you so much!
CodeIgniter is a proven, open source PHP web application framework that empowers the next generation of web apps and caters to everyone, from beginners to power users. "CI Chatsocket" is a chat application that uses Node JS and socket.io to communicate real time to each user. This library readily integrates with any existing Codeigniter website or application built with jQuery and Bootstrap.
For you to understand how this application works, I have included the full CodeIgniter installation so that you can navigate and familiarize the configuration and the chat application
Copy all the files and folders inside the full-ci folder and drop it to the folder where you want your website is located
I have included the database(db_cichatsocket.sql), upload it to your phpmyadmin
Configure your database.php to match on your mysql server configuration
Visit your website (eg. www.yourdomain.com) and login using email: admin@admin.com, password: password. which is the default access
Navigate to the console page. Please refer to Console Configuration section to familiarize this.
Information you need to know before going to setup this application from your existing codeigniter installation
If you want to turn on the csrf_protection, I recommend you to turn off the csrf_regenerate to avoid conflict of the csrf token when multiple ajax is executed
This application contains only two pages. The console configuration and the messages page.
The console configuration will appear if you place the <?php csConsole(); ?> anywhere you want it to show. -You can see this code in the full codeigniter installation included on this item in application/modules/welcome/views/console.php file
The messages page will appear if you place the <?php csMessagesPage(); ?> code anywhere you want it to show - You can see this code in the full codeigniter installation included on this item in application/modules/welcome/views/messages.php file
Lastly, in order to show the chatbox tray, you need to place the <?php csChatbox(); ?> code before the body closing tag (
) -You can see this code in the full codeigniter installation included on this item in application/views/view_html.php file
Complete all the steps below before navigating the web app.
There are four folders you can see when you download this item. The Chatsocket folder which is the library, the xwb_assets folder where the css and javascript is located, the full-ci which is the full CodeIgniter installation and the Documentation folder
Copy the Chatsocket folder to the libraries folder. If you are running codeigniter version 2.x, changing the folder into lowercase is needed
Copy the xwb_assets to the main folder of your codeigniter.
Set chatsocket in the libraries of your autoload(application/config/autoload.php) file to run it automatically on every pages.
If you are required to place an encryption key on your config.php file, then just place it.
Place this code <?php csConsole(); ?> to the body of the page where you want the console settings to displayed. -You can see this code in the full codeigniter installation included on this item in application/modules/welcome/views/console.php file
Place this code <?php csChatbox(); ?> before the body closing tag () -You can see this code in the full codeigniter installation included on this item in application/views/view_html.php file in line 72
Place this code <?php csMessagesPage(); ?> which page would you like the message to appear -You can see this code in the full codeigniter installation included on this item in application/modules/welcome/views/messages.php file
Configure the database.php if not yet configured.
Visit your website (eg. www.yourdomain.com) as it will automatically install the database.
Go to your console configuration page and set the appropriate settings based on your existing codeigniter website. Please refer to Console Configuration section.
Go to the configuration page where <?php csConsole(); ?> is placed. You will see a page like the one illustrated below
Input Description
– This is the key of the codeigniter Session where the logged in User ID is stored. Choose and select the appropriate value.
– The table from database where all the users is stored. Choose and select the appropriate value.
– The field name of the user table where the User ID is stored. Choose and select the appropriate value.
– The field name of the table where the user name is stored. This will be shown as a display name of your contacts. Choose and select the appropriate value.
Configure if display name came from another table
- You can touch this area only if the display name of the user is coming from the other table.
– The table where the display name is located. Choose and select the appropriate value.
– The field User ID relationship key of the other table from User Table's[B.] User ID[C.]. Choose and select the appropriate value.
– The field of the display name of the other table. Choose and select the appropriate value.
– Select or manage users where do you want to be able this chat application available.
– The field from the Users Table[B.] where the picture file name is stored. Choose and select the appropriate value.
– Click the “Browse” button then select the folder where all the profile picture is stored. This will be concatenated before the Picture File Name field[F.].
– Set this input If the file name is located in the other table rather than the Users Table[B.]. Choose and select the appropriate value.
- The field from the table[H.] where the picture file name is stored. Choose and select the appropriate value.
– The field User ID relationship key for the other table of picture file name. Choose and select the appropriate value.
Any functions you can see in the Chatsocket/helpers/chat_socket_helper.php can be overridden. Just create your own helper and add a function that is the same name with the function in chat_socket_helper.php. Place that helper in autoload. Refer into this web page for creating a helper CodeIgniter Helper.
If any of these is already loaded in your existing application, you can override the function csAddScript() located in chatsocket/helpers/chat_socket_helper.php as mentioned above[H.].
Once again, thank you so much for purchasing this library. As I mentioned, I'd be glad to help you if you have any questions relating to this library. No guarantees, but I'll do my best to assist. If you have a more general question relating to the library on CodeCanyon, you might consider visiting the forums and asking your question in the "Item Discussion" section.
I am also open for any suggestions for the future update
