\Announcements

Ubilling user announcements basic class

Synopsis

class Announcements {

• // constants
• const CACHE_KEY_ANN = 'ANNOUNCEMENTS';
• const CACHE_KEY_ADMAQ = 'ADMACQUAINTED';
• const INTRO_KEY = 'ZBS_INTRO';
• const URL_ME = '?module=announcements';
• const EX_ID_NO_EXIST = 'NO_EXISTING_ID_RECEIVED';
• // members
• protected string $myLogin = '';
• protected string $ann_id = '';
• protected string $ann_for = 'USERS';
• protected string $log_register = '';
• protected string $admiface = '';
• protected string $announcementsTable = 'zbsannouncements';
• protected string $historyTable = 'zbsannhist';
• protected array $adminsName = ;
• protected array $announcesAvaible = ;
• protected array $announcesHistory = ;
• protected array $announcesHistoryCount = ;
• protected string $introText = '';
• protected  $cache = '';
• protected integer $cacheTime = 2592000;
• protected  $messages = '';
• protected array $allAddress = ;
• protected array $allRealNames = ;
• // methods
• public void __construct()
• protected void initMessages()
• protected void setLogin()
• protected void initCache()
• protected void flushCache()
• protected void setAnnounceFor()
• protected void setAnnounceId()
• protected void loadAdminsName()
• protected string initAdminName()
• protected array avaibleAnnouncementsCached()
• public array loadAvaibleAnnouncements()
• protected array loadAnnouncesHistoryCached()
• public array loadAnnounceHistory()
• protected int createAnnounce()
• protected void editAnnounce()
• protected void deleteAnnounce()
• protected void deleteAnnounceHistory()
• public void deleteAnnounceData()
• public void controlAnn()
• public string renderForm()
• protected void loadIntroText()
• protected string introEditForm()
• public void saveIntroText()
• public string panel()
• protected string preview()
• protected void loadUsersData()
• public string renderAcquaintedUsers()
• public void ajaxAvaibAcquaintedUsers()
• public string renderAvaibleAnnouncements()
• public void ajaxAvaibleAnnouncements()
}


Constants

Name	Value
CACHE_KEY_ANN	'ANNOUNCEMENTS'
CACHE_KEY_ADMAQ	'ADMACQUAINTED'
INTRO_KEY	'ZBS_INTRO'
URL_ME	'?module=announcements'
EX_ID_NO_EXIST	'NO_EXISTING_ID_RECEIVED'

Members

protected

• $admiface — string
  Contains admiface #_GET parametr
• $adminsName — array
  Contains admns Name as admin_login => admin_name
• $allAddress — array
  Contains all addresses data
• $allRealNames — array
  Contains all real names data
• $ann_for — string
  Contains Announce FOR from $_GET
• $ann_id — string
  Contains Announce ID from $_GET
• $announcementsTable — string
  Contains Databases announcements table
• $announcesAvaible — array
  Contains all announces as id => array (public, type, title, text)
• $announcesHistory — array
  Contains all announces history as [annid] => Array ( parametr => Array ( [login] => $value))
• $announcesHistoryCount — array
  Contains announces history count as annid => count
• $cache —
  System caching instance placeholder
• $cacheTime — int
  Caching timeout
• $historyTable — string
  Contains Databases history table
• $introText — string
  Contains current intro text
• $log_register — string
  Contains log parametr
• $messages —
  System message helper object placeholder
• $myLogin — string
  Contains current user login

Methods

protected

• avaibleAnnouncementsCached() — Loads All avaible Announcements from cache
• createAnnounce() — Create Announce on database
• deleteAnnounce() — Delete Announce from database
• deleteAnnounceHistory() — Delete Announce History from database
• editAnnounce() — Change Announce data on database
• flushCache() — Flushes precached data
• initAdminName() — Init admin Name
• initCache() — Initalizes system cache object
• initMessages() — Inits system messages helper object for further usage
• introEditForm() — Renders intro text editing form
• loadAdminsName() — Loads admis Name
• loadAnnouncesHistoryCached() — Loads all avaible hystory results from cache
• loadIntroText() — Loads current intro text from database
• loadUsersData() — Loads users address and realname data for further usage
• preview() — returns announcement preview
• setAnnounceFor() — Initalizes $ann_for
• setAnnounceId() — Initalizes $ann_id
• setLogin() — Sets current user login

public

• __construct()
• ajaxAvaibAcquaintedUsers() — Renders list of users which acquainted with some announcement
• ajaxAvaibleAnnouncements() — Renders json formatted data about Announces
• controlAnn() — updates some existing announcement in database
• deleteAnnounceData() — Deletes all data about Announce from database by ID
• loadAnnounceHistory() — Loads all avaible votes result from databases
• loadAvaibleAnnouncements() — Loads All avaible Announcements from databases
• panel() — Renders module controls
• renderAcquaintedUsers() — Renders list of users which acquainted with some announcement
• renderAvaibleAnnouncements() — Renders Announces module control panel interface
• renderForm() — returns announcement edit form
• saveIntroText() — Stores new intro text in database