Class Users_model - echiong/testRepo GitHub Wiki

##Class Users_model

Users_model handles user related data operations.

Package: [[application<a href="Package application.models.md">models]]
Extends: CI_Model
Located at application/models/users_model.php

##Methods summary

---

public object auth ( object $fb, string $ref = null )

Authentication process - creates an account if user is unregistered.

Parameters

$fb object
$fb Facebook user detail object

$ref string
$ref Reference origin of request (Used for registration).

Returns object
Corresponding user record.

Used by Auth::facebook() m/Auth::login()

---

public get ( string|array $id, integer $limit = 100, integer $offset = 0 )

Get information about a specific user. If $id is an array, the returned array will contain every users specified in $id.

Parameters

$id string|array
$id User ID(s)

$limit integer
$limit The maximum number of records to be retrieved from the database

$offset integer
$offset The starting index to start retrieving record(s)

Used by People::follower() Users::details() People::follower() Users::details()

---

public follow ( integer $id )

Follow a specified user. (a) It makes sure the user is not already followed (b) It updates Users.StatsFollowers (c) It updates Users.ListFollowers

Parameters

$id integer
$id User ID

Used by Users::follow_user() Users::follow_user()

---

public unfollow ( integer $id )

Unfollow a specified user. (a) It makes sure the user is actually followed (b) It updates Users.StatsFollowers (c) It updates Users.ListFollowers

Parameters

$id integer
$id User ID

Used by Users::unfollow_user() Users::unfollow_user()

---

public boolean|object get_followed ( integer $n = 100, integer $offset = 0 )

Retrieves list of users followed by the current user session.

Parameters

$n integer
$n The maximum number of records to be retrieved from the database

$offset integer
$offset The starting index to start retrieving record(s)

Returns boolean|object

Used by People::followed() People::follow()

---

public string top_users ( integer $n = 100, integer $offset = 0, string $where = null )

Retrieves the top users and returns the result in html format.

Parameters

$n integer
$n The maximum number of records to be retrieved from the database

$offset integer
$offset The starting index to start retrieving record(s)

$where string
$where The where condition for the query

Returns string

Used by People::points() People::diamonds() People::points() People::diamonds()

---

public boolean update_meta ( string $tag, string $value )

Updates a single field for the current user session.

Parameters

$tag string
$tag User record field name.

$value string
$value User record field value.

Returns boolean

Used by Settings::set_username() Settings::connect_soundcloud() Settings::connect_twitter() Settings::connect_youtube() Settings::connect_vimeo() Settings::disconnect_sn() Settings::set_username() Settings::connect_soundcloud() Settings::connect_twitter() Settings::connect_youtube() Settings::connect_vimeo() Settings::disconnect_sn()

Methods inherited from CI_Model

__construct()

__get()