Blog Class Reference

Inherits DataItem.

Public Member Functions
	Owner ()
	getOwnerName ()
	Image ()
	Subscribers ($constraint="")
	allowDelete ()
	getSortOrderConstraint ()
	Articles ($constraint="")
	countArticles ()
	getURL ()
	Determines the URL for the blog. More...
	enumerateContentLinks ()
	Blog ()
	search ($params, $range=null)

Static Public Member Functions
static	findByIdentifier ($identifier)
static	findByTitle ($title)
static	getArticleTypeOptions ()

Public Attributes
	$fields
	$versioned_fields = array("title", "description", "image_id")
	$relations

Detailed Description

Definition at line 40 of file blog.inc.

Member Function Documentation

allowDelete()

Blog::allowDelete

(

)

Definition at line 94 of file blog.inc.

     {
          if(!checkRole("admin"))
          {
               return false;
          }
          
          $articles = Query::create(Article, "WHERE article_type=:article_type")
               ->bind(":article_type", $this->title)
               ->executeValue("COUNT(1)");
          
          return $articles > 0 ? false : true;
     }

Articles()

Blog::Articles

(

$constraint = ""

)

Definition at line 130 of file blog.inc.

     {
          if (!$constraint || stripos($constraint, "ORDER") === false)
          {
               $constraint .= $this->getSortOrderConstraint();
          }
 
          $constraint = preg_replace("/^\s*WHERE\s+/i", "AND ", $constraint);
     
          $constraint = "WHERE article_type=:a $constraint";
          
          $articles = Query::create(Article, $constraint)
                         ->bind(":a", $this->title)
                         ->execute();
                         
          return $articles;
     }

Blog()

Blog::Blog

(

)

Definition at line 222 of file blog.inc.

     {
          $this->primary_key = "blog_id";
          $this->table = "blog";
          
          $this->default_format = "{title}";
          
          // 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());
     }

countArticles()

Blog::countArticles

(

)

Definition at line 148 of file blog.inc.

     {
          return Query::create(Article, "WHERE article_type=:a")
                         ->bind(":a", $this->title)
                         ->executeValue("COUNT(1)");
     }

enumerateContentLinks()

Blog::enumerateContentLinks

(

)

Definition at line 210 of file blog.inc.

     {
          $articles = $this->Articles("WHERE published=1 ORDER BY sort_order, title");
          $links = array();
          foreach($articles as $article)
          {
               $links[$article->title] = $this->identifier."?article_id=".$article->article_id;
          }
          
          return $links;
     }

findByIdentifier()

static Blog::findByIdentifier (   $identifier )

static

Definition at line 155 of file blog.inc.

     {
          $match = Query::create(Blog, "WHERE identifier=:id")
                           ->bind(":id", $identifier)
                           ->executeSingle();
 
          return $match;
     }    

findByTitle()

static Blog::findByTitle (   $title )

static

Definition at line 164 of file blog.inc.

     {
          $match = Query::create(Blog, "WHERE title=:title")
                           ->bind(":title", $title)
                           ->executeSingle();
 
          return $match;
     }

getArticleTypeOptions()

static Blog::getArticleTypeOptions ( )

static

Definition at line 197 of file blog.inc.

     {
          $blogs = Query::create(Blog, "ORDER BY title")->execute();
          $options = array();
          foreach($blogs as $blog)
          {
               $options[$blog->title] = $blog->title;
          }
          
          return $options;
     }

getOwnerName()

Blog::getOwnerName

(

)

Definition at line 79 of file blog.inc.

     {
          return $this->Owner()->getFullName();
     }

getSortOrderConstraint()

Blog::getSortOrderConstraint

(

)

Definition at line 108 of file blog.inc.

     {
          $constraint = "";
          switch($this->default_article_order)
          {
               case "DESC":
                    $constraint = " ORDER BY publish_date DESC";
                    break;
                    
               case "ASC":
                    $constraint = " ORDER BY publish_date ASC";
                    break;
                    
               case "SORT":
               default:
                    $constraint = " ORDER BY sort_order";
                    break;
          }
          
          return $constraint;
     }

getURL()

Blog::getURL

(

)

Determines the URL for the blog.

Definition at line 177 of file blog.inc.

     {
          global $config;
          
          $url = "";
          
          if ($this->identifier)
          {
               $contents = SectionContent::getMappedContent($this->identifier);
               if (count($contents))
               {
                    $section = $contents[0]->Section();
                    
                    $url = $section->getSectionURL() . $this->identifier;
               }
          }
          
          return $url;
     }

Image()

Blog::Image

(

)

Definition at line 84 of file blog.inc.

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

Owner()

Blog::Owner

(

)

Definition at line 73 of file blog.inc.

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

search()

Blog::search	(		$params,
			$range = null
	)

Definition at line 238 of file blog.inc.

     {
          trace("Searching Blogs", 3);
          
          if ($range)
          {
               $range = " AND {$this->primary_key} IN (".implode($range, ", ").")";
          }
          
          if (is_object($params))
          {
               $search = clone $params;
               $search->target = $this;
               
               $search->remapField("text", "description");
               
               $constraint = $search->generateConstraint();
               $constraint .= $constraint ? " AND published=1" : " WHERE published=1";
               
               $constraint .= $range;
               
               $blogs = Query::create(Blog, $constraint)->execute();
          }
          else
          {
               $params = "%$params%";
               $blogs = Query::create(Blog, "WHERE (title like :a OR description LIKE :b) AND published=1 $range")
                                ->bind(":a", $params, ":b", $params)
                                ->execute();
          }
                                     
          return SearchManager::wrap($blogs, BlogSearchResult);
     }

Subscribers()

Blog::Subscribers

(

$constraint = ""

)

Definition at line 89 of file blog.inc.

     {
          return $this->getRelatedList(BlogSubscriber, "", $constraint);
     }

Member Data Documentation

$fields

Blog::$fields

Initial value:

= array("blog_id"                  =>   Number,
                              "title"                       =>   String,
                              "identifier"             =>   String,
                              "image_id"                    =>   Number,
                              "description"            =>   HTML,
                              "owner_id"                    =>   Number,
                              "read_access"            =>   String,
                              "write_access"           =>   String,                       
                              "default_article_order"  =>   String,
                              "articles_per_page"      =>   Number,
                              "blog_type"                   =>   String,
                              "allow_comments"         =>   Boolean,
                              "comment_moderators"     =>   String,
                              "published"                   =>   Boolean,
                              "created_date"           =>   DateTime,
                             "allow_subscriptions"     =>   Boolean,
                              "enable_rss_feed"        =>   Boolean,
                              "max_rss_articles"       =>   Number)

Definition at line 43 of file blog.inc.

$relations

Blog::$relations

Initial value:

= array(
               "Owner"             =>   "",
               "Articles"          =>   Article,
               "Image"             =>   ImageRecord,
               "Subscribers"  =>   BlogSubscriber
               )

Definition at line 66 of file blog.inc.

$versioned_fields

Blog::$versioned_fields = array("title", "description", "image_id")

Definition at line 62 of file blog.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/blog/datamodel/blog.inc