如何使用ArangoDB在PHP中进行用户注册和身份验证？

Question

ArangoDB是一个灵活的多模型数据库服务器，它具有非常好的功能和大量的文档。这是一个年轻的，非常有前途的开源项目，社区不断壮大，但没有太多真实世界的例子可以开始。

一个常见的现实世界的例子是用户注册和认证。这在大多数应用程序中都是需要的。

那么，如何使用ArangoDB在PHP中进行用户注册和身份验证？

Answer 1

您可以直接运行以下示例代码，它将通过提供一些虚构的用户数据来运行用户注册和身份验证。
它会显示它正在执行的每一步。从收集创建，到用户注册，认证并最终再次清理收集。
也有很多解释正在做什么的评论，以便更容易理解。

只需将该代码放入一个文件中，根据您的环境配置autoload.php的路径并使用浏览器访问其链接。 此代码需要ArangoDB 1.2 and up以及ArangoDB-PHP client version 1.2及以上。
该公司预计ArangoDB要在本地主机上运行，​​并监听端口8529.

注1：该脚本会自动创建“用户”收集和“用户名”独特的跳跃列表索引。它也将最终放弃收藏。
如果您想手动而不是自动创建集合，则需要注释集合和索引创建的部分以及集合被删除的部分。
打开了一个壳ArangoDB（arangosh）后，并在其中运行以下命令：

arangosh> db._createDocumentCollection('users'); 
arangosh> db.users.ensureUniqueSkiplist("username"); 

，如果你要删除的集合，类型：

arangosh> db.users.drop(); 

注2 ：我故意避免介绍更多的OO风格，比如用户对象，地址对象等等，以保持简单。

所以，最后这里的脚本。

<?php 

namespace triagens\ArangoDb; 


// use this and change it to the path to autoload.php of the arangodb-php client if you're using the client standalone... 
// require __DIR__ . '/../vendor/triagens/ArangoDb/autoload.php'; 

// ...or use this and change it to the path to autoload.php in the vendor directory if you're using Composer/Packagist 
require __DIR__ . '/../vendor/autoload.php'; 


// This function will provide us with our pre-configured connection options. 
function getConnectionOptions() 
{ 
    $traceFunc = function ($type, $data) { 
     print "TRACE FOR " . $type . PHP_EOL; 
    }; 

    return array(
     ConnectionOptions::OPTION_ENDPOINT  => 'tcp://localhost:8529/', 
     // endpoint to connect to 
     ConnectionOptions::OPTION_CONNECTION => 'Close', 
     // can use either 'Close' (one-time connections) or 'Keep-Alive' (re-used connections) 
     ConnectionOptions::OPTION_AUTH_TYPE  => 'Basic', 
     // use basic authorization 
     /* 
     ConnectionOptions::OPTION_AUTH_USER  => '',      // user for basic authorization 
     ConnectionOptions::OPTION_AUTH_PASSWD  => '',      // password for basic authorization 
     ConnectionOptions::OPTION_PORT   => 8529,     // port to connect to (deprecated, should use endpoint instead) 
     ConnectionOptions::OPTION_HOST   => "localhost",    // host to connect to (deprecated, should use endpoint instead) 
     */ 
     ConnectionOptions::OPTION_TIMEOUT  => 5, 
     // timeout in seconds 
     //ConnectionOptions::OPTION_TRACE   => $traceFunc,    // tracer function, can be used for debugging 
     ConnectionOptions::OPTION_CREATE  => false, 
     // do not create unknown collections automatically 
     ConnectionOptions::OPTION_UPDATE_POLICY => UpdatePolicy::LAST, 
     // last update wins 
    ); 
} 


// This function tries to persist the user data into the database upon registration 
// it will fail if a user with the same username already exists. 
function register($connection, $username, $password, $registrationData) 
{ 
    // This would be where you call the function that encrypts your password like you did for storage earlier 
    $hashedPassword = md5($password); 

    // assign the collection to a var (or type it directly into the methods parameters) 
    $collectionId = 'users'; 

    //create an example document or an array in order to pass to the following byExample method 
    $document = Document::createFromArray(
     array('username' => $username, 'password' => $hashedPassword, 'data' => $registrationData) 
    ); 

    // Get an instance of the collection handler 
    $documentHandler = new DocumentHandler($connection); 

    try { 
     // query the given $collectionId by example using the previously declared $exampleDocument array 
     $result = $documentHandler->add($collectionId, $document); 

     // return the result; 
     return $result; 
    } catch (Exception $e) { 

     if ($e->getCode()) { 
      echo ('User already exists... '); 
     } else { 
      // any other error 
      echo ('An error occured. Exception: ' . $e); 
     } 
    } 
} 


// This function tries to authenticate the user and will return an array with its data 
function authenticate($connection, $username, $password) 
{ 
    // This would be where you call the function that encrypts your password like you did for storage earlier 
    $hashedPassword = md5($password); 

    // assign the collection to a var (or type it directly into the methods parameters) 
    $collectionId = 'users'; 

    //create an example document or an array in order to pass to the following byExample method 
    $exampleDocumentArray = array('username' => $username, 'password' => $hashedPassword); 

    // Get an instance of the collection handler 
    $documentHandler = new CollectionHandler($connection); 

    try { 
     // query the given $collectionId by example using the previously declared $exampleDocument array 
     $cursor = $documentHandler->byExample($collectionId, $exampleDocumentArray); 
     // check if the count of the cursor is one or not. 
     if ($cursor->getCount() == 1) { 
      // do some fancy login stuff here... 

      // get the current document from the cursor 
      $userDocument = $cursor->current(); 

      // set session uid to the document key that was set automatically by ArangoDB, 
      // since we didn't provide our own on registration 
      $_SESSION['uid'] = $userDocument->getKey(); 

      // extract and return the document in form of an array 
      return $userDocument->getAll(); 
     } else { 
      return false; 
     } 
    } catch (Exception $e) { 
     echo ('An error occured. Exception: ' . $e . '<br>'); 
    } 
} 


// register the connection to ArangoDB 
$connection = new Connection(getConnectionOptions()); 


// register a collection handler to work with the 'users' collection 
$collectionHandler = new CollectionHandler($connection); 


// create the 'users' collection... 
// remark those lines if you want to create the collection by hand. 
echo "creating 'users' collection..."; 
try { 
    $collection = new Collection(); 
    $collection->setName('users'); 
    $collectionHandler->create($collection); 
    echo "created.<br>"; 
} catch (Exception $e) { 
    echo ('Could not create collection. Exception: ' . $e . '<br>'); 
} 


// create unique skip list index in 'users' collection on field ''username'... 
// remark those lines if you want to create the index by hand. 
echo "creating unique skip list index in 'users' collection on field ''username'... "; 
try { 
    $collection = new Collection(); 
    $collection->setName('users'); 
    $collectionHandler->index('users', 'skiplist', array('username'), true); 
    echo "created.<br>"; 
} catch (Exception $e) { 
    echo ('Could not create skip list index. Exception: ' . $e . '<br>'); 
} 


// let's assume those variables hold your username/password 
$userNameProvided = 'jane'; 
$passwordProvided = 'mysecretpassword'; 

// here we pass some structured registration data 
$registrationData = array(
    'name'  => 'Jane', 
    'surname' => 'Doe', 
    'addresses' => array(
     'email' => array('jane@doe.com', 'jane2@doe.com'), 
     'home' => array(
      array('street' => 'Brooklyn Ave.', 'number' => 10), 
      array('street' => '54th Street', 'number' => 340, 'is_primary' => true) 
     ) 
    ) 
); 

// First register 
echo "trying to register user for the first time... "; 
$result = register($connection, $userNameProvided, $passwordProvided, $registrationData); 
if ($result) { 
    echo " " . $userNameProvided . " registered<br>"; 
} else { 
    echo "failed<br>"; 
} 


// Trying to register user with same username a second time 
echo "trying to register user with same username a second time... "; 
$result = register($connection, $userNameProvided, $passwordProvided, $registrationData); 
if ($result) { 
    echo "registered<br>"; 
} else { 
    echo "failed<br>"; 
} 


// now authenticate with the correct username/password combination 
echo "trying to authenticate with the correct username/password combination... "; 
if ($userArray = authenticate($connection, $userNameProvided, $passwordProvided)) { 
    echo "login successful. "; 
    echo '<br>'; 
    // do some fancy after-login stuff here... 
    echo "<br>Welcome back " . $userArray['username'] . '!<br>'; 
    if (count($userArray['data']['addresses']['email']) > 0) { 
     echo "Your primary mail address is " . $userArray['data']['addresses']['email'][0] . '<br>'; 
    } 
    foreach ($userArray['data']['addresses']['home'] as $key => $value) { 
     if (array_key_exists('is_primary', $value)) { 
      $homeAddress = $userArray['data']['addresses']['home'][$key]; 
      echo "Your primary home address is " . $homeAddress['number'] . ', ' . $homeAddress['street'] . '<br>'; 
      // if found, break out of the loop. There can be only one... primary address! 
      break; 
     } 
    } 
} else { 
    // re-display login form. +1 the wrong-login counter... 
    echo "wrong username or password<br>"; 
} 
echo '<br>'; 

// now authenticate with the wrong username/password combination 
echo "trying to authenticate with the wrong username/password combination... "; 
if (authenticate($connection, $userNameProvided, 'I am a wrong password')) { 
    // do some fancy after-login stuff here... 
    echo "login successful<br>"; 
} else { 
    // re-display login form. +1 the wrong-login counter... 
    echo "wrong username or password<br>"; 
} 


// truncate the collection... not needed if dropping, but only here to empty the collection of its tests 
// in case you decide to not create and drop the collection through this script, but by hand. 
echo "truncating collection..."; 
try { 
    $collectionHandler->truncate('users'); 
    echo "truncated.<br>"; 
} catch (Exception $e) { 
    die ('Could not truncate collection. Exception: ' . $e . '<br>'); 
} 


// finally drop the collection... 
// remark those lines if you want to drop the collection by hand. 
echo "dropping collection..."; 
try { 
    $collectionHandler->drop('users'); 
    echo "dropped.<br>"; 
} catch (Exception $e) { 
    die ('Could not drop collection. Exception: ' . $e . '<br>'); 
}