APIBoost | default page

Interfaces

CacheData	This interface represents data which are stored automatically by the cache manager.
CaptchaOptions
CommentsExtensionPoint
ConfigData	This interface represents configuration data which are stored automatically by the config manager. The storage mode is very powerful, it uses a two-level cache and the database.
ContentFormattingExtensionPoint
Controller	This interface declares the minimalist controler pattern
CssFilesExtensionPoint
DAO	Describes a simple way to interact with a table
DataStore	This interface represents a data store. Its different implementations store data in different physical areas, you have to use it according to the data's life span and the efficiency you need.
DBConnection
DBMSFactory	This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.
DBMSUtils
ExtendedFieldExtensionPoint
ExtensionPoint
ExternalAuthentication
FeedProvider
FileReader
FileWriter
FormattingParser
FormButton	This class allows you to manage easily html elements.
FormConstraint
FormElement	This class allows you to manage easily html elements.
FormField	This class manage radio input fields.
FormFieldConstraint
FormFieldEnumOption
FormFieldset	This class allows you to manage easily html elements.
GraphicalEnvironment	This class is used to represent the bread crumb displayed on each page of the website.
HomePage
HomePageExtensionPoint
HTMLElement	This class allows you to manage easily html elements.
HTMLTableFilter
InjectQueryResult	this class encapsulate an inject query result
MailService
MemberExtendedFieldType
MenusExtensionPoint
ModuleSetup
ModuleTreeLinksExtensionPoint
PropertiesMapInterface
QueryResult
Response
ScheduledJobExtensionPoint
SearchableExtensionPoint
SelectQueryResult	this class encapsulate a query result set usage is: <code> foreach ($my_query_result as $result) { // do something with the $result } </code>
SQLFragmentBuilder
SQLQuerier
SQLQueryTranslator	Translates the generic query <code>$query</code> into the mysql specific dialect
Template	This class represents a PHPBoost template. Templates are used to generate text which have a common structure. You just have to write your text with tags at the place you want to insert values and assign values in the objet, when you will display them, the tags will be replaced by the corresponding value.
TemplateData	This interface describes data which are assigned to a template. There are two types of data: <ul> <li>Variables: there are string that are directly displayed</li> <li>Templates: you can embed a template in another one. When a subtemplate is displayed, it's parsed using its own data and the result is inserted where the subtemplate is embedded.</li> </ul> A template contains global variables which are available in the whole template and local variable which are only defined into a loop. To define a loop, you just have to use assign_block_vars with the same loop identifier for each loop iteration. Loops can be nested and embed both variables and subtemplates.
TemplateLoader	This class is responsible to load a template and transform it in the PHPBoost parsed template syntax.
TemplateParser	This interfaces represents a class that is able to parse a template source and transform it to a syntax that the PHP engine is able to run.
TemplateRenderer	Represents a template renderer as its names shows. Its able to get the result of the template interpration from a TemplateLoader which gives it the template source and a TemplateData which contains the data to assign in the template.
TemplateSyntaxElement
UrlMapper	Call the controller method matching an url
UrlMappingsExtensionPoint
View

Classes

AbstractAdminItemController	This class defines the minimalist controler pattern
AbstractCategoriesFormController	This class defines the minimalist controler pattern
AbstractCategoriesManagementController	This class defines the minimalist controler pattern
AbstractCommentsBuildForm
AbstractCommentsController	This class defines the minimalist controler pattern
AbstractConfigData	This is a default and minimal implementation of the ConfigData interface.
AbstractContentFormattingExtensionPoint
AbstractController	This class defines the minimalist controler pattern
AbstractDeleteCategoryController	This class defines the minimalist controler pattern
AbstractDisplayGraphicalEnvironment	This class contains the content of the writing pad which is on the home page of the administration panel.
AbstractFormButton
AbstractFormField	Abstract class that proposes a default implementation for the FormField interface.
AbstractFormFieldChoice	This class manage radio input fields.
AbstractFormFieldConstraint
AbstractFormFieldEnumOption
AbstractFormFieldset
AbstractGraphicalEnvironment
AbstractHTMLElement	This class allows you to manage easily html elements.
AbstractHTMLTableFilter
AbstractItemController	This class defines the minimalist controler pattern
AbstractMemberExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
AbstractParser	This class is the basis of all the formatting processings that exist in PHPBoost.
AbstractPHPMailerMailService
AbstractPlatform	Base class for all DatabasePlatforms. The DatabasePlatforms are the central point of abstraction of platform-specific behaviors, features and SQL dialects.
AbstractQueryResult	This class encapsulate a query result set
AbstractResponse
AbstractScheduledJobExtensionPoint
AbstractSearchableExtensionPoint
AbstractSelectQueryResult	This class encapsulate a query result set
AbstractSQLQuerier	Implements the query var replacement method
AbstractTemplate	This class is a default implementation of the Template interface using a TemplateLoader, a TemplateData and a TemplateParser.
AbstractTemplateParser	This is an abstract implementation of the {@link TemplateParser} interface.
AbstractTemplateSyntaxElement
AbstractUrlMapper	Call the controller method matching an url
ActionAuthorization	This class represents the authorizations for an action. It's associated to a label, a description, the bit in which flags are saved, and obviously the authorization array which is encapsulated in the RolesAuthorizations class.
AddCommentBuildForm
AdminController	This class defines the minimalist controler pattern
AdminDisplayFrameGraphicalEnvironment	This class contains the content of the writing pad which is on the home page of the administration panel.
AdminDisplayFrameResponse
AdminDisplayGraphicalEnvironment	This class contains the content of the writing pad which is on the home page of the administration panel.
AdminDisplayResponse
AdministratorAlert	This class represents an alert which must be sent to the administrator.
AdministratorAlertCache
AdministratorAlertService
AdminMenuDisplayResponse
AdminModuleController	This class defines the minimalist controler pattern
AdminModuleLink	This class enables you to manages the PHPBoost packages which are nothing else than the modules.
AdminNodisplayGraphicalEnvironment
AdminNodisplayResponse
AjaxCommentsDisplayController	This class defines the minimalist controler pattern
AjaxCommentsNotationController	This class defines the minimalist controler pattern
AjaxImagePreviewController	This class defines the minimalist controler pattern
AjaxKeywordsAutoCompleteController	This class defines the minimalist controler pattern
AjaxRequest
AjaxSearchUserAutoCompleteController	This class defines the minimalist controler pattern
AjaxUrlValidationController	This class defines the minimalist controler pattern
AjaxUserAutoCompleteController	This class defines the minimalist controler pattern
APCDataStore	This data store is not already available, the APC PHP extension must be enabled for you yo use it.
AppContext	This class manages all the environment services.
Application
ArrayContentTemplateSyntaxElement
Arrays
ArrayTemplateSyntaxElement
ArrayType	Type that maps a PHP array to a clob SQL type.
ATOM	This class could load a feed by its url or by a FeedData element and export it to the ATOM format
AuthenticationMethod	The AuthenticationMethod interface could be implemented in different ways to enable specifics authentication mecanisms.
AuthenticationService	This class manages the authentication mecanism. Several authentication methods could be used.
Authorizations	This class contains only static methods, it souldn't be instantiated.
AuthorizationsSettings	This class manages authorizations settings which deals with all the actions for which you want to restrict access. You can choose who can access to between the different roles existing in PHPBoost: <ul> <li>ranks (guest, member, moderator, administrator)</li> <li>groups (members can belong to one or more groups)</li> <li>members (you can tell that only a particular user can access)</li> </ul> This class contains a list of {@link ActionAuthorization} that correspond to each action with the associated authorizations.
AutoConnectData	This class manages all sessions for the users.
BBCodeHighlighter	This class is a highlighter for the PHPBoost BBCode language.
Bench	This class is done to time a process easily. You choose when to start and when to stop.
BigIntType	Type that maps a database BIGINT to a PHP string.
BooleanType	Type that maps an SQL boolean to a PHP boolean.
BreadCrumb	This class is used to represent the bread crumb displayed on each page of the website.
BrHTMLElement	This class allows you to manage easily html elements.
BufferedFileReader
BufferedFileWriter
BusinessObject
CacheDataNotFoundException	This exception is raised when you are asking a cache entry that doesn't exist.
CachedMenu
CachedStringTemplateLoader	This loader is to use when you load a template whose source is directly a PHP string and not a file. It supports caching and saves cache files in the /cache/tpl directory, using a md5 hash to distinguish eache string input.
CacheManager	This class manages cache. It makes a two-level lazy loading: <ul> <li>A top-level cache which avoids loading a data if it has already been done since the beginning of the current page generation. This cache has a short life span: it's flushed as of the PHP interpreter reaches the end of the page generation.</li> <li>A filesystem or shared RAM (via APC) cache to avoid querying the database every time to obtain the same value.
CacheService
Captcha
CaptchaProvidersService
CaptchaService
CategoriesAuthorizationsService
CategoriesCache
CategoriesItemsParameters	This class allows you to inquire the table that stores the items and the database field that contains the ID of the category in which it is located
CategoriesManager	This class allows you to easily integrate a complete system of categories in its script.
CategoriesService
CategoriesUrlBuilder
Category
CategoryNotFoundException
ClassLoader
ColumnsDisabled
CommentsAuthorizations	This class could be used to specified comments authorizations (access, read, post, moderation)
CommentsCache
CommentsConfig	This is a default and minimal implementation of the ConfigData interface.
CommentsDAO
CommentsManager	This class manage comments with different functions
CommentsProvidersService
CommentsService	This class allows you to use a comments system
CommentsTopic	This class represents the comments topic <div class="message-helper bgc notice">Do not use this class, but one of its children like for your module</div>
CommentsTopicDAO
CommentsTopicEvents
CommentsTopics
CommentsUrlBuilder	This class represents the comments topic <div class="message-helper bgc notice">Do not use this class, but one of its children like for your module</div>
ConditionTemplateSyntaxElement
ConfigManager	This class manages config loading and saving. It makes a two-level lazy loading: <ul> <li>A top-level cache which avoids loading a data if it has already been done since the beginning of the current page generation. This cache has a short life span: it's flushed as of the PHP interpreter reaches the end of the page generation.</li> <li>A filesystem or shared RAM cache to avoid querying the database many times to obtain the same value.
ConfigNotFoundException	This exception is raised when a configuration entry is load whereas it doesn't exists in the database.
ConstantTemplateSyntaxElement
ContentEditor	Abstract class for editors content.
ContentFormattingConfig	This is a default and minimal implementation of the ConfigData interface.
ContentFormattingParser	This class is abstract. It contains tools that are usefull for implement a content parser.
ContentFormattingProvidersService
ContentFormattingService	This class contains the default content formatting factory that must be used if you want a formatting factory having the default settings.
ContentFormattingUnparser	This class is an abstract class. It contains the common elements needed by all the unparsers of PHPBoost.
ContentManagementConfig	This is a default and minimal implementation of the ConfigData interface.
ContentMenu	This class represents a menu element and is used to build any kind of menu
ContentSecondParser	This class ensures the real time processing of the content. The major part of the processing is saved in the database to minimize as much as possible the treatment when the content is displayed. However, some tags cannot be cached, because we cannot have return to the original code. It's for instance the case of the code tag which replaces the code by a lot of html code which formats the code.
ContentSharingActionsMenuLink
ContentSharingActionsMenuLinksExtensionPoint
ContentSharingActionsMenuService
Contribution	This class represents a contribution made by a user to complete the content of the website.
ContributionService	This service allows developers to manage their contributions.
CookieBarConfig	This is a default and minimal implementation of the ConfigData interface.
Countries
CSSCacheConfig	This is a default and minimal implementation of the ConfigData interface.
CSSCacheManager
CSSFileOptimizer
CurrentUser	This class represente the current user
CustomizationConfig	This is a default and minimal implementation of the ConfigData interface.
CustomizeInterface
DataStoreException
DataStoreFactory	This factory returns you the data store that are the best for your requirements.
Date	This class allows you to handle easily some dates. A date is a day and an hour (year, month, day, hour, minutes, seconds).
DateTimeType	Type that maps an SQL DATETIME/TIMESTAMP to a PHP DateTime object.
DateType	Type that maps an SQL DATE to a PHP Date object.
DBConnectionException
DBFactory	class DBFactory \| This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.
DBQuerier	implements some simple queries
Debug
DecimalType	Type that maps an SQL DECIMAL to a PHP double.
DefaultAdminDisplayResponse
DefaultAjaxDeleteItemController	This class defines the minimalist controler pattern
DefaultCategoriesCache
DefaultCategoriesFeedProvider
DefaultCategoriesFormController	This class defines the minimalist controler pattern
DefaultCategoriesManagementController	This class defines the minimalist controler pattern
DefaultCommentsTopic	This class represents the comments topic <div class="message-helper bgc notice">Do not use this class, but one of its children like for your module</div>
DefaultConfigurationController	This class defines the minimalist controler pattern
DefaultDeleteCategoryController	This class defines the minimalist controler pattern
DefaultDeleteItemController	This class defines the minimalist controler pattern
DefaultDisplayItemController	This class defines the minimalist controler pattern
DefaultHomePage
DefaultHomePageDisplay
DefaultItemsManagementController	This class defines the minimalist controler pattern
DefaultMailService
DefaultModuleConfig	This is a default and minimal implementation of the ConfigData interface.
DefaultModuleSetup
DefaultRichCategoriesCache
DefaultRichModuleConfig	This is a default and minimal implementation of the ConfigData interface.
DefaultScheduledJobsModule
DefaultSearchable
DefaultSeveralItemsController	This class defines the minimalist controler pattern
DefaultSitemapCategoriesModule
DefaultSitemapModule
DefaultTemplateData	This class is a default implementation of the {@link TemplateData} interface.
DefaultTemplateRenderer	This template renderer is able to deal with both loader which cache and don't cache.
DefaultTreeLinks
DeleteLinkHTMLElement	This class allows you to manage easily html elements.
Dispatcher
DispatcherException
DispatcherUrlMapping
DispatchManager
DivHTMLElement	This class allows you to manage easily html elements.
DoctrineException	Base Exception class of Doctrine
EditCommentBuildForm
EditLinkHTMLElement	This class allows you to manage easily html elements.
Environment	This class manages all the environment that PHPBoost need to run.
ErrorHandler
Event	It's the common part between two types of event existing now in PHPBoost: <ul> <li>User contribution managed into the contribution panel</li> <li>Administrator alert, triggered for example when a new update is available or when a new member account is to approbate</li> </ul>
ExceptionHandler
ExceptionUtils
ExpressionContentTemplateSyntaxElement
ExpressionTemplateSyntaxElement
ExtendedField	This class represente a extended field
ExtendedFields
ExtendedFieldsCache
ExtendedFieldsDatabaseService	This class is responsible of all database accesses implied by the extended fields management.
ExtendedFieldsService
ExtensionPointNotFoundException
ExtensionPointProvider	This Class allow you to call methods on a ExtensionPointProvider extended class that you're not sure of the method's availality. It also provides a set of generic methods that you could use to integrate your module with others, or allow your module to share services.
ExtensionPointProviderService	This class is a ExtensionPointProvider factory providing some services like mass operations (on several modules at the same time) or identifications methods to get all ExtensionPointProvider that provide a given extension point
ExternalAuthenticationsExtensionPoint
Feed
FeedData	Contains meta-informations about a feed with its entries
FeedItem	Contains meta-informations and informations about a feed entry / item
FeedItemEnclosure	Contains meta-informations and informations about a feed item enclosure
FeedMenu	This class represents a menu element and is used to build any kind of menu
FeedsCat	Describes a feed by building a category tree
FeedsCategoriesModule
FeedsList	This class contains an agregation of differents feeds
File	This class represents a text file which can be read and written.
FileSystemDataStore	This data store is not very efficient but is the only one which has an infinite life span when APC is not available.
FileSystemElement	This class represents any file system element.
FileSystemHelper	File System helper
FileTemplate	This class allows you to handle a template file.
FileTemplateLoader	This loader is the most used. It takes a file identifier as input. This identifier corresponds to a file that can be different from the user's theme. In fact, when it loads a template, its looks for it at several places. For a module template, it can be the default one which is in the /module/templates directory, but if the file is specialized by the theme, it loads it from the theme directory. All that is explained in the {@link FileTemplate} class description.
FileTemplateLoadingException	This exception is thrown when the template cannot been loaded.
FileTemplateRenderingException
FileType
FileUploadConfig	This is a default and minimal implementation of the ConfigData interface.
FileUploadService	Manages the HTTP file upload
Filter	This class represents an abstract filter
FloatType	Type that maps an SQL FLOAT to a PHP double.
Folder	This class allows you to handle very easily a folder on the server.
FormatingHelper	Formating helper
FormBuilderDisabledFieldException
FormBuilderException
FormButtonAjax
FormButtonAjaxCssImg
FormButtonButton
FormButtonButtonCssImg
FormButtonDefaultSubmit
FormButtonLink
FormButtonLinkCssImg
FormButtonReset
FormButtonSubmit
FormButtonSubmitCssImg
FormButtonSubmitImg
FormConstraintFieldsDifferenceInferior
FormConstraintFieldsDifferenceSuperior
FormConstraintFieldsEquality
FormConstraintFieldsInequality
FormConstraintFieldsNotIncluded
FormFieldActionLink	This class manage an action link.
FormFieldActionLinkElement	This class manage action links.
FormFieldActionLinkList	This class manage action links.
FormFieldAjaxCompleter	This class represents a ajax completer field
FormFieldAjaxSearchUserAutoComplete	This class represents a search user ajax completer field
FormFieldAjaxUserAutoComplete	This class represents a user ajax completer field
FormFieldAuthorizationsSetter	Abstract class that proposes a default implementation for the FormField interface.
FormFieldBooleanInformation	This class manage free contents fields.
FormFieldCaptcha	This class manage captcha validation fields to avoid bot spam.
FormFieldCategoriesSelect	This class manage select fields.
FormFieldCheckbox	The class FormCheckBox represents a checkbox field in a form. It corresponds to a boolean.
FormFieldColorPicker	The class FormCheckBox represents a checkbox field in a form. It corresponds to a boolean.
FormFieldConstraintAntiFlood
FormFieldConstraintDate
FormFieldConstraintDisplayNameExists
FormFieldConstraintFileExtension
FormFieldConstraintFileMaxSize
FormFieldConstraintForbiddenMailDomains
FormFieldConstraintIntegerMax
FormFieldConstraintIntegerMin
FormFieldConstraintIntegerRange
FormFieldConstraintLengthMax
FormFieldConstraintLengthMin
FormFieldConstraintLengthRange
FormFieldConstraintMailAddress
FormFieldConstraintMailExist
FormFieldConstraintMaxLinks
FormFieldConstraintNotEmpty
FormFieldConstraintPasswordStrength
FormFieldConstraintPHPBoostAuthLoginExists
FormFieldConstraintPictureFile
FormFieldConstraintRegex
FormFieldConstraintTel
FormFieldConstraintUrl
FormFieldConstraintUrlExists
FormFieldConstraintUserExist
FormFieldCSRFToken	This class manage hidden input fields.
FormFieldDate	This class embeds a calendar
FormFieldDateTime	This class is able to retrieve a date and a hour (hours & minutes).
FormFieldDecimalNumberEditor	This class manages a decimal number.
FormFieldEditors	This class manage select fields.
FormFieldFilePicker	This class manage file input fields.
FormFieldFree	This class manage free contents fields.
FormFieldGroups	This class manage select fields.
FormFieldHidden	This class manage hidden input fields.
FormFieldHTML	This class manage free contents fields.
FormFieldLabel	This class manage labels
FormFieldLangsSelect	This class manage select fields.
FormFieldMailEditor	This class manage a mail address.
FormFieldMemberCaution	This class manage select fields.
FormFieldMemberSanction	This class manage select fields.
FormFieldMenuFieldset	This class is a fork of FormFieldsetHTML and manage fieldset for form with menu.
FormFieldMultiLineTextEditor	This class manage multi-line text fields, but the text can't be formatted.
FormFieldMultipleAutocompleter	This class represents a mulitple ajax completer fields
FormFieldMultipleCheckbox	This class represents a field which contains several options that can be selected simultaneously.
FormFieldMultipleCheckboxOption
FormFieldMultipleSelectChoice	This class manage select fields.
FormFieldMultipleValuedCheckboxOption
FormFieldMultitabsLink	This class manage an multitabs link.
FormFieldMultitabsLinkElement	This class manage action links.
FormFieldMultitabsLinkList	This class is a fork of FormFieldActionLinkList and manage action links for a wizard menu.
FormFieldNumberEditor	This class manage number fields.
FormFieldPasswordEditor	This class manage single-line password fields.
FormFieldPossibleValues	Abstract class that proposes a default implementation for the FormField interface.
FormFieldRadioChoice	This class manage radio input fields.
FormFieldRadioChoiceOption	This class manage radio input field options.
FormFieldRangeEditor	This class manages a range of numbers (slider).
FormFieldRanksSelect	This class manage select fields.
FormFieldRichTextEditor	This class represents a rich text editor.
FormFieldSearch	This class manages a search field.
FormFieldSelectChoiceGroupOption	This class manage select field options.
FormFieldSelectChoiceOption	This class manage select field options.
FormFieldSelectSources	Abstract class that proposes a default implementation for the FormField interface.
FormFieldsetAccordionControls
FormFieldsetHidden
FormFieldsetHorizontal
FormFieldsetHTML
FormFieldsetHTMLHeading
FormFieldsetMultitabsHTML
FormFieldsetSubmit
FormFieldsetVertical
FormFieldShortMultiLineTextEditor	This class represents a short multi-line text field.
FormFieldSimpleSelectChoice	This class manage select fields.
FormFieldSpacer	This class is a fork of FormFieldHTML and manage free contents fields.
FormFieldSubTitle	This class is a fork of FormFieldFree and manage subtitle for form with menu.
FormFieldTelEditor	This class manages an url address.
FormFieldTextEditor	This class manage single-line text fields.
FormFieldThemesSelect	This class manage select fields.
FormFieldThumbnail	Abstract class that proposes a default implementation for the FormField interface.
FormFieldTimezone	This class manage select fields.
FormFieldUploadFile	This class manage single-line text fields with a link to access the upload modal form.
FormFieldUploadPictureFile	This class manage single-line text fields with a link to access the upload modal form.
FormFieldUrlEditor	This class manages an url address.
FunctionCallTemplateSyntaxElement
FunctionTemplateSyntaxElement
GeneralConfig	This is a default and minimal implementation of the ConfigData interface.
GraphicalEnvironmentConfig	This is a default and minimal implementation of the ConfigData interface.
GroupsCache	This class contains the cache data of the groups which group users having common criteria.
GroupsService
HtaccessFileCache	This class contains the cache data of the .htaccess file which is located at the root of the site and is used to change the Apache configuration only in the PHPBoost folder.
HTMLForm	This class enables you to handle all the operations regarding forms. Indeed, you build a form using object components (fieldsets, fields, buttons) and it's able to display, to retrieve the posted values and also validate the entered data from constraints you define. The validation is done in PHP when the form is received, but also in live thanks to Javascript (each field is validated when it looses the focus and the whole form is validated when the user submits it).
HTMLTable	This class allows you to manage easily html tables.
HTMLTableAjaxUserAutoCompleteFilter
HTMLTableAjaxUserAutoCompleteSQLFilter
HTMLTableBeginsWithTextSQLFilter
HTMLTableCheckboxFilter
HTMLTableColumn	This class allows you to manage easily html tables.
HTMLTableDateComparatorSQLFilter
HTMLTableDateGreaterThanOrEqualsToSQLFilter
HTMLTableDateLessThanOrEqualsToSQLFilter
HTMLTableDateTimeGreaterThanOrEqualsToSQLFilter
HTMLTableDateTimeLessThanOrEqualsToSQLFilter
HTMLTableEndsWithTextSQLFilter
HTMLTableEqualsFromListFilter
HTMLTableEqualsFromListSQLFilter
HTMLTableEqualsToSQLFilter
HTMLTableEscapedLikeTextSQLFilter
HTMLTableGreaterThanOrEqualsToSQLFilter
HTMLTableGreaterThanSQLFilter
HTMLTableLessThanOrEqualsToSQLFilter
HTMLTableLessThanSQLFilter
HTMLTableLikeFromListSQLFilter
HTMLTableLikeTextSQLFilter
HTMLTableModel	This class allows you to manage easily html tables.
HTMLTableNumberComparatorSQLFilter
HTMLTableParameters	This class allows you to manage easily html tables.
HTMLTableRow	This class allows you to manage easily html tables.
HTMLTableRowCell	This class allows you to manage easily html tables.
HTMLTableSortingRule	This class allows you to manage easily html tables.
HTMLTableTextFilter
HTMLTableUnapprovedSQLFilter
HTTPCookie	Manages cookies via the HTTP protocol
HTTPFatalExceptionPrinter
HTTPRequestCustom	Provides access to the HTTP request parameters
HTTPResponseCustom	Manages response via the HTTP protocol
I18NMessages
IdcardService	This class represents the rating system and its parameters
IllegalArgumentException
Image	This class allows you to obtain informations on an image.
ImageResizer	This class allows you to resize images easily.
ImgHTMLElement	This class allows you to manage easily html elements.
IncludeTemplateSyntaxElement
IntegerType	The base class for so-called Doctrine mapping types.
IntegratedErrorHandler
InvalidTemplateFunctionCallException
IOException
Item
ItemsAuthorizationsService
ItemsManager
ItemsModuleExtensionPointProvider	This Class allow you to call methods on a ExtensionPointProvider extended class that you're not sure of the method's availality. It also provides a set of generic methods that you could use to integrate your module with others, or allow your module to share services.
ItemsService
ItemsUrlBuilder
JoinMappingModel
JSONResponse
KeyGenerator
Keyword
KeywordsCache
KeywordsManager
KeywordsService
Lang	This class represents a lang
LangConfiguration
LangConfigurationManager
LangLoader
LangNotFoundException
LangsConfig	This is a default and minimal implementation of the ConfigData interface.
LangsManager
LangVarTemplateSyntaxElement
LastUseDateConfig	This class contains the date of the last day where PHPBoost was used.
LinkHTMLElement	This class allows you to manage easily html elements.
LinksMenu	Create a Menu with children.
LinksMenuElement	A LinksMenuElement contains a Title, an url, and an image url <div class="message-helper bgc notice">Abstract class : Do not instanciate it LinksMenuLink and LinksMenuLink classes are based on this class use, on of these</div>
LinksMenuLink	A Simple menu link
LoopTemplateSyntaxElement
LoopVarTemplateSyntaxElement
Mail	This class allows you to send mails without having to deal with the mail headers and parameters.
MailServiceConfig	This class contains the configuration of PHPBoost's mail service.
MailToPHPMailerConverter
MailUtil	This class provides you utilities for emails.
MaintenanceConfig	This is a default and minimal implementation of the ConfigData interface.
MalformedUrlMapperRegexException	The regular expression that the controller have to match is malformed
MappingModel
MappingModelField
MemberDateExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberDisabledActionAuthorization	This class represents the authorizations for an action. It's associated to a label, a description, the bit in which flags are saved, and obviously the authorization array which is encapsulated in the RolesAuthorizations class.
MemberExtendedField	This class represente a member extended field
MemberExtendedFieldErrorsMessageException
MemberExtendedFieldsService	This class is responsible for updated, displayed and registed of member extended fields.
MemberHalfLongTextExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberHiddenExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberLongTextExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberMultipleChoiceExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberMultipleSelectExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberSanctionManager	This class is responsible a punish member
MemberShortTextExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberSimpleChoiceExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberSimpleSelectExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberUserAvatarExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberUserBornExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberUserPMToMailExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
MemberUserSexExtendedField	Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.
Menu	This class represents a menu element and is used to build any kind of menu
MenusCache
MenuService	This service manage kernel menus by adding the persistance to menus objects.
MenusProvidersService
MenuStringFilter	This class represents a filter based on string comparison
MessageHelper	Message Helper
MiniCalendar	This class enables you to retrieve easily a date entered by a user.
Module
ModuleConfiguration
ModuleConfigurationManager
ModuleController	This class defines the minimalist controler pattern
ModuleCssFiles	This class allows you to manage css files of a module
ModuleDispatchManager
ModuleExtensionPointProvider	This Class allow you to call methods on a ExtensionPointProvider extended class that you're not sure of the method's availality. It also provides a set of generic methods that you could use to integrate your module with others, or allow your module to share services.
ModuleLink
ModuleMenus
ModuleMiniMenu	This class represents a menu element and is used to build any kind of menu
ModulePagination
ModulesConfig	This class contains the cache data of the modules which module users having common criteria.
ModulesCssFilesService
ModulesManager	This class enables you to manages the PHPBoost packages which are nothing else than the modules.
ModulesUrlBuilder
ModuleTreeLinks
ModuleTreeLinksService
MySQLDBConnection
MySQLDBConnectionException
MySQLDBFactory	This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.
MySQLDBMSUtils
MySQLInjectQueryResult	This class encapsulate a query result set
MySqlPlatform	Base class for all DatabasePlatforms. The DatabasePlatforms are the central point of abstraction of platform-specific behaviors, features and SQL dialects.
MySQLQuerier	Implements the query var replacement method
MySQLQuerierException
MySQLQueryTranslator	Translates the generic query <code>$query</code> into the mysql specific dialect
MySQLSelectQueryResult	This class encapsulate a query result set
MySQLUnexistingDatabaseException
NginxFileCache	This class contains the cache data of the nginx.conf file which is located at the root of the site and is used to change the Nginx configuration only in the PHPBoost folder.
NoSuchControllerException	The specified method of the controller from the UrlDispatcherItem matching the url does not exists
NotASingleRowFoundException
Notation	This class represents the rating system and its parameters
NotationService	This class represents the rating system and its parameters
Notification	It's the common part between two types of event existing now in PHPBoost: <ul> <li>User contribution managed into the contribution panel</li> <li>Administrator alert, triggered for example when a new update is available or when a new member account is to approbate</li> </ul>
NotYetImplementedException
NoUrlMatchException	No UrlDispatcherItem were found matching the given url
NumberHelper	Number helper
ObjectNotFoundException
ObjectType	Type that maps a PHP object to a clob SQL type.
Pagination
ParametersTemplateSyntaxElement
ParameterTypeMismatchException
Path
PDODBConnection
PDODBConnectionException
PDOInjectQueryResult	This class encapsulate a query result set
PDOMySQLDBFactory	This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.
PDOQuerier	Implements the query var replacement method
PDOQuerierException
PDOSelectQueryResult	This class encapsulate a query result set
PersistenceContext	This class manages all the environment services.
PHPBoostAuthenticationMethod	The AuthenticationMethod interface could be implemented in different ways to enable specifics authentication mecanisms.
PHPBoostErrors
PHPBoostFoldersPermissions
PHPBoostIndexController	This class defines the minimalist controler pattern
PHPBoostNotInstalledException
PHPTemplateSyntaxElement
PlainCodeHighlighter	This is a manual syntax highlighter for plain code with the [highlight] tag to choose what to highlight.
PostgreSqlPlatform	PostgreSqlPlatform.
PrivateMsg	This class provides methods to manage private message.
PropertyNotFoundException	This exception is raised when a not existing property is asked in a ConfigData object.
RAMDataStore	This is a very efficient data store, but its principal weakness is that it's life span is very short, in fact it's the page's execution.
RawExceptionHandler
RegexHelper	Regex helper
RemainingStringVarException	Implements the string var replacement method
Repository
RichCategory
RichItem
RichRootCategory
Robots
RolesAuthorizations	This class stores different roles which are authorized for a given action.
RootCategory
RowNotFoundException
RSS	This class could load a feed by its url or by a FeedData element and export it to the RSS format
SearchCategoryChildrensOptions	This class allows you to manage options of children used in CategoriesManager::get_children() and CategoriesManager::get_select_categories_form_field().
SearchResult
SecurityConfig	This is a default and minimal implementation of the ConfigData interface.
SelectQueryResultMapper
SEOMetaData	This class manage the meta tags ans title for the SEO
ServerConfiguration
ServerEnvironmentConfig	This is a default and minimal implementation of the ConfigData interface.
Session	This class manages all sessions for the users.
SessionData	This class manages all sessions for the users.
SessionNotFoundException	This class manages all sessions for the users.
SessionsConfig	This is a default and minimal implementation of the ConfigData interface.
SimpleVarTemplateSyntaxElement
SiteDisplayFrameGraphicalEnvironment	This class contains the content of the writing pad which is on the home page of the administration panel.
SiteDisplayFrameResponse
SiteDisplayGraphicalEnvironment	This class contains the content of the writing pad which is on the home page of the administration panel.
SiteDisplayResponse
SitemapCategoriesModule
SiteNodisplayGraphicalEnvironment
SiteNodisplayResponse
SmallIntType	Type that maps a database SMALLINT to a PHP integer.
SmileysCache
SMTPConfiguration
SMTPMailService
SpanHTMLElement	This class allows you to manage easily html elements.
SQLDAO	Implements common access to a sql based datastore for CRUD operations on objects attached to the given <code>MappingModel</code>.
SQLFragment
SQLHTMLTableModel	This class allows you to manage easily html tables.
SqlitePlatform	The SqlitePlatform class describes the specifics and dialects of the SQLite database platform.
SQLQuerierException
SQLQueryVars	implements the query var replacement method
StatsCache
StringInputStream
StringOutputStream
StringTemplate	This class enables you to handle a template whose input is not a file but directly a string.
StringTemplateLoader	This loader is a very simple one. Its input is a string containing the template source.
StringType	Type that maps an SQL VARCHAR to a PHP string.
StringVars	Implements the string var replacement method
TemplateFunctions
TemplateHighlighter	This is a syntax highlighter for the PHPBoost template syntax.
TemplateLoadingException	This exception is thrown when the template cannot been loaded.
TemplateRenderingException
TemplateSyntaxParser	template = (variableExpression \| expression \| condition \| loop \| include \| text)* variableExpression = "{", variable, "}" expression = "${", expressionContent, "}" condition = "# IF ", "NOT "?, expression, "#", template, ("# ELSE #, template)?, "# ENDIF #" loop = "# START ", expression, " #", template, "# END (?:name)? #" include = "# INCLUDE ", name, " #" text = .+ expressionContent = array \| function \| variable \| constant function = "$\w+::$?\w+$", parameters, "$" parameters = expressionContent \| (expressionContent, (",", expressionContent)+) variable = simpleVar \| loopVar constant = "'.+'" \| [0-9]+ \| array array = "array(", arrayContent, ")" arrayContent = arrayElement \| (arrayElement, (",", arrayElement)+) arrayElement = expressionContent \| ("'\w+'\s=>\s", expressionContent) simpleVar = "\w+" loopVar = "(\w+\.)+\w+"
TemplateSyntaxParserContext
TextHelper	Text helper
TextTemplateSyntaxElement
TextType	Type that maps an SQL CLOB to a PHP string.
Theme
ThemeConfiguration
ThemeConfigurationManager
ThemesConfig	This is a default and minimal implementation of the ConfigData interface.
ThemesManager
TimeType	Type that maps an SQL TIME to a PHP DateTime object.
Timezone
Type	The base class for so-called Doctrine mapping types.
UnexistingDatabaseException
UnexistingExtensionPointProviderException
UnexistingHTTPParameterException
UnreadContributionsCache	This cache is used to know if there are unread contributions.
UnsupportedOperationException	Implements the string var replacement method
Updates
Upload	This class provides you methods to upload easily files to the ftp.
UploadedFile	Represents a HTTP uploaded file
UploadedFileTooLargeException	Represents a HTTP uploaded file
Uploads
Url
UrlControllerMapper	Call the controller method matching an url
UrlMapping
UrlMappings
UrlRedirectMapper	Redirect to the an url
UrlSerializedParameter
UrlSerializedParameterEncoder
UrlSerializedParameterParser
User
UserAccountsConfig	This class contains all the data related to the user accounts configuration.
UserService	This class manage users
ValidationResult	This class is done to time a process easily. You choose when to start and when to stop.
VariableExpressionTemplateSyntaxElement
VariableTemplateSyntaxElement
VisitorDisabledActionAuthorization	This class represents the authorizations for an action. It's associated to a label, a description, the bit in which flags are saved, and obviously the authorization array which is encapsulated in the RolesAuthorizations class.
WizardActionLinkList	This class is a fork of FormFieldActionLinkList and manage action links for a wizard menu.
WizardFormFieldsetSubmit
WizardHTMLForm	This class is a child of HTMLForms for a wizard menu and enables you to handle all the operations regarding forms.
WritingPadConfig	This class contains the content of the writing pad which is on the home page of the administration panel.

Constants

ADMIN_NOAUTH_DEFAULT

ADMIN_NOAUTH_DEFAULT = false

File

Tags

package	PHPBoost

ADMINISTRATOR_ALERT_TYPE

ADMINISTRATOR_ALERT_TYPE = 1

File

Tags

package	PHPBoost

AUTH_FLOOD

AUTH_FLOOD = 'auth_flood'

File

Tags

package	Default

CHECK_ALL_UPDATES

CHECK_ALL_UPDATES = CHECK_KERNEL | CHECK_MODULES | CHECK_THEMES

File

Tags

package	PHPBoost

CHECK_KERNEL

CHECK_KERNEL = 1

File

Tags

package	PHPBoost

CHECK_MODULES

CHECK_MODULES = 2

File

Tags

package	PHPBoost

CHECK_THEMES

CHECK_THEMES = 4

File

Tags

package	PHPBoost

COOKIE

COOKIE = 4

File

Tags

package	Helper

DATA_GROUP_LIMIT

DATA_GROUP_LIMIT = 'data_group_limit'

File

Tags

package	Default

DIR

DIR = $site_path

File

Tags

package	Default

ERROR_GETTING_CACHE

ERROR_GETTING_CACHE = 'Error regenerating and / or retrieving the syndication cache of the %s (%s)'

File

Tags

package	Content

ERROR_REPORTING

ERROR_REPORTING = E_ALL | E_NOTICE | E_STRICT

File

Tags

package	Default

FEEDS_PATH

FEEDS_PATH = PATH_TO_ROOT . '/cache/syndication/'

File

Tags

package	Content

FILES

FILES = 5

File

Tags

package	Helper

GET

GET = 1

File

Tags

package	Helper

GROUP_DEFAULT_IDSELECT

GROUP_DEFAULT_IDSELECT = ''

File

Tags

package	PHPBoost

GROUP_DISABLE_SELECT

GROUP_DISABLE_SELECT = 'disabled="disabled" '

File

Tags

package	PHPBoost

GROUP_DISABLED_ADVANCED_AUTH

GROUP_DISABLED_ADVANCED_AUTH = true

File

Tags

package	PHPBoost

GROUP_TYPE

GROUP_TYPE = 2

File

Tags

package	PHPBoost

HOST

HOST = \AppContext::get_request()->get_site_url()

File

Tags

package	Default

PATH_TO_ROOT

PATH_TO_ROOT = '../../..'

File

Tags

package	Ajax

PATH_TO_ROOT

PATH_TO_ROOT = '../../..'

File

Tags

package	Ajax

PATH_TO_ROOT

PATH_TO_ROOT = '../../..'

File

Tags

package	Ajax

PATH_TO_ROOT

PATH_TO_ROOT = '../../..'

File

Tags

package	Ajax

PATH_TO_ROOT

PATH_TO_ROOT = '../../..'

File

Tags

package	Ajax

PATH_TO_ROOT

PATH_TO_ROOT = '../../..'

File

Tags

package	Ajax

PATH_TO_ROOT

PATH_TO_ROOT = '../../..'

File

Tags

package	Ajax

PHPBOOST

PHPBOOST = true

File

Tags

package	Default

PM_GROUP_LIMIT

PM_GROUP_LIMIT = 'pm_group_limit'

File

Tags

package	Default

POST

POST = 2

File

Tags

package	Helper

QUERY_STRING

QUERY_STRING = addslashes($_SERVER['QUERY_STRING'])

File

Tags

package	Default

RANK_TYPE

RANK_TYPE = 1

File

Tags

package	PHPBoost

REQUEST

REQUEST = 3

File

Tags

package	Helper

REQUEST_URI

REQUEST_URI = $_SERVER['REQUEST_URI']

File

Tags

package	MVC

REWRITED_SCRIPT

REWRITED_SCRIPT = \TextHelper::htmlspecialchars($_SERVER['REQUEST_URI'])

File

Tags

package	Default

SCRIPT

SCRIPT = \TextHelper::htmlspecialchars($_SERVER['PHP_SELF'])

File

Tags

package	Default

SERVER_URL

SERVER_URL = $_SERVER['PHP_SELF']

File

Tags

package	Util

TARRAY

TARRAY = 'array'

File

Tags

package	Helper

TBOOL

TBOOL = 'boolean'

File

Tags

package	Helper

TDOUBLE

TDOUBLE = 'double'

File

Tags

package	Helper

TFLOAT

TFLOAT = 'double'

File

Tags

package	Helper

TINTEGER

TINTEGER = 'integer'

File

Tags

package	Helper

TITLE

TITLE = $this->get_page_title()

File

Tags

package	Default

TITLE

TITLE = ''

File

Tags

package	Ajax

TNONE

TNONE = 'none'

File

Tags

package	Helper

TPL_PATH_TO_ROOT

TPL_PATH_TO_ROOT = DIR

File

Tags

package	Default

TPL_PATH_TO_ROOT

TPL_PATH_TO_ROOT = PATH_TO_ROOT

File

Tags

package	Core

TSTRING

TSTRING = 'string'

File

Tags

package	Helper

TSTRING_AS_RECEIVED

TSTRING_AS_RECEIVED = 'string_unchanged'

File

Tags

package	Helper

TSTRING_HTML

TSTRING_HTML = 'string_html'

File

Tags

package	Helper

TSTRING_PARSE

TSTRING_PARSE = 'string_parse'

File

Tags

package	Helper

TSTRING_UNCHANGE

TSTRING_UNCHANGE = 'string_unsecure'

File

Tags

package	Helper

TUNSIGNED_DOUBLE

TUNSIGNED_DOUBLE = 'udouble'

File

Tags

package	Helper

TUNSIGNED_FLOAT

TUNSIGNED_FLOAT = 'udouble'

File

Tags

package	Helper

TUNSIGNED_INT

TUNSIGNED_INT = 'uint'

File

Tags

package	Helper

USE_DEFAULT_IF_EMPTY

USE_DEFAULT_IF_EMPTY = 1

File

Tags

package	Helper

USER_TYPE

USER_TYPE = 3

File

Tags

package	PHPBoost

Functions

find_require_dir()

find_require_dir(string $dir_path, string $require_dir, string $fatal_error = true) : string

Parameters

string	$dir_path	Path of the folder in which you want to search
string	$require_dir	Default folder
string	$fatal_error	true if you want to throw a fatal error if no file could be found, false otherwise.

Returns

string —

The path of the folder you search.

Deprecated

Finds a folder according to the user language. You find the file in a folder in which there is one folder per lang. If it doesn't exist, you want to choose the file in another language. This function returns the path of an existing file (if the required lang exists, it will be it, otherwise it will be one of the existing files).

File helper\deprecated_helper.inc.php

Tags

package

Helper

load_ini_file()

load_ini_file(string $dir_path, string $require_dir, string $ini_name = 'config.ini') : array<mixed,string>

Parameters

string	$dir_path	Path of the file (relative from this page).
string	$require_dir	The name of the folder in which the configuration file should be. This folder must be in the bases file ($dir_path). If this directory doesn't exist, another will be read.
string	$ini_name	The name of the configuration file you want to know.

Returns

array<mixed,string> —

The configuration values contained in the file $dir_path/$require_dir/$ini_name.

Deprecated

Loads a configuration file. You choose a bases path, and you specify a folder name in which you file should be found, if it doesn't exist, it will take a file in another folder. It's very interesting when you want to

File helper\deprecated_helper.inc.php

Tags

package

Helper

load_module_lang()

load_module_lang(string $module_name,  $path = PATH_TO_ROOT)

Parameters

string	$module_name	The identifier of the module for which you want to load the lang file.
	$path

Deprecated

Loads a module lang file. It will load alone the file corresponding to the user lang, but if it doesn't exist, another lang will be choosen. An error will be displayed on the page and the script execution will be stopped if no lang file is found for this module.

File helper\deprecated_helper.inc.php

Tags

package	Helper
depre

retrieve()

retrieve(integer $var_type, string $var_name, mixed $default_value, string $force_type = NULL, integer $flags) : mixed

Retrieves an input variable. You can retrieve any parameter of the HTTP request which launched the execution of this page.

Parameters

integer	$var_type	The origin of the variable: GET if it's a parameter in the request URL, POST if the variable was in a formulary, COOKIE if the variables come from a cookie and FILES if it's a file.
string	$var_name	Name of a HTTP variable you want to retrieve.
mixed	$default_value	The value you want the variable you retrieve has if the HTTP parameter doesn't exist.
string	$force_type	Type of the variable you want to retrieve. If you don't use this parameter, the returned variable will have the same type as the default value you imposed. When you force the variable type, a cast operation will be made from string (it's a string in the HTTP request) to the type you choosed. The types you can use are numerous: TINTEGER to retrieve an integer value. TSTRING to retrieve a string. The HTML code in this string is protected (XSS protection) and the dangerous MySQL characters are escaped. You can use this variable directly in a MySQL query. It you want to use it now without inserting it in a data base, use the stripslashes PHP function. TSTRING_UNCHANGE if you want to retrieve the value of a string without any processing (no quotes escaping and no HTML protection). TSTRING_PARSE if you want to parse the value you retrieved. The HTML code is protected, it parses with the user parser and the quotes are escaped. Ready to be inserted in a MySQL query ! TBOOL to retrieve a boolean value. TUNSIGNED_INT if you expect an unsigned integer. TUNSIGNED_DOUBLE to retrieve an unsigned double value. TSTRING_HTML if you don't want to protect the HTML code of the content but you want to escape the quotes. TSTRING_AS_RECEIVED if you want to retrieve the string variable as it was in the HTTP request. TARRAY to retrieve an array. The values it contains aren't processed. TDOUBLE to retrieve a double value TNONE if you want to get the input variable as it has been recieved (the return value will be a string because HTTP parameters are all strings).
integer	$flags	You can change the behaviour of this method: USE_DEFAULT_IF_EMPTY will allow you to retrieve the default value even if the parameter exists but its value is empty (to know if the var is empty, we use the empty() PHP function).

Returns

mixed —

The value of the variable you wanted to retrieve. Its type is either the same as the default value or the type you forced.

Deprecated

File helper\deprecated_helper.inc.php

Tags

package

Helper

string_var_export()

string_var_export( $var)

Parameters

$var

File io\db\dbms\Doctrine\Common\DoctrineException.php

Tags

package

Doctrine

url()

url(string $url, string $mod_rewrite = '', string $ampersand = '&amp;') : string

Parameters

string	$url	URL if the URL rewriting is disabled
string	$mod_rewrite	URL if the URL rewriting is enabled
string	$ampersand	In a redirection you mustn't put the & HTML entity (&). In this case set that parameter to &.

Returns

string —

The URL to use.

Deprecated

Adds the session ID to an URL if the user doesn't accepts cookies. This functions allows you to generate an URL according to the site configuration concerning the URL rewriting.

File helper\deprecated_helper.inc.php