XML writer class. More...
Inheritance diagram for ilUserXMLWriter:
Collaboration diagram for ilUserXMLWriter:
Public Member Functions | |
| ilUserXMLWriter () | |
| constructor | |
| setAttachRoles ($value) | |
| setObjects (&$users) | |
| start () | |
| getXML () | |
| __buildHeader () | |
| __buildFooter () | |
| __handleUser ($row) | |
| __addElement ($tagname, $value, $attrs=null, $settingsname=null) | |
| setSettings ($settings) | |
| write access to settings | |
Data Fields | |
| $ilias | |
| $xml | |
| $users | |
| $user_id = 0 | |
| $attachRoles = false | |
Private Member Functions | |
| canExport ($tagname, $settingsname=null) | |
| getPictureValue ($usr_id) | |
| return array with baseencoded picture data as key value, encoding type as encoding, and image type as key type. | |
Private Attributes | |
| $settings | |
Detailed Description
XML writer class.
Class to simplify manual writing of xml documents. It only supports writing xml sequentially, because the xml document is saved in a string with no additional structure information. The author is responsible for well-formedness and validity of the xml document.
- Version:
- Id:
- class.ilObjectXMLWriter.php,v 1.3 2005/11/04 12:50:24 smeyer Exp
Definition at line 41 of file class.ilUserXMLWriter.php.
Member Function Documentation
| ilUserXMLWriter::__addElement | ( | $ | tagname, | |
| $ | value, | |||
| $ | attrs = null, |
|||
| $ | settingsname = null | |||
| ) |
Definition at line 290 of file class.ilUserXMLWriter.php.
References canExport(), and ilXmlWriter::xmlElement().
Referenced by __handleUser().
{
if ($this->canExport($tagname, $settingsname))
$this->xmlElement ($tagname, $attrs, $value);
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilUserXMLWriter::__buildFooter | ( | ) |
Definition at line 126 of file class.ilUserXMLWriter.php.
References ilXmlWriter::xmlEndTag().
Referenced by start().
{
$this->xmlEndTag('Users');
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilUserXMLWriter::__buildHeader | ( | ) |
Definition at line 115 of file class.ilUserXMLWriter.php.
References ilXmlWriter::xmlHeader(), ilXmlWriter::xmlSetDtdDef(), ilXmlWriter::xmlSetGenCmt(), and ilXmlWriter::xmlStartTag().
Referenced by start().
{
$this->xmlSetDtdDef("<!DOCTYPE Users PUBLIC \"-//ILIAS//DTD UserImport//EN\" \"".ILIAS_HTTP_PATH."/xml/ilias_user_3_8.dtd\">");
$this->xmlSetGenCmt("User of ilias system");
$this->xmlHeader();
$this->xmlStartTag('Users');
return true;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilUserXMLWriter::__handleUser | ( | $ | row | ) |
only export one password
Definition at line 131 of file class.ilUserXMLWriter.php.
References __addElement(), ilObjUser::_lookupPref(), canExport(), ilObjUserFolder::getExportSettings(), getPictureValue(), setSettings(), ilXmlWriter::xmlElement(), ilXmlWriter::xmlEndTag(), and ilXmlWriter::xmlStartTag().
Referenced by start().
{
global $ilDB;
if (!is_array ($this->settings)) {
include_once ('./Services/User/classes/class.ilObjUserFolder.php');
$this->setSettings(ilObjUserFolder::getExportSettings());
}
if (strlen($row["language"]) == 0) $row["language"] = "en";
$attrs = array (
'Id' => "il_".IL_INST_ID."_usr_".$row["usr_id"],
'Language' => $row["language"],
'Action' => "Update");
$this->xmlStartTag("User", $attrs);
$this->xmlElement("Login", null, $row["login"]);
if ($this->attachRoles == TRUE)
{
include_once './classes/class.ilObjRole.php';
$query = sprintf("SELECT object_data.title, object_data.description, rbac_fa.*
FROM object_data, rbac_ua, rbac_fa WHERE rbac_ua.usr_id = %s AND rbac_ua.rol_id = rbac_fa.rol_id AND object_data.obj_id = rbac_fa.rol_id",
$ilDB->quote($row["usr_id"])
);
$rbacresult = $ilDB->query($query);
while ($rbacrow = $rbacresult->fetchRow(DB_FETCHMODE_ASSOC))
{
if ($rbacrow["assign"] != "y")
continue;
$type = "";
if ($rbacrow["parent"] == ROLE_FOLDER_ID)
{
$type = "Global";
}
else
{
$type = "Local";
}
if (strlen($type))
{
$this->xmlElement("Role",
array ("Id" =>
"il_".IL_INST_ID."_role_".$rbacrow["rol_id"], "Type" => $type),
$rbacrow["title"]);
}
}
}
$i2passwd = FALSE;
if ($this->canExport("i2passwd","i2passwd") && strlen($row["i2passwd"]) > 0)
{
$i2passwd = TRUE;
$this->__addElement("Password",$row["i2passwd"], array("Type" => "ILIAS2"),"i2passwd");
}
if (!$i2passwd && strlen($row["passwd"]) > 0)
{
$this->__addElement("Password",$row["passwd"], array("Type" => "ILIAS3"),"passwd");
}
$this->__addElement ("Firstname", $row["firstname"]);
$this->__addElement ("Lastname", $row["lastname"]);
$this->__addElement ("Title", $row["title"]);
if ($this->canExport("PersonalPicture", "upload"))
{
$imageData = $this->getPictureValue($row["usr_id"]);
if ($imageData)
{
$value = array_shift($imageData); //$imageData["value"];
$this->__addElement ("PersonalPicture", $value, $imageData, "upload");
}
}
$this->__addElement ("Gender", $row["gender"]);
$this->__addElement ("Email", $row["email"]);
$this->__addElement ("Institution", $row["institution"]);
$this->__addElement ("Street", $row["street"]);
$this->__addElement ("City", $row["city"]);
$this->__addElement ("PostalCode", $row["zipcode"], null, "zipcode");
$this->__addElement ("Country", $row["country"]);
$this->__addElement ("PhoneOffice", $row["phone_office"], null, "phone_office");
$this->__addElement ("PhoneHome", $row["phone_home"], null, "phone_home");
$this->__addElement ("PhoneMobile", $row["phone_mobile"], null, "phone_mobile");
$this->__addElement ("Fax", $row["fax"]);
$this->__addElement ("Hobby", $row["hobby"]);
$this->__addElement ("Department", $row["department"]);
$this->__addElement ("Comment", $row["referral_comment"], null, "referral_comment");
$this->__addElement ("Matriculation", $row["matriculation"]);
$this->__addElement ("Active", $row["active"] ? "true":"false" );
$this->__addElement ("ClientIP", $row["client_ip"], null, "client_ip");
$this->__addElement ("TimeLimitOwner", $row["time_limit_owner"], null, "time_limit_owner");
$this->__addElement ("TimeLimitUnlimited", $row["time_limit_unlimited"], null, "time_limit_unlimited");
$this->__addElement ("TimeLimitFrom", $row["time_limit_from"], null, "time_limit_from");
$this->__addElement ("TimeLimitUntil", $row["time_limit_until"], null, "time_limit_until");
$this->__addElement ("TimeLimitMessage", $row["time_limit_message"], null, "time_limit_message");
$this->__addElement ("ApproveDate", $row["approve_date"], null, "client_ip");
$this->__addElement ("AgreeDate", $row["agree_date"], null, "agree_date");
if ((int) $row["ilinc_id"] !=0) {
$this->__addElement ("iLincID", $row["ilinc_id"], "ilinc_id");
$this->__addElement ("iLincUser", $row["ilinc_user"], "ilinc_user");
$this->__addElement ("iLincPasswd", $row["ilinc_passwd"], "ilinc_passwd");
}
if (strlen($row["auth_mode"])>0)
{
$this->__addElement ("AuthMode", null, array ("type" => $row["auth_mode"]),"auth_mode");
}
if (strlen($row["ext_account"])>0)
{
$this->__addElement ("ExternalAccount", $row["ext_account"], null, "ext_account");
}
if ($this->canExport("skin_style"))
{
$this->__addElement("Look",null,array(
"Skin" => ilObjUser::_lookupPref($row["usr_id"], "skin") ,
"Style" => ilObjUser::_lookupPref($row["usr_id"], "style")
),"skin_style");
}
$this->__addElement ("LastUpdate", $row["last_update"], null, "last_update");
$this->__addElement ("LastLogin", $row["last_login"], null, "last_login");
include_once ("./Services/User/classes/class.ilUserDefinedData.php");
$udf_data = new ilUserDefinedData($row['usr_id']);
$udf_data->addToXML($this, $this->settings);
$msgrs = array ("skype" => "im_skype", "yahoo" => "im_yahoo", "msn"=>"im_msn", "aim"=>"im_aim", "icq"=>"im_icq", "delicious" => "delicious", "external" => "ext_account");
foreach ($msgrs as $type => $fieldname) {
$this->__addElement("AccountInfo", $row[$fieldname], array("Type" => $type), "instant_messengers");
}
$this->__addElement("GMapsInfo", null, array (
"longitude" => $row["longitude"],
"latitude" => $row["latitude"],
"zoom" => $row["loc_zoom"]));
$this->xmlEndTag('User');
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilUserXMLWriter::canExport | ( | $ | tagname, | |
| $ | settingsname = null | |||
| ) | [private] |
Definition at line 297 of file class.ilUserXMLWriter.php.
Referenced by __addElement(), and __handleUser().
{
return !is_array($this->settings) ||
in_array(strtolower($tagname), $this->settings) !== FALSE ||
in_array($settingsname, $this->settings) !== FALSE;
}
Here is the caller graph for this function:
| ilUserXMLWriter::getPictureValue | ( | $ | usr_id | ) | [private] |
return array with baseencoded picture data as key value, encoding type as encoding, and image type as key type.
- Parameters:
-
int $usr_id
Definition at line 318 of file class.ilUserXMLWriter.php.
References ilUtil::getWebspaceDir().
Referenced by __handleUser().
{
global $ilDB;
// personal picture
$q = sprintf("SELECT value FROM usr_pref WHERE usr_id=%s AND keyword='profile_image'", $ilDB->quote($usr_id . ""));
$r = $ilDB->query($q);
if ($r->numRows() == 1)
{
$personal_picture_data = $r->fetchRow(DB_FETCHMODE_ASSOC);
$personal_picture = $personal_picture_data["value"];
$webspace_dir = ilUtil::getWebspaceDir();
$image_file = $webspace_dir."/usr_images/".$personal_picture;
if (@is_file($image_file))
{
$fh = fopen($image_file, "rb");
if ($fh)
{
$image_data = fread($fh, filesize($image_file));
fclose($fh);
$base64 = base64_encode($image_data);
$imagetype = "image/jpeg";
if (preg_match("/.*\.(png|gif)$/", $personal_picture, $matches))
{
$imagetype = "image/".$matches[1];
}
return array (
"value" => $base64,
"encoding" => "Base64",
"imagetype" => $imagetype
);
}
}
}
return false;
}
Here is the call graph for this function:
Here is the caller graph for this function:
| ilUserXMLWriter::getXML | ( | ) |
Definition at line 109 of file class.ilUserXMLWriter.php.
References ilXmlWriter::xmlDumpMem().
{
return $this->xmlDumpMem(FALSE);
}
Here is the call graph for this function:
| ilUserXMLWriter::ilUserXMLWriter | ( | ) |
constructor
- Parameters:
-
string xml version string output encoding string input encoding public
Definition at line 63 of file class.ilUserXMLWriter.php.
References $ilias, and ilXmlWriter::ilXmlWriter().
{
global $ilias,$ilUser;
parent::ilXmlWriter();
$this->ilias =& $ilias;
$this->user_id = $ilUser->getId();
$this->attachRoles = false;
}
Here is the call graph for this function:
| ilUserXMLWriter::setAttachRoles | ( | $ | value | ) |
Definition at line 74 of file class.ilUserXMLWriter.php.
{
$this->attachRoles = $value == 1? true : false;
}
| ilUserXMLWriter::setObjects | ( | &$ | users | ) |
Definition at line 79 of file class.ilUserXMLWriter.php.
References $users.
{
$this->users = & $users;
}
| ilUserXMLWriter::setSettings | ( | $ | settings | ) |
write access to settings
- Parameters:
-
array $settings
Definition at line 309 of file class.ilUserXMLWriter.php.
References $settings.
Referenced by __handleUser().
{
$this->settings = $settings;
}
Here is the caller graph for this function:
| ilUserXMLWriter::start | ( | ) |
Definition at line 85 of file class.ilUserXMLWriter.php.
References $user, __buildFooter(), __buildHeader(), __handleUser(), and ilUserDefinedFields::_getInstance().
{
if (!is_array($this->users))
return false;
$this->__buildHeader();
include_once ("./Services/User/classes/class.ilUserDefinedFields.php");
$udf_data = & ilUserDefinedFields::_getInstance();
$udf_data->addToXML($this);
foreach ($this->users as $user)
{
$this->__handleUser ($user);
}
$this->__buildFooter();
return true;
}
Here is the call graph for this function:
Field Documentation
| ilUserXMLWriter::$attachRoles = false |
Definition at line 47 of file class.ilUserXMLWriter.php.
| ilUserXMLWriter::$ilias |
Definition at line 43 of file class.ilUserXMLWriter.php.
Referenced by ilUserXMLWriter().
ilUserXMLWriter::$settings [private] |
Definition at line 54 of file class.ilUserXMLWriter.php.
Referenced by setSettings().
| ilUserXMLWriter::$user_id = 0 |
Definition at line 46 of file class.ilUserXMLWriter.php.
| ilUserXMLWriter::$users |
Definition at line 45 of file class.ilUserXMLWriter.php.
Referenced by setObjects().
| ilUserXMLWriter::$xml |
Definition at line 44 of file class.ilUserXMLWriter.php.
The documentation for this class was generated from the following file:
- Services/User/classes/class.ilUserXMLWriter.php
