UserAction Klassenreferenz

Klassendiagramm für UserAction:

Aufstellung aller Elemente

Öffentliche Methoden
	UserAction ()
	save ()
	remove ()
	delete ()
	add ()
	adduser ()
	addgrouptouser ()
	addgroup ()
	delgroup ()
	mailPw ($pw)
	pwchange ()
	listing ()
	edit ()
	memberships ()
	groups ()
	savegroups ()
	pw ()
	rights ()
	checkMenu ($menu)
Öffentliche Attribute
	$user
	$defaultSubAction = 'edit'

---

Ausführliche Beschreibung

Definiert in Zeile 29 der Datei UserAction.class.php.

---

Dokumentation der Elementfunktionen

UserAction::add

(

)

Definiert in Zeile 101 der Datei UserAction.class.php.

     {
     }

UserAction::addgroup

(

)

Definiert in Zeile 131 der Datei UserAction.class.php.

Benutzt Action::setTemplateVar().

     {
          // Alle hinzufuegbaren Gruppen ermitteln
          $this->setTemplateVar('groups',$this->user->getOtherGroups());
     }

UserAction::addgrouptouser

(

)

Definiert in Zeile 123 der Datei UserAction.class.php.

Benutzt Action::addNotice() und Action::getRequestVar().

     {
          $this->user->addGroup( $this->getRequestVar('groupid') );
     
          $this->addNotice('user',$this->user->name,'ADDED','ok');
     }

UserAction::adduser

(

)

Definiert in Zeile 107 der Datei UserAction.class.php.

Benutzt Action::addNotice(), Action::addValidationError(), Action::callSubAction() und Action::getRequestVar().

     {
          if   ( $this->getRequestVar('name') != '' )
          {
               $this->user = new User();
               $this->user->add( $this->getRequestVar('name') );
               $this->addNotice('user',$this->user->name,'ADDED','ok');
          }
          else
          {
               $this->addValidationError('name');
               $this->callSubAction('add');
          }
     }

UserAction::checkMenu

(

$

menu

)

Parameter:

String

$name Men�punkt

Rückgabe:

boolean

Erneute Implementation von Action.

Definiert in Zeile 384 der Datei UserAction.class.php.

Benutzt $conf.

     {
          global $conf;

          switch( $menu )
          {
               case 'addgroup':
                    return count($this->user->getOtherGroups()) > 0;

               case 'groups':
                    return count($this->user->getGroups()) > 0;
     
               case 'pw':
                    return     @$conf['security']['auth']['type'] == 'database'
                           && !@$conf['security']['auth']['userdn'];
          }
          
          return true;
     }

UserAction::delete

(

)

Definiert in Zeile 86 der Datei UserAction.class.php.

Benutzt Action::addNotice(), Action::addValidationError(), Action::callSubAction() und Action::hasRequestVar().

     {
          if   ( $this->hasRequestVar('confirm') )
          {
               $this->user->delete();
               $this->addNotice('user',$this->user->name,'DELETED','ok');
          }
          else
          {
               $this->addValidationError('confirm');
               $this->callSubAction('remove');
          }
     }

UserAction::delgroup

(

)

Definiert in Zeile 138 der Datei UserAction.class.php.

Benutzt Action::addNotice() und Action::getRequestVar().

     {
          $this->user->delGroup( $this->getRequestVar('groupid') );

          $this->addNotice('user',$this->user->name,'DELETED','ok');
     }

UserAction::edit

(

)

Eigenschaften des Benutzers anzeigen

Definiert in Zeile 227 der Datei UserAction.class.php.

Benutzt Action::setTemplateVar() und Action::setTemplateVars().

     {
          $this->setTemplateVars( $this->user->getProperties() );

          $this->setTemplateVar( 'allstyles',$this->user->getAvailableStyles() );
     }

UserAction::groups

(

)

Definiert in Zeile 241 der Datei UserAction.class.php.

