ArticleManager Class Reference

Public Member Functions
	ArticleManager ()

Static Public Member Functions
static	buildArticleForm ($article)
static	onPublishArticle ($article)
	If an article is marked published but no publish date set (user may wish to set a future publish date) then set the date to today. More...
static	sendEmailToSubscribers ($article, $email_template_name)
	When an article is published, send an email to instant notification subscribers. More...
static	registerCommentAdapter ()
static	registerSearchables ($searchables)
static	registerSolrAdapter ()
static	registerTaxonomyClasses ($classes)
static	registerVersionedContent ()
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	preprocessURI ($identifier)
static	upgradeComponent ($version)

Detailed Description

Definition at line 9 of file article_manager.inc.

Member Function Documentation

ArticleManager()

ArticleManager::ArticleManager

(

)

Definition at line 11 of file article_manager.inc.

     {
          
     }

buildArticleForm()

static ArticleManager::buildArticleForm (   $article )

static

Definition at line 16 of file article_manager.inc.

     {
          if (!$article->article_id)
          {
               global $user;
               
               $mgr = new UserManager();
               $article->author = (method_exists($mgr, getUserFullName)) ? $mgr->getUserFullName($user) : "";
          }
 
          $form = new AutoForm($article);
          $form->required("title");
          $form->allowDelete = true;
          $imageSelect = new ImageSelectFieldRenderer($form, "image_id");
          $form->alias("image_id", "Associated Image");
          $form->readonly("created_date");
          $form->hide("author_id"); //TODO - allow author selection/re-assignment?
          $articleTypeSelect = new SelectFieldRenderer($form, "article_type", "Article Type", Blog::getArticleTypeOptions());
          //$articleTypeSelect->allowAddEntry();
 
          $form->annotate("identifier", "(Optional) identifier for this article for friendlier URLs");
          
          $form->annotate("post_date", "The date that will be displayed in the article's tagline.");
          $form->annotate("publish_date", "The date the article will be published on the site.");
          $form->annotate("archive_date", "The date the article will be archived from the site.");
          
          $form->getRenderer("message")->height = "480px";
          $form->getRenderer("teaser")->height = "120px";
          
          $sites = query(Site, "ORDER BY site_name");
     
          $siteSelect = new CrossReferenceSelectFieldRenderer($form, "sites", "Sites", $sites, "site_name", ArticleSiteXref);
 
          $form->getRenderer("archive_date")->validator->required = false;      
 
          VersionedContentManager::enableVersioning($form);
          
          return $form;
     }

deleteUser()

static ArticleManager::deleteUser (   $user )

static

Respond to fired event DeleteUser.

Delete any records in this component that have dependencies on user object.

Parameters

obj

$user

- class SiteUser or custom user class

Definition at line 150 of file article_manager.inc.

     {
          $pk = $user->getPrimaryKey();
          $user_id = $user->$pk;
          
          trace("Component article is deleting objects dependent on user_id {$user_id}", 3);
     
          $article = new Article();
          $article->delete("WHERE author_id={$user_id}");
          
          return $user;
     }

onPublishArticle()

static ArticleManager::onPublishArticle (   $article )

static

If an article is marked published but no publish date set (user may wish to set a future publish date) then set the date to today.

Parameters

obj

$article

Definition at line 63 of file article_manager.inc.

     {
          if($article->published && !$article->publish_date)
          {
               $article->publish_date = today();
               $article->filter = new InclusionFilter("publish_date");
               $article->save();
          }
          
          if($article->published)
          {
               ArticleManager::sendEmailToSubscribers($article, 'blog_published');
          }
     }

preprocessURI()

static ArticleManager::preprocessURI (   $identifier )

static

Definition at line 163 of file article_manager.inc.

     {
          global $section;
          
          $article = Article::fromIdentifier($identifier);
          if (!$article) return null;
          $blog = $article->getBlog();
          if (SectionManager::isInSection($section->section, $blog->identifier))
          {
               $_GET["article_id"] = $article->article_id;
               $_POST["article_id"] = $article->article_id;
               $_GET["blog"] = $blog->identifier;
               return $blog->identifier;
          }
          
          return null;
     }

registerCommentAdapter()

static ArticleManager::registerCommentAdapter ( )

static

Definition at line 115 of file article_manager.inc.

     {
          CommentManager::registerAdapter("article", Article, ArticleCommentXref);
     }

registerSearchables()

static ArticleManager::registerSearchables (   $searchables )

static

Definition at line 120 of file article_manager.inc.

     {
          trace("ArticleManager registerSearchables", 3);
          $searchables["article"] = array(Article);
          return $searchables;
     }

registerSolrAdapter()

static ArticleManager::registerSolrAdapter ( )

static

Definition at line 127 of file article_manager.inc.

     {
          SolrManager::registerSolrAdapter(Article, new ArticleSolrAdapter());
     }

registerTaxonomyClasses()

static ArticleManager::registerTaxonomyClasses (   $classes )

static

Definition at line 132 of file article_manager.inc.

     {
          $classes[] = Article;
          return $classes;
     }

registerVersionedContent()

static ArticleManager::registerVersionedContent ( )

static

Definition at line 138 of file article_manager.inc.

     {
          VersionedContentManager::registerVersionedContent(Article);
     }

sendEmailToSubscribers()

static ArticleManager::sendEmailToSubscribers (   $article,   $email_template_name  )

static

When an article is published, send an email to instant notification subscribers.

Parameters

obj	$article	class Article
String	$email_template_name	(e.g., 'blog_published')

Returns

Number $rtn true if sent; false if could not be sent

Definition at line 87 of file article_manager.inc.

     {
          if(!$article->published) return;
 
          $blog = $article->Blog();
          if(!$blog) return;
 
          $subscribers = $blog->Subscribers("WHERE subscription_type='instant'");
          
          if(!count($subscribers)) return;
          
          $emailTemplate = EmailTemplate::getEmailTemplate($email_template_name);
 
          if(!$emailTemplate) return;
          
          // Get the article id now before sending to email manager which won't be able to get it
          // from the subscriber obj.
          $emailTemplate->message = str_replace("[article_id]", $article->article_id, $emailTemplate->message);
          $emailTemplate->message = str_replace("[article_title]", $article->title, $emailTemplate->message);
          $emailTemplate->message = str_replace("[teaser]", $article->teaser, $emailTemplate->message);
          
          foreach($subscribers as $subscriber)
          {
               $mgr = new EmailManager($subscriber, $emailTemplate);
               $rtn = $mgr->sendEmail();
          }
     }

upgradeComponent()

static ArticleManager::upgradeComponent (   $version )

static

Definition at line 181 of file article_manager.inc.

     {
          $mgr = new ArticleUpgradeManager();
          $mgr->upgrade($version);
     }    

---

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

• C:/code/cms.sonjara.com/cms/components/article/article_manager.inc