Procedural File: liberty_lib.php

Source Location: /liberty/liberty_lib.php

Page Details:

Tags:

filesource:

get_image_size_options [line 885]

array get_image_size_options(
[string $pEmptyOption = 'Disable this feature'])

get a set of image size options based on $gThumbSizes

Tags:

return:	of image size options suitable for use in a form
access:	public

Parameters

string

$pEmptyOption

string to use as empty option - if set to FALSE no empty string is eincluded - Note that string is tra()'d

[ Top ]

get_leadtitle [line 904]

TRUE get_leadtitle(
string $pString)

get_leadtitle will fetch the string before the liberty_subtitle_delimiter

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

string

$pString

string that should be checked for the delimiter

[ Top ]

get_subtitle [line 916]

TRUE get_subtitle(
string $pString)

get_subtitle will fetch the string after the liberty_subtitle_delimiter

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

string

$pString

string that should be checked for the delimiter

[ Top ]

liberty_clear_thumbnails [line 650]

TRUE liberty_clear_thumbnails(
 &$pFileHash, array $pFileHash['dest_branch'])

liberty_clear_thumbnails will clear all thummbnails found in a given directory

Tags:

return:	on success, FALSE on failure
access:	public

Parameters

array	$pFileHash['dest_branch']	should contain the path to the dir where we should remove thumbnails
	&$pFileHash

[ Top ]

liberty_content_display [line 389]

void liberty_content_display(
 &$pObject,  &$pParamHash, array $pObject, array $pParamHash)

liberty_content_display

Tags:

access:

public

Parameters

array	$pObject
array	$pParamHash
	&$pObject
	&$pParamHash

[ Top ]

liberty_content_edit [line 408]

void liberty_content_edit(
 &$pObject, array $pObject, array $pParamHash)

liberty_content_edit

Tags:

access:

public

Parameters

array	$pObject
array	$pParamHash
	&$pObject

[ Top ]

liberty_content_list_sql [line 317]

content liberty_content_list_sql(
 &$pObject, [array $pParamHash = NULL], array $pParamHash['enforce_status'], array $pParamHash['min_status_id'], array $pParamHash['max_status_id'], array $pParamHash['min_owner_status_id'])

liberty_content_list_sql

Tags:

return:	list sql
access:	public

Parameters

array	$pParamHash
array	$pParamHash['enforce_status']	will add joins to status_id even if user is admin
array	$pParamHash['min_status_id']	one less than the minimum status a content can have to be included
array	$pParamHash['max_status_id']	one more than the maximum status a content can have to be included
array	$pParamHash['min_owner_status_id']	one less than the mimimum status a content can have to be included that is owned by the requester
	&$pObject

[ Top ]

liberty_content_load_sql [line 279]

content liberty_content_load_sql(
 &$pObject, [ $pParamHash = NULL])

liberty_content_load_sql

Tags:

return:	load sql
access:	public

Parameters

	&$pObject
	$pParamHash

[ Top ]

liberty_content_preview [line 366]

void liberty_content_preview(
 &$pObject, array $pObject)

liberty_content_preview

Tags:

access:

public

Parameters

array	$pObject
	&$pObject

[ Top ]

liberty_fetch_thumbnails [line 799]

array liberty_fetch_thumbnails(
array $pParamHash)

fetch all available thumbnails for a given item. if no thumbnails are present, get thumbnailing image or the appropriate mime type icon

Tags:

return:	of available thumbnails or mime icons TODO: individual options are only for legacy reasons - remove options and deprecated() soon - xing - Monday Jun 23, 2008 22:36:53 CEST
access:	public

Parameters

array

$pParamHash

Hash of all settings used to fetch thumbnails, including source_file, default_image, thumbnail_sizes, and mime_image

[ Top ]

liberty_fetch_thumbnail_url [line 865]

string liberty_fetch_thumbnail_url(
array $pParamHash)

fetch a single available thumbnail for a given item. if no thumbnail is present, return NULL

Tags:

