Inplace_edit class for ajax update of HtmlInput object. More...

Collaboration diagram for Inplace_Edit:

Public Member Functions
	__construct (HtmlInput $p_input)
	Create a Inplace_Edit, initialise JSON and fullfill the default json value: input which is the HtmlInput object serialized. More...

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

	ajax_input ()
	response in ajax to be edited More...

	display ()

	get_input ()
	return the HtmlObject , var input More...

	input ()

	set_callback ($callback)
	the php callback file to call for ajax More...

	set_input (HtmlInput $p_input)
	set the var input (HtmlObject) and update the json attribute input More...

	set_json ($json)

	set_message ($p_str)
	Message to display if the value is empty. More...

	set_value ($p_value)
	Set the value of the HtmlInput object $input. More...

	value ()
	display only the value , if the action after saving or cancelling More...

Static Public Member Functions
static	build ($p_serialize)
	build a Inplace_Edit object from a serialized string (ajax json parameter = input) More...

Private Attributes
	$callback
	Php file which answered the ajax. More...

	$input
	HtmlInput object. More...

	$json
	Json object to pass to JavaScript. More...

	$message
	Message to display if value is empty. More...

Detailed Description

Inplace_edit class for ajax update of HtmlInput object.

You need an ajax to response and modify the data. Some parameters will be sent by default when you click on the element

input : htmlInput object serialized
ieaction : ok or cancel , nothing if you just want to display the input

Very important it is the DOM ID of the HtmlInput element, it must unique. For the date set a uniq dom id, otherwise it fails $id_limit_date->id=uniqid("date");

Examples: inplace_edit.test.php.

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

Constructor & Destructor Documentation

◆ __construct()

Inplace_Edit::__construct ( HtmlInput $p_input )

Create a Inplace_Edit, initialise JSON and fullfill the default json value: input which is the HtmlInput object serialized.

Parameters

HtmlInput $p_input

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

                                             {
        $this->input=$p_input;
        $x["input"]=base64_encode(serialize($p_input));
        $this->json=json_encode($x, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP |JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES|JSON_NUMERIC_CHECK);
        $this->message=_("Cliquez pour éditer");
    }

References input().

Here is the call graph for this function:

Member Function Documentation

◆ add_json_param()

Inplace_Edit::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 198 of file inplace_edit.class.php.

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

◆ ajax_input()

Inplace_Edit::ajax_input ( )

response in ajax to be edited

Definition at line 79 of file inplace_edit.class.php.

                           {
         ob_start();
        echo $this->input->input();
        if ($this->input instanceof ITextarea) {
            echo '<br>';
        } 
        echo Icon_Action::validate("inplace_edit_ok".$this->input->id,"");
        echo Icon_Action::cancel("inplace_edit_cancel".$this->input->id, "");
        echo <<<EOF
        <script>
        $('{$this->input->id}edit').addClassName('inplace_edit_input');
            {$this->input->id}edit.onclick=null;
            inplace_edit_ok{$this->input->id}.onclick= function () {
                var json={$this->json};
                json['ieaction']='ok';
                json['value']=$('{$this->input->id}').value;
                new Ajax.Updater('{$this->input->id}edit'
                ,'{$this->callback}',
                 {parameters:  json ,evalScripts:true});}
            inplace_edit_cancel{$this->input->id}.onclick= function () {
                var json={$this->json};
                json['ieaction']='cancel';
                new Ajax.Updater('{$this->input->id}edit'
                ,'{$this->callback}',
                 {parameters:  json ,evalScripts:true});}
            
        </script>
EOF;
                $ret= ob_get_contents();
                ob_end_clean();
                return $ret;
    }

References $ret, Icon_Action\cancel(), input(), and Icon_Action\validate().

Here is the call graph for this function:

◆ build()

static Inplace_Edit::build ( $p_serialize )

static

build a Inplace_Edit object from a serialized string (ajax json parameter = input)

Examples: inplace_edit.test.php.

Definition at line 66 of file inplace_edit.class.php.

    {
        $input=  unserialize(base64_decode($p_serialize));
        $obj=new Inplace_Edit($input);
        return $obj;
    }

References $input, and $obj.

◆ display()

Inplace_Edit::display ( )

Definition at line 72 of file inplace_edit.class.php.

    {
        echo $this->input->value;
    }

References input().

Here is the call graph for this function:

◆ get_input()

Inplace_Edit::get_input ( )

return the HtmlObject , var input

Definition at line 207 of file inplace_edit.class.php.

                         {
        return $this->input;
    }

References $input.

Referenced by set_value().

◆ input()

Inplace_Edit::input ( )

