Functions
	replace_macros ($s, $r)
	This is our template processor. More...

	random_string ($size=64, $type=RANDOM_STRING_HEX)
	Generates a random string. More...

	notags ($string)
	This is our primary input filter. More...

	escape_tags ($string)

	z_input_filter ($s, $type= 'text/bbcode', $allow_code=false)

	purify_html ($s, $allow_position=false)
	Use HTMLPurifier to get standards compliant HTML. More...

	autoname ($len)
	generate a string that's random, but usually pronounceable. More...

	xmlify ($str)
	escape text ($str) for XML transport More...

	unxmlify ($s)
	Undo an xmlify. More...

	paginate (&$a)
	Automatic pagination. More...

	alt_pager (&$a, $i, $more= '', $less= '')

	item_message_id ()
	Generate a guaranteed unique (for this domain) item ID for ATOM. More...

	photo_new_resource ()
	Generate a guaranteed unique photo ID. More...

	attribute_contains ($attr, $s)
	for html,xml parsing - let's say you've got an attribute foobar="class1 class2 class3" and you want to find out if it contains 'class3'. you can't use a normal sub string search because you might match 'notclass3' and a regex to do the job is possible but a bit complicated. More...

	logger ($msg, $level=LOGGER_NORMAL, $priority=LOG_INFO)
	Logging function for Hubzilla. More...

	btlogger ($msg, $level=LOGGER_NORMAL, $priority=LOG_INFO)
	like logger() but with a function backtrace to pinpoint certain classes of problems which show up deep in the calling stack. More...

	log_priority_str ($priority)

	dlogger ($msg, $level=0)
	This is a special logging facility for developers. More...

	profiler ($t1, $t2, $label)

	activity_match ($haystack, $needle)

	get_tags ($s)
	Pull out all #hashtags and @person tags from $s. More...

	tag_sort_length ($a, $b)

	total_sort ($a, $b)

	qp ($s)
	Quick and dirty quoted_printable encoding. More...

	get_mentions ($item, $tags)

	contact_block ()

	chanlink_hash ($s)

	chanlink_url ($s)

	chanlink_cid ($d)

	magiclink_url ($observer, $myaddr, $url)

	micropro ($contact, $redirect=false, $class= '', $textmode=false)

	search ($s, $id='search-box', $url='/search', $save=false)

	searchbox ($s, $id='search-box', $url='/search', $save=false)

	linkify ($s, $me=false)
	Replace naked text hyperlink with HTML formatted hyperlink. More...

	sslify ($s)
	Replace media element using http url with https to a local redirector if using https locally. More...

	get_poke_verbs ()

	get_mood_verbs ()

	list_smilies ($default_only=false)
	Function to list all smilies, both internal and from addons. More...

	smilies ($s, $sample=false)
	Replaces text emoticons with graphical images. More...

	smile_shield ($m)

	smile_unshield ($m)

	preg_heart ($x)
	Expand <3333 to the correct number of hearts. More...

	day_translate ($s)

	normalise_link ($url)
	normalises a string. More...

	link_compare ($a, $b)
	Compare two URLs to see if they are the same. More...

	unobscure (&$item)

	unobscure_mail (&$item)

	theme_attachments (&$item)

	format_categories (&$item, $writeable)

	format_hashtags (&$item)
	Add any hashtags which weren't mentioned in the message body, e.g. community tags. More...

	format_mentions (&$item)

	format_filer (&$item)

	generate_map ($coord)

	generate_named_map ($location)

	prepare_body (&$item, $attach=false)

	prepare_binary ($item)

	prepare_text ($text, $content_type= 'text/bbcode', $cache=false)
	Given a text string, convert from bbcode to html and add smilie icons. More...

	create_export_photo_body (&$item)

	feed_hublinks ()
	Return atom link elements for all of our hubs. More...

	feed_salmonlinks ($nick)
	Return atom link elements for salmon endpoints. More...

	get_plink ($item, $conversation_mode=true)

	unamp ($s)

	layout_select ($channel_id, $current= '')

	mimetype_select ($channel_id, $current= 'text/bbcode', $choices=null, $element= 'mimetype')

	engr_units_to_bytes ($size_str)

	base64url_encode ($s, $strip_padding=true)

	base64url_decode ($s)

	base64special_encode ($s, $strip_padding=true)

	base64special_decode ($s)

	cleardiv ()
	Return a div to clear floats. More...

	bb_translate_video ($s)

	html2bb_video ($s)

	array_xmlify ($val)

	reltoabs ($text, $base)

	item_post_type ($item)

	undo_post_tagging ($s)

	fix_mce_lf ($s)

	protect_sprintf ($s)

	is_a_date_arg ($s)

	legal_webbie ($s)

	legal_webbie_text ()

	check_webbie ($arr)

	ids_to_array ($arr, $idx= 'id')

	ids_to_querystr ($arr, $idx= 'id', $quote=false)

	xchan_query (&$items, $abook=true, $effective_uid=0)
	Fetches xchan and hubloc data for an array of items with only an author_xchan and owner_xchan. More...

	xchan_mail_query (&$item)

	find_xchan_in_array ($xchan, $arr)

	get_rel_link ($j, $rel)

	magic_link ($s)

	stringify_array_elms (&$arr, $escape=false)
	If $escape is true, dbesc() each element before adding quotes. More...

	jindent ($json)
	Indents a flat JSON string to make it more human-readable. More...

	design_tools ()
	Creates navigation menu for webpage, layout, blocks, menu sites. More...

	website_portation_tools ()
	Creates website portation tools menu. More...

	in_arrayi ($needle, $haystack)
	case insensitive in_array() More...

	normalise_openid ($s)

	extra_query_args ()

	handle_tag ($a, &$body, &$access_tag, &$str_tags, $profile_uid, $tag, $diaspora=false)
	This function removes the tag $tag from the text $body and replaces it with the appropiate link. More...

	linkify_tags ($a, &$body, $uid, $diaspora=false)

	getIconFromType ($type)
	returns icon name for use with e.g. font-awesome based on mime-type. More...

	userReadableSize ($size)
	Returns a human readable formatted string for filesizes. More...

	str_rot47 ($str)

	string_replace ($old, $new, &$s)

	json_url_replace ($old, $new, &$s)

	item_url_replace ($channel, &$item, $old, $new, $oldnick= '')

	sanitise_acl (&$item)
	Used to wrap ACL elements in angle brackets for storage. More...

	perms2str ($p)
	Convert an ACL array to a storable string. More...

	expand_acl ($s)
	Turn user/group ACLs stored as angle bracketed text into arrays. More...

	acl2json ($s)

	pdl_selector ($uid, $current='')
	When editing a webpage - a dropdown is needed to select a page layout. More...

	flatten_array_recursive ($arr)
	returns a one-dimensional array from a multi-dimensional array empty values are discarded More...

	text_highlight ($s, $lang)
	Highlight Text. More...

	arrtoxml ($root_elem, $arr)

	array2XML ($obj, $array)

	create_table_from_array ($table, $arr)
	Inserts an array into $table. More...

	share_shield ($m)

	share_unshield ($m)

	cleanup_bbcode ($body)

	gen_link_id ($mid)

	array_trim (&$v, $k)

	array_escape_tags (&$v, $k)

	ellipsify ($s, $maxlen)

	purify_filename ($s)

