Docs For Class charcoal

Description

Habari Theme Class

version: $Id$
copyright: 2008

Located in /system/themes/charcoal/theme.php (line 5)

Pluggable
   |
   --Theme
      |
      --charcoal

Class Constant Summary

DISPLAY_LOGIN = true

HOME_LABEL = 'Blog'

SHOW_ENTRY_PAPERCLIP = true

SHOW_PAGE_PAPERCLIP = false

SHOW_POST_NAV = true

SHOW_POWERED = true

SHOW_TITLE_IMAGE = false

TAGS_IN_MULTIPLE = false

Method Summary

void action_init_theme ()

void add_template_vars ()

void filter_post_content_excerpt ( $return)

string filter_post_tags_out (array $array)

void theme_post_comments_link ( $theme, $post, $zero, $one, $more)

void theme_search_form ( $theme)

void theme_search_prompt ( $theme, $criteria, $has_results)

void theme_show_tags ( $theme)

Variables

Inherited Variables

Inherited from Theme

Theme::$config_vars
Theme::$template_engine
Theme::$theme_dir
Theme::$valid_filters

Inherited from Pluggable

Pluggable::$info
Pluggable::$plugin_id

Methods

action_init_theme (line 34)

Execute on theme init to apply these filters to output

access: public

void action_init_theme ()

add_template_vars (line 47)

Add some variables to the template output

access: public

void add_template_vars ()

Redefinition of:

Theme::add_template_vars(): Assign the default variables that would be used in every template

filter_post_content_excerpt (line 107)

access: public

void filter_post_content_excerpt ( $return)

$return

filter_post_tags_out (line 81)

Convert a post's tags array into a usable list of links

return: The HTML of the linked tags
access: public

string filter_post_tags_out (array $array)

array $array: The tags array from a Post object

theme_post_comments_link (line 92)

access: public

void theme_post_comments_link ( $theme, $post, $zero, $one, $more)

$theme
$post
$zero
$one
$more

theme_search_form (line 135)

access: public

void theme_search_form ( $theme)

$theme

theme_search_prompt (line 112)

access: public

void theme_search_prompt ( $theme, $criteria, $has_results)

$theme
$criteria
$has_results

theme_show_tags (line 143)

Returns an unordered list of all used Tags

access: public

void theme_show_tags ( $theme)

$theme

Inherited Methods

Inherited From Theme

Theme::__construct()
Theme::act_display()
Theme::act_display_404()
Theme::act_display_date()
Theme::act_display_entries()
Theme::act_display_home()
Theme::act_display_post()
Theme::act_display_tag()
Theme::act_search()
Theme::add_template_vars()
Theme::assign()
Theme::display()
Theme::display_fallback()
Theme::end_buffer()
Theme::fetch()
Theme::fetch_unassigned()
Theme::info()
Theme::start_buffer()
Theme::template_exists()
Theme::theme_comment_form_action()
Theme::theme_content()
Theme::theme_feed_alternate()
Theme::theme_footer()
Theme::theme_header()
Theme::theme_next_page_link()
Theme::theme_page_selector()
Theme::theme_prev_page_link()
Theme::__call()
Theme::__get()
Theme::__isset()
Theme::__set()
Theme::__unset()

Inherited From Pluggable

Pluggable::__construct()
Pluggable::get_db_schema()
Pluggable::get_file()
Pluggable::get_url()
Pluggable::load()
Pluggable::load_text_domain()
Pluggable::plugin_id()

Class Constants

DISPLAY_LOGIN = true (line 23)

HOME_LABEL = 'Blog' (line 11)

SHOW_ENTRY_PAPERCLIP = true (line 14)

SHOW_PAGE_PAPERCLIP = false (line 17)

SHOW_POST_NAV = true (line 29)

SHOW_POWERED = true (line 20)

SHOW_TITLE_IMAGE = false (line 8)

TAGS_IN_MULTIPLE = false (line 26)