Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • Alpha\Controller\ActiveRecordController
  • Alpha\Controller\ArticleController
  • Alpha\Controller\AttachmentController
  • Alpha\Controller\CacheController
  • Alpha\Controller\Controller
  • Alpha\Controller\DEnumController
  • Alpha\Controller\ExcelController
  • Alpha\Controller\FeedController
  • Alpha\Controller\Front\FrontController
  • Alpha\Controller\GenSecureQueryStringController
  • Alpha\Controller\ImageController
  • Alpha\Controller\IndexController
  • Alpha\Controller\InstallController
  • Alpha\Controller\ListActiveRecordsController
  • Alpha\Controller\LogController
  • Alpha\Controller\LoginController
  • Alpha\Controller\LogoutController
  • Alpha\Controller\MetricController
  • Alpha\Controller\PhpinfoController
  • Alpha\Controller\RecordSelectorController
  • Alpha\Controller\SearchController
  • Alpha\Controller\SequenceController
  • Alpha\Controller\TagController
  • Alpha\Model\ActionLog
  • Alpha\Model\ActiveRecord
  • Alpha\Model\ActiveRecordProviderMySQL
  • Alpha\Model\ActiveRecordProviderSQLite
  • Alpha\Model\Article
  • Alpha\Model\ArticleComment
  • Alpha\Model\ArticleVote
  • Alpha\Model\BadRequest
  • Alpha\Model\BlacklistedClient
  • Alpha\Model\BlacklistedIP
  • Alpha\Model\Person
  • Alpha\Model\Rights
  • Alpha\Model\Tag
  • Alpha\Model\Type\Boolean
  • Alpha\Model\Type\Date
  • Alpha\Model\Type\DEnum
  • Alpha\Model\Type\DEnumItem
  • Alpha\Model\Type\Double
  • Alpha\Model\Type\Enum
  • Alpha\Model\Type\Integer
  • Alpha\Model\Type\Relation
  • Alpha\Model\Type\RelationLookup
  • Alpha\Model\Type\Sequence
  • Alpha\Model\Type\SmallText
  • Alpha\Model\Type\Text
  • Alpha\Model\Type\Timestamp
  • Alpha\Model\Type\Type
  • Alpha\Task\BackupTask
  • Alpha\Task\CronManager
  • Alpha\Util\Backup\BackupUtils
  • Alpha\Util\Cache\CacheProviderAPC
  • Alpha\Util\Cache\CacheProviderArray
  • Alpha\Util\Cache\CacheProviderFile
  • Alpha\Util\Cache\CacheProviderMemcache
  • Alpha\Util\Cache\CacheProviderRedis
  • Alpha\Util\Code\Highlight\HighlightProviderGeshi
  • Alpha\Util\Code\Highlight\HighlightProviderLuminous
  • Alpha\Util\Code\Metric\Inspector
  • Alpha\Util\Config\ConfigProvider
  • Alpha\Util\Convertor\ActiveRecord2Excel
  • Alpha\Util\Email\EmailProviderPHP
  • Alpha\Util\ErrorHandlers
  • Alpha\Util\Extension\Markdown
  • Alpha\Util\Extension\MarkdownFacade
  • Alpha\Util\Extension\TCPDF
  • Alpha\Util\Extension\TCPDFFacade
  • Alpha\Util\Feed\Atom
  • Alpha\Util\Feed\Feed
  • Alpha\Util\Feed\RSS
  • Alpha\Util\Feed\RSS2
  • Alpha\Util\File\FileUtils
  • Alpha\Util\Graph\GraphNode
  • Alpha\Util\Graph\TreeGraph
  • Alpha\Util\Helper\Validator
  • Alpha\Util\Http\AgentUtils
  • Alpha\Util\Http\Filter\ClientBlacklistFilter
  • Alpha\Util\Http\Filter\ClientTempBlacklistFilter
  • Alpha\Util\Http\Filter\IPBlacklistFilter
  • Alpha\Util\Http\PHPServerUtils
  • Alpha\Util\Http\Request
  • Alpha\Util\Http\Response
  • Alpha\Util\Http\Session\SessionProviderArray
  • Alpha\Util\Http\Session\SessionProviderPHP
  • Alpha\Util\Image\ImageUtils
  • Alpha\Util\InputFilter
  • Alpha\Util\Logging\KPI
  • Alpha\Util\Logging\Logger
  • Alpha\Util\Logging\LogProviderFile
  • Alpha\Util\Search\SearchProviderTags
  • Alpha\Util\Security\SecurityUtils
  • Alpha\Util\Service\ServiceFactory
  • Alpha\View\ArticleCommentView
  • Alpha\View\ArticleView
  • Alpha\View\DEnumView
  • Alpha\View\PersonView
  • Alpha\View\Renderer\Html\RendererProviderHTML
  • Alpha\View\Renderer\Json\RendererProviderJSON
  • Alpha\View\SequenceView
  • Alpha\View\View
  • Alpha\View\ViewState
  • Alpha\View\Widget\Button
  • Alpha\View\Widget\DateBox
  • Alpha\View\Widget\Image
  • Alpha\View\Widget\RecordSelector
  • Alpha\View\Widget\SmallTextBox
  • Alpha\View\Widget\TagCloud
  • Alpha\View\Widget\TextBox

