FOSSology  4.4.0
Open Source License Compliance by Open Source Software
core_smauth Class Reference
Inheritance diagram for core_smauth:
Inheritance graph
Collaboration diagram for core_smauth:
Collaboration graph

Public Member Functions

 Install ()
 Only used during installation. This may be called multiple times. Used to ensure the DB has the right default columns. More...
 
 CheckUser ($Email)
 See if a username is valid. More...
 
 Output ()
 generate the output for this plug-in
 
- Public Member Functions inherited from FO_Plugin
 Remove ()
 This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.
 
 __construct ()
 base constructor. Most plugins will just use this More...
 
 Initialize ()
 dummy stub till all references are removed.
 
 PostInitialize ()
 This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...
 
 RegisterMenus ()
 While menus can be added to any time at or after the PostInitialize phase, this is the standard location for registering this item with menus. More...
 
 Destroy ()
 This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.
 
 OutputOpen ()
 This function is called when user output is requested. This function is responsible for assigning headers.
 
 OutputUnSet ()
 Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.
 
 getResponse ()
 
 getTemplateName ()
 
 renderString ($templateName, $vars=null)
 
 renderScripts ($scripts)
 Render JavaScript in the template's footer. More...
 
 getRequest ()
 
 execute ()
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 getName ()
 
 __toString ()
 

Public Attributes

 $Name = "smauth"
 
 $Title = TITLE_CORE_SMAUTH
 
 $Version = "1.0"
 
 $Dependency = array()
 
 $PluginLevel = 1000
 
 $LoginFlag = 0
 
- Public Attributes inherited from FO_Plugin
 $State = PLUGIN_STATE_INVALID
 
 $Name = ""
 
 $Version = "1.0"
 
 $Title = ""
 
 $DBaccess = PLUGIN_DB_NONE
 
 $LoginFlag = 0
 
 $NoMenu = 0
 
 $NoHeader = 0
 
 $PluginLevel = 10
 
 $Dependency = array()
 
 $InitOrder = 0
 
 $MenuList = NULL
 
 $MenuOrder = 0
 
 $MenuTarget = NULL
 
 $OutputType = "HTML"
 
 $OutputToStdout = 0
 

Additional Inherited Members

- Protected Member Functions inherited from FO_Plugin
 render ($templateName, $vars=null)
 
- Protected Attributes inherited from FO_Plugin
 $microMenu
 
 $renderer
 
 $vars = array()
 

Detailed Description

Definition at line 13 of file core-smauth.php.

Member Function Documentation

◆ CheckUser()

core_smauth::CheckUser (   $Email)

See if a username is valid.

Returns
string on match, or null on no-match.

Definition at line 129 of file core-smauth.php.

◆ Install()

core_smauth::Install ( )

Only used during installation. This may be called multiple times. Used to ensure the DB has the right default columns.

Returns
0 on success, non-zero on failure.

Reimplemented from FO_Plugin.

Definition at line 29 of file core-smauth.php.


The documentation for this class was generated from the following file: