content
Packages
Interfaces
Classes
Files

Element index for package content

[ 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
ADD_THIS_CATEGORY_IN_LIST
in file categories_manager.class.php, constant ADD_THIS_CATEGORY_IN_LIST
AJAX_MODE
in file categories_manager.class.php, constant AJAX_MODE
$array_tags
in file tinymce_editor.class.php, variable TinyMCEEditor::$array_tags
$array_tags2
in file tinymce_editor.class.php, variable TinyMCEEditor::$array_tags2
$array_tags3
in file tinymce_editor.class.php, variable TinyMCEEditor::$array_tags3
$array_tags
in file parser.class.php, variable Parser::$array_tags
ADD_SLASHES
in file parser.class.php, constant ADD_SLASHES
add
in file site_map_section.class.php, method SiteMapSection::add()
    Adds an elemement to the section
add
in file site_map.class.php, method SiteMap::add()
    Adds an element to the elements list of the SiteMap
$auth
in file feed_item.class.php, variable FeedItem::$auth
$auth_bit
in file feed_data.class.php, variable FeedData::$auth_bit
add_child
in file feeds_cat.class.php, method FeedsCat::add_child()
    Adds a FeedsCat child to the current FeedsCat object
add_feed
in file feeds_list.class.php, method FeedsList::add_feed()
    Adds the FeedsCat $cat_tree to the current feeds list
add_item
in file feed_data.class.php, method FeedData::add_item()
ATOM
in file atom.class.php, class ATOM
    This class could load a feed by its url or by a FeedData element and export it to the ATOM format
ATOM
in file atom.class.php, method ATOM::ATOM()
    Builds a new ATOM object
atom.class.php
procedural page atom.class.php
top

b

build_administration_interface
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.
build_children_id_list
in file categories_manager.class.php, method CategoriesManager::build_children_id_list()
    Builds the list of all the children of a category
build_parents_id_list
in file categories_manager.class.php, method CategoriesManager::build_parents_id_list()
    Builds the list of the parent categories of a category
build_select_form
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.
BBCodeEditor
in file bbcode_editor.class.php, method BBCodeEditor::BBCodeEditor()
BBCodeEditor
in file bbcode_editor.class.php, class BBCodeEditor
    This class provides an interface editor for contents.
bbcode_editor.class.php
procedural page bbcode_editor.class.php
BBCodeHighlighter
in file bbcode_highlighter.class.php, method BBCodeHighlighter::BBCodeHighlighter()
    Builds a BBCodeHighlighter objet
BBCodeHighlighter
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).
BBCodeParser
in file bbcode_parser.class.php, method BBCodeParser::BBCodeParser()
    Builds a BBCodeParser object
BBCodeUnparser
in file bbcode_unparser.class.php, method BBCodeUnparser::BBCodeUnparser()
    Builds a BBCodeUnparser object
BBCodeUnparser
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.
BBCODE_HIGHLIGHTER_BLOCK_CODE
in file bbcode_highlighter.class.php, constant BBCODE_HIGHLIGHTER_BLOCK_CODE
BBCODE_HIGHLIGHTER_INLINE_CODE
in file bbcode_highlighter.class.php, constant BBCODE_HIGHLIGHTER_INLINE_CODE
BBCODE_LANGUAGE
in file content_formatting_factory.class.php, constant BBCODE_LANGUAGE
BBCODE_LIST_ITEM_COLOR
in file bbcode_highlighter.class.php, constant BBCODE_LIST_ITEM_COLOR
BBCODE_PARAM_COLOR
in file bbcode_highlighter.class.php, constant BBCODE_PARAM_COLOR
BBCODE_PARAM_NAME_COLOR
in file bbcode_highlighter.class.php, constant BBCODE_PARAM_NAME_COLOR
BBCODE_TAG_COLOR
in file bbcode_highlighter.class.php, constant BBCODE_TAG_COLOR
bbcode_highlighter.class.php
procedural page bbcode_highlighter.class.php
bbcode_parser.class.php
procedural page bbcode_parser.class.php
bbcode_unparser.class.php
procedural page bbcode_unparser.class.php
build_kernel_map
in file site_map.class.php, method SiteMap::build_kernel_map()
    Adds to the site map all the kernel links.
build_modules_maps
in file site_map.class.php, method SiteMap::build_modules_maps()
    Adds to the site map all maps of the installed modules
top

c

