• Главная
• Gdn_Format

PHP Класс Gdn_Format, vanilla

Utility class that helps to format strings, objects, and arrays. Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$DisplayNoFollow		Flag which allows plugins to decide if the output should include rel="nofollow" on any links.
$FormatLinks		Whether or not to replace plain text links with anchors.
$MentionsUrlFormat	string

Защищенные свойства (Protected)

Свойство	Тип	Описание
$SanitizedFormats	array
$_CleanChars		Unicode to ascii conversion table.
$_UrlTranslations	array

Открытые методы

Метод	Описание
activityHeadline ( object $Activity, integer $ProfileUserID = '', $ViewingUserID = '' ) : string	The ActivityType table has some special sprintf search/replace values in the FullHeadline and ProfileHeadline fields.
alphaNumeric ( string $Mixed ) : string	Removes all non-alpha-numeric characters (except for _ and -) from
arrayAsAttributes ( array $Array ) : string
arrayAsObject ( array $Array ) : stdClass	Takes an object and convert's it's properties => values to an associative array of $Array[Property] => Value sets.
arrayValueForPhp ( $String ) : string	Formats a string so that it can be saved to a PHP file in double-quotes of an array value assignment.
auto ( mixed $Mixed ) : string	Takes a mixed variable, filters unsafe things, renders BBCode and returns it.
bbCode ( mixed $Mixed ) : string	Takes a mixed variable.
bigNumber ( mixed $Number, $Format = '' ) : string	Format a number by putting K/M/B suffix after it when appropriate.
bytes ( integer $Bytes, integer $Precision = 2 ) : string	Format a number as if it's a number of bytes by adding the appropriate B/K/M/G/T suffix.
clean ( mixed $Mixed ) : string	Convert certain unicode characters into their ascii equivalents.
date ( string $Timestamp = '', string $Format = '' ) : string	Formats a Mysql DateTime string in the specified format.
dateFull ( integer $Timestamp, string $Format = '' )	Formats a MySql datetime or a unix timestamp for display in the system.
defaultFormat ( boolean | null $is_mobile = null ) : string	Return the default input formatter.
deleted ( mixed $Mixed ) : string	Format a string from of "Deleted" content (comment, message, etc).
display ( mixed $Mixed ) : string	Takes a mixed variable, formats it for display on the screen, and returns it.
email ( string $Email ) : string	Formats an email address in a non-scrapable format.
form ( mixed $Mixed ) : string	Takes a mixed variable, formats it for display in a form, and returns it.
fuzzyTime ( $Timestamp = null, $MorePrecise = false ) : string	Show times relative to now, e.g. "4 hours ago".
getEmbedSize ( ) : array	Returns embedded video width and height, based on configuration.
html ( mixed $Mixed ) : string	Takes a mixed variable, filters unsafe HTML and returns it.
htmlFilter ( mixed $Mixed ) : string	Takes a mixed variable, filters unsafe HTML and returns it.
image ( string $Body ) : string	Format an encoded string of image properties as HTML.
links ( mixed $Mixed ) : string	Formats the anchor tags around the links in text.
markdown ( mixed $Mixed, boolean $Flavored = true ) : string	Format a string using Markdown syntax. Also purifies the output HTML.
mentions ( $Mixed ) : mixed | string	Handle mentions formatting.
objectAsArray ( object $Object ) : unknown	Takes an object and converts its properties => values to an associative array of $Array[Property] => Value sets.
plainText ( string $Body, string $Format = 'Html' ) : string	Format a string as plain text.
raw ( string | object | array $Mixed ) : string	Return the input without any operations performed at all.
reduceWhiteSpaces ( string $String )	Reduces multiple whitespaces including line breaks and tabs to one single space character.
replaceButProtectCodeBlocks ( mixed $Search, mixed $Replace, mixed $Subject, boolean $IsCallback = false ) : string	Do a preg_replace, but don't affect things inside tags.
rssHtml ( string $Text, string $Format = 'Html' ) : string	Format some text in a way suitable for passing into an rss/atom feed.
seconds ( integer $Seconds ) : string	Formats seconds in a human-readable way (ie. 45 seconds, 15 minutes, 2 hours, 4 days, 2 months, etc).
serialize ( mixed $Mixed ) : string	Takes any variable and serializes it.
spoilerHtml ( string $spoilerText ) : string	Returns spoiler text wrapped in a HTML spoiler wrapper.
tagContent ( string $html, callable $callback, boolean $skipAnchors = true, boolean $skipCode = true ) : string	Executes the callback function on parts of the string excluding html tags.
text ( mixed $mixed, $addBreaks = true ) : string	Takes a mixed variable, formats it for display on the screen as plain text.
textEx ( string $Str ) : string	Process as plain text + our magic formatting.
timespan ( integer $timespan ) : string
to ( mixed $Mixed, string $FormatMethod ) : mixed	Takes a mixed variable, formats it in the specified format type, and returns it.
toDate ( integer $Timestamp = '' ) : string	Format a timestamp or the current time to go into the database.
toDateTime ( integer $Timestamp = '' ) : string	Format a timestamp or the current time to go into the database.
toTimestamp ( string $DateTime = '' ) : string | boolean	Convert a datetime to a timestamp.
toTimezone ( integer $Timestamp ) : integer	Formats a timestamp to the current user's timezone.
unembedContent ( mixed $Mixed ) : HTML	Strips out embed/iframes we support and replaces with placeholder.
unserialize ( string $SerializedString ) : mixed	Takes a serialized variable and unserializes it back into its original state.
url ( mixed $Mixed ) : string	Creates URL codes containing only lowercase Roman letters, digits, and hyphens.
vanillaSprintf ( $PlaceholderString, $ReplaceWith ) : mixed
wysiwyg ( $Mixed ) : mixed | string	Format text from WYSIWYG editor input.

