<?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.
*/
- protected $user_id = null;
+
+ // uid is internal user ID (potentially numeric), whereas hruid is a
+ // "human readable" unique ID
+ protected $uid = null;
protected $hruid = null;
// User main email aliases (forlife is the for-life email address, bestalias
// <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;
// If the user id was not part of the known values, determines it from
// the login.
- if (!$this->user_id) {
- $this->user_id = $this->getLogin($login);
+ if (!$this->uid) {
+ $this->uid = $this->getLogin($login);
}
// Preloads main properties (assumes the loader will lazily get them
*/
public function id()
{
- return $this->user_id;
+ return $this->uid;
}
public function login()
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]);
+ }
+
+ public function __unset($name)
+ {
+ if (property_exists($this, $name)) {
+ $this->$name = null;
+ } else {
+ unset($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('uid' => $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('uid' => $uid), array('User', '_silent_user_callback'));
+ }
+
/**
* Retrieves User objects corresponding to the @p logins, and eventually
* extracts and returns the @p property. If @p strict mode is disabled, it
if (($user = User::get($login, $callback))) {
$list[$i] = $user->$property();
- } else if (!$strict || User::isForeignEmailAddress($login)) {
+ } else if (!$strict || (User::isForeignEmailAddress($login) && isvalid_email($login))) {
$list[$i] = $login;
}
}
* served locally by plat/al.
*/
abstract public static function isForeignEmailAddress($email);
+
+ private static function stripBadChars($text)
+ {
+ return str_replace(array(' ', "'"), array('-', ''),
+ strtolower(stripslashes(replace_accent(trim($text)))));
+ }
+
+ /** Creates a username from a first and last name
+ * @param $firstname User's firstname
+ * @param $lasttname User's lastname
+ * return STRING the corresponding username
+ */
+ public static function makeUserName($firstname, $lastname)
+ {
+ return self::stripBadChars($firstname) . '.' . self::stripBadChars($lastname);
+ }
+
+ /**
+ * 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)
+ {
+ $cat = self::stripBadChars($category);
+ if (!cat) {
+ Platal::page()->kill("$category is not a suitable category.");
+ }
+
+ return self::makeUserName($firstname, $lastname) . '.' . $cat;
+ }
+
+ /** Reformats the firstname so that all letters are in lower case,
+ * except the first letter of each part of the name.
+ */
+ public static function fixFirstnameCase($firstname)
+ {
+ $firstname = strtolower($firstname);
+ $pieces = explode('-', $firstname);
+
+ foreach ($pieces as $piece) {
+ $subpieces = explode("'", $piece);
+ $usubpieces = '';
+
+ foreach ($subpieces as $subpiece) {
+ $usubpieces[] = ucwords($subpiece);
+ }
+ $upieces[] = implode("'", $usubpieces);
+ }
+ return implode('-', $upieces);
+ }
}
// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
projects / platal.git / blobdiff