File Model/Person.php | Alpha Framework 3.0.0 API Documentation

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460

<?php

namespace Alpha\Model;

use Alpha\Model\Type\SmallText;
use Alpha\Model\Type\Enum;
use Alpha\Model\Type\Relation;
use Alpha\Util\Helper\Validator;
use Alpha\Util\Logging\Logger;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Service\ServiceFactory;
use Alpha\Exception\RecordNotFoundException;

/**
 * The main person/user class for the framework.
 *
 * @since 1.0
 *
 * @author John Collins <dev@alphaframework.org>
 * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
 * @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
 * All rights reserved.
 *
 * <pre>
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the
 * following conditions are met:
 *
 * * Redistributions of source code must retain the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer.
 * * Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the
 *   following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 * * Neither the name of the Alpha Framework nor the names
 *   of its contributors may be used to endorse or promote
 *   products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * </pre>
 */
class Person extends ActiveRecord
{
    /**
     * The forum display name of the person.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $username;

    /**
     * The email address for the person.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $email;

    /**
     * The password for the person.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $password;

    /**
     * A Relation containing all of the rights groups that this person belongs to.
     *
     * @var \Alpha\Model\Type\Relation
     *
     * @since 1.0
     */
    protected $rights;

    /**
     * A Relation containing all of the actions carried out by this person.
     *
     * @var \Alpha\Model\Type\Relation
     *
     * @since 1.2.2
     */
    protected $actions;

    /**
     * An array of data display labels for the class properties.
     *
     * @var array
     *
     * @since 1.0
     */
    protected $dataLabels = array('ID' => 'Member ID#',
                                    'username' => 'Username',
                                    'email' => 'E-mail Address',
                                    'password' => 'Password',
                                    'state' => 'Account state',
                                    'URL' => 'Your site address',
                                    'rights' => 'Rights Group Membership',
                                    'actions' => 'Actions',);

    /**
     * The name of the database table for the class.
     *
     * @var string
     *
     * @since 1.0
     */
    const TABLE_NAME = 'Person';

    /**
     * The state of the person (account status).
     *
     * @var Aplha\Model\Type\Enum
     *
     * @since 1.0
     */
    protected $state;

    /**
     * The website URL of the person.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $URL;

    /**
     * Trace logger.
     *
     * @var \Alpha\Util\Logging\Logger
     *
     * @since 1.0
     */
    private static $logger = null;

    /**
     * Constructor for the class that populates all of the complex types with default values.
     *
     * @since 1.0
     */
    public function __construct()
    {
        self::$logger = new Logger('Person');
        self::$logger->debug('>>__construct()');

        // ensure to call the parent constructor
        parent::__construct();
        $this->username = new SmallText();
        $this->username->setRule(Validator::REQUIRED_USERNAME);
        $this->username->setSize(70);
        $this->username->setHelper('Please provide a name for display on the website (only letters, numbers, and .-_ characters are allowed!).');
        $this->email = new SmallText();
        $this->email->setRule(Validator::REQUIRED_EMAIL);
        $this->email->setSize(70);
        $this->email->setHelper('Please provide a valid e-mail address as your username.');
        $this->password = new SmallText();
        $this->password->setSize(70);
        $this->password->setHelper('Please provide a password for logging in.');
        $this->password->isPassword(true);
        $this->state = new Enum(array(
                                    'Active',
                                    'Disabled',));
        $this->state->setValue('Active');
        $this->URL = new SmallText();
        $this->URL->setRule(Validator::OPTIONAL_HTTP_URL);
        $this->URL->setHelper('URLs must be in the format http://some_domain/ or left blank!');
        // add unique keys to username and email (which is effectively the username in Alpha)
        $this->markUnique('username');
        $this->markUnique('email');

        $this->rights = new Relation();
        $this->markTransient('rights');

        $this->actions = new Relation();
        $this->markTransient('actions');

        $this->setupRels();

        self::$logger->debug('<<__construct');
    }

    /**
     * Set up the transient attributes for the rights group after it has loaded.
     *
     * @since 1.0
     */
    protected function after_load_callback()
    {
        $this->setupRels();
    }

    /**
     * Set up the transient attributes for the site after it has loaded.
     *
     * @since 1.0
     */
    protected function after_loadByAttribute_callback()
    {
        $this->setupRels();
    }

    /**
     * Looks up the ID for the Standard rights group, then relates the new person
     * to that group if they are not in it already.  If that group does not exist it
     * will be recreated!
     *
     * @since 1.0
     */
    protected function after_save_callback()
    {
        if ($this->getVersionNumber()->getValue() == 1) {
            $standardGroup = new Rights();

            $this->setupRels();

            if (!$this->inGroup('Standard')) {
                try {
                    $standardGroup->loadByAttribute('name', 'Standard');
                } catch (RecordNotFoundException $e) {
                    $standardGroup->set('name', 'Standard');
                    $standardGroup->save();
                }

                $lookup = $this->rights->getLookup();
                $lookup->setValue(array($this->getID(), $standardGroup->getID()));
                $lookup->save();
            }
        }
    }

