API Documentation
\
JCORE
AUTH
CACHE
EXAMPLE
EXT_REF
DAO
TREE
DATA
API
FILE
MySQL
POSTGRES
REDIS
EXCEPTION
L10N
LOAD
LOG
SERVICE
AUTH
CRON
DAO
ORM
HTTP_OPTIMIZATION
ASSETIC
TEMPLATER
TRANSPORT
HTTP
JSON
REST
SOA
URL
XML
SERVICE
METRONIC

\JCORE\SERVICE\AUTHLOGIN_SERVICE

Class LOGIN_SERVICE https://github.com/CHGLongStone/just-core-auth-login

Very basic auth mechanism to white list API calls from other servers this is ONLY in place to limit access to an API based on white list there is no other authentication hook behind this fro granular control implementation ripped straight from here: https://sunnyis.me/blog/secure-passwords/ input from here: http://www.openwall.com/articles/PHP-Users-Passwords https://github.com/ircmaxell/password_compat http://php.net/manual/en/function.password-hash.php

Summary

Methods
Properties
Constants
__construct()
introspectService()
wrapMySQLResultInJSON()
init()
testInstall()
authenticate()
authorize()
authenticateUserLogin()
authenticateUserSession()
authenticateAPICall()
authenticateAPICallToken()
aServiceMethod()
$serviceResponse
$error
No constants found
No protected methods found
$serviceRequest
N/A
No private methods found
No private properties found
N/A

Properties

$serviceResponse

$serviceResponse : string

serviceResponse

Type

string

$error

$error : string

error

Type

string

$serviceRequest

$serviceRequest : string

serviceRequest

Type

string

Methods

__construct()

__construct() : null

DESCRIPTOR: an empty constructor, the service MUST be called with the service name and the service method name specified in the in the method property of the JSONRPC request in this format ""method":"AJAX_STUB.aServiceMethod"

Returns

null

introspectService()

introspectService() : string

introspectService will provide all of the methods, members and arguements within scope of the call as well as the document comments assotiatiated with the extended object. This method can be overridden or extended to parse this data into a WSDL or similar format

Returns

string —

return NULL

wrapMySQLResultInJSON()

wrapMySQLResultInJSON(array  $result) : array

encapsulates the handling of a DB error

Parameters

array $result

Returns

array

init()

init(  $args) : null

DESCRIPTOR: init

Parameters

$args

Returns

null

testInstall()

testInstall(  $args) : null

DESCRIPTOR: testInstall

Parameters

$args

Returns

null

authenticate()

authenticate(  $params = null) : boolean

DESCRIPTOR: authenticate against: abstracted for JCORE-AUTH-AUTH_HARNESS UserLogin UserSession APICall APICallToken

Parameters

$params

Returns

boolean

authorize()

authorize(  $params = null) : boolean

DESCRIPTOR: authorize ACL hook stub

Parameters

$params

Returns

boolean

authenticateUserLogin()

authenticateUserLogin(  $args) : array

DESCRIPTOR: authenticateUserLogin authenticate a login - email - password - get the user role ACL hook

Parameters

$args

Returns

array

authenticateUserSession()

authenticateUserSession(  $args) : array

DESCRIPTOR: authenticateUserSession user_id or user_email

Parameters

$args

Returns

array

authenticateAPICall()

authenticateAPICall(  $args) : array

DESCRIPTOR: authenticateAPICall http header based HTTP_API_KEY HTTP_PASS_PHRASE

Parameters

$args

Returns

array

authenticateAPICallToken()

authenticateAPICallToken(  $args) : array

DESCRIPTOR: authenticateAPICallToken check a "PUBLIC_TOKEN" in an auth whitelist

Parameters

$args

Returns

array

aServiceMethod()

aServiceMethod(  $args) : array

DESCRIPTOR: stubbeh

Parameters

$args

Returns

array