BlogManager Class Reference

Static Public Member Functions
static	displayBlog ($identifier, &$continue)
static	inlineEditingControls ($blog)
static	enumerateItems ($items)
static	registerSearchables ($searchables)
static	registerSolrAdapter ()
static	buildBlogForm ($blog, $redirect, $blogView)
static	blogTabs ($blog_id)
static	buildBlogArticleForm ($article, $blog)
static	getStyles ()
static	upgradeComponent ($version)
static	setDefaults ()
static	setDefaultEmailTemplates ()
	For blog, need default templates: blog_subscription blog_published blog_unsubscribe_confirmation. More...
static	setDefaultMergeCodes ()
	Merge codes: blog_title article_id blog_identifier unsubscribe_url blog_url. More...
static	registerTaxonomyClasses ($classes)
static	registerVersionedContent ()
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	saveBlogSubscription ($form)
	Custom save handlerf or blog_subscription_form. More...
static	sendDigests ()
static	registerSerializationHandler ()
static	registerScheduledTaskWorkers ()

Detailed Description

Definition at line 65 of file blog_manager.inc.

Member Function Documentation

blogTabs()

static BlogManager::blogTabs (   $blog_id )

static

Definition at line 156 of file blog_manager.inc.

     {
          $tabs = array( 
                    "Blog Definition"   =>   "blog_form",
                    "Articles"               =>   "blog_articles"
                    );
 
          $bar = new TabBar("tabs", $tabs, "blog_id=$blog_id");
     
          return $bar;
     }

buildBlogArticleForm()

static BlogManager::buildBlogArticleForm (   $article,   $blog  )

static

Definition at line 168 of file blog_manager.inc.

     {
          $form = new AutoForm($article);
          $form->required("title");
          $form->allowDelete = true;
          $redirect = "/admin/blog_articles?blog_id={$blog->blog_id}";
          $form->button("Cancel", $redirect);
          $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?
          $form->hide("article_type");
          
          $sites = query(Site, "ORDER BY site_name");
          $siteSelect = new CrossReferenceSelectFieldRenderer($form, "sites", "Sites", $sites, "site_name", ArticleSiteXref);
 
          $form->getRenderer("archive_date")->validator->required = false;
          
          return $form;
     }

buildBlogForm()

static BlogManager::buildBlogForm (   $blog,   $redirect,   $blogView  )

static

Definition at line 129 of file blog_manager.inc.

     {
          $form = new AutoForm($blog);
          $form->hide("owner_id", "created_date");
          $form->button("Cancel", $redirect);
          
          $blogTypes = array_keys($blogView->handlers);
          $blogTypes = array_combine($blogTypes, $blogTypes);
          
          $orderSelect = new SelectFieldRenderer($form, "default_article_order", "Default Article Order", array("DESC" => "Newest to Oldest", "ASC" => "Oldest to Newest", "SORT" => "Sorted Order"));
          $readSelect = new CheckListFieldRenderer($form, "read_access", "Read Access", SiteRole::getRolesArray());
          $readSelect->setSize(350, 150, 10);
          $writeSelect = new CheckListFieldRenderer($form, "write_access", "Write Access", SiteRole::getRolesArray());
          $writeSelect->setSize(350, 150, 10);
          $typeSelect = new SelectFieldRenderer($form, "blog_type", "Blog Type", $blogTypes);
          $imageSelect = new ImageSelectFieldRenderer($form, "image_id", false);
          $form->alias("image_id", "Image");
          $form->alias("enable_rss_feed", "Enable RSS Feed");
          $form->alias("max_rss_articles", "Max # of Articles in RSS Feed");    
          $form->annotate("max_rss_articles", "(A value of zero means no limit)");
          
 
          VersionedContentManager::enableVersioning($form);
          
          return $form;
     }

deleteUser()

static BlogManager::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 272 of file blog_manager.inc.

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

displayBlog()

static BlogManager::displayBlog (   $identifier, &  $continue  )

static