Benutzt $conf, Action::addNotice(), Group::getAll() und Action::setTemplateVar().

     {
          // Mitgliedschaften
//        $this->setTemplateVar('memberships',$this->user->getGroups());
          
          $gruppenListe = array();
          
          $allGroups  = Group::getAll();
          $userGroups = $this->user->getGroups();
          
          foreach( $allGroups as $id=>$name )
          {
               
               $hasGroup = array_key_exists($id,$userGroups);
               $varName  = 'group'.$id;
               $gruppenListe[$id] = array('name'       =>$name,
                                          'id'         =>$id,
                                          'var'        =>$varName,
                                          'member'     =>$hasGroup
                                         );
               $this->setTemplateVar($varName,$hasGroup);
          }
          $this->setTemplateVar('memberships',$gruppenListe);
          
          global $conf;
          if   ($conf['security']['authorize']['type']=='ldap')
               $this->addNotice('user',$this->user->name,'GROUPS_MAY_CONFLICT_WITH_LDAP',OR_NOTICE_WARN);
     }

UserAction::listing

(

)

Definiert in Zeile 210 der Datei UserAction.class.php.

Benutzt $user, User::getAllUsers(), Action::setTemplateVar() und Html::url().

     {
          $list = array();

          foreach( User::getAllUsers() as $user )
          {
               $list[$user->userid]         = $user->getProperties();
               $list[$user->userid]['url' ] = Html::url('main','user',$user->userid,
                                                        array(REQ_PARAM_TARGETSUBACTION=>'edit') );
          }
          $this->setTemplateVar('el',$list);
     }    

UserAction::mailPw

(

$

pw

)

Das Kennwort wird an den Benutzer geschickt

private

Definiert in Zeile 151 der Datei UserAction.class.php.

Wird benutzt von pwchange().

     {
          $to   = $this->user->fullname.' <'.$this->user->mail.'>';
          $mail = new Mail($to,'USER_MAIL');

          $mail->setVar('username',$this->user->name      );
          $mail->setVar('password',$pw                    );
          $mail->setVar('name'    ,$this->user->getName() );

          $mail->send();
     }

UserAction::memberships

(

)

Definiert in Zeile 235 der Datei UserAction.class.php.

     {
          
     }

UserAction::pw

(

)

Aendern des Kennwortes

Definiert in Zeile 298 der Datei UserAction.class.php.

Benutzt Action::setTemplateVars().

     {
          $this->setTemplateVars( $this->user->getProperties() );
     }

UserAction::pwchange

(

)

Aendern des Kennwortes

Definiert in Zeile 167 der Datei UserAction.class.php.

Benutzt $conf, Action::addNotice(), Action::addValidationError(), Action::callSubAction(), Action::getRequestVar(), Action::hasRequestVar() und mailPw().

     {
          global $conf;

          $pw1 = $this->getRequestVar('password1');
          $pw2 = $this->getRequestVar('password2');

          // Zufaelliges Kennwort erzeugen
          if   ( $this->hasRequestVar('random') && $this->hasRequestVar('email') )
          {
               $pw1 = $this->user->createPassword();
               $pw2 = $pw1;
          }

          if ( strlen($pw1)<intval($conf['security']['password']['min_length']) )
          {
               $this->addValidationError('password1');
               $this->callSubAction('pw');
          }
          elseif    ( $pw1 != $pw2 )
          {
               $this->addValidationError('password2');
               $this->callSubAction('pw');
          }
          else
          {
               // Kennwoerter identisch und lang genug
               $this->user->setPassword($pw1,!$this->hasRequestVar('timeout') ); // Kennwort setzen
               
               // E-Mail mit dem neuen Kennwort an Benutzer senden
               if   ( $this->hasRequestVar('email') && !empty($this->user->mail) && $conf['mail']['enabled'] )
               {
                    $this->mailPw( $pw1 );
                    $this->addNotice('user',$this->user->name,'MAIL_SENT','ok');
               }

               $this->addNotice('user',$this->user->name,'SAVED','ok');
          }

     }

UserAction::remove

(

)

Definiert in Zeile 79 der Datei UserAction.class.php.

Benutzt Action::setTemplateVars().

     {
          $this->setTemplateVars( $this->user->getProperties() );
     }

UserAction::rights

(

)

Anzeigen der Benutzerrechte

Definiert in Zeile 307 der Datei UserAction.class.php.