$cache_file_name
in file categories_manager.class.php, variable CategoriesManager::$cache_file_name
$cache_var
in file categories_manager.class.php, variable CategoriesManager::$cache_var
CACHE_TIME
in file search.class.php, constant CACHE_TIME
CACHE_TIMES_USED
in file search.class.php, constant CACHE_TIMES_USED
CategoriesManager
in file categories_manager.class.php, method CategoriesManager::CategoriesManager()
    Builds a CategoriesManager object
CategoriesManager
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.
CATEGORY_DOES_NOT_EXIST
in file categories_manager.class.php, constant CATEGORY_DOES_NOT_EXIST
CAT_UNVISIBLE
in file categories_manager.class.php, constant CAT_UNVISIBLE
CAT_VISIBLE
in file categories_manager.class.php, constant CAT_VISIBLE
change_visibility
in file categories_manager.class.php, method CategoriesManager::change_visibility()
    Changes the visibility of a category
check_display_config
in file categories_manager.class.php, method CategoriesManager::check_display_config()
    Checks if display configuration is good
check_error
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.
Comments
in file comments.class.php, method Comments::Comments()
    Display comments form.
Comments
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.
com_display_link
in file comments.class.php, method Comments::com_display_link()
categories_manager.class.php
procedural page categories_manager.class.php
comments.class.php
procedural page comments.class.php
ContentEditor
in file editor.class.php, method ContentEditor::ContentEditor()
ContentEditor
in file editor.class.php, class ContentEditor
    Abstract class for editors content.
$content
in file parser.class.php, variable Parser::$content
clear_html_br
in file bbcode_parser.class.php, method BBCodeParser::clear_html_br()
    Callback which clears the new line tag in the HTML generated code
content_formatting_factory.class.php
procedural page content_formatting_factory.class.php
content_parser.class.php
procedural page content_parser.class.php
content_second_parser.class.php
procedural page content_second_parser.class.php
content_unparser.class.php
procedural page content_unparser.class.php
ContentFormattingFactory
in file content_formatting_factory.class.php, method ContentFormattingFactory::ContentFormattingFactory()
    Builds a ContentFormattingFactoryy object
ContentFormattingFactory
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.
ContentParser
in file content_parser.class.php, method ContentParser::ContentParser()
    Buils a ContentParser object.
ContentParser
in file content_parser.class.php, class ContentParser
    This class is abstract. It contains tools that are usefull for implement a content parser.
ContentSecondParser
in file content_second_parser.class.php, method ContentSecondParser::ContentSecondParser()
    Builds a ContentSecondParser object
ContentSecondParser
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.
ContentUnparser
in file content_unparser.class.php, method ContentUnparser::ContentUnparser()
    Builds a ContentUnparser class.
$change_freq
in file site_map_link.class.php, variable SiteMapLink::$change_freq
$cat_name
in file feeds_cat.class.php, variable FeedsCat::$cat_name
$children
in file feeds_cat.class.php, variable FeedsCat::$children
cache
in file feed.class.php, method Feed::cache()
    Send the feed data in the cache
clear_cache
in file feed.class.php, method Feed::clear_cache()
    Clear the cache of the specified module_id.
top

d

$display_config
in file categories_manager.class.php, variable CategoriesManager::$display_config
DEBUG_MODE
in file categories_manager.class.php, constant DEBUG_MODE
del
in file comments.class.php, method Comments::del()
    Delete a comment
delete
in file categories_manager.class.php, method CategoriesManager::delete()
    Deletes a category.
delete_all
in file comments.class.php, method Comments::delete_all()
    Delete all comments for the specified item.
display
in file comments.class.php, method Comments::display()
    Display comments form.
DISPLAYING_CONFIGURATION_NOT_SET
in file categories_manager.class.php, constant DISPLAYING_CONFIGURATION_NOT_SET
display_form
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
DO_NOT_ADD_THIS_CATEGORY_IN_LIST
in file categories_manager.class.php, constant DO_NOT_ADD_THIS_CATEGORY_IN_LIST
DO_NOT_LOAD_CACHE
in file categories_manager.class.php, constant DO_NOT_LOAD_CACHE
display
in file tinymce_editor.class.php, method TinyMCEEditor::display()
    Display the editor
display
in file bbcode_editor.class.php, method BBCodeEditor::display()
    Display the editor
