2021-09-27 11:20:38 +02:00
< ? php
/* Copyright ( C ) 2017 Laurent Destailleur < eldy @ users . sourceforge . net >
* Copyright ( C ) 2021 Gauthier VERDOL < gauthier . verdol @ atm - consulting . fr >
* Copyright ( C ) 2021 Greg Rastklan < greg . rastklan @ atm - consulting . fr >
* Copyright ( C ) 2021 Jean - Pascal BOUDET < jean - pascal . boudet @ atm - consulting . fr >
* Copyright ( C ) 2021 Grégory BLEMAND < gregory . blemand @ atm - consulting . fr >
*
* This program is free software ; you can redistribute it and / or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation ; either version 3 of the License , or
* ( at your option ) any later version .
*
* This program is distributed in the hope that it will be useful ,
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU General Public License for more details .
*
* You should have received a copy of the GNU General Public License
* along with this program . If not , see < https :// www . gnu . org / licenses />.
*/
/**
* \file class / skill . class . php
* \ingroup hrm
* \brief This file is a CRUD class file for Skill ( Create / Read / Update / Delete )
*/
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT . '/core/class/commonobject.class.php' ;
//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
/**
* Class for Skill
*/
class Skill extends CommonObject
{
/**
* @ var string ID of module .
*/
public $module = 'hrm' ;
/**
* @ var string ID to identify managed object .
*/
public $element = 'skill' ;
/**
* @ var string Name of table without prefix where object is stored . This is also the key used for extrafields management .
*/
public $table_element = 'hrm_skill' ;
/**
* @ var string Name of subtable line
*/
public $table_element_line = 'skilldet' ;
/**
* @ var int Does this object support multicompany module ?
* 0 = No test on entity , 1 = Test with field entity , 'field@table' = Test with link by field @ table
*/
public $ismultientitymanaged = 0 ;
/**
* @ var int Does object support extrafields ? 0 = No , 1 = Yes
*/
public $isextrafieldmanaged = 1 ;
/**
* @ var string String with name of icon for skill . Must be the part after the 'object_' into object_skill . png
*/
public $picto = 'shapes' ;
const STATUS_DRAFT = 0 ;
const STATUS_VALIDATED = 1 ;
const STATUS_CANCELED = 9 ;
const DEFAULT_MAX_RANK_PER_SKILL = 5 ;
/**
* 'type' field format ( 'integer' , 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter]]' , 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter]]]' , 'varchar(x)' , 'double(24,8)' , 'real' , 'price' , 'text' , 'text:none' , 'html' , 'date' , 'datetime' , 'timestamp' , 'duration' , 'mail' , 'phone' , 'url' , 'password' )
* Note : Filter can be a string like " (t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL) "
* 'label' the translation key .
* 'picto' is code of a picto to show before value in forms
* 'enabled' is a condition when the field must be managed ( Example : 1 or ' $conf -> global -> MY_SETUP_PARAM )
* 'position' is the sort order of field .
* 'notnull' is set to 1 if not null in database . Set to - 1 if we must set data to null if empty ( '' or 0 ) .
* 'visible' says if field is visible in list ( Examples : 0 = Not visible , 1 = Visible on list and create / update / view forms , 2 = Visible on list only , 3 = Visible on create / update / view form only ( not list ), 4 = Visible on list and update / view form only ( not create ) . 5 = Visible on list and view only ( not create / not update ) . Using a negative value means field is not shown by default on list but can be selected for viewing )
* 'noteditable' says if field is not editable ( 1 or 0 )
* 'default' is a default value for creation ( can still be overwrote by the Setup of Default Values if field is editable in creation form ) . Note : If default is set to '(PROV)' and field is 'ref' , the default value will be set to '(PROVid)' where id is rowid when a new record is created .
* 'index' if we want an index in database .
* 'foreignkey' => 'tablename.field' if the field is a foreign key ( it is recommanded to name the field fk_ ... ) .
* 'searchall' is 1 if we want to search in this field when making a search from the quick search button .
* 'isameasure' must be set to 1 if you want to have a total on list for this field . Field type must be summable like integer or double ( 24 , 8 ) .
* 'css' and 'cssview' and 'csslist' is the CSS style to use on field . 'css' is used in creation and update . 'cssview' is used in view mode . 'csslist' is used for columns in lists . For example : 'css' => 'minwidth300 maxwidth500 widthcentpercentminusx' , 'cssview' => 'wordbreak' , 'csslist' => 'tdoverflowmax200'
* 'help' is a 'TranslationString' to use to show a tooltip on field . You can also use 'TranslationString:keyfortooltiponlick' for a tooltip on click .
* 'showoncombobox' if value of the field must be visible into the label of the combobox that list record
* 'disabled' is 1 if we want to have the field locked by a 'disabled' attribute . In most cases , this is never set into the definition of $fields into class , but is set dynamically by some part of code .
* 'arrayofkeyval' to set a list of values if type is a list of predefined values . For example : array ( " 0 " => " Draft " , " 1 " => " Active " , " -1 " => " Cancel " ) . Note that type can be 'integer' or 'varchar'
* 'autofocusoncreate' to have field having the focus on a create form . Only 1 field should have this property set to 1.
* 'comment' is not used . You can store here any text of your choice . It is not used by application .
*
* Note : To have value dynamic , you can set value to 0 in definition and edit the value on the fly into the constructor .
*/
// BEGIN MODULEBUILDER PROPERTIES
/**
* @ var array Array with all fields and their property . Do not use it as a static var . It may be modified by constructor .
*/
public $fields = array (
'rowid' => array ( 'type' => 'integer' , 'label' => 'TechnicalID' , 'enabled' => '1' , 'position' => 1 , 'notnull' => 1 , 'visible' => 0 , 'noteditable' => '1' , 'index' => 1 , 'css' => 'left' , 'comment' => " Id " ),
'label' => array ( 'type' => 'varchar(255)' , 'label' => 'Label' , 'enabled' => '1' , 'position' => 30 , 'notnull' => 1 , 'visible' => 1 , 'searchall' => 1 , 'css' => 'minwidth300' , 'cssview' => 'wordbreak' , 'showoncombobox' => '2' ,),
'description' => array ( 'type' => 'text' , 'label' => 'Description' , 'enabled' => '1' , 'position' => 60 , 'notnull' => 0 , 'visible' => 3 ,),
'date_creation' => array ( 'type' => 'datetime' , 'label' => 'DateCreation' , 'enabled' => '1' , 'position' => 500 , 'notnull' => 1 , 'visible' =>- 2 ,),
'tms' => array ( 'type' => 'timestamp' , 'label' => 'DateModification' , 'enabled' => '1' , 'position' => 501 , 'notnull' => 0 , 'visible' =>- 2 ,),
'fk_user_creat' => array ( 'type' => 'integer:User:user/class/user.class.php' , 'label' => 'UserAuthor' , 'enabled' => '1' , 'position' => 510 , 'notnull' => 1 , 'visible' =>- 2 , 'foreignkey' => 'user.rowid' ,),
'fk_user_modif' => array ( 'type' => 'integer:User:user/class/user.class.php' , 'label' => 'UserModif' , 'enabled' => '1' , 'position' => 511 , 'notnull' =>- 1 , 'visible' =>- 2 ,),
'required_level' => array ( 'type' => 'integer' , 'label' => 'requiredLevel' , 'enabled' => '1' , 'position' => 50 , 'notnull' => 1 , 'visible' => 0 ,),
'date_validite' => array ( 'type' => 'integer' , 'label' => 'date_validite' , 'enabled' => '1' , 'position' => 52 , 'notnull' => 1 , 'visible' => 0 ,),
'temps_theorique' => array ( 'type' => 'double(24,8)' , 'label' => 'temps_theorique' , 'enabled' => '1' , 'position' => 54 , 'notnull' => 1 , 'visible' => 0 ,),
'skill_type' => array ( 'type' => 'integer' , 'label' => 'SkillType' , 'enabled' => '1' , 'position' => 55 , 'notnull' => 1 , 'visible' => 1 , 'index' => 1 , 'arrayofkeyval' => array ( '0' => 'knowHow' , '1' => 'HowToBe' , '9' => 'knowledge' ), 'default' => 0 ),
'note_public' => array ( 'type' => 'html' , 'label' => 'NotePublic' , 'enabled' => '1' , 'position' => 70 , 'notnull' => 0 , 'visible' => 0 ,),
'note_private' => array ( 'type' => 'html' , 'label' => 'NotePrivate' , 'enabled' => '1' , 'position' => 71 , 'notnull' => 0 , 'visible' => 0 ,),
);
public $rowid ;
public $label ;
public $description ;
public $date_creation ;
public $tms ;
public $fk_user_creat ;
public $fk_user_modif ;
public $required_level ;
public $date_validite ;
public $temps_theorique ;
public $skill_type ;
public $note_public ;
public $note_private ;
// END MODULEBUILDER PROPERTIES
// If this object has a subtable with lines
// /**
// * @var string Name of subtable line
// */
// public $table_element_line = 'hrm_skillline';
// /**
// * @var string Field with ID of parent key if this object has a parent
// */
public $fk_element = 'fk_skill' ;
// /**
// * @var string Name of subtable class that manage subtable lines
// */
// public $class_element_line = 'Skillline';
// /**
// * @var array List of child tables. To test if we can delete object.
// */
protected $childtables = array ( 'hrm_skillrank' , 'hrm_evaluationdet' );
// /**
// * @var array List of child tables. To know object to delete on cascade.
// * If name matches '@ClassNAme:FilePathClass;ParentFkFieldName' it will
// * call method deleteByParentField(parentId, ParentFkFieldName) to fetch and delete child object
// */
protected $childtablesoncascade = array ( 'hrm_skilldet' );
// /**
// * @var SkillLine[] Array of subtable lines
// */
// public $lines = array();
/**
* Constructor
*
* @ param DoliDb $db Database handler
*/
public function __construct ( DoliDB $db )
{
global $conf , $langs ;
$this -> db = $db ;
if ( empty ( $conf -> global -> MAIN_SHOW_TECHNICAL_ID ) && isset ( $this -> fields [ 'rowid' ])) {
$this -> fields [ 'rowid' ][ 'visible' ] = 0 ;
}
if ( empty ( $conf -> multicompany -> enabled ) && isset ( $this -> fields [ 'entity' ])) {
$this -> fields [ 'entity' ][ 'enabled' ] = 0 ;
}
// Example to show how to set values of fields definition dynamically
/* if ( $user -> rights -> hrm -> skill -> read ) {
$this -> fields [ 'myfield' ][ 'visible' ] = 1 ;
$this -> fields [ 'myfield' ][ 'noteditable' ] = 0 ;
} */
// Unset fields that are disabled
foreach ( $this -> fields as $key => $val ) {
if ( isset ( $val [ 'enabled' ]) && empty ( $val [ 'enabled' ])) {
unset ( $this -> fields [ $key ]);
}
}
// Translate some data of arrayofkeyval
if ( is_object ( $langs )) {
foreach ( $this -> fields as $key => $val ) {
if ( ! empty ( $val [ 'arrayofkeyval' ]) && is_array ( $val [ 'arrayofkeyval' ])) {
foreach ( $val [ 'arrayofkeyval' ] as $key2 => $val2 ) {
$this -> fields [ $key ][ 'arrayofkeyval' ][ $key2 ] = $langs -> trans ( $val2 );
}
}
}
}
}
/**
* Create object into database
*
* @ param User $user User that creates
* @ param bool $notrigger false = launch triggers after , true = disable triggers
* @ return int < 0 if KO , Id of created object if OK
*/
public function create ( User $user , $notrigger = false )
{
global $langs , $conf ;
$resultcreate = $this -> createCommon ( $user , $notrigger );
if ( $resultcreate > 0 ) {
// skillDet create
$this -> createSkills ();
}
return $resultcreate ;
}
2021-09-28 08:40:15 +02:00
/**
2021-11-27 14:46:47 +01:00
* createSkills
*
* @ param int $i Rank from which we want to create skilldets ( level $i to HRM_MAXRANK wil be created )
2021-09-28 08:40:15 +02:00
* @ return null
*/
2021-09-27 11:20:38 +02:00
public function createSkills ( $i = 1 )
{
global $conf , $user , $langs ;
$MaxNumberSkill = isset ( $conf -> global -> HRM_MAXRANK ) ? $conf -> global -> HRM_MAXRANK : self :: DEFAULT_MAX_RANK_PER_SKILL ;
$defaultSkillDesc = ! empty ( $conf -> global -> HRM_DEFAULT_SKILL_DESCRIPTION ) ? $conf -> global -> HRM_DEFAULT_SKILL_DESCRIPTION : 'no Description' ;
2021-11-27 14:46:47 +01:00
$error = 0 ;
2021-09-27 11:20:38 +02:00
require_once __DIR__ . '/skilldet.class.php' ;
2021-11-27 14:46:47 +01:00
$this -> db -> begin ();
// Create level of skills
2021-09-27 11:20:38 +02:00
for ( $i ; $i <= $MaxNumberSkill ; $i ++ ) {
$skilldet = new Skilldet ( $this -> db );
2021-11-27 14:46:47 +01:00
$skilldet -> description = $defaultSkillDesc . " " . $i ;
$skilldet -> rankorder = $i ;
2021-09-27 11:20:38 +02:00
$skilldet -> fk_skill = $this -> id ;
$result = $skilldet -> create ( $user );
2021-11-27 14:46:47 +01:00
if ( $result <= 0 ) {
$error ++ ;
2021-09-27 11:20:38 +02:00
}
}
2021-11-27 14:46:47 +01:00
if ( ! $error ) {
$this -> db -> commit ();
setEventMessage ( $langs -> trans ( 'SkillCreated' ), $i );
return 1 ;
} else {
$this -> db -> rollback ();
return - 1 ;
}
2021-09-27 11:20:38 +02:00
}
/**
* Clone an object into another one
*
* @ param User $user User that creates
* @ param int $fromid Id of object to clone
* @ return mixed New object created , < 0 if KO
*/
public function createFromClone ( User $user , $fromid )
{
global $langs , $extrafields ;
$error = 0 ;
dol_syslog ( __METHOD__ , LOG_DEBUG );
$object = new self ( $this -> db );
$this -> db -> begin ();
// Load source object
$result = $object -> fetchCommon ( $fromid );
if ( $result > 0 && ! empty ( $object -> table_element_line )) {
$object -> fetchLines ();
}
// get lines so they will be clone
//foreach($this->lines as $line)
// $line->fetch_optionals();
// Reset some properties
unset ( $object -> id );
unset ( $object -> fk_user_creat );
unset ( $object -> import_key );
// Clear fields
if ( property_exists ( $object , 'ref' )) {
$object -> ref = empty ( $this -> fields [ 'ref' ][ 'default' ]) ? " Copy_Of_ " . $object -> ref : $this -> fields [ 'ref' ][ 'default' ];
}
if ( property_exists ( $object , 'label' )) {
$object -> label = empty ( $this -> fields [ 'label' ][ 'default' ]) ? $langs -> trans ( " CopyOf " ) . " " . $object -> label : $this -> fields [ 'label' ][ 'default' ];
}
if ( property_exists ( $object , 'status' )) {
$object -> status = self :: STATUS_DRAFT ;
}
if ( property_exists ( $object , 'date_creation' )) {
$object -> date_creation = dol_now ();
}
if ( property_exists ( $object , 'date_modification' )) {
$object -> date_modification = null ;
}
// ...
// Clear extrafields that are unique
if ( is_array ( $object -> array_options ) && count ( $object -> array_options ) > 0 ) {
$extrafields -> fetch_name_optionals_label ( $this -> table_element );
foreach ( $object -> array_options as $key => $option ) {
$shortkey = preg_replace ( '/options_/' , '' , $key );
if ( ! empty ( $extrafields -> attributes [ $this -> table_element ][ 'unique' ][ $shortkey ])) {
//var_dump($key); var_dump($clonedObj->array_options[$key]); exit;
unset ( $object -> array_options [ $key ]);
}
}
}
// Create clone
$object -> context [ 'createfromclone' ] = 'createfromclone' ;
$result = $object -> createCommon ( $user );
if ( $result < 0 ) {
$error ++ ;
$this -> error = $object -> error ;
$this -> errors = $object -> errors ;
}
if ( ! $error ) {
// copy internal contacts
if ( $this -> copy_linked_contact ( $object , 'internal' ) < 0 ) {
$error ++ ;
}
}
if ( ! $error ) {
// copy external contacts if same company
if ( property_exists ( $this , 'fk_soc' ) && $this -> fk_soc == $object -> socid ) {
if ( $this -> copy_linked_contact ( $object , 'external' ) < 0 ) {
$error ++ ;
}
}
}
unset ( $object -> context [ 'createfromclone' ]);
// End
if ( ! $error ) {
$this -> db -> commit ();
return $object ;
} else {
$this -> db -> rollback ();
return - 1 ;
}
}
/**
* Load object in memory from the database
*
* @ param int $id Id object
* @ param string $ref Ref
* @ return int < 0 if KO , 0 if not found , > 0 if OK
*/
public function fetch ( $id , $ref = null )
{
$result = $this -> fetchCommon ( $id , $ref );
if ( $result > 0 && ! empty ( $this -> table_element_line )) {
$this -> fetchLines ();
}
return $result ;
}
/**
* Load object lines in memory from the database
*
2021-11-27 14:46:47 +01:00
* @ return array < 0 if KO , array of skill level found
2021-09-27 11:20:38 +02:00
*/
public function fetchLines ()
{
$this -> lines = array ();
require_once __DIR__ . '/skilldet.class.php' ;
$skilldet = new Skilldet ( $this -> db );
$this -> lines = $skilldet -> fetchAll ( 'ASC' , '' , '' , '' , array ( 'fk_skill' => $this -> id ), '' );
2021-12-03 10:59:47 +01:00
if ( is_array ( $this -> lines )) {
return ( count ( $this -> lines ) > 0 ) ? $this -> lines : array ();
} elseif ( $this -> lines < 0 ) {
$this -> errors = array_merge ( $this -> errors , $skilldet -> errors );
$this -> error = $skilldet -> error ;
return $this -> lines ;
}
2021-09-27 11:20:38 +02:00
}
/**
* Load list of objects in memory from the database .
*
* @ param string $sortorder Sort Order
* @ param string $sortfield Sort field
* @ param int $limit limit
* @ param int $offset Offset
* @ param array $filter Filter array . Example array ( 'field' => 'valueforlike' , 'customurl' =>... )
* @ param string $filtermode Filter mode ( AND or OR )
* @ return array | int int < 0 if KO , array of pages if OK
*/
public function fetchAll ( $sortorder = '' , $sortfield = '' , $limit = 0 , $offset = 0 , array $filter = array (), $filtermode = 'AND' )
{
global $conf ;
dol_syslog ( __METHOD__ , LOG_DEBUG );
$records = array ();
$sql = 'SELECT ' ;
$sql .= $this -> getFieldList ( 't' );
$sql .= ' FROM ' . MAIN_DB_PREFIX . $this -> table_element . ' as t' ;
if ( isset ( $this -> ismultientitymanaged ) && $this -> ismultientitymanaged == 1 ) {
$sql .= ' WHERE t.entity IN (' . getEntity ( $this -> table_element ) . ')' ;
} else {
$sql .= ' WHERE 1 = 1' ;
}
// Manage filter
$sqlwhere = array ();
if ( count ( $filter ) > 0 ) {
foreach ( $filter as $key => $value ) {
if ( $key == 't.rowid' ) {
$sqlwhere [] = $key . '=' . $value ;
} elseif ( in_array ( $this -> fields [ $key ][ 'type' ], array ( 'date' , 'datetime' , 'timestamp' ))) {
$sqlwhere [] = $key . ' = \'' . $this -> db -> idate ( $value ) . '\'' ;
} elseif ( $key == 'customsql' ) {
$sqlwhere [] = $value ;
} elseif ( strpos ( $value , '%' ) === false ) {
$sqlwhere [] = $key . ' IN (' . $this -> db -> sanitize ( $this -> db -> escape ( $value )) . ')' ;
} else {
$sqlwhere [] = $key . ' LIKE \'%' . $this -> db -> escape ( $value ) . '%\'' ;
}
}
}
if ( count ( $sqlwhere ) > 0 ) {
2021-10-06 14:21:02 +02:00
$sql .= " AND ( " . implode ( " " . $filtermode . " " , $sqlwhere ) . " ) " ;
2021-09-27 11:20:38 +02:00
}
if ( ! empty ( $sortfield )) {
$sql .= $this -> db -> order ( $sortfield , $sortorder );
}
if ( ! empty ( $limit )) {
$sql .= ' ' . $this -> db -> plimit ( $limit , $offset );
}
$resql = $this -> db -> query ( $sql );
if ( $resql ) {
$num = $this -> db -> num_rows ( $resql );
$i = 0 ;
while ( $i < ( $limit ? min ( $limit , $num ) : $num )) {
$obj = $this -> db -> fetch_object ( $resql );
$record = new self ( $this -> db );
$record -> setVarsFromFetchObj ( $obj );
$records [ $record -> id ] = $record ;
$i ++ ;
}
$this -> db -> free ( $resql );
return $records ;
} else {
$this -> errors [] = 'Error ' . $this -> db -> lasterror ();
dol_syslog ( __METHOD__ . ' ' . join ( ',' , $this -> errors ), LOG_ERR );
return - 1 ;
}
}
/**
* Update object into database
*
* @ param User $user User that modifies
* @ param bool $notrigger false = launch triggers after , true = disable triggers
* @ return int < 0 if KO , > 0 if OK
*/
public function update ( User $user , $notrigger = false )
{
return $this -> updateCommon ( $user , $notrigger );
}
/**
* Delete object in database
*
* @ param User $user User that deletes
* @ param bool $notrigger false = launch triggers after , true = disable triggers
* @ return int < 0 if KO , > 0 if OK
*/
public function delete ( User $user , $notrigger = false )
{
return $this -> deleteCommon ( $user , $notrigger );;
}
/**
* Delete a line of object in database
*
* @ param User $user User that delete
* @ param int $idline Id of line to delete
* @ param bool $notrigger false = launch triggers after , true = disable triggers
* @ return int > 0 if OK , < 0 if KO
*/
public function deleteLine ( User $user , $idline , $notrigger = false )
{
if ( $this -> status < 0 ) {
$this -> error = 'ErrorDeleteLineNotAllowedByObjectStatus' ;
return - 2 ;
}
return $this -> deleteLineCommon ( $user , $idline , $notrigger );
}
/**
* Validate object
*
* @ param User $user User making status change
* @ param int $notrigger 1 = Does not execute triggers , 0 = execute triggers
* @ return int <= 0 if OK , 0 = Nothing done , > 0 if KO
*/
public function validate ( $user , $notrigger = 0 )
{
global $conf , $langs ;
require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php' ;
$error = 0 ;
// Protection
if ( $this -> status == self :: STATUS_VALIDATED ) {
dol_syslog ( get_class ( $this ) . " ::validate action abandonned: already validated " , LOG_WARNING );
return 0 ;
}
/* if ( ! (( empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> skill -> write ))
|| ( ! empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> skill -> skill_advance -> validate ))))
{
$this -> error = 'NotEnoughPermissions' ;
dol_syslog ( get_class ( $this ) . " ::valid " . $this -> error , LOG_ERR );
return - 1 ;
} */
$now = dol_now ();
$this -> db -> begin ();
// Define new ref
if ( ! $error && ( preg_match ( '/^[\(]?PROV/i' , $this -> ref ) || empty ( $this -> ref ))) { // empty should not happened, but when it occurs, the test save life
$num = $this -> getNextNumRef ();
} else {
$num = $this -> ref ;
}
$this -> newref = $num ;
if ( ! empty ( $num )) {
// Validate
$sql = " UPDATE " . MAIN_DB_PREFIX . $this -> table_element ;
$sql .= " SET ref = ' " . $this -> db -> escape ( $num ) . " ', " ;
$sql .= " status = " . self :: STATUS_VALIDATED ;
if ( ! empty ( $this -> fields [ 'date_validation' ])) {
$sql .= " , date_validation = ' " . $this -> db -> idate ( $now ) . " ' " ;
}
if ( ! empty ( $this -> fields [ 'fk_user_valid' ])) {
$sql .= " , fk_user_valid = " . (( int ) $user -> id );
}
$sql .= " WHERE rowid = " . (( int ) $this -> id );
dol_syslog ( get_class ( $this ) . " ::validate() " , LOG_DEBUG );
$resql = $this -> db -> query ( $sql );
if ( ! $resql ) {
dol_print_error ( $this -> db );
$this -> error = $this -> db -> lasterror ();
$error ++ ;
}
if ( ! $error && ! $notrigger ) {
// Call trigger
$result = $this -> call_trigger ( 'SKILL_VALIDATE' , $user );
if ( $result < 0 ) {
$error ++ ;
}
// End call triggers
}
}
if ( ! $error ) {
$this -> oldref = $this -> ref ;
// Rename directory if dir was a temporary ref
if ( preg_match ( '/^[\(]?PROV/i' , $this -> ref )) {
// Now we rename also files into index
$sql = 'UPDATE ' . MAIN_DB_PREFIX . " ecm_files set filename = CONCAT(' " . $this -> db -> escape ( $this -> newref ) . " ', SUBSTR(filename, " . ( strlen ( $this -> ref ) + 1 ) . " )), filepath = 'skill/ " . $this -> db -> escape ( $this -> newref ) . " ' " ;
$sql .= " WHERE filename LIKE ' " . $this -> db -> escape ( $this -> ref ) . " %' AND filepath = 'skill/ " . $this -> db -> escape ( $this -> ref ) . " ' and entity = " . $conf -> entity ;
$resql = $this -> db -> query ( $sql );
if ( ! $resql ) {
$error ++ ; $this -> error = $this -> db -> lasterror ();
}
// We rename directory ($this->ref = old ref, $num = new ref) in order not to lose the attachments
$oldref = dol_sanitizeFileName ( $this -> ref );
$newref = dol_sanitizeFileName ( $num );
$dirsource = $conf -> hrm -> dir_output . '/skill/' . $oldref ;
$dirdest = $conf -> hrm -> dir_output . '/skill/' . $newref ;
if ( ! $error && file_exists ( $dirsource )) {
dol_syslog ( get_class ( $this ) . " ::validate() rename dir " . $dirsource . " into " . $dirdest );
if ( @ rename ( $dirsource , $dirdest )) {
dol_syslog ( " Rename ok " );
// Rename docs starting with $oldref with $newref
$listoffiles = dol_dir_list ( $conf -> hrm -> dir_output . '/skill/' . $newref , 'files' , 1 , '^' . preg_quote ( $oldref , '/' ));
foreach ( $listoffiles as $fileentry ) {
$dirsource = $fileentry [ 'name' ];
$dirdest = preg_replace ( '/^' . preg_quote ( $oldref , '/' ) . '/' , $newref , $dirsource );
$dirsource = $fileentry [ 'path' ] . '/' . $dirsource ;
$dirdest = $fileentry [ 'path' ] . '/' . $dirdest ;
@ rename ( $dirsource , $dirdest );
}
}
}
}
}
// Set new ref and current status
if ( ! $error ) {
$this -> ref = $num ;
$this -> status = self :: STATUS_VALIDATED ;
}
if ( ! $error ) {
$this -> db -> commit ();
return 1 ;
} else {
$this -> db -> rollback ();
return - 1 ;
}
}
/**
* Set draft status
*
* @ param User $user Object user that modify
* @ param int $notrigger 1 = Does not execute triggers , 0 = Execute triggers
* @ return int < 0 if KO , > 0 if OK
*/
public function setDraft ( $user , $notrigger = 0 )
{
// Protection
if ( $this -> status <= self :: STATUS_DRAFT ) {
return 0 ;
}
/* if ( ! (( empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> write ))
|| ( ! empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> hrm_advance -> validate ))))
{
$this -> error = 'Permission denied' ;
return - 1 ;
} */
return $this -> setStatusCommon ( $user , self :: STATUS_DRAFT , $notrigger , 'SKILL_UNVALIDATE' );
}
/**
* Set cancel status
*
* @ param User $user Object user that modify
* @ param int $notrigger 1 = Does not execute triggers , 0 = Execute triggers
* @ return int < 0 if KO , 0 = Nothing done , > 0 if OK
*/
public function cancel ( $user , $notrigger = 0 )
{
// Protection
if ( $this -> status != self :: STATUS_VALIDATED ) {
return 0 ;
}
/* if ( ! (( empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> write ))
|| ( ! empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> hrm_advance -> validate ))))
{
$this -> error = 'Permission denied' ;
return - 1 ;
} */
return $this -> setStatusCommon ( $user , self :: STATUS_CANCELED , $notrigger , 'SKILL_CANCEL' );
}
/**
* Set back to validated status
*
* @ param User $user Object user that modify
* @ param int $notrigger 1 = Does not execute triggers , 0 = Execute triggers
* @ return int < 0 if KO , 0 = Nothing done , > 0 if OK
*/
public function reopen ( $user , $notrigger = 0 )
{
// Protection
if ( $this -> status != self :: STATUS_CANCELED ) {
return 0 ;
}
/* if ( ! (( empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> write ))
|| ( ! empty ( $conf -> global -> MAIN_USE_ADVANCED_PERMS ) && ! empty ( $user -> rights -> hrm -> hrm_advance -> validate ))))
{
$this -> error = 'Permission denied' ;
return - 1 ;
} */
return $this -> setStatusCommon ( $user , self :: STATUS_VALIDATED , $notrigger , 'SKILL_REOPEN' );
}
/**
* Return a link to the object card ( with optionaly the picto )
*
* @ param int $withpicto Include picto in link ( 0 = No picto , 1 = Include picto into link , 2 = Only picto )
* @ param string $option On what the link point to ( 'nolink' , ... )
* @ param int $notooltip 1 = Disable tooltip
* @ param string $morecss Add more css on link
* @ param int $save_lastsearch_value - 1 = Auto , 0 = No save of lastsearch_values when clicking , 1 = Save lastsearch_values whenclicking
* @ return string String with URL
*/
/**
* Return a link to the object card ( with optionaly the picto )
*
* @ param int $withpicto Include picto in link ( 0 = No picto , 1 = Include picto into link , 2 = Only picto )
* @ param string $option On what the link point to ( 'nolink' , ... )
* @ param int $notooltip 1 = Disable tooltip
* @ param string $morecss Add more css on link
* @ param int $save_lastsearch_value - 1 = Auto , 0 = No save of lastsearch_values when clicking , 1 = Save lastsearch_values whenclicking
* @ return string String with URL
*/
public function getNomUrl ( $withpicto = 0 , $option = '' , $notooltip = 0 , $morecss = '' , $save_lastsearch_value = - 1 )
{
global $conf , $langs , $hookmanager ;
if ( ! empty ( $conf -> dol_no_mouse_hover )) {
$notooltip = 1 ; // Force disable tooltips
}
$result = '' ;
$label = img_picto ( '' , $this -> picto ) . ' <u>' . $langs -> trans ( " Skill " ) . '</u>' ;
if ( isset ( $this -> status )) {
$label .= ' ' . $this -> getLibStatut ( 5 );
}
$label .= '<br>' ;
$label .= '<b>' . $langs -> trans ( 'Label' ) . ':</b> ' . $this -> label ;
$url = dol_buildpath ( '/hrm/skill_card.php' , 1 ) . '?id=' . $this -> id ;
if ( $option != 'nolink' ) {
// Add param to save lastsearch_values or not
$add_save_lastsearch_values = ( $save_lastsearch_value == 1 ? 1 : 0 );
if ( $save_lastsearch_value == - 1 && preg_match ( '/list\.php/' , $_SERVER [ " PHP_SELF " ])) {
$add_save_lastsearch_values = 1 ;
}
if ( $add_save_lastsearch_values ) {
$url .= '&save_lastsearch_values=1' ;
}
}
$linkclose = '' ;
if ( empty ( $notooltip )) {
if ( ! empty ( $conf -> global -> MAIN_OPTIMIZEFORTEXTBROWSER )) {
$label = $langs -> trans ( " ShowSkill " );
$linkclose .= ' alt="' . dol_escape_htmltag ( $label , 1 ) . '"' ;
}
$linkclose .= ' title="' . dol_escape_htmltag ( $label , 1 ) . '"' ;
$linkclose .= ' class="classfortooltip' . ( $morecss ? ' ' . $morecss : '' ) . '"' ;
} else {
$linkclose = ( $morecss ? ' class="' . $morecss . '"' : '' );
}
if ( $option == 'nolink' ) {
$linkstart = '<span' ;
} else {
$linkstart = '<a href="' . $url . '"' ;
}
$linkstart .= $linkclose . '>' ;
if ( $option == 'nolink' ) {
$linkend = '</span>' ;
} else {
$linkend = '</a>' ;
}
$result .= $linkstart ;
if ( empty ( $this -> showphoto_on_popup )) {
if ( $withpicto ) {
$result .= img_object (( $notooltip ? '' : $label ), ( $this -> picto ? $this -> picto : 'generic' ), ( $notooltip ? (( $withpicto != 2 ) ? 'class="paddingright"' : '' ) : 'class="' . (( $withpicto != 2 ) ? 'paddingright ' : '' ) . 'classfortooltip"' ), 0 , 0 , $notooltip ? 0 : 1 );
}
} else {
if ( $withpicto ) {
require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php' ;
list ( $class , $module ) = explode ( '@' , $this -> picto );
$upload_dir = $conf -> $module -> multidir_output [ $conf -> entity ] . " / $class / " . dol_sanitizeFileName ( $this -> ref );
$filearray = dol_dir_list ( $upload_dir , " files " );
$filename = $filearray [ 0 ][ 'name' ];
if ( ! empty ( $filename )) {
$pospoint = strpos ( $filearray [ 0 ][ 'name' ], '.' );
$pathtophoto = $class . '/' . $this -> ref . '/thumbs/' . substr ( $filename , 0 , $pospoint ) . '_mini' . substr ( $filename , $pospoint );
if ( empty ( $conf -> global -> { strtoupper ( $module . '_' . $class ) . '_FORMATLISTPHOTOSASUSERS' })) {
$result .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo' . $module . '" alt="No photo" border="0" src="' . DOL_URL_ROOT . '/viewimage.php?modulepart=' . $module . '&entity=' . $conf -> entity . '&file=' . urlencode ( $pathtophoto ) . '"></div></div>' ;
} else {
$result .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photouserphoto userphoto" alt="No photo" border="0" src="' . DOL_URL_ROOT . '/viewimage.php?modulepart=' . $module . '&entity=' . $conf -> entity . '&file=' . urlencode ( $pathtophoto ) . '"></div>' ;
}
$result .= '</div>' ;
} else {
$result .= img_object (( $notooltip ? '' : $label ), ( $this -> picto ? $this -> picto : 'generic' ), ( $notooltip ? (( $withpicto != 2 ) ? 'class="paddingright"' : '' ) : 'class="' . (( $withpicto != 2 ) ? 'paddingright ' : '' ) . 'classfortooltip"' ), 0 , 0 , $notooltip ? 0 : 1 );
}
}
}
if ( $withpicto != 2 ) {
$result .= $this -> label ;
}
$result .= $linkend ;
//if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
global $action , $hookmanager ;
2022-02-18 18:35:21 +01:00
$hookmanager -> initHooks ( array ( 'skilldao' ));
2021-11-22 19:57:26 +01:00
$parameters = array ( 'id' => $this -> id , 'getnomurl' => & $result );
2021-09-27 11:20:38 +02:00
$reshook = $hookmanager -> executeHooks ( 'getNomUrl' , $parameters , $this , $action ); // Note that $action and $object may have been modified by some hooks
if ( $reshook > 0 ) {
$result = $hookmanager -> resPrint ;
} else {
$result .= $hookmanager -> resPrint ;
}
return $result ;
}
/**
* Return the label of the status
*
* @ param int $mode 0 = long label , 1 = short label , 2 = Picto + short label , 3 = Picto , 4 = Picto + long label , 5 = Short label + Picto , 6 = Long label + Picto
* @ return string Label of status
*/
public function getLibStatut ( $mode = 0 )
{
return $this -> LibStatut ( $this -> status , $mode );
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
/**
* Return the status
*
* @ param int $status Id status
* @ param int $mode 0 = long label , 1 = short label , 2 = Picto + short label , 3 = Picto , 4 = Picto + long label , 5 = Short label + Picto , 6 = Long label + Picto
* @ return string Label of status
*/
public function LibStatut ( $status , $mode = 0 )
{
// phpcs:enable
if ( empty ( $this -> labelStatus ) || empty ( $this -> labelStatusShort )) {
global $langs ;
//$langs->load("hrm");
2021-10-16 19:37:57 +02:00
$this -> labelStatus [ self :: STATUS_DRAFT ] = $langs -> transnoentitiesnoconv ( 'Draft' );
$this -> labelStatus [ self :: STATUS_VALIDATED ] = $langs -> transnoentitiesnoconv ( 'Enabled' );
$this -> labelStatus [ self :: STATUS_CANCELED ] = $langs -> transnoentitiesnoconv ( 'Disabled' );
$this -> labelStatusShort [ self :: STATUS_DRAFT ] = $langs -> transnoentitiesnoconv ( 'Draft' );
$this -> labelStatusShort [ self :: STATUS_VALIDATED ] = $langs -> transnoentitiesnoconv ( 'Enabled' );
$this -> labelStatusShort [ self :: STATUS_CANCELED ] = $langs -> transnoentitiesnoconv ( 'Disabled' );
2021-09-27 11:20:38 +02:00
}
$statusType = 'status' . $status ;
//if ($status == self::STATUS_VALIDATED) $statusType = 'status1';
if ( $status == self :: STATUS_CANCELED ) {
$statusType = 'status6' ;
}
return dolGetStatus ( $this -> labelStatus [ $status ], $this -> labelStatusShort [ $status ], '' , $statusType , $mode );
}
/**
* Load the info information in the object
*
* @ param int $id Id of object
* @ return void
*/
public function info ( $id )
{
$sql = 'SELECT rowid, date_creation as datec, tms as datem,' ;
$sql .= ' fk_user_creat, fk_user_modif' ;
$sql .= ' FROM ' . MAIN_DB_PREFIX . $this -> table_element . ' as t' ;
$sql .= ' WHERE t.rowid = ' . (( int ) $id );
$result = $this -> db -> query ( $sql );
if ( $result ) {
if ( $this -> db -> num_rows ( $result )) {
$obj = $this -> db -> fetch_object ( $result );
$this -> id = $obj -> rowid ;
if ( $obj -> fk_user_author ) {
$cuser = new User ( $this -> db );
$cuser -> fetch ( $obj -> fk_user_author );
$this -> user_creation = $cuser ;
}
if ( $obj -> fk_user_valid ) {
$vuser = new User ( $this -> db );
$vuser -> fetch ( $obj -> fk_user_valid );
$this -> user_validation = $vuser ;
}
if ( $obj -> fk_user_cloture ) {
$cluser = new User ( $this -> db );
$cluser -> fetch ( $obj -> fk_user_cloture );
$this -> user_cloture = $cluser ;
}
$this -> date_creation = $this -> db -> jdate ( $obj -> datec );
$this -> date_modification = $this -> db -> jdate ( $obj -> datem );
$this -> date_validation = $this -> db -> jdate ( $obj -> datev );
}
$this -> db -> free ( $result );
} else {
dol_print_error ( $this -> db );
}
}
/**
* Initialise object with example values
* Id must be 0 if object instance is a specimen
*
* @ return void
*/
public function initAsSpecimen ()
{
// Set here init that are not commonf fields
// $this->property1 = ...
// $this->property2 = ...
$this -> initAsSpecimenCommon ();
}
/**
* Create an array of lines
*
* @ return array | int array of lines if OK , < 0 if KO
*/
public function getLinesArray ()
{
$this -> lines = array ();
2022-04-03 12:25:43 +02:00
$objectline = new Skilldet ( $this -> db );
2022-01-13 11:39:54 +01:00
$result = $objectline -> fetchAll ( 'ASC' , 'rankorder' , 0 , 0 , array ( 'customsql' => 'fk_skill = ' . $this -> id ));
2021-09-27 11:20:38 +02:00
if ( is_numeric ( $result )) {
$this -> error = $this -> error ;
$this -> errors = $this -> errors ;
return $result ;
} else {
$this -> lines = $result ;
return $this -> lines ;
}
}
/**
* Returns the reference to the following non used object depending on the active numbering module .
*
* @ return string Object free reference
*/
public function getNextNumRef ()
{
global $langs , $conf ;
$langs -> load ( " hrm " );
if ( empty ( $conf -> global -> hrm_SKILL_ADDON )) {
$conf -> global -> hrm_SKILL_ADDON = 'mod_skill_standard' ;
}
if ( ! empty ( $conf -> global -> hrm_SKILL_ADDON )) {
$mybool = false ;
$file = $conf -> global -> hrm_SKILL_ADDON . " .php " ;
$classname = $conf -> global -> hrm_SKILL_ADDON ;
// Include file with class
$dirmodels = array_merge ( array ( '/' ), ( array ) $conf -> modules_parts [ 'models' ]);
foreach ( $dirmodels as $reldir ) {
$dir = dol_buildpath ( $reldir . " core/modules/hrm/ " );
// Load file with numbering class (if found)
$mybool |= @ include_once $dir . $file ;
}
if ( $mybool === false ) {
dol_print_error ( '' , " Failed to include file " . $file );
return '' ;
}
if ( class_exists ( $classname )) {
$obj = new $classname ();
$numref = $obj -> getNextValue ( $this );
if ( $numref != '' && $numref != '-1' ) {
return $numref ;
} else {
$this -> error = $obj -> error ;
//dol_print_error($this->db,get_class($this)."::getNextNumRef ".$obj->error);
return " " ;
}
} else {
print $langs -> trans ( " Error " ) . " " . $langs -> trans ( " ClassNotFound " ) . ' ' . $classname ;
return " " ;
}
} else {
print $langs -> trans ( " ErrorNumberingModuleNotSetup " , $this -> element );
return " " ;
}
}
/**
* Create a document onto disk according to template module .
*
* @ param string $modele Force template to use ( '' to not force )
* @ param Translate $outputlangs objet lang a utiliser pour traduction
* @ param int $hidedetails Hide details of lines
* @ param int $hidedesc Hide description
* @ param int $hideref Hide ref
* @ param null | array $moreparams Array to provide more information
* @ return int 0 if KO , 1 if OK
*/
public function generateDocument ( $modele , $outputlangs , $hidedetails = 0 , $hidedesc = 0 , $hideref = 0 , $moreparams = null )
{
global $conf , $langs ;
$result = 0 ;
$includedocgeneration = 0 ;
$langs -> load ( " hrm " );
if ( ! dol_strlen ( $modele )) {
$modele = 'standard_skill' ;
if ( ! empty ( $this -> model_pdf )) {
$modele = $this -> model_pdf ;
} elseif ( ! empty ( $conf -> global -> SKILL_ADDON_PDF )) {
$modele = $conf -> global -> SKILL_ADDON_PDF ;
}
}
$modelpath = " core/modules/hrm/doc/ " ;
if ( $includedocgeneration && ! empty ( $modele )) {
$result = $this -> commonGenerateDocument ( $modelpath , $modele , $outputlangs , $hidedetails , $hidedesc , $hideref , $moreparams );
}
return $result ;
}
/**
* Action executed by scheduler
* CAN BE A CRON TASK . In such a case , parameters come from the schedule job setup field 'Parameters'
* Use public function doScheduledJob ( $param1 , $param2 , ... ) to get parameters
*
* @ return int 0 if OK , <> 0 if KO ( this function is used also by cron so only 0 is OK )
*/
public function doScheduledJob ()
{
global $conf , $langs ;
//$conf->global->SYSLOG_FILE = 'DOL_DATA_ROOT/dolibarr_mydedicatedlofile.log';
$error = 0 ;
$this -> output = '' ;
$this -> error = '' ;
dol_syslog ( __METHOD__ , LOG_DEBUG );
$now = dol_now ();
$this -> db -> begin ();
// ...
$this -> db -> commit ();
return $error ;
}
2021-09-28 08:40:15 +02:00
/**
* @ param int $code number of code label
* @ return int | string
*/
2021-09-27 11:20:38 +02:00
public static function typeCodeToLabel ( $code )
{
global $langs ;
$result = '' ;
switch ( $code ) {
case 0 : $result = $langs -> trans ( " knowHow " ); break ; //"Savoir Faire"
case 1 : $result = $langs -> trans ( " HowToBe " ); break ; // "Savoir être"
case 9 : $result = $langs -> trans ( " knowledge " ); break ; //"Savoir"
}
return $result ;
}
}