WebsiteBaker Documentation

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.

**[[dev:284:addonsapi|<< zurück]]**
<PHP>
class api\LockUserByAddon

/**
 *
 * @param object $oReg  valid Registry object
 */
    __construct(object $oReg, $mOptions = null)

/**
 * Get a list of groups, ordered by name
 * @return array format returned: array(['group_id'=>1, 'name'=>'group_1'],
 *                                      ...
 *                                      ['group_id'=>n, 'name'=>'group_n']
 *                                )
 */
    array getGroupsList(void)

/**
 * get all users of a group, ordered by display_name
 * @param int $iGroupId
 * @return array format returned: array(['user_id'=>1, 'display_name'=>'user_1', 'active'=>1],
 *                                      ...
 *                                      ['user_id'=>n, 'display_name'=>'user_n', 'active'=>0]
 *                                )
 */
    array getUsersByGroup(int $iGroupId)

/**
 * enable all users of the group
 * @param int $iGroupId
 * @return bool
 * @description It can be re-enabled only users that have been disabled by the same addon.
 */
    bool enableGroup(int $iGroupId)

/**
 * disable all users of the group
 * @param int $iGroupId
 * @return boolean
 */
    bool disableGroup(int $iGroupId)

/**
 * enable an user
 * @param int $iUserId
 * @return boolean
 * @description Enables the specified user, unless further lock exists.
 */
    bool enableUser(int $iUserId default = 0)

/**
 * disable an user
 * @param int $iUserId
 * @return boolean
 * @description Disable the specified user.
 */
    bool disableUser(int $iUserId default = 0)

/**
 * remove all lockings set by this caller
 * @return bool
 * @description NOTE: this method must be called on uninstall of the calling addon
 */
    bool removeAllLockings(void)
</PHP>

WebsiteBaker Documentation

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge