PalMA icon indicating copy to clipboard operation
PalMA copied to clipboard

Inconsistent wording

Open dennmuel opened this issue 4 years ago • 0 comments

Maybe more of a "note to self" than an actual issue: Working on other topics I noticed that the naming of variables concerning window and section management is a bit inconsistent.

Coming from the database perspective there is

  • the primary key of a window, called id in the database
  • the win_id (hex value used for the system-side window commands)
  • the current quadrant of a window on the palma screen, referred to as section in the db, but as $_REQUEST['window'] and $windownumber in control.php

Also there's a function called NextID which actually returns the next free section: https://github.com/UB-Mannheim/PalMA/blob/master/DBConnector.class.php#L91-L113

There's also some $window and $w arrays for windows to be created which is okay, but then there's also this $window which seems to be used to create the win_id: https://github.com/UB-Mannheim/PalMA/blob/master/control.php#L376-L387

There is no malfunction here, but maybe some consistent naming would improve code readability.

dennmuel avatar Jul 24 '20 08:07 dennmuel