Inheritance diagram for Article:

Collaboration diagram for Article:

Public Member Functions
	Image ()

	Sites ($constraint="")

	Comments ($constraint="")

	Blog ()
	We retrieve the blog related to the article by matching the article_type field to the blog's title field. More...

	Author ()

	getAuthorName ()

	getBlog ()

	getURL ()

	getBlogSubscribers ()

	getViewIdentifier ()

	formatPostDate ()

	Article ()

	search ($params, $range=null)
	DataItems must implement this method to provide search functionality. More...

Static Public Member Functions
static	fromIdentifier ($identifier)

Public Attributes
	$fields

	$relations

	$fieldAliases = array("message" => "Article Content")

	$versioned_fields = array("title", "message", "image_id", "teaser", "tags", "author", "publication")

Detailed Description

Defines the Article class.

Definition at line 44 of file article.inc.

Member Function Documentation

◆ Article()

Article::Article ( )

Definition at line 199 of file article.inc.

      {
           $this->table = "article";
           $this->primary_key = "article_id";
           $this->pretty_class_name = "Article";
           
           // Patch in the user class, since this can be overridden by the application
           $mgr = new UserManager();
           $this->relations["Owner"] = $mgr->getUserClass();           
                     
           $this->DataItem(func_get_args());
      }

◆ Author()

Article::Author ( )

Definition at line 110 of file article.inc.

      {
           $mgr = new UserManager();
           return $mgr->getUser($this->author_id);
      }

◆ Blog()

Article::Blog ( )

We retrieve the blog related to the article by matching the article_type field to the blog's title field.

This function may return null as an article may not be related to any blog.

Used for merge codes and for comment xref function verifyEnabled

Definition at line 101 of file article.inc.

      {
           $blogs = Query::create(Blog, "WHERE title=:article_type")
                ->bind(":article_type", $this->article_type)
                ->execute();
                     
           return count($blogs) ? $blogs[0] : null;
      }

◆ Comments()

Article::Comments ( $constraint = "" )

Definition at line 89 of file article.inc.

      {
           return $this->crossReference(Comment, ArticleCommentXref, $constraint);
      }

◆ formatPostDate()

Article::formatPostDate ( )

Definition at line 184 of file article.inc.

      {
           if ($this->post_date)
           {
                return $this->format("{post_date:daylong}");
           }
           
           if ($this->publish_date)
           {
                return $this->format("{publish_date:daylong}");
           }
           
           return $this->format("{created_date:daylong}");
      }

◆ fromIdentifier()

static Article::fromIdentifier ( $identifier )

static

Definition at line 134 of file article.inc.

      {
           $articles = Query::create(Article, "WHERE identifier=:i")
                                ->bind(":i", $identifier)
                                ->execute();
           
           return count($articles) > 0 ? $articles[0] : null;
      }

◆ getAuthorName()

Article::getAuthorName ( )

Definition at line 116 of file article.inc.

      {
           if ($this->author_id)
           {
                return $this->Author()->getFullName();
           }
           else return $this->author;
      }

◆ getBlog()

Article::getBlog ( )

Definition at line 125 of file article.inc.

      {
           $blogs = Query::create(Blog, "WHERE title=:type")
                           ->bind(":type", $this->article_type)
                           ->execute();
                           
           return count($blogs) ? $blogs[0] : null;
      }

◆ getBlogSubscribers()

Article::getBlogSubscribers ( )

Definition at line 156 of file article.inc.

      {
           $blogSubscribers = Query::create(BlogSubscriber, "where blog_id=:blog_id")
                                         ->bind(":blog_id", $this->getBlog()->blog_id)
                                         ->execute();
           $email_list_array = array();
           foreach($blogSubscribers as $blogSubscriber)
           {
                $email_list_array[] = $blogSubscriber->subscriber_email;
           }
           $email_list = implode(",", $email_list_array);
           
           return $email_list;
      }

◆ getURL()

Article::getURL ( )

Definition at line 143 of file article.inc.

      {
           $blog = $this->getBlog();
           if($blog)
           {
                return $blog->getURL() . "?article_id=" . $this->article_id;
           }
           else
           {
                return "article?article_id=" . $this->article_id;
           }
      }

◆ getViewIdentifier()

Article::getViewIdentifier ( )

Definition at line 171 of file article.inc.

      {
           try
           {
                $blog = $this->getBlog();
                return $blog->identifier;
           }
           catch(DataNotFoundException $e)
           {
                return "article_view";
           }
      }

◆ Image()

Article::Image ( )

Definition at line 79 of file article.inc.

      {
           return $this->getRelated(ImageRecord);
      }

◆ search()

Article::search	(	$params,
		$range = `null`
	)

DataItems must implement this method to provide search functionality.

Parameters

mixed	$params	either search text or a SearchParameters object
array	$range	an array of primary key IDs to which the search must be constrained

Implements Searchable.

Definition at line 212 of file article.inc.

      {
           trace("Searching Articles", 3);
           
           if ($range)
           {
                $range = " AND {$this->primary_key} IN (".implode($range, ", ").")";
           }
           else
           {
                $range = "";
           }
           
           if (is_object($params))
           {
                $search = clone $params;
                $search->target = $this;
                
                $search->remapField("keywords", "tags");
                
                if (!$search->get("text", "like"))
                {
                     $search->secondaryFields("tags", "message");
                }
                else
                {
                     $search->remapField("text", "message");
                }
                
                $search->remapField("publication_date", "publish_date");
                
                $constraint = $search->generateConstraint();
                $constraint .= $constraint ? " AND published=1" : " WHERE published=1";
                
                $constraint .= $range;
                
                $articles = Query::create(Article, $constraint)
                                 ->execute();
           }
           else
           {
                $params = "%$params%";
                $articles = Query::create(Article, "WHERE (title like :a OR teaser LIKE :b OR message like :c) AND published=1 $range")
                                 ->bind(":a", $params, ":b", $params, ":c", $params)
                                 ->execute();
           }
                                      
           return SearchManager::wrap($articles, ArticleSearchResult);
      }

◆ Sites()

Article::Sites ( $constraint = "" )

Definition at line 84 of file article.inc.

      {
           return $this->crossReference(Site, ArticleSiteXref, $constraint);
      }

Member Data Documentation

◆ $fieldAliases

Article::$fieldAliases = array("message" => "Article Content")

Definition at line 75 of file article.inc.

◆ $fields

Article::$fields

Initial value:

= array("article_id"     =>   Number,
                              "title"             =>   String,
                              "message"      =>   HTML,
                              "article_type" =>   String,
                              "identifier"   =>   String,
                              "image_id"          =>   Number,
                              "teaser"       =>   HTML,
                              "created_date" =>   Date,
                              "post_date"         =>   Date,
                              "archive_date"  =>  Date,
                              "publish_date"  =>  Date,
                              "last_modified"     =>   Timestamp,
                              "published"         =>   Boolean,
                              "allow_comment" =>  Boolean,
                              "headline"          =>   Boolean,
                              "tags"              =>   String,
                              "author_id"         =>   Number,
                              "author"       =>   String,
                              "publication"  =>   String,
                              "sort_order"   =>   Number
               )

Definition at line 46 of file article.inc.

◆ $relations

Article::$relations