WebsiteBaker Documentation

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Sie befinden sich hier: start » dev » 2xx » addonsapi » userlocking
dev:2xx:addonsapi:userlocking

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung		Vorhergehende Überarbeitung
dev:2xx:addonsapi:userlocking [13.10.2017 22:01] – Manuela v.d.Deckendev:2xx:addonsapi:userlocking [29.02.2020 09:36] (aktuell) – Manuela v.d.Decken
Zeile 1: Zeile 1:
-**[[dev:2xx:addonsapi|<< zurück]]**+**[[dev:284:addonsapi|<< zurück]]**
 <PHP> <PHP>
 class api\LockUserByAddon class api\LockUserByAddon
Zeile 5: Zeile 5:
 /** /**
  *  *
- * @param database $oDb  current database object+ * @param object $oReg  valid Registry object
  */  */
-    function __construct(database $oDb)+    __construct(object $oReg, $mOptions = null)
  
 /** /**
- * Get a list of groups + * Get a list of groups, ordered by name 
- * @return array + * @return array format returned: array(['group_id'=>1, 'name'=>'group_1'], 
- * @description  Groups that are allowed to access the calling addon + *                                      ... 
- *               format returned: array(['group_id'=>1, 'name'=>'group1'], + *                                      ['group_id'=>n, 'name'=>'group_n']
- *                                      ['group_id'=>2, 'name'=>'group2']+
  *                                )  *                                )
  */  */
Zeile 20: Zeile 19:
  
 /** /**
- * get all users of a group+ * get all users of a group, ordered by display_name
  * @param int $iGroupId  * @param int $iGroupId
- * @return array + * @return array format returned: array(['user_id'=>1, 'display_name'=>'user_1', 'active'=>1], 
- * @description  format returned: array(['user_id'=>1, 'display_name'=>'user1', 'active'=>1], + *                                      ... 
- *                                      ['user_id'=>2, 'display_name'=>'user2', 'active'=>0]+ *                                      ['user_id'=>n, 'display_name'=>'user_n', 'active'=>0]
  *                                )  *                                )
  */  */
Zeile 33: Zeile 32:
  * @param int $iGroupId  * @param int $iGroupId
  * @return bool  * @return bool
- * @description users disabled by the calling addon only can be enabled again+ * @description It can be re-enabled only users that have been disabled by the same addon.
  */  */
     bool enableGroup(int $iGroupId)     bool enableGroup(int $iGroupId)
Zeile 48: Zeile 47:
  * @param int $iUserId  * @param int $iUserId
  * @return boolean  * @return boolean
- * @description Enable the specified user, if also no other lock is set.+ * @description Enables the specified user, unless further lock exists.
  */  */
     bool enableUser(int $iUserId default = 0)     bool enableUser(int $iUserId default = 0)
dev/2xx/addonsapi/userlocking.1507932067.txt.gz · Zuletzt geändert: 13.10.2017 22:01 von Manuela v.d.Decken

Seiten-Werkzeuge

Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht: CC Attribution-Noncommercial-Share Alike 4.0 International
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Driven by DokuWiki Template From SyntaxSeed