Todo_List Class Reference

This class manages the table todo_list. More...

Collaboration diagram for Todo_List:

Public Member Functions
	__construct ($p_init)
	add_share ($p_login)
	Add a share with someone.
	check ($p_idx, &$p_value)
	delete ()
	display ()
	Display the note.
	display_row ($p_odd, $with_tag='Y')
	display_user ()
	display all the user to select the user with who we want to share the connected user is not shown @global type $g_user
	get_class ()
	Highlight today.
	get_info ()
	get_parameter ($p_string)
	insert ()
	is_shared_with ($p_login)
	return the todo_list_shared.id of the note, if nothing is found then return 0
	load ()
	load the todo_list row thanks it's ID
	load_all ()
	load all the task
	remove_share ($p_login)
	remove the share with someone
	remove_shared_with ($p_array)
	Insert a share for current note in the table todo_list_shared The public shared note cannot be removed.
	save ()
	save_shared_with ($p_array)
	Insert a share for current note in the table todo_list_shared.
	set_is_public ($p_value)
	set a note public
	set_parameter ($p_string, $p_value)
	toXML ()
	transform into xml for ajax answer
	update ()
	verify ()

Static Public Member Functions
static	test_me ()
	static testing function
static	to_object ($p_cn, $p_array)

Data Fields
	$tl_desc

Private Attributes
	$cn
	$is_public
	$tl_date
	$tl_id
	$tl_title
	$use_login

Static Private Attributes
static	$variable

Detailed Description

This class manages the table todo_list.

Data Member :

• $cn database connx
• $variable
  • id (todo_list.tl_id)
  • date (todo_list.tl_Date)
  • title (todo_list.title)
  • desc (todo_list.tl_desc)
  • owner (todo_list.use_id)

Definition at line 42 of file todo_list.class.php.

Constructor & Destructor Documentation

__construct()

Todo_List::__construct

(

$p_init

)

Definition at line 55 of file todo_list.class.php.

    {
        $this->cn=$p_init;
        $this->tl_id=0;
        $this->tl_desc="";
        $this->use_login=$_SESSION[SESSION_KEY.'g_user'];
        $this->is_public="N";
 
    }

References cn.

Member Function Documentation

add_share()

Todo_List::add_share

(

$p_login

)

Add a share with someone.

Parameters

type

$p_login

Definition at line 408 of file todo_list.class.php.

    {
        $this->cn->exec_sql("insert into todo_list_shared(todo_list_id,use_login) values ($1,$2)",array($this->tl_id,$p_login));
    }

References insert().

Here is the call graph for this function:

check()

Todo_List::check	(		$p_idx,
		&	$p_value )

Definition at line 74 of file todo_list.class.php.

    {
        if ( strcmp ($p_idx, 'tl_id') == 0 )
        {
            if ( strlen($p_value) > 6 || isNumber ($p_value) == false) return false;
        }
        if ( strcmp ($p_idx, 'tl_date') == 0 )
        {
            if ( noalyss_strlentrim($p_value) ==0 ||strlen($p_value) > 12 || isDate ($p_value) == false) return false;
        }
        if ( strcmp ($p_idx, 'tl_title') == 0 )
        {
            $p_value=mb_substr($p_value,0,120) ;
            return true;
        }
        if ( strcmp ($p_idx, 'tl_desc') == 0 )
        {
            $p_value=mb_substr($p_value,0,1000) ;
            return true;
        }
        return true;
    }

References isDate(), isNumber(), and noalyss_strlentrim().

Referenced by set_parameter().

Here is the call graph for this function:

delete()

Todo_List::delete

(

)

Definition at line 233 of file todo_list.class.php.

    {
        global $g_user;
        if ( $this->use_login != $_SESSION[SESSION_KEY.'g_user'] && $g_user->check_action(SHARENOTEREMOVE)==0) return;
        
        $sql="delete from todo_list_shared where todo_list_id=$1 ";
        $res=$this->cn->exec_sql($sql,array($this->tl_id));
        
        $sql="delete from todo_list where tl_id=$1 ";
        $res=$this->cn->exec_sql($sql,array($this->tl_id));
        
      
 
    }

References $g_user, $res, $sql, cn, and SHARENOTEREMOVE.