Variables
const	RANDOM_STRING_HEX 0x00

const	RANDOM_STRING_TEXT 0x01

Function Documentation

acl2json ( $s )

Referenced by Zotlabs\Module\Wiki\get(), Zotlabs\Module\Filestorage\get(), Zotlabs\Module\Chat\get(), Zotlabs\Module\Mitem\get(), Zotlabs\Module\Thing\get(), Zotlabs\Module\Events\get(), Zotlabs\Module\Settings\Channel\get(), Zotlabs\Module\Photos\get(), and Zotlabs\Lib\NativeWiki\listwikis().

activity_match	(	$haystack,
		$needle
	)

Referenced by Zotlabs\Lib\ThreadItem\add_child(), Zotlabs\Lib\ThreadStream\add_thread(), atom_entry(), builtin_activity_puller(), consume_feed(), conversation(), Zotlabs\Module\Like\get(), get_atom_elements(), item_post_type(), localize_item(), remove_community_tag(), Zotlabs\Lib\Enotify\submit(), and visible_activity().

alt_pager	(	&	$a,
			$i,
			$more = `''`,
			$less = `''`
	)

Referenced by Zotlabs\Module\Pubstream\get(), Zotlabs\Module\Cards\get(), Zotlabs\Module\Articles\get(), Zotlabs\Module\Network\get(), Zotlabs\Module\Directory\get(), and Zotlabs\Module\Channel\get().