Защищенные методы

Метод	Описание
formatMentionsCallback ( string $str ) : string	Adds a link to all mentions in a given string.
isHtml ( $Text ) : boolean	Detect HTML for the purposes of doing advanced filtering.
legacySpoilers ( string $html ) : string	Spoilers with backwards compatibility.
linksCallback ( array $Matches ) : string	Transform match to clickable links or to embedded equivalent.
listCallback ( array $Matches ) : string	Formats BBCode list items.
processHTML ( $html ) : string	Performs replacing operations on a HTML string. Usually for formatting posts.
replaceListItems ( string $html ) : string	Replaces opening html list tags with an asterisk and closing list tags with new lines.
replaceSpoilers ( string $html, string $replaceWith = '(Spoiler)' ) : string	Check to see if a string has spoilers and replace them with an innocuous string.
vanillaSprintfCallback ( $Match, boolean $InternalReplacementList = false ) : mixed

Описание методов

text() публичный статический Метод

Takes a mixed variable, formats it for display on the screen as plain text.

public static text ( mixed $mixed, $addBreaks = true ) : string
$mixed	mixed	An object, array, or string to be formatted.
Результат	string

textEx() публичный статический Метод

Process as plain text + our magic formatting.

С версии: 2.1

public static textEx ( string $Str ) : string
$Str	string
Результат	string

timespan() публичный статический Метод

public static timespan ( integer $timespan ) : string
$timespan	integer
Результат	string

to() публичный статический Метод

Takes a mixed variable, formats it in the specified format type, and returns it.

public static to ( mixed $Mixed, string $FormatMethod ) : mixed
$Mixed	mixed	An object, array, or string to be formatted.
$FormatMethod	string	The method with which the variable should be formatted.
Результат	mixed

toDate() публичный статический Метод

Format a timestamp or the current time to go into the database.

public static toDate ( integer $Timestamp = '' ) : string
$Timestamp	integer
Результат	string	The formatted date.

toDateTime() публичный статический Метод

Format a timestamp or the current time to go into the database.

public static toDateTime ( integer $Timestamp = '' ) : string
$Timestamp	integer
Результат	string	The formatted date and time.

toTimestamp() публичный статический Метод

Convert a datetime to a timestamp.

public static toTimestamp ( string $DateTime = '' ) : string | boolean
$DateTime	string	The Mysql-formatted datetime to convert to a timestamp. Should be in one of the following formats: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.
Результат	string | boolean	Returns FALSE upon failure.

toTimezone() публичный статический Метод

Formats a timestamp to the current user's timezone.

public static toTimezone ( integer $Timestamp ) : integer
$Timestamp	integer	The timestamp in gmt.
Результат	integer	The timestamp according to the user's timezone.

unembedContent() публичный статический Метод

This allows later parsing to insert a sanitized video video embed normally. Necessary for backwards compatibility from when we allowed embed & object tags. This is not an HTML filter; it enables old YouTube videos to theoretically work, it doesn't effectively block YouTube iframes or objects.

public static unembedContent ( mixed $Mixed ) : HTML
$Mixed	mixed
Результат	HTML	string

unserialize() публичный статический Метод

Takes a serialized variable and unserializes it back into its original state.

public static unserialize ( string $SerializedString ) : mixed
$SerializedString	string	A json or php serialized string to be unserialized.
Результат	mixed

url() публичный статический Метод

Creates URL codes containing only lowercase Roman letters, digits, and hyphens.

public static url ( mixed $Mixed ) : string
$Mixed	mixed	An object, array, or string to be formatted.
Результат	string

vanillaSprintf() публичный статический Метод

public static vanillaSprintf ( $PlaceholderString, $ReplaceWith ) : mixed
$PlaceholderString
$ReplaceWith
Результат	mixed

vanillaSprintfCallback() защищенный статический Метод

protected static vanillaSprintfCallback ( $Match, boolean $InternalReplacementList = false ) : mixed
$Match
$InternalReplacementList	boolean
Результат	mixed

wysiwyg() публичный статический Метод

Format text from WYSIWYG editor input.

public static wysiwyg ( $Mixed ) : mixed | string
$Mixed
Результат	mixed | string

Описание свойств

$DisplayNoFollow публичное статическое свойство

Flag which allows plugins to decide if the output should include rel="nofollow" on any links.

public static $DisplayNoFollow

$FormatLinks публичное статическое свойство

Whether or not to replace plain text links with anchors.

public static $FormatLinks

$MentionsUrlFormat публичное статическое свойство

public static string $MentionsUrlFormat
Результат	string

$SanitizedFormats защищенное статическое свойство

protected static array $SanitizedFormats
Результат	array

$_CleanChars защищенное статическое свойство

Unicode to ascii conversion table.

protected static $_CleanChars

$_UrlTranslations защищенное статическое свойство

protected static array $_UrlTranslations
Результат	array