icms_image_Object

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

icms_image_Object

An Image Object

• Class name: icms_image_Object
• Namespace:
• Parent class: icms_ipf_Object

Properties

$image_info

public array $image_info = array()

Info of Image file (width, height, bits, mimetype)

• Visibility: public

$image_body

public string $image_body

Stores image body

• Visibility: public

image_id

public int image_id

Image ID

• Visibility: public

image_name

public string image_name

Name

• Visibility: public

image_nicename

public string image_nicename

Nice name

• Visibility: public

image_mimetype

public string image_mimetype

Mimetype

• Visibility: public

image_created

public int image_created

When was created?

• Visibility: public

image_display

public int image_display

Show be this image displayed on selection?

• Visibility: public

image_weight

public int image_weight

Weight used for sorting for user

• Visibility: public

image_body

public string image_body

Image contents

• Visibility: public

imgcat_id

public int imgcat_id

Image category ID

• Visibility: public

Methods

__construct

mixed icms_image_Object::__construct(mixed handler, mixed data)

Constructor

• Visibility: public

Arguments

• handler mixed
• data mixed

getInfo

array icms_image_Object::getInfo(string path, string type, bool ret)

Returns information

• Visibility: public

Arguments

• path string - <p>The path to search through</p>
• type string - <p>The path type, url or other</p>
• ret bool - <p>Return the information or keep it stored</p>

setVars

mixed icms_image_Object::setVars(array var_arr, bool not_gpc)

Overide setVar for loading also image_body on the fly

• Visibility: public

Arguments

• var_arr array - <p>Data</p>
• not_gpc bool - <p>Not GPC?</p>

getVar

mixed icms_image_Object::getVar(string name, string format)

Returns a specific variable for the object in a proper format

• Visibility: public

Arguments

• name string - <p>Name of var</p>
• format string - <p>Format</p>

setVar

mixed icms_image_Object::setVar(string name, mixed value, array options)

Sets var value

• Visibility: public

Arguments

• name string - <p>Var name</p>
• value mixed - <p>New value</p>
• options array - <p>Options to apply when settings values</p>