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
  • Data
    • cache
    • config
    • store
  • DB
    • dbms
    • driver
      • mysql
      • pdo
    • factory
    • translator
    • util
  • Filesystem
    • stream
  • HTTP
    • upload
  • Image
  • Mail
  • Optimization
  • Template
    • data
    • loader
    • parser
      • syntax
    • renderer
  1. APIBoost
  2. Package
  3. IO

Package IO

  • APIBoost
  • IO

Classes

AbstractPHPMailerMailService

DefaultMailService

IOException

MailToPHPMailerConverter

SMTPMailService

Upload

This class provides you methods to upload easily files to the ftp.

  • APIBoost
  • IO
  • DB

Interfaces

DBConnection

InjectQueryResult

this class encapsulate an inject query result

QueryResult

SelectQueryResult

this class encapsulate a query result set usage is: <code> foreach ($my_query_result as $result) { // do something with the $result } </code>

SQLQuerier

Classes

DBConnectionException

DBQuerier

implements some simple queries

NotASingleRowFoundException

RowNotFoundException

SQLQuerierException

SQLQueryVars

implements the query var replacement method

UnexistingDatabaseException

  • APIBoost
  • IO
  • DB
  • factory

Interfaces

DBMSFactory

This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.

Classes

DBFactory

class DBFactory | This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.

MySQLDBFactory

This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.

PDOMySQLDBFactory

This factory provides the <code>DBConnection</code> and the <code>SQLQuerier</code> for the right sgbd.

  • APIBoost
  • IO
  • DB
  • driver

Classes

AbstractQueryResult

This class encapsulate a query result set

AbstractSelectQueryResult

This class encapsulate a query result set

AbstractSQLQuerier

Implements the query var replacement method

  • APIBoost
  • IO
  • DB
  • driver
  • pdo

Classes

PDODBConnection

PDODBConnectionException

PDOInjectQueryResult

This class encapsulate a query result set

PDOQuerier

Implements the query var replacement method

PDOQuerierException

PDOSelectQueryResult

This class encapsulate a query result set

  • APIBoost
  • IO
  • DB
  • driver
  • mysql

Classes

MySQLDBConnection

MySQLDBConnectionException

MySQLInjectQueryResult

This class encapsulate a query result set

MySQLQuerier

Implements the query var replacement method

MySQLQuerierException

MySQLSelectQueryResult

This class encapsulate a query result set

MySQLUnexistingDatabaseException

  • APIBoost
  • IO
  • DB
  • translator

Interfaces

SQLQueryTranslator

Translates the generic query <code>$query</code> into the mysql specific dialect

Classes

MySQLQueryTranslator

Translates the generic query <code>$query</code> into the mysql specific dialect

  • APIBoost
  • IO
  • DB
  • dbms

Interfaces

DBMSUtils

Classes

MySQLDBMSUtils

  • APIBoost
  • IO
  • DB
  • util

Interfaces

SQLFragmentBuilder

Classes

SQLFragment

  • APIBoost
  • IO
  • Data
  • APIBoost
  • IO
  • Data
  • store

Interfaces

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.

Classes

APCDataStore

This data store is not already available, the APC PHP extension must be enabled for you yo use it.

DataStoreException

DataStoreFactory

This factory returns you the data store that are the best for your requirements.

FileSystemDataStore

This data store is not very efficient but is the only one which has an infinite life span when APC is not available.

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.

  • APIBoost
  • IO
  • Data
  • config

Interfaces

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.

Classes

AbstractConfigData

This is a default and minimal implementation of the ConfigData interface.

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.

PropertyNotFoundException

This exception is raised when a not existing property is asked in a ConfigData object.

  • APIBoost
  • IO
  • Data
  • cache

Interfaces

CacheData

This interface represents data which are stored automatically by the cache manager.

Classes

CacheDataNotFoundException

This exception is raised when you are asking a cache entry that doesn't exist.

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

  • APIBoost
  • IO
  • Template

Interfaces

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.

View

Classes

AbstractTemplate

This class is a default implementation of the Template interface using a TemplateLoader, a TemplateData and a TemplateParser.

FileTemplate

This class allows you to handle a template file.

FileTemplateRenderingException

I18NMessages

StringTemplate

This class enables you to handle a template whose input is not a file but directly a string.

TemplateFunctions

TemplateRenderingException

  • APIBoost
  • IO
  • Template
  • parser

Interfaces

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.

Classes

AbstractTemplateParser

This is an abstract implementation of the {@link TemplateParser} interface.

  • APIBoost
  • IO
  • Template
  • parser
  • syntax

Interfaces

TemplateSyntaxElement

Classes

AbstractTemplateSyntaxElement

ArrayContentTemplateSyntaxElement

ArrayTemplateSyntaxElement

ConditionTemplateSyntaxElement

ConstantTemplateSyntaxElement

ExpressionContentTemplateSyntaxElement

ExpressionTemplateSyntaxElement

FunctionCallTemplateSyntaxElement

FunctionTemplateSyntaxElement

IncludeTemplateSyntaxElement

LangVarTemplateSyntaxElement

LoopTemplateSyntaxElement

LoopVarTemplateSyntaxElement

ParametersTemplateSyntaxElement

PHPTemplateSyntaxElement

SimpleVarTemplateSyntaxElement

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

TextTemplateSyntaxElement

VariableExpressionTemplateSyntaxElement

VariableTemplateSyntaxElement

  • APIBoost
  • IO
  • Template
  • renderer

Interfaces

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.

Classes

DefaultTemplateRenderer

This template renderer is able to deal with both loader which cache and don't cache.

  • APIBoost
  • IO
  • Template
  • loader

Interfaces

TemplateLoader

This class is responsible to load a template and transform it in the PHPBoost parsed template syntax.

Classes

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.

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.

StringTemplateLoader

This loader is a very simple one. Its input is a string containing the template source.

TemplateLoadingException

This exception is thrown when the template cannot been loaded.

  • APIBoost
  • IO
  • Template
  • data

Interfaces

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.

Classes

DefaultTemplateData

This class is a default implementation of the {@link TemplateData} interface.

  • APIBoost
  • IO
  • Filesystem

Classes

File

This class represents a text file which can be read and written.

FileSystemElement

This class represents any file system element.

FileType

Folder

This class allows you to handle very easily a folder on the server.

  • APIBoost
  • IO
  • Filesystem
  • stream

Interfaces

FileReader

FileWriter

Classes

BufferedFileReader

BufferedFileWriter

  • APIBoost
  • IO
  • Image

Classes

Image

This class allows you to obtain informations on an image.

ImageResizer

This class allows you to resize images easily.

  • APIBoost
  • IO
  • HTTP

Classes

HTTPCookie

Manages cookies via the HTTP protocol

HTTPRequestCustom

Provides access to the HTTP request parameters

HTTPResponseCustom

Manages response via the HTTP protocol

ParameterTypeMismatchException

UnexistingHTTPParameterException

  • APIBoost
  • IO
  • HTTP
  • upload

Classes

FileUploadService

Manages the HTTP file upload

UploadedFile

Represents a HTTP uploaded file

UploadedFileTooLargeException

Represents a HTTP uploaded file

  • APIBoost
  • IO
  • Mail

Interfaces

MailService

Classes

Mail

This class allows you to send mails without having to deal with the mail headers and parameters.

MailUtil

This class provides you utilities for emails.

SMTPConfiguration

  • APIBoost
  • IO
  • Optimization

Classes

CSSCacheManager

CSSFileOptimizer

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