APIBoost A.P.I. documentation for PHPBoost CMS
  • Packages
    • Ajax
    • Builder
    • Content
    • Core
    • Default
    • Doctrine
    • Helper
    • IO
    • MVC
    • PHPBoost
    • Util
  • Interfaces
  • Classes
  • CacheData
  • CaptchaOptions
  • CommentsExtensionPoint
  • ConfigData
  • ContentFormattingExtensionPoint
  • Controller
  • CssFilesExtensionPoint
  • DAO
  • DataStore
  • DBConnection
  • DBMSFactory
  • DBMSUtils
  • ExtendedFieldExtensionPoint
  • ExtensionPoint
  • ExternalAuthentication
  • FeedProvider
  • FileReader
  • FileWriter
  • FormattingParser
  • FormButton
  • FormConstraint
  • FormElement
  • FormField
  • FormFieldConstraint
  • FormFieldEnumOption
  • FormFieldset
  • GraphicalEnvironment
  • HomePage
  • HomePageExtensionPoint
  • HTMLElement
  • HTMLTableFilter
  • InjectQueryResult
  • MailService
  • MemberExtendedFieldType
  • MenusExtensionPoint
  • ModuleSetup
  • ModuleTreeLinksExtensionPoint
  • PropertiesMapInterface
  • QueryResult
  • Response
  • ScheduledJobExtensionPoint
  • SearchableExtensionPoint
  • SelectQueryResult
  • SQLFragmentBuilder
  • SQLQuerier
  • SQLQueryTranslator
  • Template
  • TemplateData
  • TemplateLoader
  • TemplateParser
  • TemplateRenderer
  • TemplateSyntaxElement
  • UrlMapper
  • UrlMappingsExtensionPoint
  • View
  • AbstractAdminItemController
  • AbstractCategoriesFormController
  • AbstractCategoriesManagementController
  • AbstractCommentsBuildForm
  • AbstractCommentsController
  • AbstractConfigData
  • AbstractContentFormattingExtensionPoint
  • AbstractController
  • AbstractDeleteCategoryController
  • AbstractDisplayGraphicalEnvironment
  • AbstractFormButton
  • AbstractFormField
  • AbstractFormFieldChoice
  • AbstractFormFieldConstraint
  • AbstractFormFieldEnumOption
  • AbstractFormFieldset
  • AbstractGraphicalEnvironment
  • AbstractHTMLElement
  • AbstractHTMLTableFilter
  • AbstractItemController
  • AbstractMemberExtendedField
  • AbstractParser
  • AbstractPHPMailerMailService
  • AbstractPlatform
  • AbstractQueryResult
  • AbstractResponse
  • AbstractScheduledJobExtensionPoint
  • AbstractSearchableExtensionPoint
  • AbstractSelectQueryResult
  • AbstractSQLQuerier
  • AbstractTemplate
  • AbstractTemplateParser
  • AbstractTemplateSyntaxElement
  • AbstractUrlMapper
  • ActionAuthorization
  • AddCommentBuildForm
  • AdminController
  • AdminDisplayFrameGraphicalEnvironment
  • AdminDisplayFrameResponse
  • AdminDisplayGraphicalEnvironment
  • AdminDisplayResponse
  • AdministratorAlert
  • AdministratorAlertCache
  • AdministratorAlertService
  • AdminMenuDisplayResponse
  • AdminModuleController
  • AdminModuleLink
  • AdminNodisplayGraphicalEnvironment
  • AdminNodisplayResponse
  • AjaxCommentsDisplayController
  • AjaxCommentsNotationController
  • AjaxImagePreviewController
  • AjaxKeywordsAutoCompleteController
  • AjaxRequest
  • AjaxSearchUserAutoCompleteController
  • AjaxUrlValidationController
  • AjaxUserAutoCompleteController
  • APCDataStore
  • AppContext
  • Application
  • ArrayContentTemplateSyntaxElement
  • Arrays
  • ArrayTemplateSyntaxElement
  • ArrayType
  • ATOM
  • AuthenticationMethod
  • AuthenticationService
  • Authorizations
  • AuthorizationsSettings
  • AutoConnectData
  • BBCodeHighlighter
  • Bench
  • BigIntType
  • BooleanType
  • BreadCrumb
  • BrHTMLElement
  • BufferedFileReader
  • BufferedFileWriter
  • BusinessObject
  • CacheDataNotFoundException
  • CachedMenu
  • CachedStringTemplateLoader
  • CacheManager
  • CacheService
  • Captcha
  • CaptchaProvidersService
  • CaptchaService
  • CategoriesAuthorizationsService
  • CategoriesCache
  • CategoriesItemsParameters
  • CategoriesManager
  • CategoriesService
  • CategoriesUrlBuilder
  • Category
  • CategoryNotFoundException
  • ClassLoader
  • ColumnsDisabled
  • CommentsAuthorizations
  • CommentsCache
  • CommentsConfig
  • CommentsDAO
  • CommentsManager
  • CommentsProvidersService
  • CommentsService
  • CommentsTopic
  • CommentsTopicDAO
  • CommentsTopicEvents
  • CommentsTopics
  • CommentsUrlBuilder
  • ConditionTemplateSyntaxElement
  • ConfigManager
  • ConfigNotFoundException
  • ConstantTemplateSyntaxElement
  • ContentEditor
  • ContentFormattingConfig
  • ContentFormattingParser
  • ContentFormattingProvidersService
  • ContentFormattingService
  • ContentFormattingUnparser
  • ContentManagementConfig
  • ContentMenu
  • ContentSecondParser
  • ContentSharingActionsMenuLink
  • ContentSharingActionsMenuLinksExtensionPoint
  • ContentSharingActionsMenuService
  • Contribution
  • ContributionService
  • CookieBarConfig
  • Countries
  • CSSCacheConfig
  • CSSCacheManager
  • CSSFileOptimizer
  • CurrentUser
  • CustomizationConfig
  • CustomizeInterface
  • DataStoreException
  • DataStoreFactory
  • Date
  • DateTimeType
  • DateType
  • DBConnectionException
  • DBFactory
  • DBQuerier
  • Debug
  • DecimalType
  • DefaultAdminDisplayResponse
  • DefaultAjaxDeleteItemController
  • DefaultCategoriesCache
  • DefaultCategoriesFeedProvider
  • DefaultCategoriesFormController
  • DefaultCategoriesManagementController
  • DefaultCommentsTopic
  • DefaultConfigurationController
  • DefaultDeleteCategoryController
  • DefaultDeleteItemController
  • DefaultDisplayItemController
  • DefaultHomePage
  • DefaultHomePageDisplay
  • DefaultItemsManagementController
  • DefaultMailService
  • DefaultModuleConfig
  • DefaultModuleSetup
  • DefaultRichCategoriesCache
  • DefaultRichModuleConfig
  • DefaultScheduledJobsModule
  • DefaultSearchable
  • DefaultSeveralItemsController
  • DefaultSitemapCategoriesModule
  • DefaultSitemapModule
  • DefaultTemplateData
  • DefaultTemplateRenderer
  • DefaultTreeLinks
  • DeleteLinkHTMLElement
  • Dispatcher
  • DispatcherException
  • DispatcherUrlMapping
  • DispatchManager
  • DivHTMLElement
  • DoctrineException
  • EditCommentBuildForm
  • EditLinkHTMLElement
  • Environment
  • ErrorHandler
  • Event
  • ExceptionHandler
  • ExceptionUtils
  • ExpressionContentTemplateSyntaxElement
  • ExpressionTemplateSyntaxElement
  • ExtendedField
  • ExtendedFields
  • ExtendedFieldsCache
  • ExtendedFieldsDatabaseService
  • ExtendedFieldsService
  • ExtensionPointNotFoundException
  • ExtensionPointProvider
  • ExtensionPointProviderService
  • ExternalAuthenticationsExtensionPoint
  • Feed
  • FeedData
  • FeedItem
  • FeedItemEnclosure
  • FeedMenu
  • FeedsCat
  • FeedsCategoriesModule
  • FeedsList
  • File
  • FileSystemDataStore
  • FileSystemElement
  • FileSystemHelper
  • FileTemplate
  • FileTemplateLoader
  • FileTemplateLoadingException
  • FileTemplateRenderingException
  • FileType
  • FileUploadConfig
  • FileUploadService
  • Filter
  • FloatType
  • Folder
  • FormatingHelper
  • FormBuilderDisabledFieldException
  • FormBuilderException
  • FormButtonAjax
  • FormButtonAjaxCssImg
  • FormButtonButton
  • FormButtonButtonCssImg
  • FormButtonDefaultSubmit
  • FormButtonLink
  • FormButtonLinkCssImg
  • FormButtonReset
  • FormButtonSubmit
  • FormButtonSubmitCssImg
  • FormButtonSubmitImg
  • FormConstraintFieldsDifferenceInferior
  • FormConstraintFieldsDifferenceSuperior
  • FormConstraintFieldsEquality
  • FormConstraintFieldsInequality
  • FormConstraintFieldsNotIncluded
  • FormFieldActionLink
  • FormFieldActionLinkElement
  • FormFieldActionLinkList
  • FormFieldAjaxCompleter
  • FormFieldAjaxSearchUserAutoComplete
  • FormFieldAjaxUserAutoComplete
  • FormFieldAuthorizationsSetter
  • FormFieldBooleanInformation
  • FormFieldCaptcha
  • FormFieldCategoriesSelect
  • FormFieldCheckbox
  • FormFieldColorPicker
  • 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
  • FormFieldDate
  • FormFieldDateTime
  • FormFieldDecimalNumberEditor
  • FormFieldEditors
  • FormFieldFilePicker
  • FormFieldFree
  • FormFieldGroups
  • FormFieldHidden
  • FormFieldHTML
  • FormFieldLabel
  • FormFieldLangsSelect
  • FormFieldMailEditor
  • FormFieldMemberCaution
  • FormFieldMemberSanction
  • FormFieldMenuFieldset
  • FormFieldMultiLineTextEditor
  • FormFieldMultipleAutocompleter
  • FormFieldMultipleCheckbox
  • FormFieldMultipleCheckboxOption
  • FormFieldMultipleSelectChoice
  • FormFieldMultipleValuedCheckboxOption
  • FormFieldMultitabsLink
  • FormFieldMultitabsLinkElement
  • FormFieldMultitabsLinkList
  • FormFieldNumberEditor
  • FormFieldPasswordEditor
  • FormFieldPossibleValues
  • FormFieldRadioChoice
  • FormFieldRadioChoiceOption
  • FormFieldRangeEditor
  • FormFieldRanksSelect
  • FormFieldRichTextEditor
  • FormFieldSearch
  • FormFieldSelectChoiceGroupOption
  • FormFieldSelectChoiceOption
  • FormFieldSelectSources
  • FormFieldsetAccordionControls
  • FormFieldsetHidden
  • FormFieldsetHorizontal
  • FormFieldsetHTML
  • FormFieldsetHTMLHeading
  • FormFieldsetMultitabsHTML
  • FormFieldsetSubmit
  • FormFieldsetVertical
  • FormFieldShortMultiLineTextEditor
  • FormFieldSimpleSelectChoice
  • FormFieldSpacer
  • FormFieldSubTitle
  • FormFieldTelEditor
  • FormFieldTextEditor
  • FormFieldThemesSelect
  • FormFieldThumbnail
  • FormFieldTimezone
  • FormFieldUploadFile
  • FormFieldUploadPictureFile
  • FormFieldUrlEditor
  • FunctionCallTemplateSyntaxElement
  • FunctionTemplateSyntaxElement
  • GeneralConfig
  • GraphicalEnvironmentConfig
  • GroupsCache
  • GroupsService
  • HtaccessFileCache
  • HTMLForm
  • HTMLTable
  • HTMLTableAjaxUserAutoCompleteFilter
  • HTMLTableAjaxUserAutoCompleteSQLFilter
  • HTMLTableBeginsWithTextSQLFilter
  • HTMLTableCheckboxFilter
  • HTMLTableColumn
  • HTMLTableDateComparatorSQLFilter
  • HTMLTableDateGreaterThanOrEqualsToSQLFilter
  • HTMLTableDateLessThanOrEqualsToSQLFilter
  • HTMLTableDateTimeGreaterThanOrEqualsToSQLFilter
  • HTMLTableDateTimeLessThanOrEqualsToSQLFilter
  • HTMLTableEndsWithTextSQLFilter
  • HTMLTableEqualsFromListFilter
  • HTMLTableEqualsFromListSQLFilter
  • HTMLTableEqualsToSQLFilter
  • HTMLTableEscapedLikeTextSQLFilter
  • HTMLTableGreaterThanOrEqualsToSQLFilter
  • HTMLTableGreaterThanSQLFilter
  • HTMLTableLessThanOrEqualsToSQLFilter
  • HTMLTableLessThanSQLFilter
  • HTMLTableLikeFromListSQLFilter
  • HTMLTableLikeTextSQLFilter
  • HTMLTableModel
  • HTMLTableNumberComparatorSQLFilter
  • HTMLTableParameters
  • HTMLTableRow
  • HTMLTableRowCell
  • HTMLTableSortingRule
  • HTMLTableTextFilter
  • HTMLTableUnapprovedSQLFilter
  • HTTPCookie
  • HTTPFatalExceptionPrinter
  • HTTPRequestCustom
  • HTTPResponseCustom
  • I18NMessages
  • IdcardService
  • IllegalArgumentException
  • Image
  • ImageResizer
  • ImgHTMLElement
  • IncludeTemplateSyntaxElement
  • IntegerType
  • IntegratedErrorHandler
  • InvalidTemplateFunctionCallException
  • IOException
  • Item
  • ItemsAuthorizationsService
  • ItemsManager
  • ItemsModuleExtensionPointProvider
  • ItemsService
  • ItemsUrlBuilder
  • JoinMappingModel
  • JSONResponse
  • KeyGenerator
  • Keyword
  • KeywordsCache
  • KeywordsManager
  • KeywordsService
  • Lang
  • LangConfiguration
  • LangConfigurationManager
  • LangLoader
  • LangNotFoundException
  • LangsConfig
  • LangsManager
  • LangVarTemplateSyntaxElement
  • LastUseDateConfig
  • LinkHTMLElement
  • LinksMenu
  • LinksMenuElement
  • LinksMenuLink
  • LoopTemplateSyntaxElement
  • LoopVarTemplateSyntaxElement
  • Mail
  • MailServiceConfig
  • MailToPHPMailerConverter
  • MailUtil
  • MaintenanceConfig
  • MalformedUrlMapperRegexException
  • MappingModel
  • MappingModelField
  • MemberDateExtendedField
  • MemberDisabledActionAuthorization
  • MemberExtendedField
  • MemberExtendedFieldErrorsMessageException
  • MemberExtendedFieldsService
  • MemberHalfLongTextExtendedField
  • MemberHiddenExtendedField
  • MemberLongTextExtendedField
  • MemberMultipleChoiceExtendedField
  • MemberMultipleSelectExtendedField
  • MemberSanctionManager
  • MemberShortTextExtendedField
  • MemberSimpleChoiceExtendedField
  • MemberSimpleSelectExtendedField
  • MemberUserAvatarExtendedField
  • MemberUserBornExtendedField
  • MemberUserPMToMailExtendedField
  • MemberUserSexExtendedField
  • Menu
  • MenusCache
  • MenuService
  • MenusProvidersService
  • MenuStringFilter
  • MessageHelper
  • MiniCalendar
  • Module
  • ModuleConfiguration
  • ModuleConfigurationManager
  • ModuleController
  • ModuleCssFiles
  • ModuleDispatchManager
  • ModuleExtensionPointProvider
  • ModuleLink
  • ModuleMenus
  • ModuleMiniMenu
  • ModulePagination
  • ModulesConfig
  • ModulesCssFilesService
  • ModulesManager
  • ModulesUrlBuilder
  • ModuleTreeLinks
  • ModuleTreeLinksService
  • MySQLDBConnection
  • MySQLDBConnectionException
  • MySQLDBFactory
  • MySQLDBMSUtils
  • MySQLInjectQueryResult
  • MySqlPlatform
  • MySQLQuerier
  • MySQLQuerierException
  • MySQLQueryTranslator
  • MySQLSelectQueryResult
  • MySQLUnexistingDatabaseException
  • NginxFileCache
  • NoSuchControllerException
  • NotASingleRowFoundException
  • Notation
  • NotationService
  • Notification
  • NotYetImplementedException
  • NoUrlMatchException
  • NumberHelper
  • ObjectNotFoundException
  • ObjectType
  • Pagination
  • ParametersTemplateSyntaxElement
  • ParameterTypeMismatchException
  • Path
  • PDODBConnection
  • PDODBConnectionException
  • PDOInjectQueryResult
  • PDOMySQLDBFactory
  • PDOQuerier
  • PDOQuerierException
  • PDOSelectQueryResult
  • PersistenceContext
  • PHPBoostAuthenticationMethod
  • PHPBoostErrors
  • PHPBoostFoldersPermissions
  • PHPBoostIndexController
  • PHPBoostNotInstalledException
  • PHPTemplateSyntaxElement
  • PlainCodeHighlighter
  • PostgreSqlPlatform
  • PrivateMsg
  • PropertyNotFoundException
  • RAMDataStore
  • RawExceptionHandler
  • RegexHelper
  • RemainingStringVarException
  • Repository
  • RichCategory
  • RichItem
  • RichRootCategory
  • Robots
  • RolesAuthorizations
  • RootCategory
  • RowNotFoundException
  • RSS
  • SearchCategoryChildrensOptions
  • SearchResult
  • SecurityConfig
  • SelectQueryResultMapper
  • SEOMetaData
  • ServerConfiguration
  • ServerEnvironmentConfig
  • Session
  • SessionData
  • SessionNotFoundException
  • SessionsConfig
  • SimpleVarTemplateSyntaxElement
  • SiteDisplayFrameGraphicalEnvironment
  • SiteDisplayFrameResponse
  • SiteDisplayGraphicalEnvironment
  • SiteDisplayResponse
  • SitemapCategoriesModule
  • SiteNodisplayGraphicalEnvironment
  • SiteNodisplayResponse
  • SmallIntType
  • SmileysCache
  • SMTPConfiguration
  • SMTPMailService
  • SpanHTMLElement
  • SQLDAO
  • SQLFragment
  • SQLHTMLTableModel
  • SqlitePlatform
  • SQLQuerierException
  • SQLQueryVars
  • StatsCache
  • StringInputStream
  • StringOutputStream
  • StringTemplate
  • StringTemplateLoader
  • StringType
  • StringVars
  • TemplateFunctions
  • TemplateHighlighter
  • TemplateLoadingException
  • TemplateRenderingException
  • TemplateSyntaxParser
  • TemplateSyntaxParserContext
  • TextHelper
  • TextTemplateSyntaxElement
  • TextType
  • Theme
  • ThemeConfiguration
  • ThemeConfigurationManager
  • ThemesConfig
  • ThemesManager
  • TimeType
  • Timezone
  • Type
  • UnexistingDatabaseException
  • UnexistingExtensionPointProviderException
  • UnexistingHTTPParameterException
  • UnreadContributionsCache
  • UnsupportedOperationException
  • Updates
  • Upload
  • UploadedFile
  • UploadedFileTooLargeException
  • Uploads
  • Url
  • UrlControllerMapper
  • UrlMapping
  • UrlMappings
  • UrlRedirectMapper
  • UrlSerializedParameter
  • UrlSerializedParameterEncoder
  • UrlSerializedParameterParser
  • User
  • UserAccountsConfig
  • UserService
  • ValidationResult
  • VariableExpressionTemplateSyntaxElement
  • VariableTemplateSyntaxElement
  • VisitorDisabledActionAuthorization
  • WizardActionLinkList
  • WizardFormFieldsetSubmit
  • WizardHTMLForm
  • WritingPadConfig