DEFAULT_LANGUAGE
in file content_formatting_factory.class.php, constant DEFAULT_LANGUAGE
DO_NOT_ADD_SLASHES
in file parser.class.php, constant DO_NOT_ADD_SLASHES
$depth
in file site_map_element.class.php, variable SiteMapElement::$depth
$description
in file module_map.class.php, variable ModuleMap::$description
$data
in file feed.class.php, variable Feed::$data
$date
in file feed_item.class.php, variable FeedItem::$date
$date
in file feed_data.class.php, variable FeedData::$date
$desc
in file feed_item.class.php, variable FeedItem::$desc
$desc
in file feed_data.class.php, variable FeedData::$desc
DEFAULT_ATOM_TEMPLATE
in file atom.class.php, constant DEFAULT_ATOM_TEMPLATE
DEFAULT_FEED_NAME
in file feed.class.php, constant DEFAULT_FEED_NAME
DEFAULT_RSS_TEMPLATE
in file rss.class.php, constant DEFAULT_RSS_TEMPLATE
top

e

$errors
in file categories_manager.class.php, variable CategoriesManager::$errors
$errors
in file search.class.php, variable Search::$errors
ERROR_CAT_IS_AT_BOTTOM
in file categories_manager.class.php, constant ERROR_CAT_IS_AT_BOTTOM
ERROR_CAT_IS_AT_TOP
in file categories_manager.class.php, constant ERROR_CAT_IS_AT_TOP
ERROR_UNKNOWN_MOTION
in file categories_manager.class.php, constant ERROR_UNKNOWN_MOTION
editor.class.php
procedural page editor.class.php
export_html_text
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.
$elements
in file site_map_section.class.php, variable SiteMapSection::$elements
$elements
in file site_map.class.php, variable SiteMap::$elements
export
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)
export
in file site_map_element.class.php, method SiteMapElement::export()
    Exports the element
export
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)
ERROR_GETTING_CACHE
in file feed.class.php, constant ERROR_GETTING_CACHE
export
in file feed.class.php, method Feed::export()
    Exports the feed as a string parsed by the <$tpl> template
top

f

$forbidden_tags
in file editor.class.php, variable ContentEditor::$forbidden_tags
$forbidden_tags
in file content_parser.class.php, variable ContentParser::$forbidden_tags
feed.class.php
procedural page feed.class.php
feeds_cat.class.php
procedural page feeds_cat.class.php
feeds_list.class.php
procedural page feeds_list.class.php
feed_data.class.php
procedural page feed_data.class.php
feed_item.class.php
procedural page feed_item.class.php
Feed
in file feed.class.php, method Feed::Feed()
    Builds a new feed object
Feed
in file feed.class.php, class Feed
    This class could be used to export feeds
FeedData
in file feed_data.class.php, class FeedData
    Contains meta-informations about a feed with its entries
FeedData
in file feed_data.class.php, method FeedData::FeedData()
    Builds a FeedData Object
FeedItem
in file feed_item.class.php, method FeedItem::FeedItem()
    Builds a FeedItem element
FeedItem
in file feed_item.class.php, class FeedItem
    Contains meta-informations and informations about a feed entry / item
FeedsCat
in file feeds_cat.class.php, method FeedsCat::FeedsCat()
    Builds a FeedsCat Object
FeedsCat
in file feeds_cat.class.php, class FeedsCat
    Describes a feed by building a category tree
FeedsList
in file feeds_list.class.php, class FeedsList
    This class contains an agregation of differents feeds
FeedsList
in file feeds_list.class.php, method FeedsList::FeedsList()
FEEDS_PATH
in file feed.class.php, constant FEEDS_PATH
FEED_DATA__CLASS
in file feed_data.class.php, constant FEED_DATA__CLASS
top

g

get_attribute
in file comments.class.php, method Comments::get_attribute()
get_attribute
in file note.class.php, method Note::get_attribute()
    Accessor
get_feeds_list
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.
get_forbidden_tags
in file editor.class.php, method ContentEditor::get_forbidden_tags()
    Get the fordidden tags.
get_template
in file editor.class.php, method ContentEditor::get_template()
    Get the template used for the editor.
get_available_tags
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.
get_forbidden_tags
in file content_parser.class.php, method ContentParser::get_forbidden_tags()
    Gets the forbidden tags.
get_language
in file content_formatting_factory.class.php, method ContentFormattingFactory::get_language()
    Returns the language of the factory
get_page_path
in file parser.class.php, method Parser::get_page_path()
    Returns the page path
get_parser
in file content_formatting_factory.class.php, method ContentFormattingFactory::get_parser()
    Returns a parser which will work in the language you chose.
get_path_to_root
in file parser.class.php, method Parser::get_path_to_root()
    Returns the path to root attribute.
get_second_parser
in file content_formatting_factory.class.php, method ContentFormattingFactory::get_second_parser()
    Returns a second parser which will work in the language you chose.