array2XML	(	$obj,
		$array
	)

Referenced by arrtoxml().

array_escape_tags	(	&	$v,
			$k
	)

array_trim	(	&	$v,
			$k
	)

array_xmlify ( $val )

apply xmlify() to all values of array $val, recursively

Referenced by poco().

arrtoxml	(	$root_elem,
		$arr
	)

Referenced by api_apply_template().

attribute_contains	(	$attr,
		$s
	)

for html,xml parsing - let's say you've got an attribute foobar="class1 class2 class3" and you want to find out if it contains 'class3'. you can't use a normal sub string search because you might match 'notclass3' and a regex to do the job is possible but a bit complicated.

pass the attribute string as $attr and the attribute you are looking for as $s - returns true if found, otherwise false

Parameters

string	$attr	attribute string
string	$s	attribute you are looking for

Returns: boolean true if found

Referenced by scrape_vcard().

autoname ( $len )

generate a string that's random, but usually pronounceable.

Used to generate initial passwords.

Parameters

int $len

Returns: string

Referenced by Zotlabs\Module\Setup\check_php(), Zotlabs\Module\Lostpass\get(), Zotlabs\Module\Settings\Tokens\get(), and Zotlabs\Module\Invite\get().

base64special_decode ( $s )

Referenced by smile_unshield().

base64special_encode	(	$s,
		$strip_padding = `true`
	)

Referenced by smile_shield().

base64url_decode ( $s )

Referenced by aes_unencapsulate(), check_zotinfo(), convert_salmon_key(), encode_mail(), Zotlabs\Module\Contactgroup\get(), Zotlabs\Module\Pubstream\get(), Zotlabs\Module\Display\get(), Zotlabs\Module\Hq\get(), Zotlabs\Module\Group\get(), Zotlabs\Module\Mail\get(), get_atom_elements(), get_item_elements(), identity_basic_export(), Zotlabs\Module\Import\import_account(), import_site(), import_xchan(), Zotlabs\Module\Oembed\init(), Zotlabs\Module\Magic\init(), Zotlabs\Module\Impel\init(), mail_store(), Zotlabs\Module\Oep\oep_display_reply(), other_unencapsulate(), pemtome(), Zotlabs\Module\Getfile\post(), private_messages_drop(), private_messages_fetch_conversation(), private_messages_fetch_message(), private_messages_list(), process_channel_sync_delivery(), process_rating_delivery(), pubrsatome(), Zotlabs\Zot\Finger\run(), share_unshield(), sync_directories(), sync_locations(), unobscure_mail(), Zotlabs\Zot\Auth\Verify(), xchan_store(), zot_refresh(), zot_register_hub(), zot_rekey_request(), zot_reply_auth_check(), zot_reply_pickup(), and zotinfo().

base64url_encode	(	$s,
		$strip_padding = `true`
	)

bb_translate_video ( $s )

Referenced by cleanup_bbcode().

btlogger	(	$msg,
		$level = `LOGGER_NORMAL`,
		$priority = `LOG_INFO`
	)

like logger() but with a function backtrace to pinpoint certain classes of problems which show up deep in the calling stack.

Parameters

string	$msg	Message to log
int	$level	A log level
int	$priority	- compatible with syslog

Referenced by Zotlabs\Access\Permissions\FilledPerms(), Zotlabs\Lib\PConfig\Load(), markdown_to_bb(), rsa_verify(), Zotlabs\Lib\PConfig\Set(), and xmlify().

chanlink_cid ( $d )

Referenced by Zotlabs\Module\Connedit\get().

chanlink_hash ( $s )

Referenced by builtin_activity_puller(), Zotlabs\Lib\ThreadItem\check_wall_to_wall(), Zotlabs\Module\Viewconnections\get(), Zotlabs\Module\Connections\get(), Zotlabs\Module\Mail\get(), Zotlabs\Lib\ThreadItem\get_template_data(), Zotlabs\Module\Randprof\init(), micropro(), thread_author_menu(), and Zotlabs\Widget\Conversations\widget().

chanlink_url ( $s )

