A switch let you switch between 2 values : 0 and 1, it is used to replace the check. More...

Collaboration diagram for Inplace_Switch:

Public Member Functions
	__construct ($p_name, $p_value)

	add_json_param ($p_attribute, $p_value)
	Add json parameter to the current one, if there attribute already exists it will be overwritten. More...

	get_callback ()

	get_iconoff ()

	get_iconon ()

	get_jscript ()

	get_json ()

	get_name ()

	get_value ()

	input ()

	set_callback ($callback)

	set_iconoff ($iconoff)

	set_iconon ($iconon)

	set_jscript ($jscript)

	set_json ($json)

	set_name ($name)

	set_value ($value)

Private Attributes
	$callback
	callback More...

	$iconoff
	The icon off. More...

	$iconon
	The icon on. More...

	$jscript
	Supplemental javascript command, execute after the ajax script. More...

	$json
	Json object. More...

	$name
	name of the widget, javascript id must be unique More...

	$value
	value More...

Detailed Description

A switch let you switch between 2 values : 0 and 1, it is used to replace the check.

Definition at line 33 of file inplace_switch.class.php.

Constructor & Destructor Documentation

◆ __construct()

Inplace_Switch::__construct	(	$p_name,
		$p_value
	)

Definition at line 51 of file inplace_switch.class.php.

    {
        $this->name=$p_name;
        $this->value=$p_value;
        $this->iconon=Icon_Action::iconon(uniqid(), "");
        $this->iconoff=Icon_Action::iconoff(uniqid(), "");
        $this->json=json_encode(['name'=>$p_name,"value"=>$p_value], JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES|JSON_NUMERIC_CHECK);
        $this->callback="ajax.php";
        $this->jscript="";
    }

References Icon_Action\iconoff(), Icon_Action\iconon(), name, and value.

Here is the call graph for this function:

Member Function Documentation

◆ add_json_param()

Inplace_Switch::add_json_param	(	$p_attribute,
		$p_value
	)

Add json parameter to the current one, if there attribute already exists it will be overwritten.

Definition at line 164 of file inplace_switch.class.php.

                                                   {
        $x=json_decode($this->json,TRUE);
        $x[$p_attribute]=$p_value;
        $this->json=json_encode($x, JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES|JSON_NUMERIC_CHECK);
    }

◆ get_callback()

Inplace_Switch::get_callback ( )

Definition at line 106 of file inplace_switch.class.php.

    {
        return $this->callback;
    }

References $callback.

◆ get_iconoff()

Inplace_Switch::get_iconoff ( )

Definition at line 126 of file inplace_switch.class.php.

    {
        return $this->iconoff;
    }

References $iconoff.

◆ get_iconon()

Inplace_Switch::get_iconon ( )

Definition at line 121 of file inplace_switch.class.php.

    {
        return $this->iconon;
    }

References $iconon.

◆ get_jscript()

Inplace_Switch::get_jscript ( )

Definition at line 91 of file inplace_switch.class.php.

    {
        return $this->jscript;
    }

References $jscript.

◆ get_json()

Inplace_Switch::get_json ( )

Definition at line 101 of file inplace_switch.class.php.

    {
        return $this->json;
    }

References $json.

◆ get_name()

Inplace_Switch::get_name ( )

Definition at line 131 of file inplace_switch.class.php.

    {
        return $this->name;
    }

References $name.

◆ get_value()

Inplace_Switch::get_value ( )

Definition at line 136 of file inplace_switch.class.php.

    {
        return $this->value;
    }

References $value.

◆ input()

Inplace_Switch::input ( )

Definition at line 62 of file inplace_switch.class.php.

    {
        if ($this->value==1)
        {
            $icon=$this->iconon;
            $color="green";
        }
        elseif ($this->value==0)
        {
            $icon=$this->iconoff;
            $color="red";
        }
        else
        {
            throw new Exception(_("Invalide value"));
        }
        
        $r=sprintf('<span style="text-decoration: none;color:%s" class="inplace_edit icon" id="%s">', $color,$this->name);
        $r.=$icon;
        $r.= '</span>';
        $r.=<<<EOF
        <script>
{$this->name}.onclick=function() {new Ajax.Updater({$this->name},'{$this->callback}',{method:"get",parameters:{$this->json},evalScripts:true} );
   {$this->jscript} 
   }
</script>
EOF;
    return $r;
    }

References $color, $iconoff, $iconon, $r, elseif, name, and value.

◆ set_callback()

Inplace_Switch::set_callback ( $callback )

Definition at line 116 of file inplace_switch.class.php.

    {
        $this->callback=$callback;
    }

References $callback.

◆ set_iconoff()

Inplace_Switch::set_iconoff ( $iconoff )

Definition at line 146 of file inplace_switch.class.php.

    {
        $this->iconoff=$iconoff;
    }

References $iconoff.

◆ set_iconon()

Inplace_Switch::set_iconon ( $iconon )

Definition at line 141 of file inplace_switch.class.php.

    {
        $this->iconon=$iconon;
    }

References $iconon.

◆ set_jscript()

Inplace_Switch::set_jscript ( $jscript )

Definition at line 96 of file inplace_switch.class.php.

    {
        $this->jscript=$jscript;
    }

References $jscript.

◆ set_json()

Inplace_Switch::set_json ( $json )

Definition at line 111 of file inplace_switch.class.php.

    {
        $this->json=$json;
    }

References $json.

◆ set_name()

Inplace_Switch::set_name ( $name )

Definition at line 151 of file inplace_switch.class.php.

    {
        $this->name=$name;
    }

References $name, and name.

◆ set_value()

Inplace_Switch::set_value ( $value )

Definition at line 156 of file inplace_switch.class.php.

    {
        $this->value=$value;
    }

References $value, and value.

Field Documentation

◆ $callback

Inplace_Switch::$callback

private

callback

Definition at line 47 of file inplace_switch.class.php.

Referenced by get_callback(), and set_callback().

◆ $iconoff

Inplace_Switch::$iconoff

private

The icon off.

Definition at line 39 of file inplace_switch.class.php.

Referenced by get_iconoff(), input(), and set_iconoff().

◆ $iconon

Inplace_Switch::$iconon

private

The icon on.

Definition at line 37 of file inplace_switch.class.php.

Referenced by get_iconon(), input(), and set_iconon().

◆ $jscript

Inplace_Switch::$jscript

private

Supplemental javascript command, execute after the ajax script.

Definition at line 49 of file inplace_switch.class.php.

Referenced by get_jscript(), and set_jscript().

◆ $json

Inplace_Switch::$json

private

Json object.

Definition at line 45 of file inplace_switch.class.php.

Referenced by get_json(), and set_json().

◆ $name

Inplace_Switch::$name

private

name of the widget, javascript id must be unique

Definition at line 41 of file inplace_switch.class.php.

Referenced by get_name(), and set_name().

◆ $value

Inplace_Switch::$value

private

value

Definition at line 43 of file inplace_switch.class.php.

Referenced by get_value(), and set_value().

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

include/lib/inplace_switch.class.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_json_param()

◆ get_callback()

◆ get_iconoff()

◆ get_iconon()

◆ get_jscript()

◆ get_json()

◆ get_name()

◆ get_value()

◆ input()

◆ set_callback()

◆ set_iconoff()

◆ set_iconon()

◆ set_jscript()

◆ set_json()

◆ set_name()

◆ set_value()

Field Documentation

◆ $callback

◆ $iconoff

◆ $iconon

◆ $jscript

◆ $json

◆ $name

◆ $value