get_unparser
in file content_formatting_factory.class.php, method ContentFormattingFactory::get_unparser()
    Returns a unparser which will work in the language you chose.
get_user_editor
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
get_description
in file module_map.class.php, method ModuleMap::get_description()
    Return the module description
get_last_modification_date
in file site_map_link.class.php, method SiteMapLink::get_last_modification_date()
    Returns the last modification date of the target page
get_link
in file site_map_link.class.php, method SiteMapLink::get_link()
    Returns the URL of the link
get_link
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.
get_module_map_stream
in file site_map_export_config.class.php, method SitemapExportConfig::get_module_map_stream()
    Returns the Template object to use while exporting a ModuleMap object.
get_name
in file site_map_link.class.php, method SiteMapLink::get_name()
    Returns the name of the target page
get_name
in file site_map_element.class.php, method SiteMapElement::get_name()
    Returns the name of the menu
get_priority
in file site_map_link.class.php, method SiteMapLink::get_priority()
    Gets the priority of the link
get_section_stream
in file site_map_export_config.class.php, method SitemapExportConfig::get_section_stream()
    Returns the Template object to use while exporting a SiteMapSection object.
get_site_map_stream
in file site_map_export_config.class.php, method SitemapExportConfig::get_site_map_stream()
    Returns the Template object to use while exporting a SiteMap object.
get_site_name
in file site_map.class.php, method SiteMap::get_site_name()
    Returns the name of the site
get_url
in file site_map_link.class.php, method SiteMapLink::get_url()
    Returns the URL of the link
$guid
in file feed_item.class.php, variable FeedItem::$guid
get_auth
in file feed_item.class.php, method FeedItem::get_auth()
get_cache_file_name
in file feed.class.php, method Feed::get_cache_file_name()
    Returns the feed data cache filename
get_category_id
in file feeds_cat.class.php, method FeedsCat::get_category_id()
    Returns the category id
get_category_name
in file feeds_cat.class.php, method FeedsCat::get_category_name()
    Returns the category name
get_children
in file feeds_cat.class.php, method FeedsCat::get_children()
    Returns the current category children
get_date
in file feed_data.class.php, method FeedData::get_date()
get_date
in file feed_item.class.php, method FeedItem::get_date()
get_date_rfc822
in file feed_data.class.php, method FeedData::get_date_rfc822()
get_date_rfc822
in file feed_item.class.php, method FeedItem::get_date_rfc822()
get_date_rfc3339
in file feed_data.class.php, method FeedData::get_date_rfc3339()
get_date_rfc3339
in file feed_item.class.php, method FeedItem::get_date_rfc3339()
get_desc
in file feed_item.class.php, method FeedItem::get_desc()
get_desc
in file feed_data.class.php, method FeedData::get_desc()
get_feeds_list
in file feeds_list.class.php, method FeedsList::get_feeds_list()
    Returns the feeds list
get_feed_menu
in file feed.class.php, method Feed::get_feed_menu()
    Generates the code which shows all the feeds formats.
get_guid
in file feed_item.class.php, method FeedItem::get_guid()
get_host
in file feed_data.class.php, method FeedData::get_host()
get_image_url
in file feed_item.class.php, method FeedItem::get_image_url()
get_items
in file feed_data.class.php, method FeedData::get_items()
    Returns the feed items
get_lang
in file feed_data.class.php, method FeedData::get_lang()
get_link
in file feed_item.class.php, method FeedItem::get_link()
get_link
in file feed_data.class.php, method FeedData::get_link()
get_module_id
in file feeds_cat.class.php, method FeedsCat::get_module_id()
    Returns the module id
get_parsed
in file feed.class.php, method Feed::get_parsed()
    Export a feed
get_title
in file feed_data.class.php, method FeedData::get_title()
get_title
in file feed_item.class.php, method FeedItem::get_title()
get_url
in file feeds_cat.class.php, method FeedsCat::get_url()
    Returns the feed url
top

h

$html_auth
in file content_parser.class.php, variable ContentParser::$html_auth
$host
in file feed_data.class.php, variable FeedData::$host
top

i

$idcom
in file comments.class.php, variable Comments::$idcom
$idprov
in file note.class.php, variable Note::$idprov
$idprov
in file comments.class.php, variable Comments::$idprov
$id_search
in file search.class.php, variable Search::$id_search
$id_user
in file search.class.php, variable Search::$id_user
$is_kernel_script
in file comments.class.php, variable Comments::$is_kernel_script
IGNORE_AND_CONTINUE_BROWSING_IF_A_CATEGORY_DOES_NOT_MATCH
in file categories_manager.class.php, constant IGNORE_AND_CONTINUE_BROWSING_IF_A_CATEGORY_DOES_NOT_MATCH
INCORRECT_DISPLAYING_CONFIGURATION
in file categories_manager.class.php, constant INCORRECT_DISPLAYING_CONFIGURATION
insert_results
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)
INTEGRATED_IN_ENVIRONMENT
in file comments.class.php, constant INTEGRATED_IN_ENVIRONMENT
is_in_cache
in file search.class.php, method Search::is_in_cache()
    Returns true if the module results are in cache, else, false.
