Class: Page

Source Location: /classes/page_class.inc

Class Page

Class Overview

The Page class is used to build and compile pages.

Located in /classes/page_class.inc [line 14]

Cache
   |
   --Page

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
EventDisplay	class to help render display parts of the calendar.
admin_cities	generates bottom-style default cities lists
admin_email	let you edit and send out a newsletter.
admin_index	empty class for the administration
archive_display_by_date	Display 5 archived features of a given category per page.
archive_display_calendar	creates a calendar style overview of archived features
archive_display_list	displays the list of archived features
archive_generate	class to regenerate feature archives
archive_generate_weeks	unused class
archive_index	index page of the archive pages.
archive_week_redirect	redericts you to the right archive page coming from the archive-calendar
article_bulk_status_change	updates the status of multiple articles and recaches them.
article_display_list	displays a search and facilitates administrating articles.
article_edit	page to edit articles.
comment	displays a form to be used to publish comments to articles.
upload_display_list	allows you to upload files to directories defined in the sfactive.cfg file
article_regenerate	page to mass recache articles.
authenticate	authenticates a user to the administration.
authenticate_display_logon	displays the form where users can login to the administration.
calendar_admin_index	Index page, with search, for the admin section of the calendar
calendar_delete	Deletes an event out of the database and updates minical & rdf.
calendar_display_location_add	adds a location to the dbase.
calendar_display_location_delete	deletes a location from the database.
calendar_display_location_edit	displays a form to be used for adding or editing locations.
calendar_display_location_list	displays a list of locations
calendar_display_location_update	updates a location in the dbase
calendar_display_topic_add	Adds an event-topic to the database
calendar_display_topic_delete	deletes an event-topic from the database and updates all events who depend on it.
calendar_edit	pages to update events.
calendar_display_topic_edit	displays a form to be used for adding or editing topics.
calendar_display_topic_list	Displays a list of the available event-topics in the database.
calendar_display_topic_update	updates and event-topic in the database
calendar_display_type_add	adds and event-type to the database
calendar_display_type_delete	deletes an event-type from the database and edits events who links to it.
calendar_display_type_edit	displays a form to be used for adding or editing types.
calendar_display_type_list	display the list of available event-types.
calendar_display_type_update	updates an event-type in the database
calendar_event_display_lookup	returns the confirmation number for a given event.
calendar_event_refresh_all	recaches all static html for the calendar
category_add	adds a category to the dbase with information from $_POST
category_display_edit	displays a form to add or edit a category.
category_display_list	displays the list of categories available in the database.
category_display_preview	displays a rendered centre-column so you can view it before pushing it to production
category_display_pushtoproduction_confirmation	caches the rss feeds and single feature archives for a certain category
Syndication_index	display a list of syndicatin feeds available on the system.
category_pushtoproduction	write a centre-column to disk and redirects to category_display_pushtoproduction_confirmation
category_reorder
category_update
comment_latest	displays the list of latest comments.
content_page	Class for content_page page
css_viewer	displays a form to edit a style sheet.
display_by_id	displays a feature given it's id or version id.
dossier_admin_index	displays a list of dossiers and admin options for these dossiers.
dossier_admin_statuschange	updates the status of the articles connected to a certain dossier and redirects to dossier_admin_index on success
dump_by_id	renders a single feature archive. seems unused.
dossier_article	page to add, edit and updates articles in a dossier.
dossier_dossier	displays a dossier (= feature + threaded list of articles) given it's id.
dossier_feature	displays a form to either edit or add a feature to a dossier
dossier_feature_add	adds the feature of a dossier to the database with status 'hidden'
dossier_feature_update	updates a feature in the database and redirects to dossier_list on success
dossier_list	displays a list of dossiers with some options.
dossier_refresh	refreshes the articles and features of a dossier given a dossier id
event_display_add	page to add events to the calendar.
event_display_add_confirm	displays a page with the confirmation number of the published events.
event_display_delete	deletes an event from the database and updates appropriate cached html
event_display_detail	displays detail information on an event.
event_display_edit	pages to update events.
event_display_event	renders the html for an event.
event_display_ical	displays an ical file of an event.
event_display_list	This file displays a list of events for printing
event_display_week	displays the main page of the calendar
event_search	Index page, with search, for the admin section of the calendar
feature_add	adds a feature to the database. redirects to feature_display_list
feature_change_status	updates the status of a feature in the database and redirects to feature_display_list
feature_copy	displays a form to either copy a feature or to edit the copied feature in a new category.
feature_copy_redirect	sets some values for the copy-feature and redirects to feature_display_edit
feature_delete	a class to archive a feature.
feature_display_copy	display page to copy feature
feature_display_edit	displays a form to be used to add or edit a feature and to promote an article to a feature.
feature_display_history	displays a list of all versions of a given feature
feature_display_list	displays the list of features for a given category and a given status.
feature_list	displays a list of features with their description for use at SF_FEATURE_URL
feature_reorder	reorders a list of features.
feature_undelete	seems a bogus page ...
feature_update	updates a feature in the database and redirects to feature_display_list
file_viewer	class used to edit files like comment_latest.inc
hidden	displays a page with the hidden articles.
image_browser	class to display images in website/images/ and website/im/
include_viewer	Class to edit includes.
language_add	Adds a language to your system.
language_display_edit	displays a form that you can use to add or edit a language
language_display_list	page to list the languages available on your system.
language_hide	hides a language in your site.
language_reorder	reorders the langauges in your system.
language_update	Updates a language in the database
newsroom_index	Newsroom admin section
mailable	page to let you email an article to someone.
mailinglist	allows you to subscribe to a newsletter-mailinglist.
network	displays the cities list divided into sections on sitename/website/network.php
search_page	class for searching articles.
page_viewer	page to edit process pages (located in sitename/local/cache/pages)
printable	displays an article so you can print it out easily.
publish	Allows you to publish or validate articles to the system.
xml	dynamically displays newswires/articles in an xml format
refresh	Allows you to refresh a newswire when you're logged into the admin.
spam	displays the text on the publish page when someone is blocked.
upload_display_add	allows you to upload files to directories defined in the sfactive.cfg file
template_viewer	allows to edit templates located in local/templates/
translate_form	displays a translate form at sitename/website/translate_form.php (seems unused)
feature_search	Class/Page to allow searching features
user_add	Adds a user to the database given an array with all userfields.
user_delete	deletes a user from the database.
user_display_edit	class that presents a form where you can edit and add users to the database.
user_display_list	Displays a list of users.
user_update	updates the user in the database after password security check.
feature_photo_activate	Feature Photo Activate Class
feature_photo_add	displays a form to be used to add or edit feature_photo's
feature_photo_change_status	changes the status of a feature_photo
feature_photo_list	displays a list of feature_photo's
feature_photo_reorder	displays a list of feature_photo's
feature_photo_update	updates a feature_photo in the database and redirects to feature_photo_list
search_index	An introduction page to the new search system.
dictionary_display_list	Displays a list of dictionaries
dictionary_edit	Displays a list of dictionaries
admin_css_index	displays 4 columns with respective lists of css, templates, includes and process pages.
admin_includes_index	displays 4 columns with respective lists of css, templates, includes and process pages.
admin_pages_index	displays 4 columns with respective lists of css, templates, includes and process pages.
admin_templates_index	displays 4 columns with respective lists of css, templates, includes and process pages.
newsroom_add_widget_template	Newsroom admin section
newsroom_edit_template	Newsroom admin section
newsroom_edit_widget	Newsroom admin section
newsroom_edit_widget_template	Newsroom admin section
newsroom_export_widget	Newsroom admin section
newsroom_page_add	Newsroom admin section
newsroom_page_admin	Newsroom admin section
newsroom_setup	Newsroom admin section
newsroom_page_layout	Newsroom admin section
newsroom_page_preview	Newsroom admin section
newsroom_widgets	Newsroom admin section
admin_header	Displays the menu for your admin section
admin_my_account	Class for changing a user's own account
admin_my_update	updates the user in the database after password security check.
article_cache	Page to regenerate article related pages. (articles, newswires, media_galleries
calendar_display_cache	admin page to administer caching parts of your calendar data
comment_edit	page to edit articles.
feature_cache	page to regenerate mainly archives/feature related pages
admin_advanced	Allows advanced editing of certain configuration settings
archive_by_id	displays a single feature
article_display_medialist	Allows you to view a list of files uploaded for a certain month.
category_display_cache	class to cache category specific stuff
Gallery	make galleries of uploaded files

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Cache

Cache::$allowed_html_tags

Cache::$allowed_text_tags

Cache::$cachestatus

Cache::$errorstatus

Cache::$upload_target_url

Inherited From Cache

Cache::cache_file()

writes a file to disk given it's content and the path.

Cache::cache_ram_file()

caches a ram file to disk given a upload target, a year and a month.

Cache::cache_var()

Writes an array or other variable to disk, in a php-readable format

Cache::check_file_path()

this method will check if your filepath is ok (so no .. and stuff like that).

Cache::clean()

adds slashes to a string if get_magic_quotes_runtime isn't set

Cache::cleanup_email()

cleans up an email_address

Cache::cleanup_filename()

cleans up the name of file

Cache::cleanup_html_value()

cleans up a value that is published as html

Cache::cleanup_number()

cleans up a number

Cache::cleanup_pathname()

cleans up the name of a path.

Cache::cleanup_post()

Removes dangerous HTML from data submitted via POST

Cache::cleanup_text_value()

cleans up a value that is allowed to contain limited html (an article submitted as text/plain)

Cache::cleanup_value()

cleans up a value that should not contain any html at all (the normal procedure)

Cache::clear_error_status()

Clears any existing error status

Cache::clear_update_status()

Clears any existing update status

Cache::create_dir_recursive()

creates a directory recursively

Cache::create_upload_dirs()

this will create the directories we move the article and uploaded files to if they don't exist yet

Cache::display_error_status()

displays the error status.

Cache::do_form()

calls the form we want to use in the publish process given it's name and various options.

Cache::dump()

dumps a variable encapsulated in html

Cache::get_allowed_html_tags()

returns $allowed_html_tags

Cache::get_allowed_text_tags()

returns {$link $allowed_text_tags}

Cache::get_antispam_mail()

returns an emailaddress with antispam blocks in.

Cache::get_cached_var()

Retrieve a cached variable from disk

Cache::get_error_status()

returns the $errorstatus

Cache::get_months()

returns an array of months from 01 to 12

Cache::get_update_status()

returns the $cachestatus

Cache::get_years()

returns an array of years for your calendar

Cache::is_error()

Returns true if there is an existing error

Cache::list_directories()

List the directories in the specified path

Cache::list_files()

Lists the files in the specified directory path

Cache::make_checkbox_form()

renders a checkbox form given it's name, an array with options and an option-array to preselect

Cache::make_multiple_form()

renders a multiple given it's name, an array with options and an option-array to preselect

Cache::make_select_form()

renders a select form given it's name, an array with options and an option to preselect

Cache::make_video_thumbnail()

make a "video thumbnail" of a video uploads

Cache::mirror_html()

mirrors your html files.

Cache::mirror_media()

mirrors your media files

Cache::process_file_metadata()

gets metadata from media file headers and stores them

Cache::process_uploads()

process any uploads from a POST

Cache::rel2abs()

Replaces any relative links with absolute links

Cache::rel2absfield()

Like rel2abs, replaces relative links with absolute links

Cache::render_entities()

strips tags and replaces <,> & ' out of a given html string by their htmlentities

Cache::render_protest_date()

This creates the protest-style dates, like J18 given an input date-string.

Cache::render_var()

Renders an array or other variable into php code

Cache::render_yearmonth_link()

returns a file path given a year and month

Cache::replace_rte_tags()

startx: replaces ugly tags from rte editor

Cache::set_allowed_html_tags()

sets $allowed_html_tags

Cache::set_allowed_text_tags()

sets $allowed_text_tags

Cache::set_date_from_smarty()

sets a unix timestamp from a smarty date array

Cache::set_mysql_date_from_smarty()

sets a mysql datetime from a smarty date/time array

Cache::sf_error_log()

logs an error. (don't know how it's used atm)

Cache::update_error_status()

Allows easy access to adding an update string

Cache::update_status()

Allows easy access to adding an update string

Cache::validate_event_post()

does error checking for $_POST data for a posted event.

Cache::validate_post()

does error checking on $_POST data for an article or comment.

Cache::validate_uploads()

error checking for files submitted via POST

[ Top ]

Property Summary

array	$error	contains the template errors
object	$template	sets the template object.
array	$tkeys	array containing the template variables
object	$tr	the translation object

[ Top ]

Method Summary

Page	Page()	class constructor; begins setting page properties
bool	build_page()	builds the page and sets $this->html.
void	force_new_template()	forces a new template to be used.
$this->error\|false	get_error()	returns the errors
string	get_html()	returns the html of the page.
void	set_tr()	sets the translation object

[ Top ]

Properties

array $error = '' [line 20]

contains the template errors

[ Top ]

object $template [line 25]

sets the template object.

[ Top ]

array $tkeys [line 31]

array containing the template variables

[ Top ]

object $tr [line 36]

the translation object

[ Top ]

Methods

Constructor Page [line 42]

Page Page(
[string
$pageid = ''] 
)

class constructor; begins setting page properties

Parameters:

string

$pageid:

name of the page to build

[ Top ]

build_page [line 123]

bool build_page(
[string
$content_page = ''] 
)

builds the page and sets $this->html.

Parameters:

string

$content_page:

[ Top ]

force_new_template [line 155]

void force_new_template(
string
$template_name 
)

forces a new template to be used.

Parameters:

string

$template_name:

[ Top ]

get_error [line 107]

$this->error|false get_error(
)

returns the errors

[ Top ]

get_html [line 146]

string get_html(
)

returns the html of the page.

[ Top ]

set_tr [line 99]

void set_tr(
object
&$tr 
)

sets the translation object

Parameters:

object

$tr:

[ Top ]

Documentation generated on Tue, 24 Jun 2008 01:03:51 -0700 by phpDocumentor 1.3.0RC3

	sf-active base_classes

[ class tree: sf-active ] [ index: sf-active ] [ all elements ]