Referenced by fetch_post_tags(), Zotlabs\Module\Suggest\get(), Zotlabs\Module\Directory\get(), localize_item(), and Zotlabs\Widget\Suggestions\widget().

check_webbie ( $arr )

Referenced by auto_channel_create(), channel_change_address(), create_identity(), import_channel(), Zotlabs\Module\New_channel\init(), and Zotlabs\Module\Changeaddr\post().

cleanup_bbcode ( $body )

fix naked links by passing through a callback to see if this is a hubzilla site (already known to us) which will get a zrl, otherwise link with url, add bookmark tag to both. First protect any url inside certain bbcode tags so we don't double link it.

Fold multi-line [code] sequences

Referenced by Zotlabs\Module\Mail\post(), Zotlabs\Module\Item\post(), and send_message().

cleardiv ( )

Return a div to clear floats.

Returns: string

contact_block ( )

Referenced by profile_sidebar().

create_export_photo_body ( & $item )

Referenced by atom_entry().

create_table_from_array	(	$table,
		$arr
	)

Inserts an array into $table.

Todo:: Why is this function in include/text.php?

Parameters

string	$table
array	$arr

Returns: boolean|PDOStatement

Referenced by abook_store_lowlevel(), account_store_lowlevel(), channel_store_lowlevel(), hubloc_store_lowlevel(), Zotlabs\Module\Import\import_account(), import_apps(), import_channel(), import_chatrooms(), import_config(), import_conv(), import_events(), import_hublocs(), import_likes(), import_objs(), import_profiles(), Zotlabs\Module\Profiles\init(), item_store(), mail_store(), profile_store_lowlevel(), site_store_lowlevel(), sync_apps(), sync_chatrooms(), sync_events(), sync_files(), sync_objs(), and xchan_store_lowlevel().

day_translate ( $s )

Referenced by advanced_profile(), cal(), format_event_html(), format_event_obj(), Zotlabs\Module\Cal\get(), Zotlabs\Module\Events\get(), Zotlabs\Module\Ping\init(), list_post_dates(), and posted_dates().

design_tools ( )

Creates navigation menu for webpage, layout, blocks, menu sites.

Returns: string with parsed HTML

Referenced by Zotlabs\Widget\Design_tools\widget().

dlogger	(	$msg,
		$level = `0`
	)

This is a special logging facility for developers.

It allows one to target specific things to trace/debug and is identical to logger() with the exception of the log filename. This allows one to isolate specific calls while allowing logger() to paint a bigger picture of overall activity and capture more detail.

If you find dlogger() calls in checked in code, you are free to remove them - so as to provide a noise-free development environment which responds to events you are targetting personally.

Parameters

string	$msg	Message to log
int	$level	A log level.

ellipsify	(	$s,
		$maxlen
	)

Referenced by photos_albums_list().

engr_units_to_bytes ( $size_str )

Referenced by account_service_class_allows(), Zotlabs\Module\Photos\get(), Zotlabs\Module\Item\item_check_service_class(), photo_upload(), and service_class_allows().

escape_tags ( $string )

use this on "body" or "content" input where angle chars shouldn't be removed, and allow them to be safely displayed.

Parameters

string $string

Returns: string

expand_acl ( $s )

Turn user/group ACLs stored as angle bracketed text into arrays.

turn string array of angle-bracketed elements into string array e.g. "<123xyz><246qyo><sxo33e>" => array(123xyz,246qyo,sxo33e);

Parameters

string $s

Returns: array

Referenced by acl2json(), attach_recursive_perms(), collect_recipients(), enumerate_permissions(), file_activity(), Zotlabs\Module\Lockview\get(), Zotlabs\Module\File_upload\post(), and Zotlabs\Module\Photos\post().

extra_query_args ( )

Used in ajax endless scroll request to find out all the args that the master page was viewing. This was using $_REQUEST, but $_REQUEST also contains all your cookies. So we're restricting it to $_GET and $_POST.

Returns: string with additional URL parameters

Referenced by Zotlabs\Module\Viewconnections\get(), Zotlabs\Module\Connections\get(), Zotlabs\Module\Directory\get(), and Zotlabs\Module\Photos\get().

feed_hublinks ( )

Return atom link elements for all of our hubs.

Returns: string

feed_salmonlinks ( $nick )

