bigace-classes

Files:
administration
AdminMenu.php
AdminMenuItem.php
AdminMenuItemDynamic.php
AdminRequestResult.php
AdminStyle.php
AdminStyleService.php
AdminSubMenu.php
AnswerViewDefinition.php
EditorContext.php
EditorSaveHelper.php
authentication
DefaultAuthenticator.php
category
Category.php
CategoryAdminService.php
CategoryItemEnumeration.php
CategoryList.php
CategoryService.php
CategoryTreeWalker.php
DBCategory.php
ItemCategoryEnumeration.php
configuration
ConfigurationAdmin.php
ConfigurationEntry.php
ConfigurationReader.php
IniHelper.php
consumer
Consumer.php
ConsumerDefinition.php
ConsumerDeinstaller.php
ConsumerHelper.php
ConsumerInstaller.php
ConsumerInstallHelper.php
ConsumerService.php
core
FileCache.php
Hooks.php
ServiceFactory.php
Session.php
email
email.php
EmailHelper.php
HtmlEmail.php
TextEmail.php
event
Event.php
EventDispatcher.php
EventListener.php
exception
AdministrationException.php
AuthenticationException.php
CMSException.php
CoreException.php
ExceptionHandler.php
LogEntry.php
MaintenanceException.php
MissingRightException.php
NoDeleteRightException.php
NoFunctionalRightException.php
NoReadRightException.php
NotAllowedException.php
NotFoundException.php
NoWriteRightException.php
RequestResultException.php
WrongArgumentException.php
file
File.php
FileAdminService.php
FileService.php
fright
Fright.php
FrightAdminService.php
FrightExporter.php
FrightImporter.php
FrightService.php
FrightStringsEnumeration.php
GroupFrightEnumeration.php
group
Group.php
GroupAdminService.php
GroupEnumeration.php
GroupService.php
image
Image.php
ImageAdminService.php
ImageService.php
item
EditorHelper.php
FutureItem.php
HistoryItem.php
Item.php
ItemAdminService.php
ItemEnumeration.php
ItemFutureService.php
ItemHelper.php
ItemHistoryAdminService.php
ItemHistoryEnumeration.php
ItemHistoryService.php
ItemProjectService.php
ItemRequest.php
ItemRequests.php
ItemService.php
ItemTreeWalker.php
Itemtype.php
ItemtypeHelper.php
MasterItemType.php
SimpleItemTreeWalker.php
UniqueNameAdminService.php
UniqueNameService.php
job
SessionCleanup.php
language
ItemFutureLanguageEnumeration.php
ItemLanguageEnumeration.php
Language.php
LanguageEnumeration.php
layout
Layout.php
LayoutService.php
logger
DBLogger.php
FileLogger.php
Logger.php
NullLogger.php
RuntimeLogger.php
XmlFileLogger.php
menu
ContentAdminService.php
ContentService.php
Menu.php
MenuAdminService.php
MenuService.php
modul
Modul.php
ModulEnumeration.php
ModulService.php
parser
BBCodeParser.php
LinkParser.php
PortletParser.php
UseCase.php
UseCaseEditContent.php
XmlToSqlParser.php
portlets
LastEditedItemsPortlet.php
LoginMaskPortlet.php
NavigationPortlet.php
QuickSearchPortlet.php
SkypeOnlinePortlet.php
ToolPortlet.php
TranslatedPortlet.php
principal
DefaultPrincipal.php
DefaultPrincipalService.php
right
GroupRight.php
ItemRightEnumeration.php
Right.php
RightAdminService.php
RightService.php
search
ItemSearch.php
MenuSearch.php
SearchResult.php
sql
AdoDBConnection.php
AdoDBResult.php
MySQLConnection.php
mysqldump.php
MySQLResult.php
SimpleMySQLConnection.php
SQLHelper.php
statistic
StatisticConnection.php
StatisticService.php
StatisticWriter.php
template
BigaceSmarty.php
MenuTemplate.php
SmartyDesign.php
SmartyService.php
SmartyStylesheet.php
SmartyTemplate.php
updates
AbstractConsumerUpdate.php
AbstractSystemUpdate.php
AbstractUpdate.php
SeparatorResult.php
UpdateManager.php
UpdateModul.php
UpdateResult.php
user
UserAdminService.php
UserAuthenticate.php
UserEnumeration.php
UserInfo.php
UserService.php
userdata
UserData.php
UserDataAdminService.php
UserDataService.php
util
ApplicationLinks.php
applications.php
CMSLink.php
FileLink.php
GenericForm.php
IdentifierHelper.php
ImageLink.php
IOHelper.php
LinkHelper.php
MenuLink.php
ObjectHelper.php
ResourceBundle.php
ResourceBundleHelper.php
ScriptLink.php
SmartyLink.php
Translations.php
util-captcha
B2EvoCaptcha.php
util-formular
CategorySelect.php
DesignSelect.php
EditorSelect.php
GroupSelect.php
LanguageSelect.php
ModulSelect.php
StylesheetSelect.php
TemplateSelect.php
WorkflowSelect.php
util-html
CData.php
CopyrightFooter.php
EmptyOption.php
HtmlElement.php
JavascriptHelper.php
Option.php
Select.php
util-links
ActivationLink.php
AddOnLink.php
AdministrationLink.php
AjaxItemContentLink.php
AjaxItemInfoLink.php
AuthenticateLink.php
EditorLink.php
HtmlMenuChooserLink.php
ImageChooserLink.php
ItemInfoLink.php
LoginFormularLink.php
LogoutLink.php
MenuChooserLink.php
ModulAdminLink.php
PortletAdminLink.php
RegistrationLink.php
SearchLink.php
SessionLanguageLink.php
ThumbnailLink.php
workflow
AssignWorkflowActivity.php
PendingReviewActivity.php
PublishingActivity.php
PublishingWorkflow.php
RejectChangesActivity.php
SingleReviewWorkflow.php
TerminatingActivity.php
Workflow.php
WorkflowActivity.php
WorkflowService.php

