LinkLibraryManager Class Reference

Provides a central management class for event handlers and common functionality for the link_library component. More...

Public Member Functions
	LinkLibraryManager ()
	getTabs ($key)

Static Public Member Functions
static	setDefaults ()
static	buildLinkLibraryForm ($library)
static	deleteLinkLibrary ($library)
static	upgradeComponent ($version)
static	deleteUser ($user)
	Respond to fired event DeleteUser. More...
static	enumerateItems ($items)
	Enumerate the Document objects. More...
static	displayLibrary ($identifier, &$continue)
static	registerSearchables ($searchables)
static	registerTaxonomyClasses ($classes)
static	registerSerializationHandler ()
static	formatLink ($link)

Detailed Description

Provides a central management class for event handlers and common functionality for the link_library component.

Definition at line 41 of file link_library_manager.inc.

Member Function Documentation

buildLinkLibraryForm()

static LinkLibraryManager::buildLinkLibraryForm (   $library )

static

Definition at line 62 of file link_library_manager.inc.

     {         
          $form = new AutoForm($library);
          $form->hide("owner_id", "create_date");
          $form->required("name", "identifier");
          $form->allowDelete = true;
          $form->onDelete = array(LinkLibraryManager, deleteLinkLibrary);
          
 
          $readOnlyAccessList = new CheckListFieldRenderer($form, "read_access", "Allow Read Access", SiteRole::getRolesArray());
          $writeOnlyAccessList = new CheckListFieldRenderer($form, "write_access", "Create & Delete Links", SiteRole::getRolesArray());
          
          return $form;
     }

deleteLinkLibrary()

static LinkLibraryManager::deleteLinkLibrary (   $library )

static

Definition at line 77 of file link_library_manager.inc.

     {
          trace("Deleting Link Library {$library->link_library_id}", 3);
          
          $tx = new DataTransaction();
          
          try
          {
               $library->joinTransaction($tx);
               
               $link = new LinkRecord();
               $link->joinTransaction($tx);
               $link->delete("WHERE link_library_id={$library->link_library_id}");
               $library->delete();
          
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }    
          
          return true;
     }

deleteUser()

static LinkLibraryManager::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 116 of file link_library_manager.inc.

     {
          $pk = $user->getPrimaryKey();
          $user_id = $user->$pk;
          
          trace("Component link_library is deleting objects dependent on user_id {$user_id}", 3);
     
          $tx = new DataTransaction();
          
          try
          {
               $libraries = Query::create(LinkLibrary, "WHERE owner_id=:owner_id")
                    ->bind(":owner_id", $user_id)
                    ->execute();
               
               if(count($libraries))
               {
                    foreach($libraries as $library)
                    {
                         $library->joinTransaction($tx);
                         LinkLibraryManager::deleteLinkLibrary($library);
                    }
               }
               
               $record = new LinkRecord();
               $record->joinTransaction($tx);
               $record->delete("WHERE owner_id={$user_id}");
               
               $tx->commit();
          }
          catch(Exception $e)
          {
               $tx->rollback();
               throw $e;
          }
          
          return $user;
     }

displayLibrary()

static LinkLibraryManager::displayLibrary (   $identifier, &  $continue  )

static

Definition at line 167 of file link_library_manager.inc.

     {
          try
          {
               $library = LinkLibrary::findByIdentifier($identifier);
               $page = ComponentPage::findByIdentifier("link_library", "WHERE enabled=1");
                    
               $_GET["library"] = $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 LinkLibraryManager::enumerateItems (   $items )

static

Enumerate the Document objects.

Parameters

$items

collection that the Document items are returned in

Definition at line 159 of file link_library_manager.inc.

     {
          $libraries = Query::create(LinkLibrary, "WHERE enabled=1 ORDER BY name")->execute();
     
          $items["Link Libraries"] = $libraries;
          return $items;
     }

formatLink()

static LinkLibraryManager::formatLink (   $link )

static

Definition at line 217 of file link_library_manager.inc.

     {
          $url = $link->url;
          
          $type = getDocType($url);
          $icon = getDocIcon($url);
          
          return $link->format("<h4>{title}</h4><p>{description}</p><img style='display:inline-block;vertical-align: middle' src='$icon' alt='$type'/> <a href='{url}' target='_blank'>Read More</a>");
     }         

getTabs()

LinkLibraryManager::getTabs

(

$key

)

Definition at line 53 of file link_library_manager.inc.

     {
          $tabs = array("Library Details"    =>   "/admin/link_library_form",
                           "Links"           =>   "/admin/link_library_links");
     
          $qs = ($key) ? "link_library_id=$key" : "";
          return new TabBar("tabs", $tabs, $qs);
     }

LinkLibraryManager()

LinkLibraryManager::LinkLibraryManager

(

)

Definition at line 43 of file link_library_manager.inc.

     {
 
     }

registerSearchables()

static LinkLibraryManager::registerSearchables (   $searchables )

static

Definition at line 198 of file link_library_manager.inc.

     {
          trace("LinkLibraryManager registerSearchables", 3);
          $searchables["link_library"] = array(LinkRecord);
          return $searchables;
     }

registerSerializationHandler()

static LinkLibraryManager::registerSerializationHandler ( )

static

Definition at line 211 of file link_library_manager.inc.

     {
          SerializationManager::registerHandler("link_library", "Link Libraries", new LinkLibrarySerializationHandler());
          return true;
     }

registerTaxonomyClasses()

static LinkLibraryManager::registerTaxonomyClasses (   $classes )

static

Definition at line 205 of file link_library_manager.inc.

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

setDefaults()

static LinkLibraryManager::setDefaults ( )

static

Definition at line 48 of file link_library_manager.inc.

     {
          Settings::setDefaultValue("link_library", "display_format", "Paged List", String, "Specify the format used to display link libraries.", "", "Paged List\nTabular");
     }

upgradeComponent()

static LinkLibraryManager::upgradeComponent (   $version )

static

Definition at line 103 of file link_library_manager.inc.

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

---

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

• C:/code/cms.sonjara.com/cms/components/link_library/link_library_manager.inc