Subversion Repositories php_users

Rev

Rev 4 | Rev 10 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
6 rodolico 1 
By itself, the users class (with a data access class usersDataSource like the included UsersDataSourceMySQLi class) handles basic login/logout/editing functions.
4 rodolico 2 
 
3 
The class(es) were, however, designed for extensibility and customization in mind. Some design considerations were made with this in mind.
4 
 
5 
This code uses the ternary and null coelescing shortcuts ?: and ??. I THINK these were introduced in PHP 5.3, but not sure. This code will not work on versions which do not have these shortcuts. See https://www.php.net/manual/en/language.operators.comparison.php
6 
 
6 rodolico 7 
You can get a copy of this from our subversion repository
8 
svn co http://svn.dailydata.net/svn/php_users/stable php_users
9 
My working copy is at
10 
http://svn.dailydata.net/svn/php_users/trunk
11 
but I recommend NOT using that as I use trunk as my personal playground and will commit broken code to it regularly
12 
 
4 rodolico 13 
=== Basic System ===
14 
 
15 
With no modification, the system will store username, password and two booleans, isAdmin and enabled. The default table is created as
16 
 
17 
<code sql>
18 
create or replace table _users (
19 
   _user_id    int unsigned not null auto_increment,
20 
   login       varchar(64),
21 
   password    varchar(128),
22 
   isAdmin     boolean,
23 
   enabled     boolean,
24 
   primary key (_user_id)
25 
);
26 
</code>
27 
 
28 
* login is filtered to alpha-numerics and the underscore character
29 
* password is stored as a hash using PHP's password_hash
30 
* users with isAdmin set will be able to add/edit other users
31 
* users with enabled set to false (0) will not be able to log in
32 
 
6 rodolico 33 
NOTE: the usersDataSource class has a public function, buildTable, which will build the table, so installation involves simply calling that function.
4 rodolico 34 
 
35 
IMPORTANT: to allow the Users class to work with a wide variety of data types, it does no data access itself. It requires a data access class.
36 
 
37 
Basic use in a script involves instantiating a data access class object, then instantiating a Users class object.
38 
 
39 
Example:
40 
 
41 
<code php>
42 
<?php
43 
   include_once( 'UsersDataSourceMySQLi.class.php' );
44 
   include_once( 'Users.class.php' );
45 
   session_start();
46 
   $connection = new usersDataSource(
47 
         null,
48 
         null,
49 
         array( 'username' => 'test', 'password' => 'test', 'database' => 'test' )
50 
      );
51 
   //$connection->buildTable( 'admin', 'admin' ); die;
52 
   // ensure we always have a (possibly invalid) instance of user
53 
   if ( ! isset( $_SESSION['user'] ) ) {
54 
      $_SESSION['user'] = new Users( );
55 
   }
56 
?>
57 
<html>
58 
   <body>
59 
      <div class="login">
60 
         <?php
61 
            if ( isset( $_SESSION['user'] ) )
62 
               print $_SESSION['user']->HTML($connection);
63 
         ?>
64 
      </div>
65 
   </body>
66 
</html>
67 
</code>
68 
 
6 rodolico 69 
This example is using the usersDataSource definition of  data access (included)
4 rodolico 70 
 
71 
If you run it the first time with <code php>$connection->buildTable( 'admin', 'admin' ); die;</code> uncommented, it will build the table. Comment that line out on the next run and you will be presented with a login screen.
72 
 
73 
Class function HTML() displays various things to allow login, then quits displaying anything. Setting $_REQUEST['logout'] = 1 before calling HTML() will initiate a log out which will destroy the session variable
74 
 
75 
=== Full Functionality ===
76 
 
77 
Calling the class method admin and displaying the repeatedly will generate output allowing the user to change their username, password and any other fields which do not have the 'restrict' attribute set to true
78 
 
79 
If the user has admin rights set, it will also display a list of logins and allow you to select one to edit or, add a new user. Editing someone else shows all fields, whether or not the 'restrict' attribute is set to true.
80 
 
81 
=== CSS ===
82 
 
83 
I tried to not put any HTML layout into the code, relying instead on CSS. Everything is supposed to have a class and be wrapped in a <div> with a class. Following are the classes I have in the code (I THINK).
84 
* login_field = This is the class of all INPUT fields, and div's surrounding them
85 
* login_form  = the class for all <form definitions
86 
* login_list  = the class of the unsigned list (ul) which displays the links to edit other users for admin's
87 
* login       = NOT in code, but used in example as a div around the div around the login area
88 
 