is_loaded
in file comments.class.php, method Comments::is_loaded()
    Check if the comments system is correctly loaded.
is_search_id_in_cache
in file search.class.php, method Search::is_search_id_in_cache()
    Returns true if the id_search is in cache, else, false.
$identifier
in file editor.class.php, variable ContentEditor::$identifier
$id
in file feeds_cat.class.php, variable FeedsCat::$id
$id_cat
in file feed.class.php, variable Feed::$id_cat
$image_url
in file feed_item.class.php, variable FeedItem::$image_url
$items
in file feed_data.class.php, variable FeedData::$items
is_in_cache
in file feed.class.php, method Feed::is_in_cache()
    Returns true if the feed data are in the cache
top

k

KERNEL_SCRIPT
in file comments.class.php, constant KERNEL_SCRIPT
top

l

$lock_com
in file comments.class.php, variable Comments::$lock_com
LOAD_CACHE
in file categories_manager.class.php, constant LOAD_CACHE
lock
in file comments.class.php, method Comments::lock()
    Lock or unlock comments for an item.
$language_type
in file editor.class.php, variable ContentEditor::$language_type
$language_type
in file content_formatting_factory.class.php, variable ContentFormattingFactory::$language_type
$last_modification_date
in file site_map_link.class.php, variable SiteMapLink::$last_modification_date
$link
in file site_map_section.class.php, variable SiteMapSection::$link
$link
in file site_map_link.class.php, variable SiteMapLink::$link
$link_file
in file site_map_export_config.class.php, variable SitemapExportConfig::$link_file
$lang
in file feed_data.class.php, variable FeedData::$lang
$link
in file feed_data.class.php, variable FeedData::$link
$link
in file feed_item.class.php, variable FeedItem::$link
$list
in file feeds_list.class.php, variable FeedsList::$list
load_data
in file feed.class.php, method Feed::load_data()
    Loads a FeedData element
load_file
in file rss.class.php, method RSS::load_file()
    Loads a feed by its url
load_file
in file feed.class.php, method Feed::load_file()
    Loads a feed by its url
load_file
in file atom.class.php, method ATOM::load_file()
    Loads a feed by its url
top

m

$modules
in file search.class.php, variable Search::$modules
$modules_conditions
in file search.class.php, variable Search::$modules_conditions
$module_folder
in file note.class.php, variable Note::$module_folder
$module_folder
in file comments.class.php, variable Comments::$module_folder
modules_in_cache
in file search.class.php, method Search::modules_in_cache()
    Returns the list of the modules ids present in the cache
move
in file categories_manager.class.php, method CategoriesManager::move()
    Moves a category (makes it gone up or down)
MOVE_CATEGORY_DOWN
in file categories_manager.class.php, constant MOVE_CATEGORY_DOWN
MOVE_CATEGORY_UP
in file categories_manager.class.php, constant MOVE_CATEGORY_UP
move_into_another
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.
$module_map_file
in file site_map_export_config.class.php, variable SitemapExportConfig::$module_map_file
module_map.class.php
procedural page module_map.class.php
ModuleMap
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).
ModuleMap
in file module_map.class.php, method ModuleMap::ModuleMap()
    Builds a ModuleMap object
$module_id
in file feeds_cat.class.php, variable FeedsCat::$module_id
$module_id
in file feed.class.php, variable Feed::$module_id
top

n

$nbr_com
in file comments.class.php, variable Comments::$nbr_com
$notation_scale
in file note.class.php, variable Note::$notation_scale
note.class.php
procedural page note.class.php
NEW_CATEGORY_IS_IN_ITS_CHILDRENS
in file categories_manager.class.php, constant NEW_CATEGORY_IS_IN_ITS_CHILDRENS
NEW_PARENT_CATEGORY_DOES_NOT_EXIST
in file categories_manager.class.php, constant NEW_PARENT_CATEGORY_DOES_NOT_EXIST
NEW_STATUS_UNKNOWN
in file categories_manager.class.php, constant NEW_STATUS_UNKNOWN
NORMAL_MODE
in file categories_manager.class.php, constant NORMAL_MODE
Note
in file note.class.php, method Note::Note()
    Create an new object Note.
