Documentation

Utilities
in package

Table of Contents

check_certificate_format()  : mixed
currentPageUrl()  : string
The function returns the current page URL.
desanitize_certificate()  : mixed
getAlternatePrivateKey()  : mixed
getBaseUrl()  : string
Get the base url of the site.
getImageUrl()  : mixed
Get Image Resource URL
getPrivateKey()  : string
Get the Private Key File Path
getPublicKey()  : string
Get the Public Key File Path
getResourceDir()  : string
Get resource director path
isBlank()  : true
This function checks if a value is set or empty. Returns true if value is empty
isSPConfigured()  : bool
Checks if the SAML Plugin has been configured or not. Checks if the IDP cert, Login Url , entity id and SP ACS url and entity id has been set.
sanitize_certificate()  : mixed
This function sanitizes the certificate
showErrorMessage()  : mixed
Exception Page HTML Content

Methods

check_certificate_format()

public static check_certificate_format(mixed $certificate) : mixed
Parameters
$certificate : mixed
Return values
mixed

currentPageUrl()

The function returns the current page URL.

public static currentPageUrl() : string
Return values
string

desanitize_certificate()

public static desanitize_certificate(mixed $certificate) : mixed
Parameters
$certificate : mixed
Return values
mixed

getAlternatePrivateKey()

public static getAlternatePrivateKey() : mixed
Return values
mixed

getBaseUrl()

Get the base url of the site.

public static getBaseUrl() : string
Return values
string

getImageUrl()

Get Image Resource URL

public static getImageUrl(mixed $imgFileName) : mixed
Parameters
$imgFileName : mixed
Return values
mixed

getPrivateKey()

Get the Private Key File Path

public static getPrivateKey() : string
Return values
string

getPublicKey()

Get the Public Key File Path

public static getPublicKey() : string
Return values
string

getResourceDir()

Get resource director path

public static getResourceDir() : string
Return values
string

isBlank()

This function checks if a value is set or empty. Returns true if value is empty

public static isBlank( $value) : true
Parameters
$value :
  • references the variable passed.
Return values
true

or False

isSPConfigured()

Checks if the SAML Plugin has been configured or not. Checks if the IDP cert, Login Url , entity id and SP ACS url and entity id has been set.

public static isSPConfigured() : bool
Return values
bool

sanitize_certificate()

This function sanitizes the certificate

public static sanitize_certificate(mixed $certificate) : mixed
Parameters
$certificate : mixed
Return values
mixed

showErrorMessage()

Exception Page HTML Content

public static showErrorMessage( $message) : mixed
Parameters
$message :
Return values
mixed

Search results