Public Member Functions | Data Fields

ilSoapAdministration Class Reference

Inheritance diagram for ilSoapAdministration:

Public Member Functions

 ilSoapAdministration ($use_nusoap=true)
 __checkSession ($sid)
 __explodeSid ($sid)
 __setMessage ($a_str)
 __getMessage ()
 __appendMessage ($a_str)
 __initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)
 __raiseError ($a_message, $a_code)

Data Fields

 $sauth = null
 $error_method = null

Detailed Description

Definition at line 38 of file class.ilSoapAdministration.php.


Member Function Documentation

ilSoapAdministration::__appendMessage ( a_str  ) 

Definition at line 99 of file class.ilSoapAdministration.php.

Referenced by ilSoapUserAdministration::__validateUserData().

        {
                $this->message .= isset($this->message) ? ' ' : '';
                $this->message .= $a_str;
        }

Here is the caller graph for this function:

ilSoapAdministration::__checkSession ( sid  ) 

Definition at line 68 of file class.ilSoapAdministration.php.

References $client, and __explodeSid().

Referenced by ilSoapCourseAdministration::addCourse(), ilSoapGroupAdministration::addGroup(), ilSoapObjectAdministration::addObject(), ilSoapObjectAdministration::addReference(), ilSoapRBACAdministration::addRole(), ilSoapRBACAdministration::addRoleFromTemplate(), ilSoapUserAdministration::addUser(), ilSoapRBACAdministration::addUserRoleEntry(), ilSoapCourseAdministration::assignCourseMember(), ilSoapGroupAdministration::assignGroupMember(), ilSoapCourseAdministration::deleteCourse(), ilSoapObjectAdministration::deleteObject(), ilSoapRBACAdministration::deleteRole(), ilSoapUserAdministration::deleteUser(), ilSoapRBACAdministration::deleteUserRoleEntry(), ilSoapCourseAdministration::excludeCourseMember(), ilSoapGroupAdministration::excludeGroupMember(), ilSoapCourseAdministration::getCourseXML(), ilSoapGroupAdministration::getGroup(), ilSoapRBACAdministration::getLocalRoles(), ilSoapUtils::getMobsOfObject(), ilSoapObjectAdministration::getObjectByReference(), ilSoapObjectAdministration::getObjectsByTitle(), ilSoapRBACAdministration::getObjectTreeOperations(), ilSoapObjectAdministration::getObjIdByImportId(), ilSoapRBACAdministration::getOperations(), ilSoapObjectAdministration::getRefIdsByImportId(), ilSoapObjectAdministration::getRefIdsByObjId(), ilSoapRBACAdministration::getRoles(), ilSOAPStructureObjectAdministration::getStructureObjects(), ilSoapObjectAdministration::getTreeChilds(), ilSoapUserAdministration::getUser(), ilSoapUserAdministration::getUserForRole(), ilSoapRBACAdministration::getUserRoles(), ilSoapUserAdministration::getUsersForContainer(), ilSoapObjectAdministration::getXMLTree(), ilSoapRBACAdministration::grantPermissions(), ilSoapGroupAdministration::groupExists(), ilSoapUserAdministration::hasNewMail(), ilSoapUserAdministration::importUsers(), ilSoapCourseAdministration::isAssignedToCourse(), ilSoapGroupAdministration::isAssignedToGroup(), ilSoapUserAdministration::logout(), ilSoapUserAdministration::lookupUser(), ilSoapObjectAdministration::removeFromSystemByImportId(), ilSoapRBACAdministration::revokePermissions(), ilSoapUtils::saveQuestionResult(), ilSoapUtils::saveTempFileAsMediaObject(), ilSoapObjectAdministration::searchObjects(), ilSoapUserAdministration::searchUser(), ilSoapUtils::sendMail(), ilSoapCourseAdministration::updateCourse(), ilSoapObjectAdministration::updateObjects(), ilSoapUserAdministration::updatePassword(), and ilSoapUserAdministration::updateUser().

        {
                list($sid,$client) = $this->__explodeSid($sid);

                $this->sauth->setClient($client);
                $this->sauth->setSid($sid);

                if(!$this->sauth->validateSession())
                {
                        return false;
                }                       
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSoapAdministration::__explodeSid ( sid  ) 

Definition at line 83 of file class.ilSoapAdministration.php.

Referenced by __checkSession().

        {
                $exploded = explode('::',$sid);

                return is_array($exploded) ? $exploded : array('sid' => '','client' => '');
        }

Here is the caller graph for this function:

ilSoapAdministration::__getMessage (  ) 

Definition at line 95 of file class.ilSoapAdministration.php.

Referenced by ilSoapUserAdministration::__validateUserData(), ilSoapUserAdministration::addUser(), and ilSoapUserAdministration::updateUser().

        {
                return $this->message;
        }

Here is the caller graph for this function:

ilSoapAdministration::__initAuthenticationObject ( a_auth_mode = AUTH_LOCAL  ) 

Definition at line 106 of file class.ilSoapAdministration.php.

Referenced by ilSoapAdministration(), ilSoapUserAdministration::login(), and ilSoapUserAdministration::loginCAS().

        {
                switch($a_auth_mode)
                {
                        case AUTH_CAS:
                                include_once './webservice/soap/classes/class.ilSoapAuthenticationCAS.php';
                                return $this->sauth = new ilSoapAuthenticationCAS();
                        
                        default:
                                include_once './webservice/soap/classes/class.ilSoapAuthentication.php';
                                return $this->sauth = new ilSoapAuthentication();
                }
        }

Here is the caller graph for this function:

ilSoapAdministration::__raiseError ( a_message,
a_code 
)

Definition at line 121 of file class.ilSoapAdministration.php.

Referenced by ilSoapUserAdministration::__getImportProtocolAsXML(), ilSoapUserAdministration::__getUserMappingAsXML(), ilSoapCourseAdministration::addCourse(), ilSoapGroupAdministration::addGroup(), ilSoapObjectAdministration::addObject(), ilSoapObjectAdministration::addReference(), ilSoapRBACAdministration::addRole(), ilSoapRBACAdministration::addRoleFromTemplate(), ilSoapUserAdministration::addUser(), ilSoapRBACAdministration::addUserRoleEntry(), ilSoapCourseAdministration::assignCourseMember(), ilSoapGroupAdministration::assignGroupMember(), ilSoapCourseAdministration::deleteCourse(), ilSoapObjectAdministration::deleteObject(), ilSoapRBACAdministration::deleteRole(), ilSoapUserAdministration::deleteUser(), ilSoapRBACAdministration::deleteUserRoleEntry(), ilSoapCourseAdministration::excludeCourseMember(), ilSoapGroupAdministration::excludeGroupMember(), ilSoapCourseAdministration::getCourseXML(), ilSoapGroupAdministration::getGroup(), ilSoapRBACAdministration::getLocalRoles(), ilSoapUtils::getMobsOfObject(), ilSoapObjectAdministration::getObjectByReference(), ilSoapObjectAdministration::getObjectsByTitle(), ilSoapRBACAdministration::getObjectTreeOperations(), ilSoapObjectAdministration::getObjIdByImportId(), ilSoapRBACAdministration::getOperations(), ilSoapObjectAdministration::getRefIdsByImportId(), ilSoapObjectAdministration::getRefIdsByObjId(), ilSoapRBACAdministration::getRoles(), ilSOAPStructureObjectAdministration::getStructureObjects(), ilSoapObjectAdministration::getTreeChilds(), ilSoapUserAdministration::getUser(), ilSoapUserAdministration::getUserForRole(), ilSoapRBACAdministration::getUserRoles(), ilSoapUserAdministration::getUsersForContainer(), ilSoapObjectAdministration::getXMLTree(), ilSoapRBACAdministration::grantPermissions(), ilSoapGroupAdministration::groupExists(), ilSoapUserAdministration::hasNewMail(), ilSoapUserAdministration::importUsers(), ilSoapCourseAdministration::isAssignedToCourse(), ilSoapGroupAdministration::isAssignedToGroup(), ilSoapUserAdministration::login(), ilSoapUserAdministration::loginCAS(), ilSoapUserAdministration::logout(), ilSoapUserAdministration::lookupUser(), ilSoapObjectAdministration::removeFromSystemByImportId(), ilSoapRBACAdministration::revokePermissions(), ilSoapUtils::saveQuestionResult(), ilSoapUtils::saveTempFileAsMediaObject(), ilSoapObjectAdministration::searchObjects(), ilSoapUserAdministration::searchUser(), ilSoapUtils::sendMail(), ilSoapCourseAdministration::updateCourse(), ilSoapObjectAdministration::updateObjects(), ilSoapUserAdministration::updatePassword(), and ilSoapUserAdministration::updateUser().

        {
                switch($this->error_method)
                {
                        case NUSOAP:

                                return new soap_fault($a_code,'',$a_message);
                }
        }

Here is the caller graph for this function:

ilSoapAdministration::__setMessage ( a_str  ) 

Definition at line 91 of file class.ilSoapAdministration.php.

Referenced by ilSoapUserAdministration::__validateUserData().

        {
                $this->message = $a_str;
        }

Here is the caller graph for this function:

ilSoapAdministration::ilSoapAdministration ( use_nusoap = true  ) 

Field Documentation

ilSoapAdministration::$error_method = null

Definition at line 50 of file class.ilSoapAdministration.php.

ilSoapAdministration::$sauth = null

Definition at line 44 of file class.ilSoapAdministration.php.


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