• Home
• gb

PHP Class gb, gitblog

These values can be overridden in gb-config.php (or somewhere else for that matter). 显示文件 Open project: rsms/gitblog Class Usage Examples

Public Properties

Property	Type	Description
$_authenticators
$authorized		# Admin authentication
$categories_prefix		URL prefix for categories
$comments_cache_fnext
$content_cache_fnext
$data_store_class		# data -- arbitrary key-value storage
$data_stores
$deferred		# defer -- Delayed execution
$deferred_time_limit
$dir		Absolute path to the gitblog directory
$errors		Themes should take care of this and display these error messages where appropriate.
$events		# Events
$feed_prefix		URL prefix for the feed
$filters		# Filters
$index_cache_fnext
$index_prefix		URL to gitblog index _relative_ to gb::$site_url
$is_404
$is_categories
$is_feed
$is_internal_call		True if some part of gitblog (inside the gitblog directory) is the initial invoker
$is_page
$is_post
$is_posts
$is_preview		This is automatically set to true by the request handler (end of this file) when all of the following are true: - gb::$preview_query_key is set in the query string (i.e. "?preview") - Client is authorized (gb::$authorized is non-false)
$is_search
$is_tags
$log_cb
$log_filter		Disable logging by setting this to -1. See the "Logging" section in gitblog.php for more information.
$log_open		# Logging
$object_indices		# reading object indices
$pages_prefix		URL prefix for pages
$pathspec_query_key		When this query string key is set and gb::$is_preview is true, the object specified by pathspec is loaded. This overrides parsing the URI and is needed in cases where there are multiple posts with the same name but with different file extensions (content types).
$plugins_loaded		# Plugins
$posts_cn_pattern		The granularity of this date is the "bottleneck", or "limiter", for $posts_prefix. If you specify "%Y", $posts_prefix can define patterns with granularity ranging from year to second. But if you set this parameter to "%Y/%m/%d-" the minimum granularity of $posts_prefix goes up to day, which means that this: $posts_prefix = '%Y/%m/' will not work, as day is missing. However this: $posts_prefix = '%y-%m-%e/' and $posts_prefix = '%y/%m/%e/%H/%M/' works fine, as they both have a granularity of one day or more. It's recommended not to alter this value. The only viable case where altering this is if you are posting many many posts every day, thus adding day ($posts_cn_pattern = '%Y/%m/%d-') would give a slight file system performance improvement on most file systems.
$posts_fuzzy_lookup		Enables fuzzy URI matching of posts
$posts_pagesize		Number of posts per page.
$posts_prefix		Need to specify at least year and month. Day, time and so on is optional. Changing this parameter does not affect the cache.
$preview_query_key		When this query string key is set and the client is authorized, the same effect as setting $version_query_key to "work" is achieved.
$rebuilders		# GitBlog
$request_query		'PATH_INFO' or any other string which will then be matched in $_GET[string]
$secret		Shared secret
$settings		A JSONDict
$site_description		Site description
$site_dir		Absolute path to the site root
$site_path		Absolute URL path (i.e. starts with a slash) to the site root
$site_state		Contains the site.json structure or null if not loaded
$site_title		Site title
$site_url		Absolute URL to the site root, not including gb::$index_prefix
$tags_prefix		URL prefix for tags
$theme_dir		Absolute path to current theme. Available when running a theme.
$theme_url		Absolute URL to current theme. Available when running a theme.
$title		# The following are used at runtime.
$version		# Constants
$version_query_key		When this query string key is set and the client is authorized, the specified version of a viewed post is displayed rather than the live version.

Protected Properties

Property	Type	Description
$current_url		# Info about the Request

Public Methods

Method	Description
add_filter ( $tag, $func, $priority = 100 )	Add a filter
authenticate ( $force = true, $context = 'gb-admin' )
authenticator ( $context = 'gb-admin' )
categories ( $indexname = 'category-to-objs' )
data ( $name, $default = null )
deauthorize ( $redirect = true, $context = 'gb-admin' )
defer ( $callable )	Schedule $callable for delayed execution.
event ( )	Dispatch an event, optionally with arguments.
filter ( $tag, $value )	Apply filters for $tag on $value
glob ( $pattern, $skip = '/\/$/' )	Glob with PCRE skip filter which defaults to skipping directories.
index ( $name, $fallback = null )
index_cachename ( $name )
index_path ( $name )
init ( $add_sample_content = true, $shared = 'true', $theme = 'default', $mkdirmode = 509 )
load_plugins ( $context )
load_site_state ( )	Load the site state
log ( )	Send a message to syslog.
observe ( $event, $callable )	Register $callable for receiving $event s
openlog ( $ident = null, $options = LOG_PID, $facility = LOG_USER )
pathToTheme ( $file = '' )
plugin_check_enabled ( $context, $name )
referrer_url ( $fallback_on_http_referer = false )
run_deferred ( )
shell ( $cmd, $input = null, $cwd = null, $env = null )	Execute a command inside a shell
stop_observing ( $callable, $event = null )	Unregister $callable from receiving $event s
tags ( $indexname = 'tags-by-popularity' )
url ( )
urlToCategories ( $categories )
urlToCategory ( $category )
urlToTag ( $tag )
urlToTags ( $tags )
url_to ( $part = null, $htmlsafe = true )
verify ( )
verify_config ( )
verify_integrity ( )	Verify integrity of the site, automatically taking any actions to restore it if broken.
version_format ( $v )
version_parse ( $s )
vlog ( $priority, $vargs, $btoffset = 1, $prefix = null )

Method Details

Property Details