Core Class Reference
[Core]

Class containing system-wide functions. More...

List of all members.

Public Member Functions

 cleanFileVar ($var)
 cleanVar ($var)
 getBaseDir ()
 getCurrentDate ($ts=null)
 isWindows ()
 microtime ()
 serverPHPOS ()
 serverPHPVersion ()


Detailed Description

Class containing system-wide functions.

Definition at line 22 of file Core.inc.php.


Member Function Documentation

Core.cleanFileVar ( var  ) 

Sanitize a value to be used in a file path. Removes any characters except alphanumeric characters, underscores, and dashes.

Parameters:
$var string
Returns:
string

Definition at line 69 of file Core.inc.php.

References String.regexp_replace().

Referenced by Request.getRequestedJournalPath(), Request.getRequestedOp(), and Request.getRequestedPage().

Core.cleanVar ( var  ) 

Core.getBaseDir (  ) 

Get the path to the base OJS directory.

Returns:
string

Definition at line 28 of file Core.inc.php.

Referenced by TemplateManager.TemplateManager().

Core.getCurrentDate ( ts = null  ) 

Return the current date in ISO (YYYY-MM-DD HH:MM:SS) format.

Parameters:
$ts int optional, use specified timestamp instead of current time
Returns:
string

Definition at line 78 of file Core.inc.php.

Referenced by RegistrationHandler.activateUser(), SectionEditorAction.addReviewer(), SectionEditorAction.addSubmissionNote(), TemporaryFileManager.articleToTemporaryFile(), EditorAction.assignEditor(), ProofreaderAction.authorProofreadingUnderway(), SectionEditorAction.cancelReview(), AuthorAction.completeAuthorCopyedit(), SectionEditorAction.completeCopyedit(), CopyeditorAction.completeCopyedit(), SectionEditorAction.completeFinalCopyedit(), CopyeditorAction.completeFinalCopyedit(), LayoutEditorAction.completeLayoutEditing(), ReviewerAction.confirmReview(), SectionEditorAction.confirmReviewForReviewer(), ArticleFileManager.copyAndRenameFile(), CopyeditorAction.copyeditUnderway(), AuthorAction.copyeditUnderway(), ImportOJS1.copyJournalImage(), Install.createData(), AccessKeyManager.createKey(), AccessKeyDAO.deleteExpiredKeys(), SubmissionEditHandler.editorCompleteLayoutEditor(), SubmissionEditHandler.editorCompleteProofreader(), SubmissionEditHandler.editorInitiateLayoutEditor(), SubmissionEditHandler.editorInitiateProofreader(), EmailHandler.email(), SectionEditorAction.emailEditorDecisionComment(), AuthorAction.emailEditorDecisionComment(), ThesisForm.execute(), StudentThesisForm.execute(), RegistrationForm.execute(), PeerReviewCommentForm.execute(), EditCommentForm.execute(), CreateReviewerForm.execute(), UserManagementForm.execute(), AnnouncementForm.execute(), IssueForm.execute(), CommentForm.execute(), AuthorSubmitStep5Form.execute(), ThesisFeedGatewayPlugin.fetch(), AnnouncementFeedGatewayPlugin.fetch(), ArticleFileManager.generateDummyFile(), AccessKeyDAO.getAccessKey(), AccessKeyDAO.getAccessKeyByKeyHash(), ArticleFileManager.handleCopy(), TemporaryFileManager.handleUpload(), ArticleFileManager.handleUpload(), ArticleFileManager.handleWrite(), SectionEditorAction.initiateCopyedit(), CaptchaDAO.insertCaptcha(), CommentDAO.insertComment(), OJSCompletedPaymentDAO.insertCompletedPayment(), ArticleEventLogDAO.insertLogEntry(), ArticleEmailLogDAO.insertLogEntry(), QueuedPaymentDAO.insertQueuedPayment(), SuppFileDAO.insertSuppFile(), UserDAO.insertUser(), VersionDAO.insertVersion(), SubscriptionDAO.isValidSubscriptionByDomain(), SubscriptionDAO.isValidSubscriptionByIP(), SubscriptionDAO.isValidSubscriptionByUser(), ProofreaderAction.layoutEditorProofreadingUnderway(), Validation.login(), CounterPlugin.logRequest(), SectionEditorAction.notifyAuthorCopyedit(), SectionEditorAction.notifyCopyeditor(), SectionEditorAction.notifyFinalCopyedit(), SectionEditorAction.notifyLayoutEditor(), SectionEditorAction.notifyReviewer(), IssueManagementHandler.notifyUsers(), ProofreaderAction.proofreadEmail(), ProofreaderAction.proofreaderProofreadingUnderway(), IssueManagementHandler.publishIssue(), SectionEditorAction.rateReviewer(), SectionEditorAction.recordDecision(), ReviewerAction.recordRecommendation(), SectionEditorAction.remindReviewer(), SubmissionEditHandler.scheduleForPublication(), SectionEditorAction.setReviewerRecommendation(), SuppFileForm.setSuppFileData(), AuthorSubmitSuppFileForm.setSuppFileData(), ReviewAssignment.stampModified(), Article.stampModified(), Article.stampStatusModified(), SubmissionLayoutHandler.submission(), SectionEditorAction.thankAuthorCopyedit(), SectionEditorAction.thankCopyeditor(), SectionEditorAction.thankFinalCopyedit(), SectionEditorAction.thankLayoutEditor(), SectionEditorAction.thankReviewer(), CommentDAO.updateComment(), QueuedPaymentDAO.updateQueuedPayment(), SectionEditorAction.updateSubmissionNote(), UserDAO.updateUser(), CopyeditorAction.uploadCopyeditVersion(), JournalSetupStep5Form.uploadImage(), SiteSettingsForm.uploadPageHeaderTitleImage(), ReviewerAction.uploadReviewerVersion(), SectionEditorAction.uploadReviewForReviewer(), and SubmissionEditHandler.validate().

Core.isWindows (  ) 

Check if the server platform is Windows.

Returns:
boolean

Definition at line 111 of file Core.inc.php.

References serverPHPOS().

Referenced by Mail.getAddressArrayString(), InstallForm.initData(), and Mail.send().

Core.microtime (  ) 

Return *nix timestamp with microseconds (in units of seconds).

Returns:
float

Definition at line 86 of file Core.inc.php.

Referenced by TemplateManager.smartyGetDebugInfo().

Core.serverPHPOS (  ) 

Get the operating system of the server.

Returns:
string

Definition at line 95 of file Core.inc.php.

Referenced by isWindows(), and AdminFunctionsHandler.systemInfo().

Core.serverPHPVersion (  ) 

Get the version of PHP running on the server.

Returns:
string

Definition at line 103 of file Core.inc.php.

Referenced by AdminFunctionsHandler.systemInfo().


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

Generated on Mon Jul 14 10:55:41 2008 for Open Journal Systems by  doxygen 1.5.6