Class PublisherUtils

Package: Publisher
Copyright: XOOPS Project (http://xoops.org)
License: GPL V2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: trabis lusopoemas@gmail.com
Author: The SmartFactory <www.smartfactory.ca>
Author: trabis lusopoemas@gmail.com
Since: 1.0
Located at odules/publisher/class/utils.php

Methods summary
`public static`	# `cpHeader( )` Includes scripts in HTML header Includes scripts in HTML header
`public static string`	# `getOrderBy( string $sort )` Default sorting for a given order Default sorting for a given order Parameters `$sort` Returns string
`public static string`	# `substr( string $str, integer $start, integer $length, string $trimmarker = '...' )` Parameters `$str` `$start` `$length` `$trimmarker` Returns string Credits Thanks to Mithandir
`public static string`	# `html2text( string $document )` Parameters `$document` Returns string
`public static string[]`	# `getAllowedImagesTypes( )` Returns string[]
`public static string`	# `moduleHome( boolean $withLink = true )` Parameters `$withLink` Returns string
`public static boolean`	# `copyr( string $source, string $dest )` Copy a file, or a folder and its contents Copy a file, or a folder and its contents Parameters `$source` The source `$dest` The destination Returns boolean Returns true on success, false on failure Author Aidan Lister aidan@php.net Version 1.0.0
`public static boolean\|integer\|string`	# `getPathStatus( string $item, boolean $getStatus = false )` Parameters `$item` `$getStatus` Returns boolean\|integer\|string Credits Thanks to the NewBB2 Development Team
`public static boolean`	# `mkdir( string $target )` Parameters `$target` Returns boolean Credits Thanks to the NewBB2 Development Team
`public static boolean`	# `chmod( string $target, integer $mode = 0777 )` Parameters `$target` `$mode` Returns boolean Credits Thanks to the NewBB2 Development Team
`public static string`	# `getUploadDir( boolean $hasPath = true, boolean $item = false )` Parameters `$hasPath` `$item` Returns string
`public static string`	# `getImageDir( string $item = '', boolean $hasPath = true )` Parameters `$item` `$hasPath` Returns string
`public static string`	# `formatErrors( array $errors = array() )` Parameters `$errors` Returns string
`public static boolean`	# `IsUserAuthor( object $itemObj )` Check is current user is author of a given article Check is current user is author of a given article Parameters `$itemObj` Returns boolean
`public static boolean`	# `IsUserModerator( PublisherItem $itemObj )` Check is current user is moderator of a given article Check is current user is moderator of a given article Parameters `$itemObj` Returns boolean
`public static`	# `IsUserAdmin( )`
`public static boolean`	# `saveCategoryPermissions( array $groups, integer $categoryid, string $perm_name )` Saves permissions for the selected category Saves permissions for the selected category Parameters `$groups` : group with granted permission `$categoryid` : categoryid on which we are setting permissions `$perm_name` : name of the permission Returns boolean : TRUE if the no errors occured
`public static`	# `openCollapsableBar( string $tablename = '', string $iconname = '', string $tabletitle = '', string $tabledsc = '', boolean $open = true )` Parameters `$tablename` `$iconname` `$tabletitle` `$tabledsc` `$open`
`public static`	# `closeCollapsableBar( string $name, string $icon )` Parameters `$name` `$icon`
`public static`	# `setCookieVar( string $name, string $value, integer $time = 0 )` Parameters `$name` `$value` `$time`
`public static string`	# `getCookieVar( string $name, string $default = '' )` Parameters `$name` `$default` Returns string
`public static array`	# `getCurrentUrls( )` Returns array
`public static string`	# `getCurrentPage( )` Returns string
`public static string`	# `addCategoryOption( object $categoryObj, integer $selectedid = 0, integer $level = 0, string $ret = '' )` Parameters `$categoryObj` `$selectedid` `$level` `$ret` Returns string
`public static string`	# `createCategorySelect( integer $selectedid = 0, integer $parentcategory = 0, boolean $allCatOption = true, string $selectname = 'options[0]' )` Parameters `$selectedid` `$parentcategory` `$allCatOption` `$selectname` Returns string
`public static string`	# `createCategoryOptions( integer $selectedid = 0, integer $parentcategory = 0, boolean $allCatOption = true )` Parameters `$selectedid` `$parentcategory` `$allCatOption` Returns string
`public static`	# `renderErrors( array & $err_arr, string $reseturl = '' )` Parameters `$err_arr` `$reseturl`
`public static string`	# `makeURI( string $page, array $vars = array(), boolean $encodeAmp = true )` Generate publisher URL Generate publisher URL Parameters `$page` `$vars` `$encodeAmp` Returns string Credit : xHelp module, developped by 3Dev
`public static string`	# `tellafriend( string $subject = '' )` Parameters `$subject` Returns string
`public static boolean\|string`	# `uploadFile( boolean $another, boolean $withRedirect, & $itemObj )` Parameters `$another` `$withRedirect` `$itemObj` Returns boolean\|string
`public static string`	# `newFeatureTag( )` Returns string
`public static string`	# `truncateTagSafe( string $string, integer $length = 80, string $etc = '...', boolean $break_words = false )` Smarty truncate_tagsafe modifier plugin Type: modifier Name: truncate_tagsafe Purpose: Truncate a string to a certain length if necessary, optionally splitting in the middle of a word, and appending the $etc string or inserting $etc into the middle. Makes sure no tags are left half-open or half-closed (e.g. "Banana in a <a...") Smarty truncate_tagsafe modifier plugin Type: modifier Name: truncate_tagsafe Purpose: Truncate a string to a certain length if necessary, optionally splitting in the middle of a word, and appending the $etc string or inserting $etc into the middle. Makes sure no tags are left half-open or half-closed (e.g. "Banana in a <a...") Parameters `$string` `$length` `$etc` `$break_words` Returns string Author Monte Ohrt , modified by Amos Robinson
`public static string`	# `closeTags( string $string )` Parameters `$string` Returns string Author Monte Ohrt , modified by Amos Robinson
`public static string`	# `ratingBar( integer $itemid )` Parameters `$itemid` Returns string
`public static array`	# `getEditors( array $allowed_editors = null )` Parameters `$allowed_editors` Returns array
`public static integer`	# `stringToInt( string $string = '', integer $length = 5 )` Parameters `$string` `$length` Returns integer
`public static string`	# `convertCharset( string $item )` Parameters `$item` Returns string
`public static`	# `seoTitle( $title = '', $withExt = true )`
`public static string`	# `seoGenUrl( string $op, integer $id, string $short_url = "" )` seoGenUrl seoGenUrl Parameters `$op` `$id` `$short_url` Returns string
`public static string`	# `displayFlash( string $url, integer $width = 0, integer $height = 0 )` Parameters `$url` `$width` `$height` Returns string

Namespaces

Classes

Interfaces

Functions

Class PublisherUtils

Parameters

Returns

Parameters

Returns

Credits

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Author

Version

Parameters

Returns

Credits

Parameters

Returns

Credits

Parameters

Returns

Credits

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Credit

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns