<?php
/***************************************************************************
- * Copyright (C) 2003-2008 Polytechnique.org *
+ * Copyright (C) 2003-2010 Polytechnique.org *
* http://opensource.polytechnique.org/ *
* *
* This program is free software; you can redistribute it and/or modify *
abstract class PlUser
{
/**
+ * User data enumerations.
+ */
+ const GENDER_FEMALE = true;
+ const GENDER_MALE = false;
+ const FORMAT_HTML = "html";
+ const FORMAT_TEXT = "text";
+
+ /**
* User data storage.
* By convention, null means the information hasn't been fetched yet, and
* false means the information is not available.
*/
+
+ // user_id is internal user ID (potentially numeric), whereas hruid is a
+ // "human readable" unique ID
protected $user_id = null;
protected $hruid = null;
// <display name> !"), while full name is the official full name.
protected $display_name = null;
protected $full_name = null;
- protected $promo = null;
+
+ // Other important parameters used when sending emails.
+ protected $gender = null; // Acceptable values are GENDER_MALE and GENDER_FEMALE
+ protected $email_format = null; // Acceptable values are FORMAT_HTML and FORMAT_TEXT
// Permissions
protected $perms = null;
return $this->full_name;
}
+ abstract public function password();
+
+ // Fallback value is GENDER_MALE.
+ public function isFemale()
+ {
+ return $this->gender == self::GENDER_FEMALE;
+ }
+
+ // Fallback value is FORMAT_TEXT.
+ public function isEmailFormatHtml()
+ {
+ return $this->email_format == self::FORMAT_HTML;
+ }
+
/**
* Other properties are available directly through the $data array, or as
* standard object variables, using a getter.
public function __get($name)
{
- if (isset($this->$name)) {
+ if (property_exists($this, $name)) {
return $this->$name;
}
public function __isset($name)
{
- return isset($this->$name) || isset($this->data[$name]);
+ return property_exists($this, $name) || isset($this->data[$name]);
}
/**
$this->data = array_merge($this->data, $values);
}
+ /**
+ * Adds properties to the object; this method does not allow the caller to
+ * update core properties (id, ...).
+ *
+ * @param $values An associative array of non-core properties.
+ */
+ public function addProperties(array $values)
+ {
+ foreach ($values as $key => $value) {
+ if (!property_exists($this, $key)) {
+ $this->data[$key] = $value;
+ }
+ }
+ }
+
/**
* Build the permissions flags for the user.
}
}
+ public static function getWithUID($uid, $callback = false)
+ {
+ return User::getWithValues(null, array('user_id' => $uid), $callback);
+ }
+
// Same as above, but using the silent callback as default.
public static function getSilent($login)
{
return User::getWithValues($login, $values, array('User', '_silent_user_callback'));
}
+ public static function getSilentWithUID($uid)
+ {
+ return User::getWithValues(null, array('user_id' => $uid), array('User', '_silent_user_callback'));
+ }
+
/**
- * Returns forlife emails corresponding to the @p logins. If @p strict mode
- * is disabled, it also includes login for which no forlife was found (but
- * still call the callback for them).
+ * Retrieves User objects corresponding to the @p logins, and eventually
+ * extracts and returns the @p property. If @p strict mode is disabled, it
+ * also includes logins for which no forlife was found (but it still calls
+ * the callback for them).
* In all cases, email addresses which are not from the local domains are
* kept.
*
* @param $logins Array of user logins.
+ * @param $property Property to retrieve from the User objects.
* @param $strict Should unvalidated logins be returned as-is or discarded ?
* @param $callback Callback to call when a login is unknown to the system.
* @return Array of validated user forlife emails.
*/
- public static function getBulkForlifeEmails($logins, $strict = true, $callback = false)
+ private static function getBulkUserProperties($logins, $property, $strict, $callback)
{
if (!is_array($logins)) {
if (strlen(trim($logins)) == 0) {
}
if (($user = User::get($login, $callback))) {
- $list[$i] = $user->forlifeEmail();
- } else if (!$strict || User::isForeignEmailAddress($login)) {
+ $list[$i] = $user->$property();
+ } else if (!$strict || (User::isForeignEmailAddress($login) && isvalid_email($login))) {
$list[$i] = $login;
}
}
}
/**
+ * Returns hruid corresponding to the @p logins. See getBulkUserProperties()
+ * for details.
+ */
+ public static function getBulkHruid($logins, $callback = false)
+ {
+ return self::getBulkUserProperties($logins, 'login', true, $callback);
+ }
+
+ /**
+ * Returns forlife emails corresponding to the @p logins. See
+ * getBulkUserProperties() for details.
+ */
+ public static function getBulkForlifeEmails($logins, $strict = true, $callback = false)
+ {
+ return self::getBulkUserProperties($logins, 'forlifeEmail', $strict, $callback);
+ }
+
+ /**
* Predefined callbacks for the user lookup; they are called when a given
* login is found not to be associated with any valid user. Silent callback
* does nothing; default callback is supposed to display an error message,
* served locally by plat/al.
*/
abstract public static function isForeignEmailAddress($email);
+
+ /**
+ * Creates a user forlive identifier from:
+ * @param $firstname User's firstname
+ * @param $lasttname User's lastname
+ * @param $category User's promotion or type of account
+ */
+ public static function makeHrid($firstname, $lastname, $category)
+ {
+ assert(trim($category));
+ $plainFirstname = replace_accent(trim($firstname));
+ $plainLastname = replace_accent(trim($lastname));
+
+ $hrid = strtolower($plainFirstname . '.' . $plainLastname . '.' . trim($category));
+ $hrid = str_replace(' ', '-', $hrid);
+ $hrid = str_replace("'", '', $hrid);
+ return $hrid;
+ }
+
+
}
// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
projects / platal.git / blobdiff