return:	url TODO: individual options are only for legacy reasons - remove options and deprecated() soon - xing - Monday Jun 23, 2008 22:36:53 CEST
access:	public

Parameters

array

$pParamHash

Hash of all settings used to fetch thumbnails including: size, source_file, default_image, and mime_image

[ Top ]

liberty_generate_thumbnails [line 694]

TRUE liberty_generate_thumbnails(
array $pFileHash)

liberty_generate_thumbnails

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

array

$pFileHash

[ Top ]

liberty_get_function [line 681]

TRUE liberty_get_function(
array $pType)

liberty_get_function

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

array

$pType

[ Top ]

liberty_plugins_wrapper_style [line 189]

hash liberty_plugins_wrapper_style(
array $pParamHash)

pass in the plugin paramaters and out comes a hash with usable styling information

Tags:

return:	full of styling goodies
access:	public

Parameters

array

$pParamHash

[ Top ]

liberty_process_archive [line 473]

TRUE liberty_process_archive(
 &$pFileHash, array $pFileHash)

liberty_process_archive

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

array	$pFileHash
	&$pFileHash

[ Top ]

liberty_process_generic [line 572]

TRUE liberty_process_generic(
 &$pFileHash, [array $pMoveFile = TRUE], array $pFileHash)

liberty_process_generic

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

array	$pFileHash
array	$pMoveFile
	&$pFileHash

[ Top ]

liberty_process_image [line 617]

TRUE liberty_process_image(
 &$pFileHash, [ $pMoveFile = TRUE], array $pFileHash)

liberty_process_image

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

array	$pFileHash
	&$pFileHash
	$pMoveFile

[ Top ]

liberty_process_upload [line 430]

TRUE liberty_process_upload(
 &$pFileHash, [boolean $pMoveFile = TRUE], array $pFileHash, array $pFileHash['name'], array $pFileHash['type'], array $pFileHash['dest_branch'], array $pFileHash['tmp_name'], boolean $pFileHash['thumbnail'], array $pFileHash['thumbnail_sizes'])

Process uploaded files. Will automagically generate thumbnails for images

Tags:

return:	on success, FALSE on failure - mErrors will contain reason for failure
access:	public

Parameters

array	$pFileHash	Data require to process the files
array	$pFileHash['name']	(required) Name of the uploaded file
array	$pFileHash['type']	(required) Mime type of the file uploaded
array	$pFileHash['dest_branch']	(required) Relative path where you want to store the file (trailing slash required)
array	$pFileHash['tmp_name']	(required) Absolute path to file including file name
boolean	$pFileHash['thumbnail']	(optional) Set to FALSE if you don't want to generate thumbnails
array	$pFileHash['thumbnail_sizes']	(optional) Decide what sizes thumbnails you want to create: icon, avatar, small, medium, large
boolean	$pMoveFile	(optional) specify if you want to move or copy the original file
	&$pFileHash

[ Top ]

parse_data_plugins [line 16]

void parse_data_plugins(
 &$pData,  &$pReplace,  &$pCommonObject,  $pParseHash, array $pData)

This crazy function will parse all the data plugin stuff found within any parsed text section

Tags:

access:

public

Parameters

array	$pData	Data to be parsed
	&$pData
	&$pReplace
	&$pCommonObject
	$pParseHash

[ Top ]

parse_protect [line 145]

void parse_protect(
 &$pData,  &$pReplace, array $pData, array $preparsed, array $noparsed)

This function replaces pre- and no-parsed sections with unique keys and saves the section contents for later reinsertion. It is needed by parse_data_plugins() to extract sections that don't require parsing

Tags:

access:

public

Parameters

array	$pData	data that might contain ~np~ or ~pp~ strings
array	$preparsed	array that is updated by refrerence with key and data that needs to be substituted later
array	$noparsed	array that is updated by refrerence with key and data that needs to be substituted later
	&$pData
	&$pReplace

[ Top ]

Documentation generated on Wed, 29 Jul 2015 13:57:00 +0000 by phpDocumentor 1.5.0-lsces