icms_ipf_category_Object

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_ipf_category_Object

Persistble category object

Base class representing a single icms_ipf_Object with "search engine optimisation" capabilities

• Class name: icms_ipf_category_Object
• Namespace:
• Parent class: icms_ipf_seo_Object

Properties

$_categoryPath

private mixed $_categoryPath

Path that corresponds to the category

• Visibility: private

categoryid

public int categoryid

Category ID

• Visibility: public

parentid

public int parentid

Parent category ID

• Visibility: public

name

public string name

Name

• Visibility: public

description

public string description

Description

• Visibility: public

image

public string image

image

• Visibility: public

meta_keywords

public string meta_keywords

Meta keywords

• Visibility: public
• This property is defined by icms_ipf_seo_Object

meta_description

public string meta_description

Meta description

• Visibility: public
• This property is defined by icms_ipf_seo_Object

short_url

public string short_url

Short URL

• Visibility: public
• This property is defined by icms_ipf_seo_Object

Methods

__construct

mixed icms_ipf_seo_Object::__construct(mixed handler)

• Visibility: public
• This method is defined by icms_ipf_seo_Object

Arguments

• handler mixed

getVar

mixed icms_ipf_category_Object::getVar(string key, string format)

returns a specific variable for the object in a proper format

• Visibility: public

Arguments

• key string - <p>key of the object's variable to be returned</p>
• format string - <p>format to use for the output</p>

description

string icms_ipf_category_Object::description()

Returns the description for the category

• Visibility: public

image

mixed icms_ipf_category_Object::image()

Returns the image for the category

• Visibility: public

toArray

array icms_ipf_category_Object::toArray()

Create an array of the category's properties

• Visibility: public

getCategoryPath

string icms_ipf_category_Object::getCategoryPath(bool withAllLink, mixed currentCategory)

Create the complete path of a category

• Visibility: public

Arguments

• withAllLink bool - <p>make all name clickable</p>
• currentCategory mixed

initiateSEO

mixed icms_ipf_seo_Object::initiateSEO()

• Visibility: public
• This method is defined by icms_ipf_seo_Object

short_url

string icms_ipf_seo_Object::short_url()

Return the value of the short_url field of this object

• Visibility: public
• This method is defined by icms_ipf_seo_Object

meta_keywords

string icms_ipf_seo_Object::meta_keywords()

Return the value of the meta_keywords field of this object

• Visibility: public
• This method is defined by icms_ipf_seo_Object

meta_description

string icms_ipf_seo_Object::meta_description()

Return the value of the meta_description field of this object

• Visibility: public
• This method is defined by icms_ipf_seo_Object