CWIS Developer Documentation
SystemConfiguration.php
Go to the documentation of this file.
1 <?php
2 #
3 # FILE: SystemConfiguration.php
4 #
5 # Part of the Collection Workflow Integration System (CWIS)
6 # Copyright 2013 Edward Almasy and Internet Scout Research Group
7 # http://scout.wisc.edu/cwis/
8 #
9 
11 
17 
18  # ---- PUBLIC INTERFACE --------------------------------------------------
19 
25  function SystemConfiguration($DB = NULL)
26  {
27  $this->DB = new Database();
28  }
29 
37  function TopLinkString($NewValue = DB_NOVALUE){ return $this->UpdateValue("TopLinkString", $NewValue); }
38 
46  function TopLinkBeginLetter($NewValue = DB_NOVALUE) { return $this->UpdateValue("TopLinkBeginLetter", $NewValue); }
47 
55  function TopLinkEndLetter($NewValue = DB_NOVALUE) { return $this->UpdateValue("TopLinkEndLetter", $NewValue); }
56 
63  function AdminEmail($NewValue = DB_NOVALUE) { return $this->UpdateValue("AdminEmail", $NewValue); }
64 
71  function PasswordMailSubject($NewValue = DB_NOVALUE) { return $this->UpdateValue("PasswordMailSubject", $NewValue); }
72 
79  function PasswordMailBody($NewValue = DB_NOVALUE) { return $this->UpdateValue("PasswordMailBody", $NewValue); }
80 
87  function PasswordResetMailSubject($NewValue = DB_NOVALUE) { return $this->UpdateValue("PasswordResetMailSubject", $NewValue); }
88 
95  function PasswordResetMailBody($NewValue = DB_NOVALUE) { return $this->UpdateValue("PasswordResetMailBody", $NewValue); }
96 
103  function MailChangeMailSubject($NewValue = DB_NOVALUE) { return $this->UpdateValue("MailChangeMailSubject", $NewValue); }
104 
111  function MailChangeMailBody($NewValue = DB_NOVALUE) { return $this->UpdateValue("MailChangeMailBody", $NewValue); }
112 
119  function PortalName($NewValue = DB_NOVALUE) { return $this->UpdateValue("PortalName", $NewValue); }
120 
127  function DefaultActiveUI($NewValue = DB_NOVALUE) { return $this->UpdateValue("DefaultActiveUI", $NewValue); }
128 
135  function CurrentTheme($NewValue = DB_NOVALUE) { return $this->UpdateValue("CurrentTheme", $NewValue); }
136 
143  function DefaultCharacterSet($NewValue = DB_NOVALUE) { return $this->UpdateValue("DefaultCharacterSet", $NewValue); }
144 
152  function SearchTermsRequired($NewValue = DB_NOVALUE) { return $this->UpdateValue("SearchTermsRequired", $NewValue); }
153 
161  function ShowNumResourcesEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("ShowNumResourcesEnabled", $NewValue); }
162 
169  function AnnouncementsEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("AnnouncementsEnabled", $NewValue); }
170 
177  function ForumsEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("ForumsEnabled", $NewValue); }
178 
184  function ForumsAllowHTML($NewValue = DB_NOVALUE) { return $this->UpdateValue("ForumsAllowHTML", $NewValue); }
185 
191  function ForumsUseWYSIWYG($NewValue = DB_NOVALUE) { return $this->UpdateValue("ForumsUseWYSIWYG", $NewValue); }
192 
200  function AllowMultipleUIsEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("AllowMultipleUIsEnabled", $NewValue); }
201 
211  function ResourceLaunchesNewWindowEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("ResourceLaunchesNewWindowEnabled", $NewValue); }
212 
220  function UserAgentsEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("UserAgentsEnabled", $NewValue); }
221 
228  function ResourceRatingsEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("ResourceRatingsEnabled", $NewValue); }
229 
236  function ResourceCommentsEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("ResourceCommentsEnabled", $NewValue); }
237 
245  function AccessibilityWizardEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("AccessibilityWizardEnabled", $NewValue); }
246 
255  function IncrementalKeywordSearchEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("IncrementalKeywordSearchEnabled", $NewValue); }
256 
264  function ReleaseFlagApproved($NewValue = DB_NOVALUE) { return $this->UpdateValue("ReleaseFlagApproved", $NewValue); }
265 
272  function SearchDBEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("SearchDBEnabled", $NewValue); }
273 
281  function RecommenderDBEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("RecommenderDBEnabled", $NewValue); }
282 
289  function OAISQEnabled($NewValue = DB_NOVALUE) { return $this->UpdateValue("OAISQEnabled", $NewValue); }
290 
299  function NumAnnounceOnHomePage($NewValue = DB_NOVALUE) { return $this->UpdateValue("NumAnnounceOnHomePage", $NewValue); }
300 
308  function NumResourcesOnHomePage($NewValue = DB_NOVALUE) { return $this->UpdateValue("NumResourcesOnHomePage", $NewValue); }
309 
316  function LegalNotice($NewValue = DB_NOVALUE) { return $this->UpdateValue("LegalNotice", $NewValue); }
317 
324  function DefaultRecordsPerPage($NewValue = DB_NOVALUE) { return $this->UpdateValue("DefaultRecordsPerPage", $NewValue); }
325 
334  { return $this->UpdateValue("NumResourcesForSearchFacets", $NewValue); }
335 
342  function MaxFacetsPerField($NewValue = DB_NOVALUE)
343  { return $this->UpdateValue("MaxFacetsPerField", $NewValue); }
344 
353  function NumClassesPerBrowsePage($NewValue = DB_NOVALUE)
354  {
355  # if new classes per browse page has been specified
356  if ($NewValue !== DB_NOVALUE &&
357  $NewValue != $this->UpdateValue("NumClassesPerBrowsePage",DB_NOVALUE))
358  {
359  # clear all classification links
360  $this->TopLinkString("");
361  $this->DB->Query("UPDATE Classifications SET LinkString=''");
362  }
363  return $this->UpdateValue("NumClassesPerBrowsePage", $NewValue);
364  }
365 
374  function NumColumnsPerBrowsePage($NewValue = DB_NOVALUE) { return $this->UpdateValue("NumColumnsPerBrowsePage", $NewValue); }
375 
383  function BrowsingFieldId($NewValue = DB_NOVALUE) { return $this->UpdateValue("BrowsingFieldId", $NewValue); }
384 
391  function OaiIdDomain($NewValue = DB_NOVALUE) { return $this->UpdateValue("OaiIdDomain", $NewValue); }
392 
399  function OaiIdPrefix($NewValue = DB_NOVALUE) { return $this->UpdateValue("OaiIdPrefix", $NewValue); }
400 
407  function OaiEarliestDate($NewValue = DB_NOVALUE) { return $this->UpdateValue("OaiEarliestDate", $NewValue); }
408 
415  function OaiDateGranularity($NewValue = DB_NOVALUE) { return $this->UpdateValue("OaiDateGranularity", $NewValue); }
416 
423  function SiteKeywords($NewValue = DB_NOVALUE) { return $this->UpdateValue("SiteKeywords", $NewValue); }
424 
431  function AboutText($NewValue = DB_NOVALUE) { return $this->UpdateValue("AboutText", $NewValue); }
432 
439  function ContactName($NewValue = DB_NOVALUE) { return $this->UpdateValue("ContactName", $NewValue); }
440 
447  function ContactEmail($NewValue = DB_NOVALUE) { return $this->UpdateValue("ContactEmail", $NewValue); }
448 
455  function Organization($NewValue = DB_NOVALUE) { return $this->UpdateValue("Organization", $NewValue); }
456 
463  function OrganizationType($NewValue = DB_NOVALUE) { return $this->UpdateValue("OrganizationType", $NewValue); }
464 
471  function SiteType($NewValue = DB_NOVALUE) { return $this->UpdateValue("SiteType", $NewValue); }
472 
481  function OkayToListSite($NewValue = DB_NOVALUE) { return $this->UpdateValue("OkayToListSite", $NewValue); }
482 
489  function LastRegisteredOn($NewValue = DB_NOVALUE) { return $this->UpdateValue("LastRegisteredOn", $NewValue); }
490 
497  function AddAWStatsScript($NewValue = DB_NOVALUE) { return $this->UpdateValue("AddAWStatsScript", $NewValue); }
498 
505  function AddGoogleAnalytics($NewValue = DB_NOVALUE) { return $this->UpdateValue("AddGoogleAnalytics", $NewValue); }
506 
513  function GoogleAnalyticsCode($NewValue = DB_NOVALUE) { return $this->UpdateValue("GoogleAnalyticsCode", $NewValue); }
514 
523  function DisplayLimitsByDefault($NewValue = DB_NOVALUE) { return $this->UpdateValue("DisplayLimitsByDefault", $NewValue); }
524 
532  function DefaultSortField($NewValue = DB_NOVALUE) { return $this->UpdateValue("DefaultSortField", $NewValue); }
533 
541  function FieldDisplayFolder($NewValue = DB_NOVALUE) { return $this->UpdateValue("FieldDisplayFolder", $NewValue); }
542 
550  function FieldEditFolder($NewValue = DB_NOVALUE) { return $this->UpdateValue("FieldEditFolder", $NewValue); }
551 
560  function CollapseMetadataFieldGroups($NewValue = DB_NOVALUE) { return $this->UpdateValue("CollapseMetadataFieldGroups", $NewValue); }
561 
568  function RequireEmailWithFeedback($NewValue = DB_NOVALUE) { return $this->UpdateValue("RequireEmailWithFeedback", $NewValue); }
569 
576  function UseMinimizedJavascript($NewValue = DB_NOVALUE) { return $this->UpdateValue("UseMinimizedJavascript", $NewValue); }
577 
585  function SearchEngineUpdatePriority($NewValue = DB_NOVALUE) { return $this->UpdateValue("SearchEngineUpdatePriority", $NewValue); }
586 
595  function RecommenderEngineUpdatePriority($NewValue = DB_NOVALUE) { return $this->UpdateValue("RecommenderEngineUpdatePriority", $NewValue); }
596 
603  function LogoFileName() { return $this->UpdateValue("LogoFileName",DB_NOVALUE, "UIStyleConfiguration"); }
604 
611  function LogoAltText() { return $this->UpdateValue("LogoAltText",DB_NOVALUE, "UIStyleConfiguration"); }
612 
619  function LogoWidth() { return $this->UpdateValue("LogoWidth",DB_NOVALUE,"UIStyleConfiguration"); }
620 
627  function LogoHeight() { return $this->UpdateValue("LogoHeight",DB_NOVALUE,"UIStyleConfiguration"); }
628 
635  function HasRegistered() { return strlen($this->UpdateValue("LastRegisteredOn",DB_NOVALUE)) ? TRUE : FALSE; }
636 
643  function TitleField($NewValue = DB_NOVALUE) { return $this->UpdateValue("TitleField", $NewValue); }
644 
651  function DescriptionField($NewValue = DB_NOVALUE) { return $this->UpdateValue("DescriptionField", $NewValue); }
652 
659  function UrlField($NewValue = DB_NOVALUE) { return $this->UpdateValue("UrlField", $NewValue); }
660 
667  function ScreenshotField($NewValue = DB_NOVALUE) { return $this->UpdateValue("ScreenshotField", $NewValue); }
668 
675  function SecureLogin($NewValue = DB_NOVALUE) { return $this->UpdateValue("SecureLogin", $NewValue); }
676 
683  function EmailLineEnding($NewValue = DB_NOVALUE) { return $this->UpdateValue("EmailLineEnding", $NewValue); }
684 
691  function SavedSearchMailTemplate($NewValue = DB_NOVALUE) { return $this->UpdateValue("SavedSearchMailTemplate", $NewValue); }
692 
699  function DefaultUserPrivs($NewValue = DB_NOVALUE)
700  {
701  if ($NewValue !== DB_NOVALUE)
702  {
703  $NewValue = serialize($NewValue);
704  }
705 
706  $Result = unserialize($this->UpdateValue("DefaultUserPrivs", $NewValue));
707 
708  if (!is_array($Result))
709  {
710  $Result = $this->DefaultUserPrivs(array());
711  }
712 
713  return $Result;
714  }
715 
722  function Value($FieldName, $NewValue = DB_NOVALUE)
723  { return $this->UpdateValue($FieldName, $NewValue); }
724 
725  # ---- PRIVATE INTERFACE -------------------------------------------------
726 
727  private $DB;
728  private $DBFields;
729 
738  private function UpdateValue($FieldName, $NewValue, $Table="SystemConfiguration")
739  {
740  if ($NewValue != DB_NOVALUE)
741  {
742  $SignalResult = $GLOBALS["AF"]->SignalEvent(
743  "EVENT_SET_SYSCONFIG_VALUE", array(
744  "FieldName" => $FieldName,
745  "NewValue" => $NewValue));
746  $NewValue = $SignalResult["NewValue"];
747  }
748  $Value = $this->DB->UpdateValue($Table, $FieldName,
749  $NewValue, NULL, $this->DBFields);
750  $SignalResult = $GLOBALS["AF"]->SignalEvent(
751  "EVENT_GET_SYSCONFIG_VALUE", array(
752  "FieldName" => $FieldName,
753  "Value" => $Value));
754  $Value = $SignalResult["Value"];
755  return $Value;
756  }
757 }
const UNCHANGED_VALUE
This value is used to determine if a value is changed.
NumResourcesForSearchFacets($NewValue=DB_NOVALUE)
Gets or sets the number of resources considered to build search facets.
GoogleAnalyticsCode($NewValue=DB_NOVALUE)
Gets or sets the Google Analytics code system configuration setting.
ContactName($NewValue=DB_NOVALUE)
Gets or sets the contact name system configuration setting.
DefaultCharacterSet($NewValue=DB_NOVALUE)
Gets or sets the default character set system configuration setting.
ResourceRatingsEnabled($NewValue=DB_NOVALUE)
Gets or sets the resource ratings enabled system configuration setting.
DefaultUserPrivs($NewValue=DB_NOVALUE)
Gets or sets the default user privileges system configuration setting.
ReleaseFlagApproved($NewValue=DB_NOVALUE)
Gets or sets the release flag approved system configuration setting.
OkayToListSite($NewValue=DB_NOVALUE)
Gets or sets the okay to list site system configuration setting.
ForumsAllowHTML($NewValue=DB_NOVALUE)
Gets or sets the forums allow html system configuration setting.
PortalName($NewValue=DB_NOVALUE)
Gets or sets the portal name system configuration setting.
ContactEmail($NewValue=DB_NOVALUE)
Gets or sets the contact email system configuration setting.
AddAWStatsScript($NewValue=DB_NOVALUE)
Gets or sets the add AW stats script system configuration setting.
FieldDisplayFolder($NewValue=DB_NOVALUE)
Gets or sets the field display folder system configuration setting.
ResourceLaunchesNewWindowEnabled($NewValue=DB_NOVALUE)
Gets or sets the resource launches new window enabled system configuration setting.
AddGoogleAnalytics($NewValue=DB_NOVALUE)
Gets or sets the add Google Analytics system configuration setting.
MailChangeMailBody($NewValue=DB_NOVALUE)
Gets or sets the mail change mail body system configuration setting.
RecommenderEngineUpdatePriority($NewValue=DB_NOVALUE)
Gets or sets the recommender engine update priority system configuration setting. ...
SQL database abstraction object with smart query caching.
RecommenderDBEnabled($NewValue=DB_NOVALUE)
Gets or sets the recommender database enabled system configuration setting.
TopLinkString($NewValue=DB_NOVALUE)
Gets or sets the top link string system configuration setting.
const DB_NOVALUE
NumClassesPerBrowsePage($NewValue=DB_NOVALUE)
Gets or sets the number of classes per browse page system configuration setting.
LogoFileName()
Gets or sets the logo file name system configuration setting.
SystemConfiguration($DB=NULL)
Constructs a new SystemConfiguration object.
SecureLogin($NewValue=DB_NOVALUE)
Gets or sets the secure login system configuration setting.
MailChangeMailSubject($NewValue=DB_NOVALUE)
Gets or sets the mail change mail subject system configuration setting.
DefaultSortField($NewValue=DB_NOVALUE)
Gets or sets the default sort field system configuration setting.
NumColumnsPerBrowsePage($NewValue=DB_NOVALUE)
Gets or sets the number of columns per browse page system configuration setting.
UrlField($NewValue=DB_NOVALUE)
Gets or sets the url field system configuration setting.
CurrentTheme($NewValue=DB_NOVALUE)
Gets or sets the current theme system configuration setting.
SearchEngineUpdatePriority($NewValue=DB_NOVALUE)
Gets or sets the search engine update priority system configuration setting.
LogoHeight()
Gets or sets the logo height system configuration setting.
DefaultActiveUI($NewValue=DB_NOVALUE)
Gets or sets the default active UI system configuration setting.
UserAgentsEnabled($NewValue=DB_NOVALUE)
Gets or sets the user agents enabled system configuration setting.
ResourceCommentsEnabled($NewValue=DB_NOVALUE)
Gets or sets the resource comments enabled system configuration setting.
OaiDateGranularity($NewValue=DB_NOVALUE)
Gets or sets the OAI date granularity system configuration setting.
SavedSearchMailTemplate($NewValue=DB_NOVALUE)
Gets or sets the saved search mail template system configuration setting.
HasRegistered()
Gets or sets the has registered system configuration setting.
NumAnnounceOnHomePage($NewValue=DB_NOVALUE)
Gets or sets the number of announcements on homepage system configuration setting.
ForumsEnabled($NewValue=DB_NOVALUE)
Gets or sets the forums enabled system configuration setting.
RequireEmailWithFeedback($NewValue=DB_NOVALUE)
Gets or sets the require email with feedback system configuration setting.
CollapseMetadataFieldGroups($NewValue=DB_NOVALUE)
Gets or sets the collapse metadata field groups system configuration setting.
OaiIdDomain($NewValue=DB_NOVALUE)
Gets or sets the OAI ID domain system configuration setting.
AdminEmail($NewValue=DB_NOVALUE)
Gets or sets the admin email system configuration setting.
ForumsUseWYSIWYG($NewValue=DB_NOVALUE)
Gets or sets the forums use WYSIWYG editor setting.
IncrementalKeywordSearchEnabled($NewValue=DB_NOVALUE)
Gets or sets the incremental keyword search enabled system configuration setting. ...
SearchTermsRequired($NewValue=DB_NOVALUE)
Gets or sets the search terms required system configuration setting.
AllowMultipleUIsEnabled($NewValue=DB_NOVALUE)
Gets or sets the allow multiple UIs enabled system configuration setting.
AnnouncementsEnabled($NewValue=DB_NOVALUE)
Gets or sets the announcements enabled system configuration setting.
OrganizationType($NewValue=DB_NOVALUE)
Gets or sets the organization type system configuration setting.
Value($FieldName, $NewValue=DB_NOVALUE)
Gets or changes a value in the database.
SiteType($NewValue=DB_NOVALUE)
Gets or sets the site type system configuration setting.
DisplayLimitsByDefault($NewValue=DB_NOVALUE)
Gets or sets the display limits by default system configuration setting.
MaxFacetsPerField($NewValue=DB_NOVALUE)
Gets or sets the number of facets considered excessive, above which we won&#39;t display the facets...
DescriptionField($NewValue=DB_NOVALUE)
Gets or sets the description field system configuration setting.
LegalNotice($NewValue=DB_NOVALUE)
Gets or sets the legal notice system configuration setting.
OaiEarliestDate($NewValue=DB_NOVALUE)
Gets or sets the OAI earliest date system configuration setting.
UseMinimizedJavascript($NewValue=DB_NOVALUE)
Gets or sets the use mimimized javascript system configuration setting.
Organization($NewValue=DB_NOVALUE)
Gets or sets the organization system configuration setting.
SearchDBEnabled($NewValue=DB_NOVALUE)
Gets or sets the search database enabled system configuration setting.
NumResourcesOnHomePage($NewValue=DB_NOVALUE)
Gets or sets the number of resources on homepage system configuration setting.
AccessibilityWizardEnabled($NewValue=DB_NOVALUE)
Gets or sets the accessibility wizard enabled system configuration setting.
EmailLineEnding($NewValue=DB_NOVALUE)
Gets or sets the email line ending system configuration setting.
SiteKeywords($NewValue=DB_NOVALUE)
Gets or sets the site keywords system configuration setting.
PasswordResetMailBody($NewValue=DB_NOVALUE)
Gets or sets the password reset mail body system configuration setting.
FieldEditFolder($NewValue=DB_NOVALUE)
Gets or sets the field edit folder system configuration setting.
ShowNumResourcesEnabled($NewValue=DB_NOVALUE)
Gets or sets the show number of resources enabled system configuration setting.
TopLinkBeginLetter($NewValue=DB_NOVALUE)
Gets or sets the top link begin letter system configuration setting.
PasswordMailSubject($NewValue=DB_NOVALUE)
Gets or sets the password mail subject system configuration setting.
LogoWidth()
Gets or sets the logo width system configuration setting.
LogoAltText()
Gets or sets the logo alt text system configuration setting.
PasswordResetMailSubject($NewValue=DB_NOVALUE)
Gets or sets the password reset mail subject system configuration setting.
LastRegisteredOn($NewValue=DB_NOVALUE)
Gets or sets the last registered on system configuration setting.
TopLinkEndLetter($NewValue=DB_NOVALUE)
Gets or sets the top link end letter system configuration setting.
ScreenshotField($NewValue=DB_NOVALUE)
Gets or sets the screenshot field system configuration setting.
DefaultRecordsPerPage($NewValue=DB_NOVALUE)
Gets or sets the default records per page system configuration setting.
BrowsingFieldId($NewValue=DB_NOVALUE)
Gets or sets the browsing field ID system configuration setting.
AboutText($NewValue=DB_NOVALUE)
Gets or sets the about text system configuration setting.
PasswordMailBody($NewValue=DB_NOVALUE)
Gets or sets the password mail body system configuration setting.
OAISQEnabled($NewValue=DB_NOVALUE)
Gets or sets OAISQ enabled system configuration setting.
OaiIdPrefix($NewValue=DB_NOVALUE)
Gets or sets the OAI ID prefix system configuration setting.
TitleField($NewValue=DB_NOVALUE)
Gets or sets the title field system configuration setting.