[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
a
add
in file note.class.php, method Note::add() Add a note on the item. It has to be into the notation scale.
add
in file comments.class.php, method Comments::add() Add a comment
add
in file categories_manager.class.php, method CategoriesManager::add() Adds a category. We can decide if it will be visible and what its position will be
in file categories_manager.class.php, method CategoriesManager::build_administration_interface() Builds the list of categories and links to makes operations to administrate them (delete, move, add...), it supplies a string ready to be displayed. It uses AJAX, read the class description to understand this user interface.
in file categories_manager.class.php, method CategoriesManager::build_select_form() Builds a formulary which allows user to choose a category in a select form.
in file bbcode_highlighter.class.php, class BBCodeHighlighter This class is a highlighter for the PHPBoost BBCode language. It supplies the highlighted code written in XHTML.
BBCodeParser
in file bbcode_parser.class.php, class BBCodeParser Converts the PHPBoost BBCode language to the XHTML language which is stocked in the database and can be displayed nearly directly. It parses only the authorized tags (defined in the parent class which is ContentParser).
in file bbcode_unparser.class.php, class BBCodeUnparser BBCode unparser. It converts a content using the PHPBoost HTML reference code (for example coming from a database) to the PHPBoost BBCode syntax.
in file categories_manager.class.php, class CategoriesManager This class enables you to manage easily the administration of categories for your modules. It's as generic as possible, if you want to complete some actions to specialize them for you module, you can create a new class inheritating of it in which you call its methods using the syntax parent::method(). /!\ Warning : /!\
Your DB table must respect some rules :
You must have an integer attribute whose name is id and which represents the identifier of each category. It must be a primary key.
You also must have an integer attribute named id_parent which represents the identifier of the parent category (it will be 0 if its parent category is the root of the tree).
To maintain order, you must have a field containing the rank of the category which be an integer named c_order.
A field visible boolean (tynint 1 sur mysql)
A field name containing the category name
In this class the user are supposed to be an administrator, no checking of his auth is done.
To be correctly displayed, you must supply to functions a variable extracted from a file cache. Use the Cache class to build your file cache. Your variable must be an array in which keys are categories identifiers, an values are still arrays which are as this :
key id_parent containing the id_parent field of the database
key name containing the name of the category
key order
key visible which is a boolean
You can also have other fields such as auth level, description, visible, that class won't modify them.
To display the list of categories and actions you can do on them, you may want to customize it. For that you must build an array that you will give to set_display_config() containing your choices :
Key 'xmlhttprequest_file' which corresponds to the name of the file which will treat the AJAX requests. We usually call it xmlhttprequest.php.
Key 'url' which represents the url of the category (it won't display any link up to categories if you don't give this field). Its structure is the following :
key 'unrewrited' => string containing unrewrited urls (let %d where you want to display the category identifier)
Key administration_file_name which represents the file which allows you to update category
rewrited url (optionnal) 'rewrited' => string containing rewrited urls (let %d where you want to display the category identifier and %s the category name if you need it)
If you need more informations to use this class, we advise you to look at the wiki of PHPBoost, in which there is a tutorial explaining how to use it step by step.
in file categories_manager.class.php, method CategoriesManager::check_error() Checks if an error has been raised on the last reported error. At each call of a method of this class which can raise an error, the last error is erased.
in file comments.class.php, class Comments This class manages comments everywhere in phpboost Simplyfied use with the display_comments function: //news is the name of the modue, $idnews is the id in database for this item. display_comments('news', $idnews, url('news.php?id=' . $idnews . '&com=%s', 'news-0-' . $idnews . '.php?com=%s'))
compute_heritated_auth
in file categories_manager.class.php, method CategoriesManager::compute_heritated_auth() Computes the global authorization level of the whole parent categories. The result corresponds to all the category's parents merged.
in file content_formatting_factory.class.php, class ContentFormattingFactory This class is approximatively a factory which provides objets capable to format some content. The text formatting uses a syntax, PHPBoost supports both the BBCode syntax and a WYSIWYG tool syntax (TinyMCE). You can choose the formatting type you want to deal with.
in file content_second_parser.class.php, class 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. This kind of tag is treated in real time by this class. The content you put in that parser must come from a ContentParser class (BBCodeParser or TinyMCEParser) (it can have been saved in a database between the first parsing and the real time parsing).
ContentUnparser
in file content_unparser.class.php, class ContentUnparser This class is an abstract class. It contains the common elements needed by all the unparsers of PHPBoost.
in file note.class.php, method Note::display_form() Display the ajax notation form.
display_img
in file note.class.php, method Note::display_img() Static method which display the notation with images, you can restrain the number of images displayed with the argument $num_stars_display
in file content_second_parser.class.php, method ContentSecondParser::export_html_text() Transforms a PHPBoost HTML content to make it exportable and usable every where in the web.
in file site_map_link.class.php, method SiteMapLink::export() Exports the section according to the given configuration. You will use the following template variables:
LOC containing the URL of the link
TEXT containing the name of the target page
C_DISPLAY_DATE indicating if the date is not empty
DATE containing the date of the last modification of the target page, formatted for the sitemap.xml file
ACTUALIZATION_FREQUENCY corresponding to the code needed in the sitemap.xml file
PRIORITY corresponding to the code needed in the sitemap.xml file to indicate the priority of the target page.
C_LINK indicating that we are displaying a link (useful if you want to use a signe template export configuration)
export
in file site_map_section.class.php, method SiteMapSection::export() Exports the section according to the given configuration. You will use the following template variables:
SECTION_NAME which contains the name of the section
SECTION_URL which contains the URL of the link associated to the section
DEPTH which contains the depth of the section in the site map tree (useful for CSS classes names)
LINK_CODE which contains the code got by the associated link export
C_SECTION, boolean meaning that it's a section (useful if you want to use a sigle template for the whole export configuration)
A loop "element" containing evert element of the section (their code is available in the CODE variable of the loop)
in file site_map.class.php, method SiteMap::export() Exports a SiteMap. You will be able to use the following variables into the templates used to export:
C_SITE_MAP which is a condition indicating if it's a site map (useful if you want to use a sigle template
for the whole export configuration)
SITE_NAME which contains the name of the site
A loop "element" in which the code of each element is in the variable CODE
export
in file module_map.class.php, method ModuleMap::export() Exports the sitemap (according to a configuration of templates). In your template, you will be able to use the following variables:
MODULE_NAME which contains the name of the module
MODULE_DESCRIPTION which contains the description of the module
MODULE_URL which contains the URL of the module root page
DEPTH which is the depth of the module map in the sitemap (generally 1).
It might be usefull to apply different CSS styles to each level of depth.
LINK_CODE which contains the code of the link associated to the module root exported with the same configuration.
C_MODULE_MAP which is a boolean whose value is true, this will enable you to use a single template for the whole export configuration
The loop "element" for which the variable CODE contains the code of each sub element of the module (for example categories)
in file categories_manager.class.php, method CategoriesManager::get_feeds_list() Computes the list of the feeds corresponding to each category of the category tree.
get_ids
in file search.class.php, method Search::get_ids() Returns the search id
get_results
in file search.class.php, method Search::get_results() Puts results from the search results in the $results parameter and returns the number of results. Query complexity: 1 query.
get_results_by_id
in file search.class.php, method Search::get_results_by_id() Puts results from the search results identified by the $id_search parameter in the $results parameter and returns the number of results. Query complexity: 2 queries.
in file content_formatting_factory.class.php, method ContentFormattingFactory::get_available_tags() Returns the map of all the formatting types supported by the PHPBoost formatting editors and parsers. The keys of the map are the tags identifiers and the values the tags names.
get_content
in file parser.class.php, method Parser::get_content() Returns the content of the parser. If you called a method which parses the content, this content will be parsed.
get_editor
in file content_formatting_factory.class.php, method ContentFormattingFactory::get_editor() Returns an editor object which will display the editor corresponding to the language you chose.
in file content_formatting_factory.class.php, method ContentFormattingFactory::get_user_editor() Returns the name of the editor of the current user (chosen in its profile).
get_change_freq
in file site_map_link.class.php, method SiteMapLink::get_change_freq() Gets the change frequency (how often the target page is actualized)
get_depth
in file site_map_element.class.php, method SiteMapElement::get_depth() Returns the depth of the element in the tree
in file site_map_section.class.php, method SiteMapSection::get_link() Returns the link associated to the section
get_link_stream
in file site_map_export_config.class.php, method SitemapExportConfig::get_link_stream() Returns the Template object to use while exporting a SiteMapLink object.
in file site_map_export_config.class.php, method SitemapExportConfig::get_section_stream() Returns the Template object to use while exporting a SiteMapSection object.
in file search.class.php, method Search::insert_results() Inserts search results in the database cache in order to speed up next searches. Query complexity: 1 + k / 10 queries. (k represent the number of results to insert in the database)
in file categories_manager.class.php, method CategoriesManager::move_into_another() Moves a category into another category. You can specify its future position in its future parent category.
in file module_map.class.php, class ModuleMap The ModuleMap class represents the map of a module. It has a description (generally the module description) and contains some elements which can be some simple links or some sections (which can match the categories for example).
in file bbcode_highlighter.class.php, method BBCodeHighlighter::parse() Highlights the content of the parser.
parse
in file tinymce_unparser.class.php, method TinyMCEUnparser::parse() Unparses the content of the parser. It goes from the PHPBoost reference formatting syntax to the TinyMCE one.
parse
in file template_highlighter.class.php, method TemplateHighlighter::parse() Highlights the code. It uses the geshi HTML syntax highlighter and then it highlights the specific template syntax.
parse
in file tinymce_parser.class.php, method TinyMCEParser::parse() Parses the content of the parser. Translates the whole content from the TinyMCE syntax to the PHPBoost one.
parse
in file bbcode_parser.class.php, method BBCodeParser::parse() Parses the parser content from BBCode to XHTML.
parse
in file bbcode_unparser.class.php, method BBCodeUnparser::parse() Unparses the content of the parser. Converts it from HTML syntax to BBcode syntax
parse
in file content_second_parser.class.php, method ContentSecondParser::parse() Parses the content of the parser. The result will be ready to be displayed.
parse
in file content_parser.class.php, method ContentParser::parse() Parses the content of the parser
Parser
in file parser.class.php, method Parser::Parser() Builds a Parser object.
Parser
in file parser.class.php, class Parser This class is the basis of all the formatting processings that exist in PHPBoost.
in file search.class.php, method Search::Search() Builds a search object. Query Complexity: 6 + k / 10 database queries. (k represent the number of module without search cache)
in file parser.class.php, method Parser::set_content() Sets the content of the parser. When you will call a parse method, it will deal with this content.
in file content_parser.class.php, method ContentParser::set_html_auth() Sets the required authorizations that are necessary to post some HTML code which will be displayed by the web browser.
in file site_map_section.class.php, method SiteMapSection::set_link() Sets the link associated to the section
set_link_stream
in file site_map_export_config.class.php, method SitemapExportConfig::set_link_stream() Sets the Template object to use while exporting a SiteMapLink object.
in file site_map.class.php, method SiteMap::set_site_name() Sets the name of the site. The default value is the name of the site taken from the site configuration.
SiteMap
in file site_map.class.php, class SiteMap Describes the map of the site. Can be exported according to any text form by using a template configuration. A site map contains some links, some link sections and some module maps (which also contain links and sections).
SiteMap
in file site_map.class.php, method SiteMap::SiteMap() Builds a SiteMap object with its elements
in file site_map_element.class.php, class SiteMapElement This abstract is the root of every object which can be contained by a SiteMap object. Some SiteMapElements objects can contain one or many SiteMapElement objects therefore the elements can be represented by a tree an each element has a depth in the tree.
in file site_map_export_config.class.php, class SitemapExportConfig Configuration used to export a SiteMap. It contains some Template objects which are used to export each kind of elements of a sitemap. Using different configurations will enable you for example to export in HTML code to be displayed in a page of the web site (the site map) or to be written in the sitemap.xml file at the root of your site, this file will be read by the search engines to optimize the research of your site.
in file template_highlighter.class.php, class TemplateHighlighter This is a syntax highlighter for the PHPBoost template syntax.
TinyMCEParser
in file tinymce_parser.class.php, class TinyMCEParser This class enables to use TinyMCE without breaking the compatibility with the BBCode formatting. PHPBoost has a reference syntax, it in HTML with specific CSS classes. The HTML code generated by TinyMCE must be modified to conform itself to this specific syntax. This class makes the translation from the TinyMCE HTML to the PHPBoost HTML.
in file tinymce_unparser.class.php, class TinyMCEUnparser This class enables to translate the content formatting from the PHPBoost standard one to the TinyMCE one. The PHPBoost one is historically the one corresponding to the BBCode translation in HTML and is now the reference. TinyMCE has a particular syntax and it must be respected if we want to make a formatting which can be edited after having beeing written, enough what using a WYSIWYG editor hasn't any advantage.
Les partenaires
Le projet PHPBoost
Contribuer au Projet
Support PHPBoost