display()

Todo_List::display

(

)

Display the note.

Returns

html string

Definition at line 302 of file todo_list.class.php.

    {
        ob_start();
        $this->load();
        include NOALYSS_TEMPLATE.'/todo_list_display.php';
        $ret=ob_get_clean();
        
        return $ret;
    }

References $ret, and load().

Here is the call graph for this function:

display_row()

Todo_List::display_row	(		$p_odd,
			$with_tag = 'Y' )

Definition at line 322 of file todo_list.class.php.

    {
        $r="";
        $highlight=$this->get_class();
        $p_odd=($highlight == "")?$p_odd:$highlight;
        if ( $with_tag == 'Y') $r =  '<tr id="tr'.$this->tl_id.'" class="'.$p_odd.'">';
        $r.=
      '<td sorttable_customkey="'.format_date($this->tl_date,'DD.MM.YYYY','YYYYMMDD').'">'.
                $this->tl_date.
      '</td>'.
      '<td>'.
      '<a class="line" href="javascript:void(0)" onclick="todo_list_show(\''.$this->tl_id.'\')">'.
      htmlspecialchars($this->tl_title).
      '</a>'.
       '</td>';
        if ( $this->is_public == 'Y' && $this->use_login != $_SESSION[SESSION_KEY.'g_user'] )
        { // This is a public note, cannot be removed
            $r.= '<td></td>';
        }
        elseif ($this->use_login == $_SESSION[SESSION_KEY.'g_user'] )
        {
            // This a note the user owns
            $r.=  '<td>'.
                Icon_Action::trash(uniqid(),sprintf("todo_list_remove('%s')",$this->tl_id)).
         '</td>';
        }
        else
        { 
            // this is a note shared by someone else
            $r.=  '<td>'.
                Icon_Action::trash(uniqid(),sprintf("todo_list_remove_share('%s','%s','%s')",$this->tl_id,$this->use_login,Dossier::id())).
         '</td>';
        }
        
      if ( $with_tag == 'Y')  $r .= '</tr>';
        return $r;
    }

References $r, and get_class().

Here is the call graph for this function:

display_user()

Todo_List::display_user

(

)

display all the user to select the user with who we want to share the connected user is not shown @global type $g_user

Definition at line 383 of file todo_list.class.php.

    {
        global $g_user;
        // Get array of user
        $p_array=Noalyss_user::get_list(Dossier::id());
        $dossier=Dossier::id();
        include NOALYSS_TEMPLATE.'/todo_list_list_user.php';
        
    }

get_class()

Todo_List::get_class

(

)

Highlight today.

Returns

string

Definition at line 315 of file todo_list.class.php.

    {
        $p_odd="";
        $a=date('d.m.Y');
        if ($a == $this->tl_date) $p_odd='highlight';
        return $p_odd;
    }

References $a.

Referenced by display_row().

get_info()

Todo_List::get_info

(

)

Definition at line 108 of file todo_list.class.php.

    {
        return var_export(self::$variable,true);
    }

get_parameter()

Todo_List::get_parameter

(

$p_string

)

Definition at line 64 of file todo_list.class.php.

    {
        if ( array_key_exists($p_string,self::$variable) )
        {
            $idx=self::$variable[$p_string];
            return $this->$idx;
        }
        else
            throw new Exception("Attribut inexistant $p_string");
    }

References $idx.

Referenced by save().

insert()

Todo_List::insert

(

)

Definition at line 128 of file todo_list.class.php.

    {
        if ( $this->verify() != 0 ) return;
        if (trim($this->tl_title)=='')
            $this->tl_title=mb_substr(trim($this->tl_desc),0,30);
 
        if (trim($this->tl_title)=='')
        {
            alert('La note est vide');
            return;
        }
 
        /*  limit the title to 35 char */
        $this->tl_title=mb_substr(trim($this->tl_title),0,30);
 
        $sql="insert into todo_list (tl_date,tl_title,tl_desc,use_login,is_public) ".
             " values (to_date($1,'DD.MM.YYYY'),$2,$3,$4,$5)  returning tl_id";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->tl_date,
                       $this->tl_title,
                       $this->tl_desc,
                       $this->use_login,
                     $this->is_public)
             );
        $this->tl_id=Database::fetch_result($res,0,0);
 
    }

