Documentation by Pricop Alexandru
Thank you for purchasing phpDolphin software. If you have any questions that are beyond the scope of this documentation, please feel free to contact me trough this form.

1. Preparing - top

Make sure you have the following:
  1. PHP 5.3+
  2. MySQLi Extension
  3. GD Library
  4. Rewrite Module for Apache (optional, required for permalinks structure)
  5. cURL & OpenSSL (optional, required for Facebook integration)

2. Installation Process - top

  1. Import the phpdolphin.sql file from the "MySQL" folder into your MySQL database using the import function available in MySQL.
  2. With a text editor open the following file located inside the 'Script/includes/' folder: config.php, and replace what's between the brackets (e.g: 'YOURDBNAME') with your MySQL settings:
    	$CONF['user'] = 'YOURDBUSER';
    	$CONF['pass'] = 'YOURDBPASS';
    	$CONF['name'] = 'YOURDBNAME';
    	$CONF['url'] = 'http://yourdomain.com';
    	$CONF['email'] = 'notifications@yourdomain.com';
    	
  3. Upload the files from the "Script" folder on the FTP server (usually public_html folder when installing it on a domain).
  4. Set the CHMOD to 777, 775 or 755 (depending on the server configuration) to the following folders: 'cache', 'uploads' and its subfolders: 'avatars', 'covers', 'media'.

3. Configuration - top

The default username for the Admin is "admin", and the password is "password" without quotes (the admin panel link is located in footer).

  • Dashboard
  • Shows you quick statistics and performance of the current day along with graphs for the last 7 days, site information and useful links.

  • Site Settins
  • Allows you to change the website settings such as general, registration, emails and limits.
      Enabling Facebook Login
    1. Go to developers.facebook.com and create a new "Website" app. (Skip Quickstart)
    2. Go to your App from "Apps", add your Site URL and copy the "App ID" and "App Secret".
    3. You can now enable the Facebook Login from the Admin Panel by adding the "App ID" and "App Secret" and enabling "Facebook Login".
  • Themes
  • Allows you to change the website interface.

  • Plugins
  • Allows you to Activate or Deactivate plugins.

  • Statistics
  • Advanced user and site statistics (Registered Users, Messages, Comments, Likes, Shares and Groups).

  • Manage Users
  • Allows you to manage users by categories, promote, edit, suspend or delete users. Basic settings can be changed as well as making users Verified.

  • Manage Groups
  • Allows you to edit or delete groups and change their settings.

  • Manage Reports
  • Allows you to manage the reported Messages and Comments, you can mark them as Safe (they can't be reported again), or delete them.

  • Manage Ads
  • Allows you to add Advertisments in certain places on the website.

  • Password
  • It's the page where you can change the Admin password.

    4. FAQ - top

    1. Q: I want to modify the text on the website.
      A: You can change any text from the language files located in the /languages/ folder.

    2. Q: I want to change the website's logo.
      A: You can change the logo simply by replacing the current logo with your new one at /themes/theme-name/images/logo.png.

    3. Q: I want to promote a user to the Moderator status.
      A: You can promote users by going to Admin Panel > Manage Users > Edit > Other.

    4. Q: I want to change the content of the Privacy Policy, Contact, Disclaimer and/or ToS page.
      A: Open themes/theme-name/info/ and open the .html file you want to edit, save & upload, that's it.

    5. Q: I have problems/questions related to the script, how can I contact you?
      A: You can contact me via the contact form at http://codecanyon.net/user/Pricop#contact

    5. Developers - top

    As a developer, the only mandatory requirement is a valid phpDolphin license key.

    Themes

    • Make a copy of the default 'dolphin' theme, and rename the folder into your theme's name
    • Theme's folder name should not contain any white spaces
    • Edit info.php with your own details [Author, Version, etc]
    • Edit icon.png with your own theme icon
    Recommendations:
    • Edit the original 'dolphin' theme, as it contains all the strings and files required

    Languages

    • Make a copy of the original 'english.php' file into the 'languages' folder, rename it into your language and then start translating it
    • If you're using special characters, save the file using UTF-8 without BOM

    Plugins

    • Plugin's folder name should not contain any white spaces (example: "lorem")
    • The main .php file from plugin to be executed should have the exact name as the plugin parent folder (example: "lorem.php")
    • To specify a plugin type, alter the $type from info.php with one or more (yes, it can support multiple values, for example $type = '23'; for feed and profile sidebar) of the following values:
    • 	$type = 'e'; // Message event
      	$type = 'd'; // Message delete
      	$type = '1'; // Message event output
      	$type = '2'; // Feed sidebar widget
      	$type = '3'; // Profile sidebar widget
      	$type = '4'; // Welcome page
      	$type = '5'; // Feed page
      	$type = '6'; // Profile page
      	$type = '7'; // Message footer
      	$type = '8'; // Stylesheet
      	$type = '9'; // JavaScript
      						
    • Message event
    • If you want to create a plugin that hooks to the Message form ($type = 'e';) to add a new event type, you would have the "lorem_event.php" which will return your button (the button must contain the class="plugin-button" set to the button label), and the inputs should be moved using JS in the "plugins-forms" div when the button is clicked. Also the .show() jQuery method needs to be used to display all the divs that contains your inputs as by default they will be hidden.

    • Message delete
    • If you want to create a plugin that hooks to the delete function ($type = 'd';) to do an action when a message is being deleted, you would have the "lorem_delete.php" file which will contain the functions you want to be executed. The file should not return anything.

    • Message event output
    • If you want to create a plugin that hooks to the Message event output ($type = '1';), you would have the "lorem.php" file which will parse the Message event input and store it into the database, while "lorem_output.php" will parse and output the database values. If you want to add error messages to the Message event input, then the output of lorem.php should be an array, otherwise a string should be returned.

    • Feed and Profile sidebar widgets
    • If you want to create a plugin that hooks on the sidebar ($type = '2'; or $type = '3';), you would have the "lorem_sidebar.php" which will contain the functions you want to be executed.

    • Welcome page
    • If you want to create a plugin that hooks to the Welcome page ($type = '4';), you would have the "lorem.php" file which will contain the functions you want to be executed.

    • Feed page
    • If you want to create a plugin that hooks to the Feed page ($type = '5';), you would have the "lorem.php" file which will contain the functions you want to be executed.

    • Profile page
    • If you want to create a plugin that hooks to the Profile page ($type = '6';), you would have the "lorem.php" file which will contain the functions you want to be executed.

    • Message footer
    • If you want to create a plugin that hooks on the footer of a Message and work with data already in the database ($type = '7';), you would have the "lorem_output.php" which you can use for data output (for example you can implement an API to return a game's information without storing anything in the database), this also keeps the default events being displayed in their original form (e.g: I played: value).

    • Stylesheet
    • If you want to create a plugin that hooks a stylesheet file ($type = '8';), you would have the "lorem.css" file which will contain the CSS code you want to be included.

    • JavaScript
    • If you want to create a plugin that hooks a javascript file ($type = '9';), you would have the "lorem.js" file which will contain the JS code you want to be included.

    • Settings Page
    • If you want your plugin to have a dedicated settings page in the Admin Panel, you would have the lorem_settings.php file which will contain the function lorem_settings() { } function as well as function lorem_save() { } function if you're having forms that are being sent using the POST method.

    • Activate/Deactivate plugin hooks
    • If you want to add activate/deactivate events upon plugin activation/deactivation, you would have lorem_activate.php or lorem_deactivate.php file with the main function having the same name as the file name (e.g: function lorem_activate() { }).

      Info: Each .php file that is being executed should have a main function with the same name as the filename (example: for the lorem_output.php file you will have the function: function lorem_output() {} which will be automatically being called by the software.

    • Edit info.php with your own details [Author, Version, etc]
    • Edit icon.png with your own plugin icon
    Recommendations:
    • Edit the "lorem" plugin example from the /plugins/example.zip file
    Copyright © 2016 phpDolphin. All rights reserved.
    A product by Pricop Alexandru Mihai.
    Go To Table of Contents