openwebpresence/owp-framework

The openWebPresence Framework.

1.5.9 2018-04-19 05:48 UTC

README

[Open Web Presence] (http://openwebpresence.com/ "Open Web Presence")

Open Web Presence Framework Support Library

Author GitHub Tag Software License Packagist Build Status

This framework is corrently under active development (Feb, 2017) and subject to MANY changes until version 2.0 is completed and released officially.

Visit Open Web Presence for more information.

Class documentation can be found in the generated phpDoc.

Features

User Class Hooks

  • owpUDF_On_addUserValiateData(object db, object firephp, array user_data)
  • owpUDF_On_addUserSuccess(int userID, object db, object firephp);
  • owpUDF_On_deleteUser(int userID, object db, object firephp);
  • owpUDF_On_logOut(int userID, object db, object firephp);
  • owpUDF_On_setStatusID(int userID, object db, object firephp);
  • owpUDF_On_updatePassword(int userID, object db, object firephp);
  • owpUDF_On_updateUser(int userID, object db, object firephp);
  • owpUDF_On_userLoginCore(int userID, object db, object firephp);

Messaging Class Hooks

  • owpUDF_On_sendEmailDirect(int userID, object db, object firephp);
  • owpUDF_On_sendEmailViaSMTP(int userID, object db, object firephp);

Exception Codes

All of the above methods when returning anything other than false will throw and exception with the contents of the return as the exception message. (string).

  • 10 - owpUser method exception
  • 20 - InvalidArgumentException
  • 30 - User Class Hook exception

Requirements

"require": {
    "php": ">=5.6.0",
    "ext-imap": "*",
    "vlucas/phpdotenv": "^2.4",
    "guzzlehttp/guzzle": "~6.0",
    "firephp/firephp-core": "^0.4.0",
    "openwebpresence/owp-users": "^1.2",
    "jv2222/ezsql": "dev-master",
    "phpmailer/phpmailer": "^5.2",
    "squeaky-minds/squeaky-minds-php-helper": "^1.1.1",
    "hautelook/phpass": "^1.1"
}

Installation by Composer

"require": {
    "openwebpresence/owp-framework": "~1.0"
}

Or

$ composer require openwebpresence/owp-framework