Note
in file note.class.php, class Note
    This class provides you an easy way to manage notation.
NOTE_DISPLAY_BLOCK
in file note.class.php, constant NOTE_DISPLAY_BLOCK
NOTE_DISPLAY_NOTE
in file note.class.php, constant NOTE_DISPLAY_NOTE
NOTE_NODISPLAY_NBRNOTES
in file note.class.php, constant NOTE_NODISPLAY_NBRNOTES
NOT_RECURSIVE_EXPLORATION
in file categories_manager.class.php, constant NOT_RECURSIVE_EXPLORATION
$name
in file site_map_link.class.php, variable SiteMapLink::$name
$name
in file feed.class.php, variable Feed::$name
top

o

$options
in file note.class.php, variable Note::$options
top

p

$path
in file note.class.php, variable Note::$path
$path
in file comments.class.php, variable Comments::$path
POP_UP_WINDOW
in file comments.class.php, constant POP_UP_WINDOW
PRODUCTION_MODE
in file categories_manager.class.php, constant PRODUCTION_MODE
$page_path
in file parser.class.php, variable Parser::$page_path
$path_to_root
in file parser.class.php, variable Parser::$path_to_root
parser.class.php
procedural page parser.class.php
parse
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.
PARSER_DO_NOT_STRIP_SLASHES
in file parser.class.php, constant PARSER_DO_NOT_STRIP_SLASHES
PARSER_STRIP_SLASHES
in file parser.class.php, constant PARSER_STRIP_SLASHES
PICK_UP
in file parser.class.php, constant PICK_UP
$priority
in file site_map_link.class.php, variable SiteMapLink::$priority
top

r

RECURSIVE_EXPLORATION
in file categories_manager.class.php, constant RECURSIVE_EXPLORATION
REIMPLANT
in file parser.class.php, constant REIMPLANT
rss.class.php
procedural page rss.class.php
read
in file feed.class.php, method Feed::read()
    Loads the feed data in cache and export it
RSS
in file rss.class.php, method RSS::RSS()
    Builds a new RSS object
RSS
in file rss.class.php, class RSS
    This class could load a feed by its url or by a FeedData element and export it to the RSS format
top

s

$script
in file comments.class.php, variable Comments::$script
$script
in file note.class.php, variable Note::$script
$script_path
in file note.class.php, variable Note::$script_path
$search
in file search.class.php, variable Search::$search
$sql_table
in file comments.class.php, variable Comments::$sql_table
$sql_table
in file note.class.php, variable Note::$sql_table
search.class.php
procedural page search.class.php
Search
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)
Search
in file search.class.php, class Search
set_arg
in file comments.class.php, method Comments::set_arg()
    Set argument for the comments system.
set_display_config
in file categories_manager.class.php, method CategoriesManager::set_display_config()
    Method which sets the displaying configuration Config example $config = array( 'xmlhttprequest_file' => 'xmlhttprequest.php', 'administration_file_name' => 'admin_news_cats.php', 'url' => array( 'unrewrited' => PATH_TO_ROOT . '/news/news.php?id=%d', 'rewrited' => PATH_TO_ROOT . '/news-%d+%s.php' ), );
STOP_BROWSING_IF_A_CATEGORY_DOES_NOT_MATCH
in file categories_manager.class.php, constant STOP_BROWSING_IF_A_CATEGORY_DOES_NOT_MATCH
set_forbidden_tags
in file editor.class.php, method ContentEditor::set_forbidden_tags()
    Set the forbidden tags
set_identifier
in file editor.class.php, method ContentEditor::set_identifier()
    Set the html identifier of the textarea field which contain the content to edit.
set_template
in file editor.class.php, method ContentEditor::set_template()
    Set an alternative template for the editor.
set_content
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.
set_forbidden_tags
in file content_parser.class.php, method ContentParser::set_forbidden_tags()
    Sets the tags which mustn't be parsed.
set_html_auth
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.
set_language
in file content_formatting_factory.class.php, method ContentFormattingFactory::set_language()
    Changes the language of the factory
set_page_path
in file parser.class.php, method Parser::set_page_path()
    Sets the page path
set_path_to_root
in file parser.class.php, method Parser::set_path_to_root()
    Sets the reference path for relative URL
