Overview

Packages

  • Auth
    • Ads
    • Ldap
    • Xoops
  • Autotasks
  • Config
    • Category
    • Item
    • Option
  • Core
    • Filesystem
    • Filters
    • Logger
    • Mail
    • Message
    • Password
    • Security
    • StopSpammer
    • Template
    • Textsanitizer
    • VersionChecker
  • Data
    • Avatar
    • Comment
  • Database
    • Connection
    • Criteria
    • Legacy
    • MySQL
    • PDO
    • Updater
  • Feeds
    • RSS
  • File
  • Form
    • Base
    • Elements
  • ICMS
    • IPF
      • View
  • Image
    • Category
  • Ipf
    • Category
    • Controller
    • Export
    • form
    • Keyhighlighter
    • Member
    • Object
    • Permission
    • richfile
    • Tree
    • urllink
    • View
  • kernel
    • Set
  • Member
    • Group
    • GroupMembership
    • GroupPermission
    • User
  • Messaging
  • Module
  • None
  • Notification
  • Page
  • Plugins
    • Editor
  • Preload
    • Libraries
  • Privmessage
  • Session
  • SmartObject
  • View
    • Block
    • Breadcrumb
    • PageNav
    • PrinterFriendly
    • Template
    • Templates
    • Theme
    • Tree

Classes

  • icms_ipf_category_Handler
  • icms_ipf_category_Object
  • Overview
  • Package
  • Class

Class icms_ipf_category_Object

Persistble category object

icms_core_Object
Extended by icms_ipf_Object
Extended by icms_ipf_seo_Object
Extended by icms_ipf_category_Object
Package: Ipf\Category
Category: ICMS
Copyright: The ImpressCMS Project http://www.impresscms.org/
License: GNU General Public License (GPL)
Author: marcan marcan@impresscms.org
Author: Sina Asghari (aka stranger) pesian_stranger@users.sourceforge.net
Since: 1.1
Located at ipf/category/Object.php
Methods summary
public icms_ipf_category_Object
# __construct( )

Constructor for icms_ipf_category_Object

Constructor for icms_ipf_category_Object

Returns

icms_ipf_category_Object

Overrides

icms_ipf_seo_Object::__construct()
public mixed
# getVar( string $key, string $format = 's' )

returns a specific variable for the object in a proper format

returns a specific variable for the object in a proper format

Parameters

$key
key of the object's variable to be returned
$format
format to use for the output

Returns

mixed
formatted value of the variable

Overrides

icms_ipf_Object::getVar()
public string
# description( )

Returns the description for the category

Returns the description for the category

Returns

string
Text to display as the description

See

icms_ipf_Object::getValueFor()
public mixed
# image( )

Returns the image for the category

Returns the image for the category

Returns

mixed
Returns false if there is no image, or the image, if it exists
public array
# toArray( )

Create an array of the category's properties

Create an array of the category's properties

Returns

array
An array of the category's properties

Overrides

icms_ipf_Object::toArray()
public string
# getCategoryPath( boolean $withAllLink = true, $currentCategory = false )

Create the complete path of a category

Create the complete path of a category

Parameters

$withAllLink
make all name clickable
$currentCategory

Returns

string
complete path (breadcrumb)
Methods inherited from icms_ipf_seo_Object
IcmsPersistableSeoObject(), initiateSEO(), meta_description(), meta_keywords(), short_url()
Methods inherited from icms_ipf_Object
IcmsPersistableObject(), accessGranted(), closeFormSection(), delete(), displayFieldOnSingleView(), displaySingleObject(), doDisplayFieldOnSingleView(), doHideFieldFromForm(), doHideFieldFromSingleView(), doMakeFieldreadOnly(), doSetAdvancedFormFields(), doSetFieldAsRequired(), doSetFieldForSorting(), doShowFieldOnForm(), getAdminViewItemLink(), getControl(), getDeleteItemLink(), getEditItemLink(), getFieldsForSorting(), getFileObj(), getForm(), getGroupPerm(), getImageDir(), getItemLink(), getPrintAndMailLink(), getSecureForm(), getUploadDir(), getUrlLinkObj(), getValueFor(), getVarInfo(), getViewItemLink(), hasError(), hideFieldFromForm(), hideFieldFromSingleView(), id(), initCommonVar(), initNonPersistableVar(), initVar(), makeFieldReadOnly(), openFormSection(), quickInitVar(), setAdvancedFormFields(), setControl(), setErrors(), setFieldAsRequired(), setFieldForSorting(), setImageDir(), setType(), setVarInfo(), showFieldOnForm(), store(), storeFileObj(), storeUrlLinkObj(), summary(), title()
Methods inherited from icms_core_Object
assignVar(), assignVars(), cleanVars(), getErrors(), getHtmlErrors(), getValues(), getVars(), isDirty(), isNew(), isNewConfig(), registerFilter(), setDirty(), setFormVars(), setNew(), setNewConfig(), setVar(), setVars(), unsetDirty(), unsetNew(), unsetNewConfig(), xoopsClone()
Properties inherited from icms_ipf_Object
$_image_path, $_image_url, $controls, $handler, $seoEnabled, $summaryField, $titleField
Properties inherited from icms_core_Object
$_isNewConfig, $cleanVars, $vars
API documentation generated by ApiGen