phpDocumentor pivotx
extensions
[ class tree: pivotx ] [ index: pivotx ] [ all elements ]

Class: Messages

Source Location: /modules/module_messages.php

Class Messages

Class Overview

The class that renders pages and handles caching, for all the pages that are seen on the 'front side'.

Located in /modules/module_messages.php [line 39]



		
		
		
		

Properties

Methods

[ Top ]
Property Summary
mixed   $filelist  
mixed   $messages  
mixed   $warnings  

[ Top ]
Method Summary
Messages   __construct()   Initialise the Messages object.
void   addMessage()   Add a message to the $message array
void   addWarning()   Add a warning to the $warning array
void   checkWarnings()   Check for common misconfigurations, filerights, and whatnot.
array   getMessages()   Get an array of the messages.
void   getWarnings()   Returns an array containing the HTML for showing the user. (if any warnings were
boolean   _checkFilerights()   Recursively check a folder for non-writable files. Store the results in $this->filelist
void   _makeFileWarning()   Make the HTML for the warning, listing the unwritable files.

[ Top ]
Properties
mixed   $filelist [line 41]

[ Top ]
mixed   $messages [line 42]

[ Top ]
mixed   $warnings [line 43]

[ Top ]
Methods
Constructor __construct  [line 49]

  Messages __construct( )

Initialise the Messages object.



[ Top ]
addMessage  [line 73]

  void addMessage( string $message  )

Add a message to the $message array

Parameters:
string   $message: 


[ Top ]
addWarning  [line 103]

  void addWarning( string $warning, [ $additionalinfo = ""]  )

Add a warning to the $warning array

Parameters:
string   $warning: 
   $additionalinfo: 


[ Top ]
checkWarnings  [line 119]

  void checkWarnings( )

Check for common misconfigurations, filerights, and whatnot.



[ Top ]
getMessages  [line 86]

  array getMessages( )

Get an array of the messages.



[ Top ]
getWarnings  [line 282]

  void getWarnings( )

Returns an array containing the HTML for showing the user. (if any warnings were

triggered, either by 'checkWarnings()' or directly)



[ Top ]
_checkFilerights  [line 303]

  boolean _checkFilerights( string $folder, string $base, [ $checkexecutables = true]  )

Recursively check a folder for non-writable files. Store the results in $this->filelist

Parameters:
string   $folder: 
string   $base: 
   $checkexecutables: 


[ Top ]
_makeFileWarning  [line 360]

  void _makeFileWarning( string $folder  )

Make the HTML for the warning, listing the unwritable files.

Parameters:
string   $folder: 


[ Top ]

Documentation generated on Tue, 05 Sep 2017 01:06:08 +0200 by phpDocumentor 1.4.3