Sub Packages
  • authorization
  • extended-fields
    • field
  1. APIBoost
  2. Package
  3. Member

Package Member

  • APIBoost
  • PHPBoost
  • Member

Classes

MemberSanctionManager

This class is responsible a punish member

PrivateMsg

This class provides methods to manage private message.

Uploads

  • APIBoost
  • PHPBoost
  • Member
  • authorization

Classes

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.

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.

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.

RolesAuthorizations

This class stores different roles which are authorized for a given action.

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.

  • APIBoost
  • PHPBoost
  • Member
  • extended-fields

Interfaces

ExtendedFieldExtensionPoint

Classes

ExtendedField

This class represente a extended field

ExtendedFields

ExtendedFieldsDatabaseService

This class is responsible of all database accesses implied by the extended fields management.

ExtendedFieldsService

MemberExtendedField

This class represente a member extended field

MemberExtendedFieldsService

This class is responsible for updated, displayed and registed of member extended fields.

  • APIBoost
  • PHPBoost
  • Member
  • extended-fields
  • field

Interfaces

MemberExtendedFieldType

Classes

AbstractMemberExtendedField

Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.

MemberDateExtendedField

Abstract class that proposes a default implementation for the MemberExtendedFieldType interface.

MemberExtendedFieldErrorsMessageException

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.

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.

Documentation is powered by phpDocumentor and generated on Thu, 25 Jun 2020 11:09:44 +0200.