Return atom link elements for salmon endpoints.

Parameters

string $nick

Returns: string

find_xchan_in_array	(	$xchan,
		$arr
	)

Referenced by private_messages_fetch_conversation(), private_messages_fetch_message(), private_messages_list(), xchan_mail_query(), and xchan_query().

fix_mce_lf ( $s )

Referenced by Zotlabs\Module\Profiles\post().

flatten_array_recursive ( $arr )

returns a one-dimensional array from a multi-dimensional array empty values are discarded

example: print_r(flatten_array_recursive(array('foo','bar',array('baz','blip',array('zob','glob')),'','grip')));

Array ( [0] => foo [1] => bar [2] => baz [3] => blip [4] => zob [5] => glob [6] => grip )

Parameters

array $arr multi-dimensional array

Returns: one-dimensional array

Referenced by proc_run().

format_categories	(	&	$item,
			$writeable
	)

Referenced by prepare_body().

format_filer ( & $item )

Referenced by prepare_body().

format_hashtags ( & $item )

Add any hashtags which weren't mentioned in the message body, e.g. community tags.

Parameters

[in] array &$item

Returns: string HTML link of hashtag

Referenced by prepare_body().

format_mentions ( & $item )

Referenced by prepare_body().

gen_link_id ( $mid )

Referenced by conversation(), event_store_item(), Zotlabs\Module\Subthread\get(), Zotlabs\Module\Tagger\get(), Zotlabs\Module\Like\get(), item_store(), Zotlabs\Module\Item\post(), and send_status_notifications().

generate_map ( $coord )

Referenced by prepare_body().

generate_named_map ( $location )

get_mentions	(	$item,
		$tags
	)

get_mood_verbs ( )

Referenced by Zotlabs\Module\Mood\get(), and Zotlabs\Module\Mood\init().

get_plink	(	$item,
		$conversation_mode = `true`
	)

Referenced by conversation(), and Zotlabs\Lib\ThreadItem\get_template_data().

get_poke_verbs ( )

Referenced by Zotlabs\Module\Poke\get(), and Zotlabs\Module\Poke\init().

get_rel_link	(	$j,
		$rel
	)

Referenced by Zotlabs\Module\Sharedwithme\get(), localize_item(), remove_community_tag(), and tag_deliver().

get_tags ( $s )

Pull out all #hashtags and @person tags from $s.

We also get @person@domain.com - which would make the regex quite complicated as tags can also end a sentence. So we'll run through our results and strip the period from any tags which end with one.

Parameters

string $s

Returns: Returns array of tags found, or empty array.

Referenced by linkify_tags().

getIconFromType ( $type )

returns icon name for use with e.g. font-awesome based on mime-type.

These are the the font-awesome names of version 3.2.1. The newer font-awesome 4 has different names.

Parameters

string $type mime type

Returns: string

Todo:: rename to get_icon_from_type()

Referenced by Zotlabs\Module\Sharedwithme\get(), and theme_attachments().

handle_tag	(		$a,
		&	$body,
		&	$access_tag,
		&	$str_tags,
			$profile_uid,
			$tag,
			$diaspora = `false`
	)

This function removes the tag $tag from the text $body and replaces it with the appropiate link.

Parameters

	App	$a
[in,out]	string	&$body	the text to replace the tag in
[in,out]	string	&$access_tag	used to return tag ACL exclusions e.g. @!foo
[in,out]	string	&$str_tags	string to add the tag to
	int	$profile_uid
	string	$tag	the tag to replace
	boolean	$diaspora	default false

Returns: boolean true if replaced, false if not replaced

Referenced by linkify_tags().

html2bb_video ( $s )

Referenced by get_atom_elements().

ids_to_array	(	$arr,
		$idx = `'id'`
	)

Referenced by Zotlabs\Module\Acl\init(), and visible_plugin_list().

ids_to_querystr	(	$arr,
		$idx = `'id'`,
		$quote = `false`
	)

Referenced by Zotlabs\Module\Pubstream\get(), Zotlabs\Module\Display\get(), Zotlabs\Module\Articles\get(), Zotlabs\Module\Cards\get(), Zotlabs\Module\Network\get(), Zotlabs\Module\Hq\get(), Zotlabs\Module\Channel\get(), items_fetch(), photos_albums_list(), stream_perms_api_uids(), stream_perms_xchans(), Zotlabs\Widget\Forums\widget(), and zot_feed().