Interfaces

  • Alpha\Controller\ControllerInterface
  • Alpha\Model\ActiveRecordProviderInterface
  • Alpha\Model\Type\TypeInterface
  • Alpha\Task\TaskInterface
  • Alpha\Util\Cache\CacheProviderInterface
  • Alpha\Util\Code\Highlight\HighlightProviderInterface
  • Alpha\Util\Email\EmailProviderInterface
  • Alpha\Util\Http\Filter\FilterInterface
  • Alpha\Util\Http\Session\SessionProviderInterface
  • Alpha\Util\Logging\LogProviderInterface
  • Alpha\Util\Search\SearchProviderInterface
  • Alpha\View\Renderer\RendererProviderInterface

Exceptions

  • Alpha\Exception\AlphaException
  • Alpha\Exception\BadTableNameException
  • Alpha\Exception\CustomQueryException
  • Alpha\Exception\FailedDeleteException
  • Alpha\Exception\FailedIndexCreateException
  • Alpha\Exception\FailedLookupCreateException
  • Alpha\Exception\FailedSaveException
  • Alpha\Exception\FailedUnitCommitException
  • Alpha\Exception\FileNotFoundException
  • Alpha\Exception\IllegalArguementException
  • Alpha\Exception\LockingException
  • Alpha\Exception\MailNotSentException
  • Alpha\Exception\NotImplementedException
  • Alpha\Exception\PHPException
  • Alpha\Exception\RecordNotFoundException
  • Alpha\Exception\ResourceNotAllowedException
  • Alpha\Exception\ResourceNotFoundException
  • Alpha\Exception\SearchIndexWriteException
  • Alpha\Exception\SecurityException
  • Alpha\Exception\ValidationException
  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 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 
<?php

namespace Alpha\Model;

use Alpha\Model\Type\SmallText;
use Alpha\Model\Type\DEnum;
use Alpha\Model\Type\Text;
use Alpha\Model\Type\Boolean;
use Alpha\Model\Type\Relation;
use Alpha\Util\Config\Configprovider;
use Alpha\Util\Logging\Logger;
use Alpha\Util\Service\ServiceFactory;
use Alpha\Exception\ValidationException;
use Alpha\Exception\FileNotFoundException;
use Alpha\Exception\AlphaException;
use Alpha\Controller\Front\FrontController;

