yana

Description
  Class trees
  Index of elements
  Todo List
core
  Classes
    FormCreator
    Index
    Language
    Object
    Plugin
    PluginManager
    Singleton
    SmartTemplate
    SmartView
    Utility
    Yana
database
  Classes
    DbBlob
    DbCreator
    DbDesigner4
    DbExtractor
    DbQuery
    DbQueryParser
    DbServer
    DbStream
    DbStructure
    FileDb
error_reporting
  Classes
    Alert
    Error
    ErrorUtility
    Log
    Message
    Report
    Warning
file_system
  Classes
    DatFile
    Dir
    Executeable
    File
    FileReadonly
    FileSystemResource
    SML
javascript
  Classes
    AjaxRequest
  Functions
    preview
    yanaAddEventListener
    yanaAddIcon
    yanaCheckEmbTags
    yanaCloseAll
    yanaGetCookie
    yanaGetElementsByClassName
    yanaMaxLength
    yanaMenu
    yanaMenuCookie
    yanaSetCookie
mail
  Classes
    FormMailer
    Mailer
plugins
  Classes
    plugin_blog
    plugin_check
    plugin_db_admin
    plugin_db_tools
    plugin_default_library
    plugin_diagnostics
    plugin_guestbook
    plugin_guestbook_admin
    plugin_ipblock
    plugin_ipblock_admin
    plugin_rss
    plugin_rss_admin
    plugin_sdk
    plugin_search
    plugin_search_admin
    plugin_user
    plugin_user_admin
utilities
  Classes
    Brush
    Counter
    Hashtable
    Image
    Microsummary
    RSS
    RSSitem
    String
  Functions
    checkArgumentList
    cloneArray
    dirlist
    qSearchArray
    untaintInput
    XMLencode
vdrive
  Classes
    Registry
    VDrive
zip
  Classes
    PclZip

phpDocumentor v 1.4.0

YANA Framework for PHPDocs For Class plugin_user_admin

### Class plugin_user_admin

#### Description

user management plugin
This creates forms and implements functions to manage user data.

- access: public

    Plugin
       |
       --plugin_user_admin

##### Method Summary

- bool get_access_list (array $ARGS)
- bool get_profile_image (array $ARGS)
- bool get_user_list (array $ARGS)
- bool get_user_mail (array $ARGS)
- bool get_user_new (array $ARGS)
- bool set_access_delete (array $ARGS)
- bool set_access_edit (array $ARGS)
- bool set_access_new (array $ARGS)
- bool set_user_delete (array $ARGS)
- bool set_user_edit (array $ARGS)
- bool set_user_new (array $ARGS)
- bool user_authentification (array $ARGS)
- bool view_profile (array $ARGS)

#### Methods

##### user configuration panel

bool get_access_list (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

- access: public

##### show image

bool get_profile_image (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

- access: public

##### user configuration panel

bool get_user_list (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

- access: public

##### Form to create a new user

bool get_user_mail (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

Note: visitors must be allowed to sign on for themselves, or this will fail.
Shows a form, where visitors may enter the prefered user name and mail address.
A mail with the login link will be send to them. (implements double-opt-in procedure)

- access: public

##### Create "new user" form

bool get_user_new (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

this action expects no arguments
on success: -> user::set_user_new

- access: public

##### set_access_delete

bool set_access_delete (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array | array of params passed to the function

###### Description:

returns bool(true) on success and bool(false) on error

- access: public

##### set_access_edit

bool set_access_edit (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array | array of params passed to the function

###### Description:

returns bool(true) on success and bool(false) on error

- access: public

##### set_access_new

bool set_access_new (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array | array of params passed to the function

###### Description:

returns bool(true) on success and bool(false) on error

- access: public

##### Delete user

bool set_user_delete (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

- access: public

##### Delete user

bool set_user_edit (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

- access: public

##### Insert a new user

bool set_user_new (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

handles input from action "get_user_new" this action expects no arguments

- access: public

##### Create a new user

bool user_authentification (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

This function registers new user. Note: visitors must be allowed to sign on for themselves, or this will fail.
This checks the provided authentification id and if valid, creates a new user according to the dataset in table "newuser". Settings of this new user depend on the system settings for the default user (see file: system.config).

- access: public

##### view user profile

bool view_profile (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array |

###### Description:

- access: public

##### inherited from base classes

Inherited From Plugin

- Plugin::Plugin()
- Plugin::getName()
- Plugin::_default()

Documentation generated on Sun, 04 Jan 2009 03:49:18 +0100 by phpDocumentor 1.4.0

yana author: Thomas Meyerwww.yanaframework.net