PendingUser - Code Metrics - Inspection of "Initial Commit of Magic Functions for User Attribu..." - BurningFlipside/CommonCode - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Branch — MagicUser (b8f336)

by Patrick
created 2016-06-09 21:33 UTC
PendingUser A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	198
Duplicated Lines	0 %
Coupling/Cohesion

Components	1
Dependencies	3
Importance

Changes	4
Bugs	1	Features	2
Metric	Value
c	4
b	1
f	2
dl	0
loc	198
rs	10
wmc	23
lcom	1
cbo	3
16 Methods

Rating	Name	Size	Complexity
A	getHash()	4	1
A	getRegistrationTime()	4	1
A	isInGroupNamed()	4	1
A	getEmail()	8	2
A	__get()	8	2
A	__set()	4	1
A	getLastName()	8	2
A	getPassword()	4	1
A	getLoginProviders()	8	2
A	addLoginProvider()	11	2
A	setEmail()	5	1
A	setGivenName()	5	1
A	setLastName()	5	1
A	jsonSerialize()	14	2
A	sendEmail()	20	2
A	delete()	3	1
<?php
/**
 * PendingUser class
 *
 * This file describes the PendingUser classes
 *
 * PHP version 5 and 7
 *
 * @author Patrick Boyd / [email protected]
 * @copyright Copyright (c) 2015, Austin Artistic Reconstruction
 * @license http://www.apache.org/licenses/ Apache 2.0 License
 */

namespace Auth;

/**
 * A class to abstract access to PendingUsers (users that have not completed registration) regardless of the Authentication type used.
 *
 * This class is the primary method to access pending user information.
 */
class PendingUser extends User
{
    protected $intData = array();

    public function getHash()
    {
        return false;
    }

    public function getRegistrationTime()
    {
        return false;
    }

    /**
     * Is this user in the Group or a child of that group?
     *
     * @param string $name The name of the group to check if the user is in
     *
     * @return boolean True if the user is in the group, false otherwise
     */
    public function isInGroupNamed($name)
    {
        return false;
    }

    /**
     * The email address for the user
     *
     * @return string The user's email address
     */
    public function getEmail()
    {
        if(isset($this->email))
        {
            return $this->email;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        return parent::getEmail();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function __get($propName)
    {
        if(isset($this->intData[$propName]))
        {
            return $this->intData[$propName];
        }
        return parent::__get($propName);
    }

    public function __set($propName, $value)
    {
        $this->intData[$propName] = $value;
    }

    /**
     * The last name for the user
     *
     * @return string The user's last name
     */
    public function getLastName()
    {
        if(isset($this->sn))
        {
            return $this->sn;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        return parent::getLastName();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Get the user's password as specified during registration
     *
     * We need the ability to obtain the user's unhashed plain text password to allow for it to be sent 
     * to the correct backend which will hash it
     *
     * @return boolean|string The current password
     */
    public function getPassword()
    {
        return false;
    }

    /**
     * The supplemental login types that the user can use to login
     *
     * @return array The user's login providers
     */
    public function getLoginProviders()
    {
        if(isset($this->host))
        {
            return $this->host;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        return parent::getLoginProviders();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Add a supplemental login type that the user can use to login
     *
     * @param string $provider The hostname for the provider
     *
     * @return true|false true if the addition worked, false otherwise
     */
    public function addLoginProvider($provider)
    {
        if(isset($this->host))
        {
            array_push($this->host, $provider);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        else
        {
            $this->host = array($provider);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }

    /**
     * Set the user's email address
     *
     * @param string $email The user's new email address
     *
     * @return boolean true if the user's email address was changed, false otherwise
     */
    public function setEmail($email)
    {
        $this->email = $email;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return true;
    }

    /**
     * Set the user's given (first) name
     *
     * @param string $givenName The user's new given name
     *
     * @return boolean true if the user's given name was changed, false otherwise
     */
    public function setGivenName($givenName)
    {
        $this->givenName = $givenName;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return true;
    }

    /**
     * Set the user's last name
     *
     * @param string $sn The user's new last name
     *
     * @return boolean true if the user's last name was changed, false otherwise
     */
    public function setLastName($sn)
    {
        $this->sn = $sn;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        return true;
    }

    /**
     * Serialize the user data into a format usable by the json_encode method
     *
     * @return array A simple keyed array representing the user
     */
    public function jsonSerialize()
    {
        $user = array();
        $user['hash'] = $this->getHash();
        $user['mail'] = $this->getEmail();
        $user['uid'] = $this->getUid();
        $time = $this->getRegistrationTime();
        if($time !== false)
        {
            $user['time'] = $time->format(\DateTime::RFC822);

        }
        $user['class'] = get_class($this);
        return $user; 
    }

    public function sendEmail()
    {
        $email_msg = new \Email\Email();
        $email_msg->addToAddress($this->getEmail());
        $email_msg->setTextBody('Thank you for signing up with Burning Flipside. Your registration is not complete until you goto the address below.
                https://profiles.burningflipside.com/finish.php?hash='.$this->getHash().'
                Thank you,
                Burning Flipside Technology Team');
        $email_msg->setHTMLBody('Thank you for signing up with Burning Flipside. Your registration is not complete until you follow the link below.<br/>
                <a href="https://profiles.burningflipside.com/finish.php?hash='.$this->getHash().'">Complete Registration</a><br/>
                Thank you,<br/>
                Burning Flipside Technology Team');
        $email_msg->setSubject('Burning Flipside Registration');
        $email_provider = \EmailProvider::getInstance();
        if($email_provider->sendEmail($email_msg) === false)
        {
            throw new \Exception('Unable to send email!');
        }
        return true;
    }

    public function delete()
    {
    }
}
/* vim: set tabstop=4 shiftwidth=4 expandtab: */

BurningFlipside / CommonCode

Branch — MagicUser (b8f336)

PendingUser A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

Duplication Side-by-Side

Filter issues like