References $res, $sql, alert(), cn, DatabaseCore\fetch_result(), and verify().

Referenced by add_share(), and save().

Here is the call graph for this function:

is_shared_with()

Todo_List::is_shared_with

(

$p_login

)

return the todo_list_shared.id of the note, if nothing is found then return 0

Parameters

$p_login

Returns

int

Definition at line 398 of file todo_list.class.php.

    {
        $ret=$this->cn->get_value("select id from todo_list_shared where use_login=$1 and todo_list_id=$2",array($p_login,$this->tl_id));
        if ($ret == "")return 0;
        return $ret;
    }

References from.

load()

Todo_List::load

(

)

load the todo_list row thanks it's ID

Returns

boolean true if found else false

Definition at line 213 of file todo_list.class.php.

                          :bool
    {
 
        $sql="select tl_id,tl_title,tl_desc,to_char( tl_date,'DD.MM.YYYY') as tl_date,is_public,use_login
             from todo_list where tl_id=$1 ";
 
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->tl_id)
             );
 
        if ( Database::num_row($res) == 0 ) return false;
        $row=Database::fetch_array($res,0);
        $aIndex=array_values(self::$variable);
        foreach ($aIndex as $idx)
        {
            $this->$idx=$row[$idx];
        }
        return true;
    }

References $idx, $res, $row, $sql, cn, DatabaseCore\fetch_array(), and DatabaseCore\num_row().

Referenced by display().

Here is the call graph for this function:

load_all()

Todo_List::load_all

(

)

load all the task

Returns

an array of the existing tasks of the current user

Definition at line 188 of file todo_list.class.php.

    {
        $sql="select tl_id, 
                tl_title,
                tl_desc,
                to_char( tl_date,'DD.MM.YYYY') as tl_date,
                is_public,
                use_login
             from todo_list 
             where 
                use_login=$1
                or is_public = 'Y'
                or tl_id in (select todo_list_id from todo_list_shared where use_login=$1)
             order by tl_date::date desc";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->use_login));
        $array=Database::fetch_all($res);
        
        return $array;
    }

References $array, $res, $sql, cn, and DatabaseCore\fetch_all().

Here is the call graph for this function:

remove_share()

Todo_List::remove_share

(

$p_login

)

remove the share with someone

Parameters

type

$p_login

Definition at line 416 of file todo_list.class.php.

    {
        $this->cn->exec_sql("delete from todo_list_shared where todo_list_id = $1 and use_login  = $2 ",array($this->tl_id,$p_login));
    }

References from.

remove_shared_with()

Todo_List::remove_shared_with

(

$p_array

)

Insert a share for current note in the table todo_list_shared The public shared note cannot be removed.

Parameters

string

(use_login)

Definition at line 292 of file todo_list.class.php.

    {
          $this->cn->exec_sql('delete from todo_list_shared where todo_list_id = $1 and use_login=$2',
                    array($this->tl_id,$p_array));
    }

References $p_array, and cn.

save()

Todo_List::save

(

)

Definition at line 120 of file todo_list.class.php.

    {
        if (  $this->get_parameter("id") == 0 )
            $this->insert();
        else
            $this->update();
    }

References get_parameter(), insert(), and update().

Here is the call graph for this function:

save_shared_with()

Todo_List::save_shared_with

(

$p_array

)

Insert a share for current note in the table todo_list_shared.

Parameters

string

(use_login)

Definition at line 276 of file todo_list.class.php.

    {
        global $g_user;
        if ($g_user->check_action(SHARENOTE) == 1 )
        {
            $this->cn->exec_sql('insert into todo_list_shared (todo_list_id,use_login) values ($1,$2)',
                    array($this->tl_id,$p_array));
            
        }
    }

References $g_user, $p_array, cn, and SHARENOTE.

set_is_public()

Todo_List::set_is_public

(

$p_value

)

set a note public

Parameters

$p_value

is Y or N

Definition at line 263 of file todo_list.class.php.

    {
        global $g_user;
        if ($g_user->check_action(SHARENOTEPUBLIC) == 1 )
        {
            $this->is_public=$p_value;
        }
    }