$section_file
in file site_map_export_config.class.php, variable SitemapExportConfig::$section_file
$site_map_file
in file site_map_export_config.class.php, variable SitemapExportConfig::$site_map_file
$site_name
in file site_map.class.php, variable SiteMap::$site_name
site_map.class.php
procedural page site_map.class.php
site_map_element.class.php
procedural page site_map_element.class.php
site_map_export_config.class.php
procedural page site_map_export_config.class.php
site_map_link.class.php
procedural page site_map_link.class.php
site_map_section.class.php
procedural page site_map_section.class.php
set_change_freq
in file site_map_link.class.php, method SiteMapLink::set_change_freq()
    Sets the change frequency
set_depth
in file site_map_section.class.php, method SiteMapSection::set_depth()
    Sets the depth of the element
set_depth
in file site_map_element.class.php, method SiteMapElement::set_depth()
    Sets the depth of the element
set_description
in file module_map.class.php, method ModuleMap::set_description()
    Sets the description of the module
set_last_modification_date
in file site_map_link.class.php, method SiteMapLink::set_last_modification_date()
    Sets the last modification date of the target page
set_link
in file site_map_link.class.php, method SiteMapLink::set_link()
    Sets the URL of the link
set_link
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.
set_module_map_stream
in file site_map_export_config.class.php, method SitemapExportConfig::set_module_map_stream()
    Sets the Template object to use while exporting a ModuleMap object.
set_name
in file site_map_link.class.php, method SiteMapLink::set_name()
    Sets the name of the element
set_priority
in file site_map_link.class.php, method SiteMapLink::set_priority()
    Sets the priority of the link
set_section_stream
in file site_map_export_config.class.php, method SitemapExportConfig::set_section_stream()
    Sets the Template object to use while exporting a SiteMapSection object.
set_site_map_stream
in file site_map_export_config.class.php, method SitemapExportConfig::set_site_map_stream()
    Sets the Template object to use while exporting a Site object.
set_site_name
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
SiteMapElement
in file site_map_element.class.php, method SiteMapElement::SiteMapElement()
    Builds a SiteMapElement object
SiteMapElement
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.
SitemapExportConfig
in file site_map_export_config.class.php, method SitemapExportConfig::SitemapExportConfig()
    Builds a SiteMapExportConfig object
SitemapExportConfig
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.
SitemapLink
in file site_map_link.class.php, method SiteMapLink::SitemapLink()
    Builds a SiteMapLink object
SiteMapLink
in file site_map_link.class.php, class SiteMapLink
    This class represents a link of a site map.
SiteMapSection
in file site_map_section.class.php, class SiteMapSection
    This class represents a section of a site map.
SiteMapSection
in file site_map_section.class.php, method SiteMapSection::SiteMapSection()
    Builds a SiteMapSection object
SITE_MAP_AUTH_GUEST
in file site_map.class.php, constant SITE_MAP_AUTH_GUEST
    The site map will be seen by every body, only the public elements must appear
SITE_MAP_AUTH_USER
in file site_map.class.php, constant SITE_MAP_AUTH_USER
    The site map is for the current user.