89 
=== Extended Functionality ===
90 
 
91 
First, everything is pretty basic. I tried to limit the number of fields to the absolute minimum, but also set it up to allow additional fields to be added programmatically. The example does this.
92 
 
93 
If you open the class source, you'll find the private member $dbDefinition, which defines everything in the code (I hope). When you create a new instance, you can pass the constructor an array which will be merged with this member, optionally increasing the number and definition of the fields.
94 
 
6 rodolico 95 
WARNING: if you add new fields to the Users class, you must also add them to class usersDataSource. See below
4 rodolico 96 
 
97 
Let's add a new field, say we want to store the users e-mail address. In our PHP, create an array as follows:
98 
 
99 
<code php>
100 
   $customFields = array(
101 
      'tables' => array(
102 
         'users' => array(
103 
            'fields' => array(
104 
               'email' => array(
105 
                     // == For Users class ==
106 
                     // this will be the display label on the form
107 
                     'label'  => 'E-Mail',
108 
                     // the input type to use for data entry
109 
                     'html type' => 'text',
110 
                     // you can only edit this if an admin and changing someone
111 
                     // else' record
112 
                     'restrict' => false,
113 
                     // will be displayed on a hover in HTML5 (ie, title=)
114 
                     'instructions' => 'Enter your e-mail address (WARNING, not verified)',
115 
                     // this is entered in an empty box, ie placeholder=
116 
                     'hint'     => 'E-Mail Address',
117 
                     // a regex to run it against to verify it is ok
118 
                     'filter'   => '/[-_a-z0-9.]+@[_a-z0-9]\.[a-z0-9]/i',
119 
 
120 
                     // == for Data Source ==
121 
                     'dbColumn'  =>  'email',
122 
                     // actual mySQL column type
123 
                     'type'      => 'varchar(64)',
124 
                     // set it to not null if we build the table ourselves
125 
                     'required'  => false
126 
                     )
127 
                  )
128 
               )
129 
            )
130 
      );
131 
 ?>
132 
 </code>
133 
 
6 rodolico 134 
 Now, when we instantiate a new object of class Users AND class usersDataSource, we simply pass this array in.
4 rodolico 135 
 
136 
 <code php>
137 
    $connection = new usersDataSource(
138 
         null,
139 
         $customFields,
140 
         array( 'username' => 'test', 'password' => 'test', 'database' => 'test' )
141 
      );
142 
   if ( ! isset( $_SESSION['user'] ) ) {
143 
      $_SESSION['user'] = new Users( $customFields );
144 
   }
145 
</php>
146 
 
6 rodolico 147 
Note that since we replicated the basic structure of $dbDefinition in Users and usersDataSource, we can use the same hash to pass into both; they will store, but ignore values not relevant to them.
4 rodolico 148 
 
149 
When the usersDataSource and Users objects are created, $customFields will be merged, with duplicates overwritten by the $customFields value.
150 
 
151 
This is not limited to adding new columns; you can modify the display definitions also, ie how the information is stored on the screen, to some extent.
6 rodolico 152 
 
153 
==== usersDataSource ====
154 
 
155 
This is our data access class. It really doesn't matter what it is called, though I plan to call it the same when I add more data access objects.
156 
 
157 
This code accesses the data (duh), and is consistently called $connection in the Users class. The only requirement is that it must be able to implement the following functions
158 
 
159 
getPassword( $username ) returns encrypted password
160 
getRecord( $username ) returns array containing the values for a user
161 
getAllUsers() returns an array of all user id's and names
162 
getARecord( array of key value pairs to limit what is retrieved ) returns all values
163 
update( array of key value pairs ) returns true/false on success/failure
164 
 
165 
It is also nice is it can A) handle new columns and B) create and initialize the necessary storage
166 
 
167 
I separated this out from the Users class because not all programs need database access. For instance, the favorites_urls app uses file based storage, so by writing a new access class for it, we will hopefully be able to get the same functionality, but with a different storage back end.
168 
 
169 
==== Future ====
170 
 
171 
This is only the initial part of this particular project. I now intend to extend both classes to allow boolean permissions which will be integrated into our new version of CAMP, giving very granular rights to users. It will be available as a second set of files in this repository and is planned for release by October 2021.