Definition at line 67 of file blog_manager.inc.

     {
          try
          {
               trace("Searching for blog with identifier '$identifier'", 2);
               $blog = Blog::findByIdentifier($identifier);
               $page = ComponentPage::findByIdentifier("blog", "WHERE enabled=1");
               $_GET["blog"] = $identifier;
          
               $pageView = new ComponentPageView($page, "{$page->template}.tpl");
          
               $page_role = $page->role;
               
               if (!checkRole($page->role))
               {
                    LoginManager::storeRedirectPage();
                    redirect("/login");
               }
               
               echo $pageView->drawView();
               
               $continue = false;
          }
          catch(DataNotFoundException $e)
          {
               
          }
          
          return $identifier;
     }

enumerateItems()

static BlogManager::enumerateItems (   $items )

static

Definition at line 107 of file blog_manager.inc.

     {
          $blogs = Query::create(Blog, "ORDER BY title")->execute();
          
          $items["Blogs"] = $blogs;
          return $items;
     }

getStyles()

static BlogManager::getStyles ( )

static

Definition at line 189 of file blog_manager.inc.

     {
          $styles .= "<link href=\"/fakoli/css/tabs.css\" rel=\"stylesheet\"/>\n";
          
          return $styles;
     }    

inlineEditingControls()

static BlogManager::inlineEditingControls (   $blog )

static

Definition at line 98 of file blog_manager.inc.

     {
 
          if (Settings::getValue("settings", "enable_inline_editing") && Settings::checkPermission("settings", "editor_roles"))
          {
               echo "<p id='inline_editing'><a href='#' onclick='new BlogManager().editBlog({$blog->blog_id}); return false;'>Edit</a>&nbsp;&nbsp;<a href='#' onclick='new ArticleManager().editArticle(\"\", {$blog->blog_id}); return false;'>Add an Article</a></p>";
          }         
     }

registerScheduledTaskWorkers()

static BlogManager::registerScheduledTaskWorkers ( )

static

Definition at line 334 of file blog_manager.inc.

     {
          ScheduledTaskManager::registerWorker("blog", "Send Digests", array(BlogManager, sendDigests));
     }

registerSearchables()

static BlogManager::registerSearchables (   $searchables )

static

Definition at line 116 of file blog_manager.inc.

     {
          trace("BlogManager registerSearchables", 3);
          $searchables["blog"] = array(Blog);
          return $searchables;
     }

registerSerializationHandler()

static BlogManager::registerSerializationHandler ( )

static

Definition at line 328 of file blog_manager.inc.

     {
          SerializationManager::registerHandler("blog", "Articles and Blogs", new BlogSerializationHandler());
          return true;
     }

registerSolrAdapter()

static BlogManager::registerSolrAdapter ( )

static

Definition at line 123 of file blog_manager.inc.

     {
          SolrManager::registerSolrAdapter(Blog, new BlogSolrAdapter());
     }

registerTaxonomyClasses()

static BlogManager::registerTaxonomyClasses (   $classes )

static

Definition at line 254 of file blog_manager.inc.

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

registerVersionedContent()

static BlogManager::registerVersionedContent ( )

static

Definition at line 260 of file blog_manager.inc.

     {
          VersionedContentManager::registerVersionedContent(Blog);
     }

saveBlogSubscription()

static BlogManager::saveBlogSubscription (   $form )

static

Custom save handlerf or blog_subscription_form.

Avoid saving duplicate subscriptions (same email and blog_id).

Parameters

unknown

$form

Definition at line 291 of file blog_manager.inc.

     {
          $blogSubscriber = &$form->data;
          
          $subscriptions = Query::create(BlogSubscriber, "WHERE subscriber_email=:email AND blog_id=:blog_id")
               ->bind(":email", $blogSubscriber->subscriber_email, ":blog_id", $blogSubscriber->blog_id)
               ->execute();
          
          $subscription = (count($subscriptions)) ? $subscriptions[0] : null;
          
          if($subscription && $subscription->subscription_type != $blogSubscriber->subscription_type)
          {
               $subscription->subscription_type = $blogSubscriber->subscription_type;
               $subscription->filter = new InclusionFilter("subscription_type");
               $subscription->save();
 
               $form->data = $subscription;
          }
          else if(!$subscription)
          {
               if (!$blogSubscriber->subscription_token) 
               {
                    $blogSubscriber->subscription_token = BlogSubscriptionManager::generateToken();
               }
               $blogSubscriber->save();
          }
          
          return true;
     }

