ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
ilImageLinkButton Class Reference
+ Inheritance diagram for ilImageLinkButton:
+ Collaboration diagram for ilImageLinkButton:

Public Member Functions

 setImage ($a_value, $a_is_internal=true)
 Set image. More...
 
 getImage ()
 Get image. More...
 
 forceTitle ($a_value)
 
 hasForceTitle ()
 
- Public Member Functions inherited from ilLinkButton
 setUrl ($a_value)
 Set URL. More...
 
 getUrl ()
 Get URL. More...
 
 setTarget ($a_value)
 Set target. More...
 
 getTarget ()
 Get target. More...
 
 render ()
 
- Public Member Functions inherited from ilButtonBase
 __clone ()
 Clone instance. More...
 
 getType ()
 Get button type. More...
 
 setId ($a_value)
 Set id. More...
 
 getId ()
 Get id. More...
 
 setCaption ($a_value, $a_is_lng_id=true)
 Set caption. More...
 
 getCaption ($a_translate=true)
 Get caption. More...
 
 setPrimary ($a_value)
 Toggle primary status. More...
 
 isPrimary ()
 Get primary status. More...
 
 setOmitPreventDoubleSubmission ($a_value)
 Toggle double submission prevention status. More...
 
 getOmitPreventDoubleSubmission ()
 Get double submission prevention status. More...
 
 setOnClick ($a_value)
 Set onclick. More...
 
 getOnClick ()
 Get onclick. More...
 
 setAccessKey ($a_value)
 Set access key. More...
 
 getAccessKey ()
 Get access key. More...
 
 setDisabled ($a_value)
 Toggle disabled status. More...
 
 isDisabled ()
 Get disabled status. More...
 
 addCSSClass ($a_value)
 Add CSS class. More...
 
 getCSSClasses ()
 Get CSS class(es) More...
 
 applyDefaultCss ($apply_default_css=null)
 
 render ()
 Render HTML. More...
 
 getToolbarHTML ()
 

Static Public Member Functions

static getInstance ()
 
- Static Public Member Functions inherited from ilLinkButton
static getInstance ()
 
- Static Public Member Functions inherited from ilButtonBase
static getInstance ()
 Factory. More...
 

Protected Member Functions

 prepareRender ()
 
 renderCaption ()
 
- Protected Member Functions inherited from ilLinkButton
 renderCaption ()
 Prepare caption for render. More...
 
 renderAttributes (array $a_additional_attr=null)
 
- Protected Member Functions inherited from ilButtonBase
 __construct ($a_type)
 Constructor. More...
 
 setType ($a_value)
 Set button type. More...
 
 gatherCssClasses ()
 Gather all active CSS classes. More...
 
 renderAttributesHelper (array $a_attr)
 Render HTML node attributes. More...
 
 renderAttributes (array $a_additional_attr=null)
 Render current HTML attributes. More...
 
 prepareRender ()
 Prepare render. More...
 

Protected Attributes

 $src
 
 $force_title
 
- Protected Attributes inherited from ilLinkButton
 $url
 
 $target
 
- Protected Attributes inherited from ilButtonBase
 $type
 
 $id
 
 $caption
 
 $caption_is_lng_id
 
 $primary
 
 $omit_prevent_double_submission
 
 $onclick
 
 $acc_key
 
 $disabled
 
 $css = array()
 
 $apply_default_css = true
 

Additional Inherited Members

- Data Fields inherited from ilButtonBase
const TYPE_SUBMIT = 1
 
const TYPE_LINK = 2
 
const TYPE_SPLIT = 3
 
const TYPE_BUTTON = 4
 

Detailed Description

Definition at line 13 of file class.ilImageLinkButton.php.

Member Function Documentation

◆ forceTitle()

ilImageLinkButton::forceTitle (   $a_value)

Definition at line 53 of file class.ilImageLinkButton.php.

54  {
55  $this->force_title = (bool)$a_value;
56  }

◆ getImage()

ilImageLinkButton::getImage ( )

Get image.

Returns
string

Definition at line 48 of file class.ilImageLinkButton.php.

References $src.

Referenced by renderCaption().

49  {
50  return $this->src;
51  }
+ Here is the caller graph for this function:

◆ getInstance()

static ilImageLinkButton::getInstance ( )
static

Definition at line 18 of file class.ilImageLinkButton.php.

Referenced by ilBibliographicSetting\getButton().

19  {
20  return new self(self::TYPE_LINK);
21  }
+ Here is the caller graph for this function:

◆ hasForceTitle()

ilImageLinkButton::hasForceTitle ( )

Definition at line 58 of file class.ilImageLinkButton.php.

References $force_title.

Referenced by renderCaption().

59  {
60  return $this->force_title;
61  }
+ Here is the caller graph for this function:

◆ prepareRender()

ilImageLinkButton::prepareRender ( )
protected

Definition at line 68 of file class.ilImageLinkButton.php.

69  {
70  // get rid of parent "submit" css class...
71  }

◆ renderCaption()

ilImageLinkButton::renderCaption ( )
protected

Definition at line 73 of file class.ilImageLinkButton.php.

References ilButtonBase\getCaption(), getImage(), and hasForceTitle().

74  {
75  $attr = array();
76  $attr["src"] = $this->getImage();
77  $attr["alt"] = $this->getCaption();
78  if($this->hasForceTitle())
79  {
80  $attr["title"] = $this->getCaption();
81  }
82  return '<img'.$this->renderAttributesHelper($attr).' />';
83  }
getCaption($a_translate=true)
Get caption.
+ Here is the call graph for this function:

◆ setImage()

ilImageLinkButton::setImage (   $a_value,
  $a_is_internal = true 
)

Set image.

Parameters
string$a_value
bool$a_is_internal

Definition at line 34 of file class.ilImageLinkButton.php.

References ilUtil\getImagePath().

35  {
36  if((bool)$a_is_internal)
37  {
38  $a_value = ilUtil::getImagePath($a_value);
39  }
40  $this->src = trim($a_value);
41  }
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
+ Here is the call graph for this function:

Field Documentation

◆ $force_title

ilImageLinkButton::$force_title
protected

Definition at line 16 of file class.ilImageLinkButton.php.

Referenced by hasForceTitle().

◆ $src

ilImageLinkButton::$src
protected

Definition at line 15 of file class.ilImageLinkButton.php.

Referenced by getImage().


The documentation for this class was generated from the following file: