Fix formatting and add documentation

- mod/register
- mod/regmod
- Model/User
- Worker/CronJobs

mod/register.php

@@ -6,9 +6,9 @@ use Friendica\Core\PConfig;
 use Friendica\Core\System;
 use Friendica\Core\Worker;
 
-require_once('include/enotify.php');
-require_once('include/bbcode.php');
 require_once('include/user.php');
+require_once 'include/enotify.php';
+require_once 'include/bbcode.php';
 
 if(! function_exists('register_post')) {
 function register_post(App $a) {

mod/regmod.php

@@ -6,11 +6,12 @@ use Friendica\Core\System;
 use Friendica\Core\Worker;
 use Friendica\Database\DBM;
 
-require_once('include/enotify.php');
 require_once('include/user.php');
 
-function user_allow($hash) {
+require_once 'include/enotify.php';
 
+function user_allow($hash)
+{
 	$a = get_app();
 
 	$register = q("SELECT * FROM `register` WHERE `hash` = '%s' LIMIT 1",
@@ -64,16 +65,13 @@ function user_allow($hash) {
 		info(t('Account approved.') . EOL);
 		return true;
 	}
-
 }
 
-
 // This does not have to go through user_remove() and save the nickname
 // permanently against re-registration, as the person was not yet
 // allowed to have friends on this system
-
+function user_deny($hash)
-function user_deny($hash) {
+{
-
 	$register = q("SELECT * FROM `register` WHERE `hash` = '%s' LIMIT 1",
 		dbesc($hash)
 	);
@@ -91,11 +89,10 @@ function user_deny($hash) {
 
 	notice(sprintf(t('Registration revoked for %s'), $user[0]['username']) . EOL);
 	return true;
-
 }
 
-function regmod_content(App $a) {
+function regmod_content(App $a)
-
+{
 	global $lang;
 
 	$_SESSION['return_url'] = $a->cmd;
@@ -118,8 +115,6 @@ function regmod_content(App $a) {
 	$cmd = $a->argv[1];
 	$hash = $a->argv[2];
 
-
-
 	if ($cmd === 'deny') {
 		user_deny($hash);
 		goaway(System::baseUrl() . "/admin/users/");

src/Model/User.php

@@ -20,6 +20,19 @@ require_once 'include/plugin.php';
  */
 class User
 {
+	/**
+	 * @brief Authenticate a user with a clear text password
+	 *
+	 * User info can be any of the following:
+	 * - User DB object
+	 * - User Id
+	 * - User email or username or nickname
+	 * - User array with at least the uid and the hashed password
+	 *
+	 * @param mixed $user_info
+	 * @param string $password
+	 * @return boolean
+	 */
 	public static function authenticate($user_info, $password)
 	{
 		if (is_object($user_info)) {

src/Worker/CronJobs.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @file src/worker/CronJobs.php
  */
@@ -14,15 +15,16 @@ use Friendica\Network\Probe;
 use Friendica\Protocol\PortableContact;
 use dba;
 
-class CronJobs {
+class CronJobs
-	public static function execute($command = ''){
+{
+	public static function execute($command = '')
+	{
 		global $a;
 
 		require_once 'include/datetime.php';
 		require_once 'include/post_update.php';
 		require_once 'mod/nodeinfo.php';
 		require_once 'include/photos.php';
-		require_once 'include/user.php';
 
 		// No parameter set? So return
 		if ($command == '') {
@@ -86,7 +88,8 @@ class CronJobs {
 	/**
 	 * @brief Update the cached values for the number of photo albums per user
 	 */
-	private static function updatePhotoAlbums() {
+	private static function updatePhotoAlbums()
+	{
 		$r = q("SELECT `uid` FROM `user` WHERE NOT `account_expired` AND NOT `account_removed`");
 		if (!DBM::is_result($r)) {
 			return;
@@ -100,7 +103,8 @@ class CronJobs {
 	/**
 	 * @brief Expire and remove user entries
 	 */
-	private static function expireAndRemoveUsers() {
+	private static function expireAndRemoveUsers()
+	{
 		// expire any expired accounts
 		q("UPDATE user SET `account_expired` = 1 where `account_expired` = 0
 			AND `account_expires_on` > '%s'
@@ -120,8 +124,8 @@ class CronJobs {
 	 *
 	 * @param App $a
 	 */
-	private static function clearCache(App $a) {
+	private static function clearCache(App $a)
-
+	{
 		$last = Config::get('system', 'cache_last_cleared');
 
 		if ($last) {
@@ -215,8 +219,8 @@ class CronJobs {
 	 *
 	 * @param App $a
 	 */
-	private static function repairDiaspora(App $a) {
+	private static function repairDiaspora(App $a)
-
+	{
 		$starttime = time();
 
 		$r = q("SELECT `id`, `url` FROM `contact`
@@ -252,15 +256,15 @@ class CronJobs {
 	 * @brief Do some repairs in database entries
 	 *
 	 */
-	private static function repairDatabase() {
+	private static function repairDatabase()
-
+	{
 		// Sometimes there seem to be issues where the "self" contact vanishes.
 		// We haven't found the origin of the problem by now.
 		$r = q("SELECT `uid` FROM `user` WHERE NOT EXISTS (SELECT `uid` FROM `contact` WHERE `contact`.`uid` = `user`.`uid` AND `contact`.`self`)");
 		if (DBM::is_result($r)) {
 			foreach ($r AS $user) {
-				logger('Create missing self contact for user '.$user['uid']);
 				user_create_self_contact($user['uid']);
+				logger('Create missing self contact for user ' . $user['uid']);
 			}
 		}