Class: Consumer

Source Location: /CORE/system/classes/consumer/Consumer.php

Class Consumer

Class Overview
Class Overview | Method Summary | Methods Detail

This class is a wrapper that should not be instantiated! It is a simple container that is returned by the

  1. ConsumerService
.

Located in /CORE/system/classes/consumer/Consumer.php [line 41] 



		
				Author(s):
		
    
		  			 			 
  • Kevin Papst
    • 
			 		  			 		  			 		  			 		  		

		
		
Information Tags:



				
Version:  $Id: Consumer.php,v 1.7 2008/09/21 14:46:47 kpapst Exp $

				
Copyright:  Copyright (C) Kevin Papst

				
License:  GNU Public License

	

				

		
				
		
Methods

		
				
		
		

		
[ Top ]

	








	
	

		
Method Summary

		

			Class Overview
									    					| Method Summary | Methods Detail
		

		

			

				

											

											

											

											

											

											

											

											

											

																																																																																								
Consumer  
										Consumer()  
					

				
																
array  
										getAlias()  
					

				
																
String  
										getDomainName()  
					Get the Domain for this Consumer.

				
																
int  
										getID()  
					Returns the ID for this Consumer.

				
																
string  
										getLanguage()  
					Returns th language for this community if configured, otherwise null.

				
																
String  
										getMaintenanceFilename()  
					Returns the Filename where this Consumer saves its Maintenance Message.

				
																
String  
										getMaintenanceHTML()  
					Get the HTML that should be displayed if the Consumer is deactivated.

				
																
void  
										getPath()  
					Return the base path of this consumer.

				
																
void  
										isActivated()  
					Return whether this Consumer is activated or not.

				
												

			

			
[ Top ]

		

	



	
	

		
Methods

		

			Class Overview
																			| Method Summary | Methods Detail
					

		

			







	Constructor Consumer  [line 56]





	

    

    
 
		Consumer Consumer(

$domain, 
$values, 
$alias 
)
    

    



	
			Parameters:

			

					

				  
				
				$domain: 
				
							

					

				  
				
				$values: 
				
							

					

				  
				
				$alias: 
				
							

				


	

	

		
		

	
[ Top ]









	getAlias  [line 86]





	

    

    
 
		array getAlias(
)
    

    



	
	

	API Tags:



  

    Return:  an Array with all Alias Names for this Consumer
  







		
		

	
[ Top ]









	getDomainName  [line 79]





	

    

    
 
		String getDomainName(
)
    

    



	
Get the Domain for this Consumer.



	

	API Tags:



  

    Return:  the Domain Name
  







		
		

	
[ Top ]









	getID  [line 71]





	

    

    
 
		int getID(
)
    

    



	
Returns the ID for this Consumer.



	

	API Tags:



  

    Return:  the Consumer ID
  







		
		

	
[ Top ]









	getLanguage  [line 127]





	

    

    
 
		string getLanguage(
)
    

    



	
Returns th language for this community if configured, otherwise null.



	

	API Tags:



  

    Return:  the locale or null
  







		
		

	
[ Top ]









	getMaintenanceFilename  [line 101]





	

    

    
 
		String getMaintenanceFilename(
)
    

    



	
Returns the Filename where this Consumer saves its Maintenance Message.



	

	API Tags:



  

    Return:  the Filename for the Maintenance HTML
  







		
		

	
[ Top ]









	getMaintenanceHTML  [line 109]





	

    

    
 
		String getMaintenanceHTML(
)
    

    



	
Get the HTML that should be displayed if the Consumer is deactivated.



	

	API Tags:



  

    Return:  the HTML Message
  







		
		

	
[ Top ]









	getPath  [line 118]





	

    

    
 
		void getPath(
)
    

    



	
Return the base path of this consumer.



	

	

		
		

	
[ Top ]









	isActivated  [line 93]





	

    

    
 
		void isActivated(
)
    

    



	
Return whether this Consumer is activated or not.



	

	

		
		

	
[ Top ]



		

	



      

    		
  









This is the Developer Documentation of the BIGACE Web CMS. 

It was generated using phpDocumentor 1.4.1

© 2002-2009 Kevin Papst. All rights reserved.