Class constructor

Update user password

• return: true on success, else false

• integer $user_id: User ID
• string $old_password: Old (current) user password
• string $new_password: New user password

Delete exercise and all related data from database by user ID, day, and rank

Note : Get exercise ID, then calls delete_exercise_by_id().

• return: true on success, else false (no exercise)

• integer $user_id: User ID
• string $day: day of exercise (format : YYYY-MM-DD)
• integer $rank: Rank of exercise within day

Get day information data for a user

• return: Day information (associative array with plw_day_info SQL table structure)

• integer $user_id: User ID
• string $day: Day (format : YYYY-MM-DD)

Get global statistics about online exercises

Consider all active members. Consider all online exercises having a matching sport ID (even unknown).

• return: Associative array of records indexed by publish status ('all' if not splitted), 'public' and 'public-but-desc' are grouped as 'public'. then by sport index ('all' if not splitted). Each record is an associative array :
  • 'nb' => Number of exercises
  • 'elapsed' => Sum of exercices duration in seconds x 10
  • 'distance' => Sum of exercices distance in meters
  • 'ascend' => Sum of exercices ascend in meters
  Array is sorted by publish status, then by decreasing number of exercises for each sport.

• array $params: Associative array of parameters :
  • 'max_age' : Only exercises newer than <max_age> days
  • 'min_elapsed' : Only exercises during at least <min_elapsed> minutes
  • 'publish_list' : Array of publish status to filter ('public' => 'public' or 'public-but-desc')
  • 'by_publish' : Split by publish status if true
  • 'sport_list' : Array of sport indexes to filter
  • 'by_sport' : Split by sport index if true
• integer &$sum_nb_exe: Total nb of matching exercises

Get all laps in an exercise

• return: Array of laps indexed by lap number from 1. Each lap is an associative array with plw_lap SQL table structure. If $lap_type is null, associative array of lap types.

• integer $exe_id: Exercise ID
• string $lap_type: Lap type in ('polar','distance','altitude','interval'). If null, all types are returned.

Get global statistics about active members / online exercises

Consider all active members. Consider all online exercises (even with none matching sport ID)

• return: Associative arrays of records :
  • 'mbr' : active member count indexed by
  publish status ('all' if not splitted), 'public' and 'public-but-desc' are grouped as 'public'. Each record is an associative array :
  • 'nb' => Number of active members
  • 'exe' : Exercise count indexed by
  publish status ('all' if not splitted), 'public' and 'public-but-desc' are grouped as 'public'. Each record is an associative array :
  • 'nb' => Number of exercises
  • 'elapsed' => Sum of exercices duration in seconds x 10
  Both arrays are sorted by publish status;

• array $params: Associative array of parameters :
  • 'publish_list' : Array of publish status to filter ('public' => 'public' or 'public-but-desc')
  • 'by_publish' : Split by publish status if true

Get last exercises of all public (and active) users.

Last means most recent exercise date / time. Exercises are sorted from most recent to less recent. Consider all online exercises having a matching sport ID (even unknown).

• return: Array of exercises indexed from 0. Each exercise is an associative array :
  • 'user_id' : User ID
  • 'nickname' : User nickname
  • 'gender' : User gender in ('male','female')
  • 'birthdate' : User birthdate (YYYY-MM-DD)
  • 'weather' : Weather string
  • 'temperature' : Temperature in Celcius x 10
  • 'sport_index' : Sport index string
  • 'sport_name' : Sport name in case sport is unknown
  • 'exe_id' : Exercise ID
  • 'exe_type' : Exercise type string
  • 'day' : Exercise date (YYYY-MM-DD format)
  • 'start_time' : Exercise start time (HH:MI:SS format)
  • 'title' => Exercise title
  • 'monitor_type' => HR Monitor ID (polar_monitors.php)
  • 's_mode' => List of data measured (comma sep)
  • 'elapsed' => Exercice duration in seconds x 10
  • 'distance' => Exercice distance in meters
  • 'ascend' => Ascend in meters

• array $params: Associative array of parameters :
  • 'max_exe' : Maximum number of exercises to return
  • 'max_age' : Only exercises newer than <max_age> days
  • 'min_elapsed' : Only exercises during at least <min_elapsed> minutes

Get read rights on one user booknote for another user (or anonymous reader)

• return: Read rights, one of :
  • null : <publish_user_id> does not exist
  • 'private' : No read rights
  • 'public' : Read rights
  • 'public-but-desc' : Read rights except descriptions
• todo: Return day info display flag
• todo: Add groups rights

• integer $publish_user_id: ID of user owner of booknote
• integer $logged_user_id: ID uf user logged in (null if anonymous)
• string &$nickname: Nickname of <publish_user_id> user

Get user information data

• return: User information (associative array with plw_user SQL table structure)

• integer $user_id: User ID

Create a new user (with inactive status)

• return: true on success, else false

• array $info: Associative array of user fields :
  • 'nickname' : User nickname
  • 'email' : User email address
  • 'password' : User password
  • 'publish' : Publish status
• integer &$user_id: ID of user created
• string &$activ_code: Activation code (32 chars MD5 generated)

Set user preferences

Insert preference if not exist, delete if value is '', else update value.

• return: true on success, else false

• integer $user_id: User ID
• array $prefs: User preferences : Associative array of preferences (see get_user_preferences)