Benutzt $user, Action::addNotice(), Acl::getAvailableRights(), lang() und Action::setTemplateVar().

     {
          $rights = $this->user->getAllAcls();

          $projects = array();
          
          foreach( $rights as $acl )
          {
               if   ( !isset($projects[$acl->projectid]))
               {
                    $projects[$acl->projectid] = array();
                    $p = new Project($acl->projectid);
                    $p->load();
                    $projects[$acl->projectid]['projectname'] = $p->name;
                    $projects[$acl->projectid]['rights'     ] = array();
               }

               $right = array();
               
               if   ( $acl->languageid > 0 )
               {
                    $language = new Language($acl->languageid);
                    $language->load();
                    $right['languagename'] = $language->name;
               }
               else
               {
                    $right['languagename'] = lang('ALL_LANGUAGES');
               }
               
               
               $o = new Object($acl->objectid);
               $o->objectLoad();
               $right['objectname'] = $o->name;
               $right['objectid'  ] = $o->objectid;
               $right['objecttype'] = $o->getType();
               
               if   ( $acl->userid > 0 )
               {
                    $user = new User($acl->userid);
                    $user->load();
                    $right['username'] = $user->name;
               }
               elseif    ( $acl->groupid > 0 )
               {
                    $group = new Group($acl->groupid);
                    $group->load();
                    $right['groupname'] = $group->name;
               }
               else
               {
                    // Berechtigung f�r "alle".
               }

//             $show = array();
//             foreach( $acl->getProperties() as $p=>$set)
//                  $show[$p] = $set;
//                  
//             $right['show'] = $show;
               $right['bits'] = $acl->getProperties();
               
               $projects[$acl->projectid]['rights'][] = $right;
          }
          
          $this->setTemplateVar('projects'    ,$projects );
          
          $this->setTemplateVar('show',Acl::getAvailableRights() );
          
          if   ( $this->user->isAdmin )
               $this->addNotice('user',$this->user->name,'ADMIN_NEEDS_NO_RIGHTS',OR_NOTICE_WARN);
     }

UserAction::save

(

)

Definiert in Zeile 49 der Datei UserAction.class.php.

Benutzt $conf, Action::addNotice(), Action::addValidationError(), Action::callSubAction(), Action::getRequestVar() und Action::hasRequestVar().

     {
          if   ( $this->getRequestVar('name') != '' )
          {
               // Benutzer speichern
               $this->user->name     = $this->getRequestVar('name'    );
               $this->user->fullname = $this->getRequestVar('fullname');
               $this->user->isAdmin  = $this->hasRequestVar('is_admin');
               $this->user->ldap_dn  = $this->getRequestVar('ldap_dn' );
               $this->user->tel      = $this->getRequestVar('tel'     );
               $this->user->desc     = $this->getRequestVar('desc'    );
               
               global $conf;
               if   ( @$conf['security']['user']['show_mail'] )
                    $this->user->mail = $this->getRequestVar('mail'    );
                    
               $this->user->style    = $this->getRequestVar('style'   );
     
               $this->user->save();
               $this->addNotice('user',$this->user->name,'SAVED','ok');
          }
          else
          {
               $this->addValidationError('name');
               $this->callSubAction('edit');
          }
     }

UserAction::savegroups

(

)

Definiert in Zeile 271 der Datei UserAction.class.php.

Benutzt Action::addNotice(), Group::getAll() und Action::hasRequestVar().

     {
          $allGroups  = Group::getAll();
          $userGroups = $this->user->getGroups();
          
          foreach( $allGroups as $id=>$name )
          {
               $hasGroup = array_key_exists($id,$userGroups);
               
               if   ( !$hasGroup && $this->hasRequestVar('group'.$id) )
               {
                    $this->user->addGroup($id);
                    $this->addNotice('group',$name,'ADDED');
               }

               if   ( $hasGroup && !$this->hasRequestVar('group'.$id) )
               {
                    $this->user->delGroup($id);
                    $this->addNotice('group',$name,'DELETED');
               }
          }
     }

UserAction::UserAction

(

)

Definiert in Zeile 35 der Datei UserAction.class.php.

Benutzt Action::getRequestId(), Action::setTemplateVar() und Action::userIsAdmin().

     {
          if   ( !$this->userIsAdmin() )
               die('you are not an admin');

          if   ( $this->getRequestId() != 0 )
          {
               $this->user = new User( $this->getRequestId() );
               $this->user->load();
               $this->setTemplateVar('userid',$this->user->userid);
          }
     }

---

Dokumentation der Datenelemente

UserAction::$defaultSubAction = 'edit'

Definiert in Zeile 32 der Datei UserAction.class.php.

UserAction::$user

Definiert in Zeile 31 der Datei UserAction.class.php.

Wird benutzt von listing() und rights().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• actionClasses/UserAction.class.php