in_arrayi	(	$needle,
		$haystack
	)

case insensitive in_array()

Parameters

string	$needle
array	$haystack

Returns: boolean

Referenced by Zotlabs\Module\Directory\get(), and import_directory_profile().

is_a_date_arg ( $s )

Referenced by Zotlabs\Module\Network\get(), and Zotlabs\Module\Channel\get().

item_message_id ( )

Generate a guaranteed unique (for this domain) item ID for ATOM.

Safe from birthday paradox.

Returns: string a unique id

Referenced by Zotlabs\Lib\NativeWiki\create_wiki(), event_store_item(), file_activity(), Zotlabs\Module\React\get(), Zotlabs\Module\Subthread\get(), Zotlabs\Module\Like\get(), import_webpage_element(), Zotlabs\Module\Impel\init(), Zotlabs\Module\Mood\init(), item_create_edit_activity(), photo_upload(), photos_create_item(), Zotlabs\Module\Item\post(), post_activity_item(), profile_activity(), and store_doc_file().

item_post_type ( $item )

Referenced by Zotlabs\Lib\Enotify\submit().

item_url_replace	(		$channel,
		&	$item,
			$old,
			$new,
			$oldnick = `''`
	)

Referenced by import_items().

jindent ( $json )

Indents a flat JSON string to make it more human-readable.

Parameters

string $json The original JSON string to process.

Returns: string Indented version of the original JSON string.

Referenced by text_highlight().

json_url_replace	(		$old,
			$new,
		&	$s
	)

Referenced by item_url_replace().

layout_select	(	$channel_id,
		$current = `''`
	)

legal_webbie ( $s )

Referenced by auto_channel_create(), check_webbie(), and Zotlabs\Module\New_channel\init().

legal_webbie_text ( )

link_compare	(	$a,
		$b
	)

Compare two URLs to see if they are the same.

But ignore slight but hopefully insignificant differences such as if one is https and the other isn't, or if one is www.something and the other isn't - and also ignore case differences.

See Also: normalise_link()

Parameters

string	$a
string	$b

Returns: true if the URLs match, otherwise false

Referenced by consume_feed(), tag_deliver(), tgroup_check(), and zid().

linkify	(	$s,
		$me = `false`
	)

Replace naked text hyperlink with HTML formatted hyperlink.

Parameters

string	$s
boolean	$me	(optional) default false

Returns: string

Referenced by advanced_profile(), Zotlabs\Module\Directory\get(), and profile_sidebar().

linkify_tags	(		$a,
		&	$body,
			$uid,
			$diaspora = `false`
	)

Referenced by photo_upload(), Zotlabs\Module\Admin\Site\post(), Zotlabs\Module\Events\post(), Zotlabs\Module\Mail\post(), Zotlabs\Module\Item\post(), Zotlabs\Module\Photos\post(), Zotlabs\Module\Profiles\post(), and send_message().

list_smilies ( $default_only = false )

Function to list all smilies, both internal and from addons.

Returns: Returns array with keys 'texts' and 'icons'

Referenced by Zotlabs\Module\Smilies\get(), and smilies().

log_priority_str ( $priority )

Referenced by btlogger(), and logger().

logger	(	$msg,
		$level = `LOGGER_NORMAL`,
		$priority = `LOG_INFO`
	)

Logging function for Hubzilla.

Logging output is configured through Hubzilla's system config. The log file is set in system logfile, log level in system loglevel and to enable logging set system debugging.

Available constants for log level are LOGGER_NORMAL, LOGGER_TRACE, LOGGER_DEBUG, LOGGER_DATA and LOGGER_ALL.

Since PHP5.4 we get the file, function and line automatically where the logger was called, so no need to add it to the message anymore.

Parameters

string	$msg	Message to log
int	$level	A log level
int	$priority	- compatible with syslog

magic_link ( $s )

magiclink_url	(	$observer,
		$myaddr,
		$url
	)

Referenced by item_redir_and_replace_images().

micropro	(	$contact,
		$redirect = `false`,
		$class = `''`,
		$textmode = `false`
	)

Referenced by contact_block().

mimetype_select	(	$channel_id,
		$current = `'text/bbcode'`,
		$choices = `null`,
		$element = `'mimetype'`
	)