/**
 * An article class for the CMS.
 *
 * @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 Article extends ActiveRecord
{
    /**
     * The article title.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $title;

    /**
     * The description of the article.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $description;

    /**
     * Optional custom body onload Javascript.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $bodyOnload;

    /**
     * Any custom HTML header content (e.g. Javascript) for the article.
     *
     * @var \Alpha\Model\Type\Text
     *
     * @since 1.0
     */
    protected $headerContent;

    /**
     * The article content.
     *
     * @var \Alpha\Model\Type\Text
     *
     * @since 1.0
     */
    protected $content;

    /**
     * The author of the article.
     *
     * @var \Alpha\Model\Type\SmallText
     *
     * @since 1.0
     */
    protected $author;

    /**
     * A boolean to control whether the artcile is publically accessible or not.
     *
     * @var \Alpha\Model\Type\Boolean
     *
     * @since 1.0
     */
    protected $published;

    /**
     * A Relation containing all of the comments on this article.
     *
     * @var \Alpha\Model\Type\Relation
     *
     * @since 1.0
     */
    protected $comments;

    /**
     * A Relation containing all of the votes on this article.
     *
     * @var \Alpha\Model\Type\Relation
     *
     * @since 1.0
     */
    protected $votes;

    /**
     * A Relation containing all of the tags on this article.
     *
     * @var \Alpha\Model\Type\Relation
     *
     * @since 1.0
     */
    protected $tags;

    /**
     * An array of all of the attributes on this Record which are tagged.
     *
     * @var array
     *
     * @since 1.0
     */
    protected $taggedAttributes = array('title', 'description', 'content');

    /**
     * Path to a .text file where the content of this article is stored (optional).
     *
     * @var string
     *
     * @since 1.0
     */
    private $filePath;

    /**
     * An array of data display labels for the class properties.
     *
     * @var array
     *
     * @since 1.0
     */
    protected $dataLabels = array('ID' => 'Article ID#', 'title' => 'Title', 'description' => 'Description', 'bodyOnload' => 'Body onload Javascript', 'content' => 'Content', 'headerContent' => 'HTML Header Content', 'author' => 'Author', 'created_ts' => 'Date Added', 'updated_ts' => 'Date of last Update', 'published' => 'Published', 'URL' => 'URL', 'printURL' => 'Printer version URL', 'comments' => 'Comments', 'votes' => 'Votes', 'tags' => 'Tags');

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

    /**
     * The URL for this article (transient).
     *
     * @var string
     *
     * @since 1.0
     */
    protected $URL;

    /**
     * The print URL for this article (transient).
     *
     * @var string
     *
     * @since 1.0
     */
    protected $printURL;

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

    /**
     * The constructor which sets up some housekeeping attributes.
     *
     * @since 1.0
     */
    public function __construct()
    {
        self::$logger = new Logger('Article');

        $config = ConfigProvider::getInstance();
        $separator = $config->get('cms.url.title.separator');

        // ensure to call the parent constructor
        parent::__construct();

        $this->title = new SmallText();
        $this->title->setHelper('Please provide a title for the article. Note that the '.$separator.' character is not allowed!');
        $this->title->setSize(100);
        $this->title->setRule('/^[^'.$separator.']*$/');

        $this->description = new SmallText();
        $this->description->setHelper('Please provide a brief description of the article.');
        $this->description->setSize(200);
        $this->description->setRule("/\w+/");
        $this->bodyOnload = new SmallText();
        $this->content = new Text();
        $this->headerContent = new Text();
        $this->author = new SmallText();
        $this->author->setHelper('Please state the name of the author of this article');
        $this->author->setSize(70);
        $this->author->setRule("/\w+/");
        $this->published = new Boolean(0);

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

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

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

        $this->URL = '';
        $this->printURL = '';
        // mark the URL attributes as transient
        $this->markTransient('URL');
        $this->markTransient('printURL');

        // mark title as unique
        $this->markUnique('title');

        $this->markTransient('filePath');
        $this->markTransient('taggedAttributes');

        $this->setupRels();
    }

    /**
     * After creating a new Article, tokenize the description field to form a set
     * of automated tags and save them.
     *
     * @since 1.0
     */
    protected function after_save_callback()
    {
        if ($this->getVersion() == 1 && $this->tags instanceof \Alpha\Model\Type\Relation) {
            // update the empty tags values to reference this ID
            $this->tags->setValue($this->ID);

            foreach ($this->taggedAttributes as $tagged) {
                $tags = Tag::tokenize($this->get($tagged), 'Alpha\Model\Article', $this->getID());
                foreach ($tags as $tag) {
                    try {
                        $tag->save();
                    } catch (ValidationException $e) {
                        /*
                         * The unique key has most-likely been violated because this Record is already tagged with this
                         * value, so we can ignore in this case.
                         */
                    }
                }
            }
        }

        $this->setupRels();
    }

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

    /**
     * Set up the transient URL attributes for the article after it has loaded.
     *
     * @since 1.0
     */
    protected function after_load_callback()
    {
        $config = ConfigProvider::getInstance();

        $this->URL = $config->get('app.url').'/a/'.str_replace(' ', $config->get('cms.url.title.separator'), $this->title->getValue());

        $this->printURL = $config->get('app.url').'/a/'.str_replace(' ', $config->get('cms.url.title.separator'), $this->title->getValue()).'/print';

        $this->setupRels();
    }

    /**
     * Gets an array of the IDs of the most recent articles added to the system (by date), from the newest
     * article to the amount specified by the $limit.
     *
     * @param int    $limit
     *
     * @return array
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\AlphaException
     */
    public function loadRecentWithLimit($limit)
    {
        $sqlQuery = 'SELECT ID FROM '.$this->getTableName()." WHERE published='1' ORDER BY created_ts DESC LIMIT 0, $limit;";

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

        $IDs = array();

        foreach ($result as $row) {
            array_push($IDs, $row['ID']);
        }

        return $IDs;
    }

    /**
     * Generates the location of the attachments folder for this article.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getAttachmentsLocation()
    {
        $config = ConfigProvider::getInstance();

        return $config->get('app.file.store.dir').'attachments/article_'.$this->getID();
    }

    /**
     * Generates the URL of the attachments folder for this article.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getAttachmentsURL()
    {
        $config = ConfigProvider::getInstance();

        return $config->get('app.url').'/attachments/article_'.$this->getID();
    }

    /**
     * Generates a secure URL for downloading an attachment file via the ViewAttachment controller.
     *
     * @param string $filename
     *
     * @since 1.0
     */
    public function getAttachmentSecureURL($filename)
    {
        return FrontController::generateSecureURL('act=Alpha\\Controller\\AttachmentController&articleID='.$this->getID().'&filename='.$filename);
    }

    /**
     * Creates the attachment folder for the article on the server.
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\AlphaException
     */
    public function createAttachmentsFolder()
    {
        // create the attachment directory for the article
        try {
            mkdir($this->getAttachmentsLocation());
        } catch (\Exception $e) {
            throw new AlphaException('Unable to create the folder ['.$this->getAttachmentsLocation().'] for the article.');
        }

        // ...and set write permissions on the folder
        try {
            chmod($this->getAttachmentsLocation(), 0777);
        } catch (\Exception $e) {
            throw new AlphaException('Unable to set write permissions on the folder ['.$this->getAttachmentsLocation().'].');
        }
    }

    /**
     * Method for returning the calculated score for this article.
     *
     * @return string
     *
     * @since 1.0
     */
    public function getArticleScore()
    {
        $votes = $this->getArticleVotes();

        $score = 0;
        $total_score = 0;
        $vote_count = count($votes);

        for ($i = 0; $i < $vote_count; ++$i) {
            $total_score += $votes[$i]->get('score');
        }

        if ($vote_count > 0) {
            $score = $total_score/$vote_count;
        }

        return sprintf('%01.2f', $score);
    }

    /**
     * Method for fetching all of the votes for this article.
     *
     * @return array An array of ArticleVote objects
     *
     * @since 1.0
     */
    public function getArticleVotes()
    {
        $votes = $this->votes->getRelated();

        return $votes;
    }

    /**
     * Method to determine if the logged-in user has already voted for this article.
     *
     * @return bool True if they have voted already, false otherwise
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\AlphaException
     */
    public function checkUserVoted()
    {
        $config = ConfigProvider::getInstance();
        $sessionProvider = $config->get('session.provider.name');
        $session = ServiceFactory::getInstance($sessionProvider, 'Alpha\Util\Http\Session\SessionProviderInterface');
        // just going to return true if nobody is logged in
        if ($session->get('currentUser') == null) {
            return true;
        }

        $userID = $session->get('currentUser')->getID();

        $vote = new ArticleVote();

        $sqlQuery = 'SELECT COUNT(*) AS usersVote FROM '.$vote->getTableName()." WHERE articleID='".$this->ID."' AND personID='".$userID."';";

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

        if (!isset($result[0])) {
            throw new AlphaException('Failed to check if the current user voted for the article ['.$this->ID.'], query ['.$sqlQuery.']');
        }

        $row = $result[0];

        if ($row['usersVote'] == '0') {
            return false;
        } else {
            return true;
        }
    }

    /**
     * Method for fetching all of the comments for this article.
     *
     * @return array An array of ArticleComment objects
     *
     * @since 1.0
     */
    public function getArticleComments()
    {
        $comments = $this->comments->getRelated();

        return $comments;
    }

    /**
     * Loads the content of the ArticleObject from the specified file path.
     *
     * @param string $filePath
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\FileNotFoundException
     */
    public function loadContentFromFile($filePath)
    {
        try {
            $this->content->setValue(file_get_contents($filePath));
            $this->filePath = $filePath;
        } catch (\Exception $e) {
            throw new FileNotFoundException($e->getMessage());
        }
    }

    /**
     * Returns true if the article content was loaded from a .text file, false otherwise.
     *
     * @return bool
     *
     * @since 1.0
     */
    public function isLoadedFromFile()
    {
        return $this->filePath == '' ? false : true;
    }

    /**
     * Returns the timestamp of when the content .text file for this article was last
     * modified.
     *
     * @return string
     *
     * @since 1.0
     *
     * @throws \Alpha\Exception\FileNotFoundException
     */
    public function getContentFileDate()
    {
        if ($this->filePath != '') {
            try {
                return date('Y-m-d H:i:s', filemtime($this->filePath));
            } catch (\Exception $e) {
                throw new FileNotFoundException($e->getMessage());
            }
        } else {
            throw new FileNotFoundException('Error trying to access an article content file when none is set!');
        }
    }

    /**
     * Sets up the Relation definitions on this record object.
     *
     * @since 2.0
     */
    protected function setupRels()
    {
        $this->comments->setValue($this->ID);
        $this->comments->setRelatedClass('Alpha\Model\ArticleComment');
        $this->comments->setRelatedClassField('articleID');
        $this->comments->setRelatedClassDisplayField('content');
        $this->comments->setRelationType('ONE-TO-MANY');

        $this->votes->setValue($this->ID);
        $this->votes->setRelatedClass('Alpha\Model\ArticleVote');
        $this->votes->setRelatedClassField('articleID');
        $this->votes->setRelatedClassDisplayField('score');
        $this->votes->setRelationType('ONE-TO-MANY');

        $this->tags->setRelatedClass('Alpha\Model\Tag');
        $this->tags->setRelatedClassField('taggedID');
        $this->tags->setRelatedClassDisplayField('content');
        $this->tags->setRelationType('ONE-TO-MANY');
        $this->tags->setTaggedClass(get_class($this));
        $this->tags->setValue($this->ID);
    }
}
Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen