Overview

Packages

  • akismet
  • None
  • PHP
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • plugins
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Signatures
    • Signed
    • Transport
  • wa-apps
    • blog
      • actions
        • backend
        • blog
        • comment
        • cron
        • design
        • frontend
        • page
        • plugin
        • post
      • api
        • v1
      • cli
      • layout
      • model
      • plugin
        • aksimet
        • category
        • emailsubscription
        • favorite
        • gravatar
        • import
        • markdown
        • myposts
        • tag
        • troll
      • settings
    • checklists
      • backend
      • json
    • contacts
      • backend
    • developer
    • dummy
    • guestbook
    • guestbook2
    • photos
      • album
      • api
        • v1
      • backend
      • design
      • dialog
      • frontend
      • page
      • photo
      • plugin
        • comment
        • imageeffects
        • import
        • publicgallery
        • watermark
      • search
      • settings
      • stack
      • tag
      • upload
    • site
      • backend
      • blocks
      • config
      • design
      • domains
      • files
      • frontend
      • helper
      • layout
      • pages
      • routing
      • setting
    • stickies
      • api
        • v1
      • sheet
      • stiky
  • wa-plugin
    • payment
    • shipping
    • sms
  • wa-plugins
    • shipping
      • usps
  • wa-system
    • API
    • Auth
      • Adapters
    • Autoload
    • Cache
      • Adapter
    • Captcha
    • Config
    • Contact
    • controller
    • currency
    • database
    • datetime
    • design
    • event
    • exception
    • files
    • image
    • layout
    • locale
    • log
    • mail
    • page
      • action
      • model
    • payment
    • plugin
    • request
    • response
    • routing
    • shipping
    • sms
    • storage
    • user
    • util
    • validator
    • view
    • webasyst
      • api
      • backend
      • cli
      • config
      • layout
      • login
      • model
      • password
      • payment
      • profile
      • settings
      • shipment
    • widget
    • workflow
  • waPlugins
    • Payment
  • webasyst
    • wa-system
      • helper

Classes

  • blogActivity
  • blogBlog
  • blogCategoryPluginBackendSettingsAction
  • blogConfig
  • blogContactsDeleteHandler
  • blogContactsLinksHandler
  • blogFrontController
  • blogHelper
  • blogPluginsSettingsViewAction
  • blogPost
  • blogRightConfig
  • blogSitemapConfig
  • blogSlugValidator
  • blogViewAction
  • blogViewHelper
  • waPluginSettings
  • waSettings
  • waSettingWrapper
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class blogHelper

Package: wa-apps\blog
Located at wa-apps/blog/lib/classes/blogHelper.class.php
Methods summary
public static array
# getAuthors( integer $blog_id = 0 )

Get blog authors list

Parameters

$blog_id
integer
$blog_id

Returns

array
public static integer|null
# checkRights( integer $blog_id = null, boolean|integer $contact_id = true, integer $mode = blogRightConfig::RIGHT_READ_WRITE )

Check blog rights for current or specified user

Check blog rights for current or specified user

Parameters

$blog_id
integer
$blog_id null to check blog create
$contact_id
boolean|integer
$contact_id
$mode
integer
$mode

Returns

integer|null

Throws

waRightsException

Internal

param $blogRightConfig .RIGHT_READ_WRITE|int $mode
public static array|boolean
# getContactInfo( integer $id, integer|int[] $size = 50 )

Get contact extra info

Parameters

$id
integer
$id
$size
integer|int[]
$size

Returns

array|boolean
public static
# extendUser( array & $rows, array $fields = array(), boolean $get_link = false )

Extend items by adding contact info into $rows[i]['user'] Uses:

  • $rows[i]['contact_id']
  • $rows[i]['name'] or $rows[i]['contact_name'] when contact is not found or its name is empty
  • $rows[i]['auth_provider'] for default userpic URL

Extend items by adding contact info into $rows[i]['user'] Uses:

  • $rows[i]['contact_id']
  • $rows[i]['name'] or $rows[i]['contact_name'] when contact is not found or its name is empty
  • $rows[i]['auth_provider'] for default userpic URL

Parameters

$rows
array
$rows
$fields
array
$fields
$get_link
boolean
$get_link pass true to get $rows[i]['user']['posts_link']
public static
# extendRights( mixed & $items, mixed $blogs = array(), mixed $contact_id = null )

Extend item rights

Parameters

$items
mixed
$items
$blogs
mixed
$blogs
$contact_id
mixed
$contact_id
public static
# extendPostState( mixed & $posts, mixed $mode = false )
public static
# extendPostComments( array & $posts )

Get comments for posts

Parameters

$posts
array
$posts
public static string
# buildCacheKey( array $params = array() )

Build properly cache key for blog item

Build properly cache key for blog item

Parameters

$params
array
$params

Returns

string

Link

http://www.smarty.net/forums/viewtopic.php?p=75251

Todo

enable partial caching wait for Smarty 3.2.x
public static array
# getAvailable( boolean $extended = true, integer $blog_id = null )

Parameters

$extended
boolean
$extended
$blog_id
integer
$blog_id

Returns

array

See

blogBlog::getAvailable
public static
# extendIcon( mixed & $item )
public static
# transliterate( mixed $slug )
public static string
# getUrl( mixed $blog_id = null, string $route_rule = null, array $params = array(), boolean $absolute = true )

Get urls (url) of item (blog, post) taking in account multiple settlements

Parameters

$blog_id
mixed
(integer|null) $blog_id
$route_rule
string
$route_rule
$params
array
$params params of routing
$absolute
boolean
$absolute if url will be absolute

Returns

string
public static string|string[]
# getRouteSettingsUrl( boolean $all = false )

Get application route settings url

Parameters

$all
boolean
$all

Returns

string|string[]
My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0