Referenced by Zotlabs\Widget\Wiki_pages\create_missing_page(), and Zotlabs\Widget\Wiki_pages\widget().

normalise_link ( $url )

normalises a string.

Parameters

string $url

Returns: string

Referenced by best_link_url(), link_compare(), tag_deliver(), tgroup_check(), and thread_author_menu().

normalise_openid ( $s )

notags ( $string )

This is our primary input filter.

The high bit hack only involved some old IE browser, forget which (IE5/Mac?) that had an XSS attack vector due to stripping the high-bit on an 8-bit character after cleansing, and angle chars with the high bit set could get through as markup.

This is now disabled because it was interfering with some legitimate unicode sequences and hopefully there aren't a lot of those browsers left.

Use this on any text input where angle chars are not valid or permitted They will be replaced with safer brackets. This may be filtered further if these are not allowed either.

Parameters

string $string Input string

Returns: string Filtered string

paginate ( & $a )

Automatic pagination.

To use, get the count of total items. Then call App::set_pager_total($number_items); Optionally call App::set_pager_itemspage($n) to the number of items to display on each page Then call paginate($a) after the end of the display loop to insert the pager block on the page (assuming there are enough items to paginate). When using with SQL, the setting LIMIT d, d => App::$pager['start'],App::$pager['itemspage'] will limit the results to the correct items for the current page. The actual page handling is then accomplished at the application layer.

Parameters

App &$a

Referenced by Zotlabs\Module\Connections\get(), Zotlabs\Module\Admin\Channels\get(), and Zotlabs\Module\Admin\Accounts\get().

pdl_selector	(	$uid,
		$current = `''`
	)

When editing a webpage - a dropdown is needed to select a page layout.

On submit, the pdl_select value (which is the mid of an item with item_type = ITEM_TYPE_PDL) is stored in the webpage's resource_id, with resource_type 'pdl'.

Then when displaying a webpage, we can see if it has a pdl attached. If not we'll use the default site/page layout.

If it has a pdl we'll load it as we know the mid and pass the body through comanche_parser() which will generate the page layout from the given description

Fixme:

there is apparently a very similar function called layout_select; this one should probably take precedence and the other should be checked for compatibility and removed

Parameters

int	$uid
string	$current

Returns: string HTML code for dropdown

perms2str ( $p )

Convert an ACL array to a storable string.

Parameters

array $p

Returns: array

Referenced by attach_store(), file_activity(), and Zotlabs\Module\File_upload\post().

photo_new_resource ( )

Generate a guaranteed unique photo ID.

Safe from birthday paradox.

Returns: string a uniqe hash

Referenced by import_channel_photo(), import_xchan_photo(), photo_upload(), Zotlabs\Module\Cover_photo\post(), and Zotlabs\Module\Profile_photo\post().

preg_heart ( $x )

Expand <3333 to the correct number of hearts.

Parameters

array $x

prepare_binary ( $item )

Referenced by prepare_body().

prepare_body	(	&	$item,
			$attach = `false`
	)

Referenced by conversation(), and Zotlabs\Lib\ThreadItem\get_template_data().

prepare_text	(	$text,
		$content_type = `'text/bbcode'`,
		$cache = `false`
	)

Given a text string, convert from bbcode to html and add smilie icons.

Parameters

string	$text
sting	$content_type	(optional) default text/bbcode
boolean	$cache	(optional) default false

Returns: string

Referenced by advanced_profile(), atom_entry(), Zotlabs\Render\Comanche\block(), check_item_source(), Zotlabs\Module\Search\get(), Zotlabs\Module\Connect\get(), post_is_importable(), prepare_body(), store_doc_file(), and Zotlabs\Widget\Random_block\widget().

profiler	(	$t1,
		$t2,
		$label
	)

protect_sprintf ( $s )

purify_filename ( $s )

Referenced by nav(), and Zotlabs\Render\Comanche\widget().

purify_html	(	$s,
		$allow_position = `false`
	)

Use HTMLPurifier to get standards compliant HTML.

Use the HTMLPurifier library to get filtered and standards compliant HTML.

See Also: HTMLPurifier

Parameters

string	$s	raw HTML
boolean	$allow_position	allow CSS position

Returns: string standards compliant filtered HTML

Fixme:: this function has html output, not bbcode - so safely purify these require_once('include/html2bbcode.php'); $s = html2bb_video($s); $s = oembed_html2bbcode($s);

Referenced by feed_get_reshare(), get_atom_elements(), oembed_fetch_url(), Zotlabs\Lib\MarkdownSoap\purify(), and z_input_filter().

qp ( $s )

Quick and dirty quoted_printable encoding.

Parameters

string $s

Returns: string

random_string	(	$size = `64`,
		$type = `RANDOM_STRING_HEX`
	)

Generates a random string.

Parameters

number	$size
int	$type

Returns: string

reltoabs	(	$text,
		$base
	)

Referenced by get_atom_elements().

replace_macros	(	$s,
		$r
	)

This is our template processor.

Parameters

string \| SmartyEngine	$s	the string requiring macro substitution, or an instance of SmartyEngine
array	$r	key value pairs (search => replace)

Returns: string substituted string

sanitise_acl ( & $item )

Used to wrap ACL elements in angle brackets for storage.

Parameters

[in,out] array &$item

search	(	$s,
		$id = `'search-box'`,
		$url = `'/search'`,
		$save = `false`
	)

Referenced by Zotlabs\Module\Search\get().

searchbox	(	$s,
		$id = `'search-box'`,
		$url = `'/search'`,
		$save = `false`
	)

Referenced by Zotlabs\Widget\Savedsearch\widget(), and Zotlabs\Widget\Sitesearch\widget().

share_shield ( $m )

share_unshield ( $m )

smile_shield ( $m )

Parameters

array $m

Returns: string

smile_unshield ( $m )

smilies	(	$s,
		$sample = `false`
	)

Replaces text emoticons with graphical images.

It is expected that this function will be called using HTML text. We will escape text between HTML pre and code blocks, and HTML attributes (such as urls) from being processed.

At a higher level, the bbcode [nosmile] tag can be used to prevent this function from being executed by the prepare_text() routine when preparing bbcode source for HTML display.

Parameters

string	$s
boolean	$sample	(optional) default false

Returns: string

Referenced by format_event_html(), format_event_obj(), Zotlabs\Module\Smilies\get(), Zotlabs\Module\Wiki\get(), Zotlabs\Module\Cal\get(), Zotlabs\Module\Chatsvc\get(), Zotlabs\Module\Mail\get(), Zotlabs\Module\Events\get(), menu_render(), Zotlabs\Module\Mail\post(), Zotlabs\Module\Wiki\post(), and prepare_text().

sslify ( $s )

Replace media element using http url with https to a local redirector if using https locally.

Looks for HTML tags containing src elements that are http when we're viewing an https page Typically this throws an insecure content violation in the browser. So we redirect them to a local redirector which uses https and which redirects to the selected content

Parameters

string $s

Returns: string

Referenced by prepare_body().

str_rot47 ( $str )

Referenced by create_conversation(), encode_mail(), Zotlabs\Module\Mail\get(), get_mail_elements(), identity_basic_export(), import_conv(), mail_store(), private_messages_drop(), private_messages_fetch_conversation(), private_messages_fetch_message(), private_messages_list(), send_message(), and unobscure_mail().

string_replace	(		$old,
			$new,
		&	$s
	)

Referenced by item_url_replace().

stringify_array_elms	(	&	$arr,
			$escape = `false`
	)

If $escape is true, dbesc() each element before adding quotes.

Parameters

[in,out]	array	&$arr
	boolean	$escape	(optional) default false

Referenced by article_tagadelic(), card_tagadelic(), expand_groups(), Zotlabs\Module\Lockview\get(), get_things(), identity_basic_export(), Zotlabs\Daemon\Notifier\run(), tagadelic(), and zot_import().

tag_sort_length	(	$a,
		$b
	)

text_highlight	(	$s,
		$lang
	)

Highlight Text.

Parameters

string	$s	Text to highlight
string	$lang	Which language should be highlighted

Returns: string Important: The returned text has the text pattern 'http' translated to 'eY9-!' which should be converted back after further processing. This was done to prevent oembed links from occurring inside code blocks. See include/bbcode.php

Referenced by bb_highlight().

theme_attachments ( & $item )

Referenced by Zotlabs\Module\Mail\get(), and prepare_body().