Definition at line 145 of file inplace_edit.class.php.

                     {
        ob_start();
        $v=$this->input->get_value();
        $v=html_entity_decode($v??"");
        if ( $this->input instanceof ITextarea) {
            echo '<span class="" id="'.$this->input->id.'edit" >';
            echo '<pre class="field_follow_up">';
            $v=(trim($v)=="")?$this->message:$v;
            echo $v;
            echo '</pre>';
            echo'<span class="smallbutton" style="margin-left:5px">Cliquer pour changer</span> ';
        } else {
            $v=(trim($v)=="")?$this->message:$v;
        echo <<<EOF
            <span class="inplace_edit" id="{$this->input->id}edit" >
EOF;
            echo $v;
            
            echo'<span class="smallicon icon" style="margin-left:5px">&#xe80d;</span> ';
        }
        echo "</span>";
        echo "
            
            <script>
        {$this->input->id}edit.onclick=function() {
                 new Ajax.Updater('{$this->input->id}edit'
                ,'{$this->callback}',
                 {parameters:  {$this->json} ,evalScripts:true});
             }
            </script>
              ";   
         $ret= ob_get_contents();
         ob_end_clean();
         return $ret;
    }

References $ret, input(), and span().

Referenced by __construct(), ajax_input(), display(), input(), set_input(), set_value(), and value().

Here is the call graph for this function:

◆ set_callback()

Inplace_Edit::set_callback ( $callback )

the php callback file to call for ajax

Definition at line 183 of file inplace_edit.class.php.

                                     {
        $this->callback=$callback;
    }

References $callback.

◆ set_input()

Inplace_Edit::set_input ( HtmlInput $p_input )

set the var input (HtmlObject) and update the json attribute input

Parameters

HtmlInput $p_input

Definition at line 215 of file inplace_edit.class.php.

                                           {
        $this->input = $p_input;
        $x=json_decode($this->json,TRUE);
        $x["input"]=base64_encode(serialize($p_input));
        $this->json=json_encode($x, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP |JSON_UNESCAPED_UNICODE|JSON_UNESCAPED_SLASHES|JSON_NUMERIC_CHECK);
    }

References input().

Referenced by set_value().

Here is the call graph for this function:

◆ set_json()

Inplace_Edit::set_json ( $json )

Definition at line 191 of file inplace_edit.class.php.

                             {
        $this->json=$json;
    }

References $json.

◆ set_message()

Inplace_Edit::set_message ( $p_str )

Message to display if the value is empty.

Parameters

string $p_str

Definition at line 234 of file inplace_edit.class.php.

                                 {
        $this->message=$p_str;
    }

◆ set_value()

Inplace_Edit::set_value ( $p_value )

Set the value of the HtmlInput object $input.

Parameters

type $p_value

Definition at line 225 of file inplace_edit.class.php.

                                 {
        $input=$this->get_input();
        $this->input->set_value($p_value);
        $this->set_input($input);
    }

References $input, get_input(), input(), and set_input().

Here is the call graph for this function:

◆ value()

Inplace_Edit::value ( )

display only the value , if the action after saving or cancelling

Definition at line 115 of file inplace_edit.class.php.

    {
        $v=$this->input->get_value();
        $v=html_entity_decode($v??"");
         if ( $this->input instanceof ITextarea) {
           
            echo '<pre class="field_follow_up">';
            $v=(trim($v)=="")?$this->message:$v;
            echo $v;
            echo '</pre>';
            echo'<span class="smallbutton" style="margin-left:5px">Cliquer pour changer</span> ';
        } else {
            $v=(trim($v)=="")?$this->message:$v;
            echo $v,
                     '<span class="smallicon icon" style="margin-left:5px">&#xe80d;</span> ';
        }
                    
         echo "
                <script>
            $('{$this->input->id}edit').removeClassName('inplace_edit_input');
        {$this->input->id}edit.onclick=function() {
                 new Ajax.Updater('{$this->input->id}edit'
                ,'{$this->callback}',
                 {parameters:  {$this->json} ,evalScripts:true});}
            </script>
              ";   
    }

References input().

Here is the call graph for this function:

Field Documentation

◆ $callback

Inplace_Edit::$callback

private

Php file which answered the ajax.

Definition at line 50 of file inplace_edit.class.php.

Referenced by set_callback().

◆ $input

Inplace_Edit::$input

private

HtmlInput object.

Definition at line 46 of file inplace_edit.class.php.

Referenced by build(), get_input(), and set_value().

◆ $json

Inplace_Edit::$json

private

Json object to pass to JavaScript.

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

Referenced by set_json().

◆ $message

Inplace_Edit::$message

private

Message to display if value is empty.

Definition at line 52 of file inplace_edit.class.php.

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

include/lib/inplace_edit.class.php

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add_json_param()

◆ ajax_input()

◆ build()

◆ display()

◆ get_input()

◆ input()

◆ set_callback()

◆ set_input()

◆ set_json()

◆ set_message()

◆ set_value()

◆ value()

Field Documentation

◆ $callback

◆ $input

◆ $json

◆ $message