References $g_user, and SHARENOTEPUBLIC.

set_parameter()

Todo_List::set_parameter	(		$p_string,
			$p_value )

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

    {
        if ( array_key_exists($p_string,self::$variable) )
        {
            $idx=self::$variable[$p_string];
            if ($this->check($idx,$p_value) == true )      $this->$idx=$p_value;
        }
        else
            throw new Exception("Attribut inexistant $p_string");
 
 
    }

References $idx, and check().

Here is the call graph for this function:

test_me()

static Todo_List::test_me ( )

static

static testing function

Definition at line 422 of file todo_list.class.php.

    {
    }

to_object()

static Todo_List::to_object ( $p_cn, $p_array )

static

Definition at line 359 of file todo_list.class.php.

    {
        
        $ret=array();
        if ( $p_array == FALSE ) return $ret;
        $end=count($p_array);
        for ($i=0;$i < $end;$i++)
        {
            $t=new Todo_List($p_cn);
            $t->tl_id=$p_array[$i]['tl_id'];
            $t->tl_date=$p_array[$i]['tl_date'];
            $t->tl_title=$p_array[$i]['tl_title'];
            $t->tl_desc=$p_array[$i]['tl_desc'];
            $t->is_public=$p_array[$i]['is_public'];
            $t->use_login=$p_array[$i]['use_login'];
            $ret[$i]=clone $t;
        }
        return $ret;
    }

Referenced by Noalyss\Widget\Todo_List\display().

toXML()

Todo_List::toXML

(

)

transform into xml for ajax answer

Definition at line 250 of file todo_list.class.php.

    {
        $id='<tl_id>'.$this->tl_id.'</tl_id>';
        $title='<tl_title>'.escape_xml($this->tl_title).'</tl_title>';
        $desc='<tl_desc>'.escape_xml($this->tl_desc).'</tl_desc>';
        $date='<tl_date>'.$this->tl_date.'</tl_date>';
        $ret='<data>'.$id.$title.$desc.$date.'</data>';
        return $ret;
    }

References $date, $desc, $id, $ret, and $title.

update()

Todo_List::update

(

)

Definition at line 157 of file todo_list.class.php.

    {
        if ( $this->verify() != 0 ) return;
 
        if (trim($this->tl_title)=='')
            $this->tl_title=mb_substr(trim($this->tl_desc),0,40);
 
        if (trim($this->tl_title)=='')
        {
            
            return;
        }
 
        /*  limit the title to 35 char */
        $this->tl_title=mb_substr(trim($this->tl_title),0,40);
 
        $sql="update todo_list set tl_title=$1,tl_date=to_date($2,'DD.MM.YYYY'),tl_desc=$3,is_public=$5 ".
             " where tl_id = $4";
        $res=$this->cn->exec_sql(
                 $sql,
                 array($this->tl_title,
                       $this->tl_date,
                       $this->tl_desc,
                       $this->tl_id,
                     $this->is_public)
             );
 
    }

References $res, $sql, cn, and verify().

Referenced by save().

Here is the call graph for this function:

verify()

Todo_List::verify

(

)

Definition at line 112 of file todo_list.class.php.

    {
        if ( isDate($this->tl_date) == false )
        {
                        $this->tl_date=date('d.m.Y');
        }
        return 0;
    }

References isDate().

Referenced by insert(), and update().

Here is the call graph for this function:

Field Documentation

$cn

Todo_List::$cn

private

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

$is_public

Todo_List::$is_public

private

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

$tl_date

Todo_List::$tl_date

private

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

$tl_desc

Todo_List::$tl_desc

Definition at line 54 of file todo_list.class.php.

$tl_id

Todo_List::$tl_id

private

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

$tl_title

Todo_List::$tl_title

private

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

$use_login

Todo_List::$use_login

private

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

$variable

Todo_List::$variable

staticprivate

Initial value:

=array(
                                 "id"=>"tl_id",
                                 "date"=>"tl_date",
                                 "title"=>"tl_title",
                                 "desc"=>"tl_desc",
                                 "owner"=>"use_login",
                                 "is_public"=>"is_public")

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

---

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

• include/class/todo_list.class.php