    /**
     * Encrypts password value if it is plaintext before saving.
     *
     * @since 2.0
     */
    protected function before_save_callback()
    {
        if (password_needs_rehash($this->get('password'), PASSWORD_DEFAULT, ['cost' => 12])) {
            $this->set('password', password_hash($this->get('password'), PASSWORD_DEFAULT, ['cost' => 12]));
        }
    }

    /**
     * Sets up the Relation definitions on this record.
     *
     * @since 1.0
     */
    protected function setupRels()
    {
        // set up MANY-TO-MANY relation person2rights
        if (isset($this->rights)) {
            $this->rights->setRelatedClass('Alpha\Model\Person', 'left');
            $this->rights->setRelatedClassDisplayField('email', 'left');
            $this->rights->setRelatedClass('Alpha\Model\Rights', 'right');
            $this->rights->setRelatedClassDisplayField('name', 'right');
            $this->rights->setRelationType('MANY-TO-MANY');
            $this->rights->setValue($this->getID());
        }

        if (isset($this->actions)) {
            $this->actions->setValue($this->ID);
            $this->actions->setRelatedClass('Alpha\Model\ActionLog');
            $this->actions->setRelatedClassField('created_by');
            $this->actions->setRelatedClassDisplayField('message');
            $this->actions->setRelationType('ONE-TO-MANY');
        }
    }

    /**
     * Setter for username.
     *
     * @param string $username
     *
     * @since 1.0
     */
    public function setUsername($username)
    {
        $this->username->setValue($username);
    }

    /**
     * Getter for username.
     *
     * @return \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * Checks to see if the person is in the rights group specified.
     *
     * @param string $groupName
     *
     * @return bool
     *
     * @since 1.0
     */
    public function inGroup($groupName)
    {
        if (self::$logger == null) {
            self::$logger = new Logger('Person');
        }
        self::$logger->debug('>>inGroup(groupName=['.$groupName.'])');

        $group = new Rights();

        try {
            $group->loadByAttribute('name', $groupName);
        } catch (RecordNotFoundException $e) {
            self::$logger->error('Unable to load the group named ['.$groupName.']');
            self::$logger->debug('<<inGroup [false]');

            return false;
        }

        $rel = $group->getMembers();

        try {
            // load all person2rights RelationLookup objects for this person
            $lookUps = $rel->getLookup()->loadAllByAttribute('leftID', $this->getID());
            foreach ($lookUps as $lookUp) {
                // the rightID (i.e. Rights ID) will be on the right side of the value array
                $ids = $lookUp->getValue();
                // if we have found a match, return true right away
                if ($ids[1] == $group->getID()) {
                    self::$logger->debug('<<inGroup [true]');

                    return true;
                }
            }
        } catch (RecordNotFoundException $e) {
            self::$logger->debug('<<inGroup [false]');

            return false;
        }

        self::$logger->debug('<<inGroup [false]');

        return false;
    }

    /**
     * Adds this person to the rights group specified.
     *
     * @param string $groupName
     *
     * @throws \Alpha\Exception\RecordNotFoundException
     *
     * @since 2.0
     */
    public function addToGroup($groupName)
    {
        if (self::$logger == null) {
            self::$logger = new Logger('Person');
        }
        self::$logger->debug('>>addToGroup(groupName=['.$groupName.'])');

        $group = new Rights();
        $group->loadByAttribute('name', $groupName);

        $lookup = $this->getPropObject('rights')->getLookup();
        $lookup->setValue(array($this->getID(), $group->getID()));
        $lookup->save();

        self::$logger->debug('<<addToGroup');
    }

    /**
     * A generic method for mailing a person.
     *
     * @param string $message
     * @param string $subject
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\MailNotSentException
     */
    public function sendMail($message, $subject)
    {
        $config = ConfigProvider::getInstance();

        $body = '<html><head></head><body><p>Dear '.$this->getUsername().',</p>';

        $body .= $message;

        $body .= '</body></html>';

        $mailer = ServiceFactory::getInstance('Alpha\Util\Email\EmailProviderPHP', 'Alpha\Util\Email\EmailProviderInterface');
        $mailer->send($this->get('email'), $config->get('email.reply.to'), $subject, $body, true);
    }

    /**
     * Generates a random password for the user.
     *
     * @return string
     *
     * @since 1.0
     */
    public function generatePassword()
    {
        $alphabet = array('a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z');
        // the password will be 7 random characters and 2 numbers
        $newPassword = '';
        for ($i = 0; $i < 7; ++$i) {
            $newPassword .= $alphabet[rand(0, 25)];
        }
        $newPassword .= rand(0, 100);
        $newPassword .= rand(0, 100);

        return $newPassword;
    }

    /**
     * Method for getting a count of the amount of article comments posted by the user.
     *
     * @return int
     *
     * @since 1.0
     */
    public function getCommentCount()
    {
        $temp = new ArticleComment();

        $sqlQuery = 'SELECT COUNT(ID) AS post_count FROM '.$temp->getTableName()." WHERE created_by='".$this->ID."';";

        $result = $this->query($sqlQuery);

        $row = $result[0];

        if (isset($row['post_count'])) {
            return $row['post_count'];
        } else {
            return 0;
        }
    }
}

Namespaces

Classes

Interfaces

Exceptions