sendDigests()

static BlogManager::sendDigests ( )

static

Definition at line 321 of file blog_manager.inc.

     {
          $mgr = new BlogSubscriptionManager();
          
          $mgr->sendDigests();
     }

setDefaultEmailTemplates()

static BlogManager::setDefaultEmailTemplates ( )

static

For blog, need default templates: blog_subscription blog_published blog_unsubscribe_confirmation.

Definition at line 219 of file blog_manager.inc.

     {
          global $config;
 
          $sitename = $config["sitename"];
          
          $message = "This is an automated message from {$sitename}. You have successfully subscribed to the {Blog.title}.<br><br>To unsubscribe, <a href='{getUnsubscribeUrl()}'>click here</a> or follow this link: {getUnsubscribeUrl()}.";
          EmailTemplate::setDefaultTemplate("blog_subscription", "{subscriber_email}", "{$sitename} Blog Subscription: {Blog.title}", $message, "BlogSubscriber");
          
          $message = "Greetings. This is an automated message from {$sitename}. A new post has been published on {Blog.title}. Click the link below to read it.<br><br>{getBlogUrl()}?article_id=[article_id]<br><br>You are receiving this message because you subscribed to {Blog.title}. To unsubscribe, please follow this link: {getUnsubscribeUrl()}";
          EmailTemplate::setDefaultTemplate("blog_published", "{subscriber_email}", "{$sitename} post: {Blog.title}", $message, "BlogSubscriber");
     
          $message = "This is an automated message from {$sitename}. You have successfully unsubscribed to the {Blog.title}.";
          EmailTemplate::setDefaultTemplate("blog_unsubscribe_confirmation", "{subscriber_email}", "{$sitename} Blog Subscription: {Blog.title}", $message, "BlogSubscriber");
     
     }

setDefaultMergeCodes()

static BlogManager::setDefaultMergeCodes ( )

static

Merge codes: blog_title article_id blog_identifier unsubscribe_url blog_url.

Definition at line 245 of file blog_manager.inc.

     {
          MergeCode::setDefaultMergeCode("blog_title", "Blog.title", "BlogSubscriber", "Blog Title");
          MergeCode::setDefaultMergeCode("article_id", "", "BlogSubscriber", "ID of the article whose publication is the cause of the subscriber email being sent. This value is provided in the calling code b/c it can't be accessed through the blog subscriber.");
          MergeCode::setDefaultMergeCode("blog_identifier", "Blog.identifier", "BlogSubscriber", "The CMS page identifier of the blog.");
          MergeCode::setDefaultMergeCode("unsubscribe_url", "getUnsubscribeUrl", "BlogSubscriber", "The url to unsubscribe from a blog.");
          MergeCode::setDefaultMergeCode("blog_url", "getBlogUrl", "BlogSubscriber", "The url to view blog posts.");
     }

setDefaults()

static BlogManager::setDefaults ( )

static

Definition at line 202 of file blog_manager.inc.

     {
          Settings::setDefaultValue("blog", "allow_subscription_options", "0", Boolean, "Whether to allow users to choose subscription type options. Cron job must be setup for the website to call handler file 'send_digest'.");
          Settings::setDefaultValue("blog", "weekly_digest_day", "Mon", String, "The day of the week when the weekly digest will be sent for sites that allow that option.", "", "Sun\nMon\nTue\nWed\nThu\nFri\nSat");
          Settings::setDefaultValue("blog", "subscribe_button_format", "Subscribe to {title}", String, "Format string to use for subscribe buttons");
          Settings::setDefaultValue("blog", "enable_extended_subscription_fields", false, Boolean, "Ask subscribers for their name and organization when subscribing");
          
          BlogManager::setDefaultEmailTemplates();
          BlogManager::setDefaultMergeCodes();
     }

upgradeComponent()

static BlogManager::upgradeComponent (   $version )

static

Definition at line 196 of file blog_manager.inc.

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

---

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

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