SITE_MAP_FREQ_ALWAYS
in file site_map.class.php, constant SITE_MAP_FREQ_ALWAYS
SITE_MAP_FREQ_DAILY
in file site_map.class.php, constant SITE_MAP_FREQ_DAILY
SITE_MAP_FREQ_DEFAULT
in file site_map.class.php, constant SITE_MAP_FREQ_DEFAULT
SITE_MAP_FREQ_HOURLY
in file site_map.class.php, constant SITE_MAP_FREQ_HOURLY
SITE_MAP_FREQ_MONTHLY
in file site_map.class.php, constant SITE_MAP_FREQ_MONTHLY
SITE_MAP_FREQ_NEVER
in file site_map.class.php, constant SITE_MAP_FREQ_NEVER
SITE_MAP_FREQ_WEEKLY
in file site_map.class.php, constant SITE_MAP_FREQ_WEEKLY
SITE_MAP_FREQ_YEARLY
in file site_map.class.php, constant SITE_MAP_FREQ_YEARLY
SITE_MAP_PRIORITY_AVERAGE
in file site_map.class.php, constant SITE_MAP_PRIORITY_AVERAGE
SITE_MAP_PRIORITY_HIGH
in file site_map.class.php, constant SITE_MAP_PRIORITY_HIGH
SITE_MAP_PRIORITY_LOW
in file site_map.class.php, constant SITE_MAP_PRIORITY_LOW
SITE_MAP_PRIORITY_MAX
in file site_map.class.php, constant SITE_MAP_PRIORITY_MAX
SITE_MAP_PRIORITY_MIN
in file site_map.class.php, constant SITE_MAP_PRIORITY_MIN
SITE_MAP_SEARCH_ENGINE_MODE
in file site_map.class.php, constant SITE_MAP_SEARCH_ENGINE_MODE
    It will be for the search engines (sitemap. can be forgotten in that case.
SITE_MAP_USER_MODE
in file site_map.class.php, constant SITE_MAP_USER_MODE
    It will be a page of the site containing the site map
$str
in file feed.class.php, variable Feed::$str
serialize
in file feed_data.class.php, method FeedData::serialize()
set_auth
in file feed_item.class.php, method FeedItem::set_auth()
    Sets the feed item auth, useful to check authorizations
set_auth_bit
in file feed_data.class.php, method FeedData::set_auth_bit()
    Sets the feed auth bit, useful to check authorizations
set_date
in file feed_item.class.php, method FeedItem::set_date()
    Sets the feed item date
set_date
in file feed_data.class.php, method FeedData::set_date()
    Sets the feed data date
set_desc
in file feed_data.class.php, method FeedData::set_desc()
    Sets the feed description
set_desc
in file feed_item.class.php, method FeedItem::set_desc()
    Sets the feed item description
set_guid
in file feed_item.class.php, method FeedItem::set_guid()
    Sets the feed item guid
set_host
in file feed_data.class.php, method FeedData::set_host()
    Sets the feed host
set_image_url
in file feed_item.class.php, method FeedItem::set_image_url()
    Sets the feed item picture
set_lang
in file feed_data.class.php, method FeedData::set_lang()
    Sets the feed language
set_link
in file feed_data.class.php, method FeedData::set_link()
    Sets the feed item link
set_link
in file feed_item.class.php, method FeedItem::set_link()
    Sets the feed item link
set_title
in file feed_item.class.php, method FeedItem::set_title()
    Sets the feed item title
set_title
in file feed_data.class.php, method FeedData::set_title()
    Sets the feed title
subitems
in file feed_data.class.php, method FeedData::subitems()
    Returns a items list containing $number items starting from the $begin_at one
top

t

$table
in file categories_manager.class.php, variable CategoriesManager::$table
$template
in file editor.class.php, variable ContentEditor::$template
tinymce_editor.class.php
procedural page tinymce_editor.class.php
TinyMCEEditor
in file tinymce_editor.class.php, method TinyMCEEditor::TinyMCEEditor()
TinyMCEEditor
in file tinymce_editor.class.php, class TinyMCEEditor
    This class provides an interface editor for contents.
$tag
in file content_parser.class.php, variable ContentParser::$tag
template_highlighter.class.php
procedural page template_highlighter.class.php
tinymce_parser.class.php
procedural page tinymce_parser.class.php
tinymce_unparser.class.php
procedural page tinymce_unparser.class.php
TemplateHighlighter
in file template_highlighter.class.php, method TemplateHighlighter::TemplateHighlighter()
    Build a TemplateHighlighter object.
TemplateHighlighter
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.
TinyMCEParser
in file tinymce_parser.class.php, method TinyMCEParser::TinyMCEParser()
    Builds this kind of parser
TinyMCEUnparser
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.
TinyMCEUnparser
in file tinymce_unparser.class.php, method TinyMCEUnparser::TinyMCEUnparser()
    Builds a TinyMCEUnparser object
TINYMCE_LANGUAGE
in file content_formatting_factory.class.php, constant TINYMCE_LANGUAGE
TPL_BRACES_STYLE
in file template_highlighter.class.php, constant TPL_BRACES_STYLE
TPL_KEYWORD_STYLE
in file template_highlighter.class.php, constant TPL_KEYWORD_STYLE
TPL_NESTED_VARIABLE_STYLE
in file template_highlighter.class.php, constant TPL_NESTED_VARIABLE_STYLE
TPL_SHARP_STYLE
in file template_highlighter.class.php, constant TPL_SHARP_STYLE
TPL_VARIABLE_STYLE
in file template_highlighter.class.php, constant TPL_VARIABLE_STYLE
$title
in file feed_item.class.php, variable FeedItem::$title
$title
in file feed_data.class.php, variable FeedData::$title
$tpl
in file feed.class.php, variable Feed::$tpl
top

u

update
in file comments.class.php, method Comments::update()
    Edit a comment
update_cache
in file feed.class.php, method Feed::update_cache()
    Update the cache of the $module_id, $name, $idcat feed with $data
top

v

$vars
in file comments.class.php, variable Comments::$vars
top
Documentation generated on Tue, 28 Jul 2009 22:43:33 +0200 by phpDocumentor 1.4.1