Object Klassenreferenz

Klassendiagramm für Object:

Aufstellung aller Elemente

Öffentliche Methoden
	Object ($objectid= '')
	getAllObjectIds ()
	full_filename ()
	checkRight ($type)
	hasRight ($type)
	getType ()
	getProperties ()
	path ()
	goodFilename ($filename)
	filename ()
	available ($objectid)
	objectLoad ()
	objectLoadRaw ()
	setDatabaseRow ($row)
	load ()
	objectLoadName ()
	objectSave ($withName=true)
	setTimestamp ()
	ObjectSaveName ()
	objectDelete ()
	objectAdd ()
	checkFilename ()
	filenameIsUnique ($filename)
	checkName ()
	getAclIds ()
	getAllAclIds ()
	getInheritedAclIds ()
	getAllInheritedAclIds ()
	getRelatedAclTypes ()
	getAssocRelatedAclTypes ()
	deleteAllACLs ()
	tmpfileYYYYYY ()
	getTempDir ()
	getTempFileName ($attr=array())
	getTempFile ()
	setOrderId ($orderid)
	setParentId ($parentid)
	getDependentObjectIds ()
	getObjectIdsByFileName ($text)
	getObjectIdsByName ($text)
	getObjectIdsByDescription ($text)
	getObjectIdsByCreateUserId ($userid)
	getObjectIdsByLastChangeUserId ($userid)
	isObjectId ($id)
Öffentliche Attribute
	$id
	$objectid
	$parentid
	$filename = ''
	$name = ''
	$description = 'none'
	$desc = ''
	$createDate
	$lastchangeDate
	$createUser
	$lastchangeUser
	$isFolder = false
	$isFile = false
	$isPage = false
	$isLink = false
	$type = null
	$isRoot = false
	$languageid
	$modelid
	$projectid
	$tmpfile
	$aclMask = null

---

Ausführliche Beschreibung

Definiert in Zeile 135 der Datei Object.class.php.

---

Dokumentation der Elementfunktionen

Object::available

(

$

objectid

)

Stellt fest, ob das Objekt mit der angegebenen Id existiert.

Definiert in Zeile 551 der Datei Object.class.php.

Benutzt $db, $objectid und db_connection().

Wird benutzt von IndexAction::evaluateRequestVars(), Value::generate(), IndexAction::login(), Page::path_to_object(), SearchAction::quicksearch(), XhtmlRenderer::renderElement(), PdfRenderer::renderElement(), HtmlRenderer::renderElement() und HtmlDomRenderer::renderElement().

     {
          $db = db_connection();

          // Vielleicht k�nnen wir uns den DB-Zugriff auch ganz sparen.
          if   ( !is_numeric($objectid) || $objectid <= 0 )
               return false; // Objekt-Id ung�ltig.
               
          $sql = new Sql('SELECT 1 FROM {t_object} '.
                         ' WHERE id={objectid}');
          $sql->setInt('objectid'  , $objectid  );

          return intval($db->getOne($sql->query)) == 1;
     }

Object::checkFilename

(

)

Pruefung auf Gueltigkeit des Dateinamens

Definiert in Zeile 994 der Datei Object.class.php.

Benutzt filename() und filenameIsUnique().

Wird benutzt von objectAdd() und objectSave().

     {
          if   ( empty($this->filename) )
               $this->filename = $this->objectid;

//        $this->filename = trim(strtolower($this->filename));

//        $this->filename = $this->goodFilename( $this->filename);

          if   ( $this->isRoot )
               return;

          if   ( !$this->filenameIsUnique( $this->filename ) )
          {
//             $this->filename = $this->objectid;
//
//             if   ( !$this->filenameIsUnique( $this->filename ) )
                    $this->filename = $this->filename.'.'.md5(microtime());
          }
     }

Object::checkName

(

)

Pruefung auf Gueltigkeit des logischen Namens

Definiert in Zeile 1034 der Datei Object.class.php.

Benutzt filename().

Wird benutzt von setDatabaseRow().

     {
          if   ( empty($this->name) )
               $this->name = $this->filename;

          if   ( empty($this->name) )
               $this->name = $this->objectid;
     }

Object::checkRight

(

$

type

)

Pr?fen einer Berechtigung zu diesem Objekt

Definiert in Zeile 331 der Datei Object.class.php.

     {
          return true;
     }

Object::deleteAllACLs

(

)

Entfernen aller ACLs zu diesem Objekt private

Definiert in Zeile 1168 der Datei Object.class.php.

Benutzt getAllAclIds().

Wird benutzt von objectDelete().

     {
          foreach( $this->getAllAclIds() as $aclid )
          {
               $acl = new Acl( $aclid );
               $acl->delete();
          }
     }

Object::filename

(

)

Ermitteln des Dateinamens und Rueckgabe desselben

Rückgabe:

String Dateiname

Definiert in Zeile 480 der Datei Object.class.php.

Benutzt $conf und goodFilename().

Wird benutzt von checkFilename(), checkName(), File::filenameWithExtension(), Page::full_filename(), full_filename(), getProperties(), goodFilename(), File::mimeType(), objectAdd(), objectLoadName(), objectLoadRaw(), objectSave(), Folder::parentfolder_bak(), File::parse_filename() und setDatabaseRow().

     {

          global $conf;

          if   ( $conf['filename']['edit'] && $this->filename != '' && $this->filename != $this->objectid )
          {
               $this->filename = $this->goodFilename(trim(strtolower($this->name)));
               return $this->filename;
          }

          if   ( $this->type == OR_TYPE_FOLDER )
          {
               $this->filename = $this->objectid;
          }
          elseif    ( $this->orderid == 1              &&
                 !empty($conf['filename']['default']) &&
                 !$conf['filename']['edit']              )
          {
               $this->filename = $conf['filename']['default'];
          }
          else
          {
               switch( $conf['filename']['style'] )
               {
                    case 'longid':
                         // Eine etwas laengere ID als Dateinamen benutzen
                         $this->filename = base_convert(str_pad($this->objectid,6,'a'),11,10);
                         break;

                    case 'id':
                         // Einfach die Objekt-Id als Dateinamen verwenden.
                         $this->filename = $this->objectid;
                         break;

                    case 'short':
                         // So kurz wie moeglich: Erhoehen der Basis vom 10 auf 36.
                         // Beispiele:
                         // 1  -> 1
                         // 10 -> a
                         $this->filename = base_convert($this->objectid,10,36);
                         break;

//                       case 'md5':
//                            $this->filename = md5(md5($this->objectid));
//                            break;
                    case  'ss':
                         // Imitieren von "StoryServer" URLs. Wers braucht.
                         $this->filename = '0,'.
                                           base_convert(str_pad($this->parentid,3,'a'),11,10).
                                           ','.
                                           base_convert(str_pad($this->objectid,7,'a'),11,10).
                                           ',00';
                         break;
//                       case  'title':
//                            $this->filename = $this->goodFilename(trim(strtolower($this->name)));
//                            break;

                    default:
                         die('Unknown filename style: '.$conf['filename']['style'] );
               }
          }

          return $this->filename;
     }

Object::filenameIsUnique

(

$

filename

)

Definiert in Zeile 1016 der Datei Object.class.php.

Benutzt $db, $filename und db_connection().

Wird benutzt von checkFilename().

     {
          $db = db_connection();

          $sql = new Sql('SELECT COUNT(*) FROM {t_object}'.' WHERE parentid={parentid} AND filename={filename} AND NOT id = {objectid}');

          $sql->setString('parentid', $this->parentid);
          $sql->setString('objectid', $this->objectid);

          $sql->setString('filename', $filename      );

          return( intval($db->getOne($sql->query)) == 0 );
     }

Object::full_filename

(

)

Erneute Implementation in File und Page.

Definiert in Zeile 316 der Datei Object.class.php.

Benutzt filename() und path().

     {
          $path = $this->path();

          if ($path != '')
               $path.= '/';

          $path.= $this->filename();

          return $path;
     }

Object::getAclIds

(

)

Definiert in Zeile 1044 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT id FROM {t_acl} '.
                          '  WHERE objectid={objectid}'.
                          '    AND ( languageid IS NULL OR '.
                          '          languageid = {languageid} )'.
                          '  ORDER BY userid,groupid ASC' );
          $sql->setInt('languageid',$this->languageid);
          $sql->setInt('objectid'  ,$this->objectid);

          return $db->getCol( $sql->query );
     }

Object::getAllAclIds

(

)

Definiert in Zeile 1060 der Datei Object.class.php.

Benutzt $db und db_connection().

Wird benutzt von deleteAllACLs().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT id FROM {t_acl} '.
                          '  WHERE objectid={objectid}'.
                          '  ORDER BY userid,groupid ASC' );
          $sql->setInt('objectid'  ,$this->objectid);

          return $db->getCol( $sql->query );
     }

Object::getAllInheritedAclIds

(

)

Definiert in Zeile 1104 der Datei Object.class.php.

Benutzt $db, db_connection(), getType() und load().

     {
          $acls = array();
          
          if   ( $this->getType() == 'unknown' )
               $this->load();

          // Root-Ordner erhaelt keine Vererbungen
          if   ( $this->isRoot )
               return $acls;
          
          $db = db_connection();
          $folder = new Folder( $this->parentid );
          
          foreach( $folder->parentObjectIds(true,true) as $oid )
          {
               $sql = new Sql( 'SELECT id FROM {t_acl} '.
                               '  WHERE objectid={objectid}'.
                               '    AND is_transmit = 1'.
                               '  ORDER BY userid,groupid ASC' );
               $sql->setInt('objectid'  ,$oid);
               $acls = array_merge( $acls,$db->getCol( $sql->query ) );
          }

          return $acls;
     }

Object::getAllObjectIds

(

)

Lesen aller Objekte aus dem aktuellen Projekt

Rückgabe:

Array Alle Objekt-IDs des aktuellen Projektes

Definiert in Zeile 292 der Datei Object.class.php.

Benutzt $db, $projectid, $SESS, db_connection() und Session::getProject().

Wird benutzt von LinkAction::edit(), PageelementAction::editlink(), PageelementAction::editlongtext(), PageAction::elsave(), PageAction::form(), ElementAction::properties() und PageelementAction::savelongtext().

     {
          global $SESS;
          $db = db_connection();

          if   ( ! isset($this->projectid) )
          {
               $project = Session::getProject();
               $projectid = $project->projectid;
          }
          else
          {
               $projectid = $this->projectid;
          }

          $sql = new Sql('SELECT id from {t_object} '.
                         '  WHERE projectid={projectid}');
          $sql->setInt('projectid', $projectid);

          return $db->getCol($sql->query);
     }

Object::getAssocRelatedAclTypes

(

)

Ermitteln aller Berechtigungsstufen, die fuer diesen Objekttyp wichtig sind

Definiert in Zeile 1151 der Datei Object.class.php.

Benutzt getRelatedAclTypes().

     {
          $rights = array('read','write','delete','prop','release','publish','create_folder','create_file','create_page','create_link','grant','transmit');
          $types  = array();
          foreach( $rights as $r )
               $types[$r] = false;

          foreach( $this->getRelatedAclTypes() as $t )
               $types[$t] = true;

          return $types;
     }

Object::getDependentObjectIds

(

)

Definiert in Zeile 1319 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();

          $sql = new Sql( 'SELECT {t_page}.objectid FROM {t_value}'.
                          '  LEFT JOIN {t_page} '.
                          '    ON {t_value}.pageid = {t_page}.id '.
                          '  WHERE linkobjectid={objectid}' );
          $sql->setInt( 'objectid',$this->objectid );

          return $db->getCol( $sql->query );
     }

Object::getInheritedAclIds

(

)

Definiert in Zeile 1073 der Datei Object.class.php.

Benutzt $db, db_connection(), getType() und load().

     {
          $acls = array();
          
          if   ( $this->getType() == 'unknown' )
               $this->load();

          // Root-Ordner erhaelt keine Vererbungen
          if   ( $this->isRoot )
               return $acls;
          
          $db = db_connection();
          $folder = new Folder( $this->parentid );
          
          foreach( $folder->parentObjectIds(true,true) as $oid )
          {
               $sql = new Sql( 'SELECT id FROM {t_acl} '.
                               '  WHERE objectid={objectid}'.
                               '    AND is_transmit = 1'.
                               '    AND ( languageid IS NULL OR '.
                               '          languageid = {languageid} )'.
                               '  ORDER BY userid,groupid ASC' );
               $sql->setInt('objectid'  ,$oid);
               $sql->setInt('languageid',$this->languageid);
               $acls = array_merge( $acls,$db->getCol( $sql->query ) );
          }

          return $acls;
     }

Object::getObjectIdsByCreateUserId

(

$

userid

)

Es werden Objekte mit einer UserId ermittelt

Parameter:

Integer

Benutzer-Id der Erstellung

Rückgabe:

Array Liste der gefundenen Objekt-IDs

Definiert in Zeile 1406 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT id FROM {t_object} '.
                          ' WHERE create_userid={userid}'.
                          '   AND projectid={projectid}'.
                          '  ORDER BY lastchange_date DESC' );
          $sql->setInt   ( 'projectid',$this->projectid );
          $sql->setInt   ( 'userid'   ,$userid          );
          
          return $db->getCol( $sql->query );
     }

Object::getObjectIdsByDescription

(

$

text

)

Es werden Objekte mit einer Beschreibung ermittelt

Parameter:

String

Suchbegriff

Rückgabe:

Array Liste der gefundenen Objekt-IDs

Definiert in Zeile 1382 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT {t_object}.id FROM {t_object} '.
                          ' LEFT JOIN {t_name} '.
                          '   ON {t_object}.id={t_name}.objectid'.
                          ' WHERE {t_name}.descr LIKE {desc}'.
                          '   AND {t_name}.languageid={languageid}'.
                          '   AND {t_object}.projectid={projectid}'.
                          '  ORDER BY lastchange_date DESC' );
          $sql->setInt   ( 'projectid' ,$this->projectid );
          $sql->setInt   ( 'languageid',$this->languageid );
          $sql->setString( 'desc'      ,'%'.$text.'%' );
          
          return $db->getCol( $sql->query );
     }

Object::getObjectIdsByFileName

(

$

text

)

Es werden Objekte mit einem bestimmten Namen ermittelt

Parameter:

String

Suchbegriff

Rückgabe:

Array Liste der gefundenen Objekt-IDs

Definiert in Zeile 1338 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT id FROM {t_object} '.
                          ' WHERE filename LIKE {filename}'.
                          '   AND projectid={projectid}'.
                          '  ORDER BY lastchange_date DESC' );
          $sql->setInt   ( 'projectid',$this->projectid );
          $sql->setString( 'filename','%'.$text.'%' );
          
          return $db->getCol( $sql->query );
     }

Object::getObjectIdsByLastChangeUserId

(

$

userid

)

Es werden Objekte mit einer UserId ermittelt

Parameter:

Integer

Benutzer-Id der letzten ?nderung

Rückgabe:

Array Liste der gefundenen Objekt-IDs

Definiert in Zeile 1426 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT id FROM {t_object} '.
                          ' WHERE lastchange_userid={userid}'.
                          '   AND projectid={projectid}'.
                          '  ORDER BY lastchange_date DESC' );
          $sql->setInt   ( 'projectid',$this->projectid );
          $sql->setInt   ( 'userid'   ,$userid          );
          
          return $db->getCol( $sql->query );
     }

Object::getObjectIdsByName

(

$

text

)

Es werden Objekte mit einem Namen ermittelt

Parameter:

String

Suchbegriff

Rückgabe:

Array Liste der gefundenen Objekt-IDs

Definiert in Zeile 1358 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT {t_object}.id FROM {t_object} '.
                          ' LEFT JOIN {t_name} '.
                          '   ON {t_object}.id={t_name}.objectid'.
                          ' WHERE {t_name}.name LIKE {name}'.
                          '   AND {t_name}.languageid={languageid}'.
                          '   AND {t_object}.projectid={projectid}'.
                          '  ORDER BY lastchange_date DESC' );
          $sql->setInt   ( 'projectid' ,$this->projectid );
          $sql->setInt   ( 'languageid',$this->languageid );
          $sql->setString( 'name'      ,'%'.$text.'%' );
          
          return $db->getCol( $sql->query );
     }

Object::getProperties

(

)

Erneute Implementation in File, Link und Page.

Definiert in Zeile 424 der Datei Object.class.php.

Benutzt filename() und getType().

     {
          return Array( 'id'               =>$this->objectid,
                        'objectid'         =>$this->objectid,
                        'parentid'         =>$this->parentid,
                        'filename'         =>$this->filename,
                        'name'             =>$this->name,
                        'desc'             =>$this->desc,
                        'description'      =>$this->desc,
                        'create_date'      =>$this->createDate,
                        'create_user'      =>$this->createUser,
                        'lastchange_date'  =>$this->lastchangeDate,
                        'lastchange_user'  =>$this->lastchangeUser,
                        'isFolder'         =>$this->isFolder,
                        'isFile'           =>$this->isFile,
                        'isLink'           =>$this->isLink,
                        'isPage'           =>$this->isPage,
                        'isRoot'           =>$this->isRoot,
                        'languageid'       =>$this->languageid,
                        'modelid'          =>$this->modelid,
                        'projectid'        =>$this->projectid,
                        'type'             =>$this->getType()  );
     }

Object::getRelatedAclTypes

(

)

Ermitteln aller Berechtigungsstufen, die fuer diesen Objekttyp wichtig sind

Definiert in Zeile 1135 der Datei Object.class.php.

Wird benutzt von getAssocRelatedAclTypes().

     {
          if   ( $this->isFolder )
               return( array('read','write','delete','prop','release','publish','create_folder','create_file','create_page','create_link','grant','transmit') );
          if   ( $this->isFile )
               return( array('read','write','delete','prop','release','publish','grant') );
          if   ( $this->isPage )
               return( array('read','write','delete','prop','release','publish','grant') );
          if   ( $this->isLink )
               return( array('read','write','delete','prop','grant') );
     }

Object::getTempDir

(

)

Liefert einen Verzeichnisnamen fuer temporaere Dateien.

Definiert in Zeile 1217 der Datei Object.class.php.

Benutzt $conf und $tmpfile.

Wird benutzt von Code::execute(), getTempFileName() und File::tmpfile().

     {
          global $conf;
          $tmpdir = @$conf['cache']['tmp_dir'];
          $tmpfile = @tempnam( $tmpdir,'openrat_tmp' );

          // 2. Versuch: Temp-Dir aus "upload_tmp_dir".
          if   ( $tmpfile === FALSE )
          {
               $tmpdir = ini_get('upload_tmp_dir');
               $tmpfile = @tempnam( $tmpdir,'openrat_tmp' );
          }
          
          elseif    ( $tmpfile === FALSE )
          {
               $tmpfile = @tempnam( '','openrat_tmp' );
          }
          
          $tmpdir = dirname($tmpfile);
          @unlink($tmpfile);
               
          return $tmpdir;
     }

Object::getTempFile

(

)

Gibt ein fertiges Dateihandle fuer eine temporaere Datei zurück.

Rückgabe:

Resource

Definiert in Zeile 1276 der Datei Object.class.php.

     {
          return tmpfile();
     }

Object::getTempFileName

(

$

attr = array()

)

Liefert einen temporären Dateinamen.

Parameter:

$attr

Attribute fuer den Dateinamen, um diesen eindeutig zu gestalten.

Rückgabe:

unknown_type

Definiert in Zeile 1248 der Datei Object.class.php.

Benutzt $conf, $filename und getTempDir().

Wird benutzt von Value::tmpfile() und Page::tmpfile().

     {
          global $conf;
          
//        if   ( $conf['cache']['enable_cache'] )
//        {
               $filename = Object::getTempDir().'/openrat';
               foreach( $attr as $a=>$w )
                    $filename .= '_'.$a.$w;
                    
               $filename .= '.tmp';
               return $filename;
//        }
//        else
//        {
//             $tmpdir = @$conf['cache']['tmp_dir'];
//             $tmpfile = tempnam( $tmpdir,'openrat_tmp' );
//             
//             return $tmpfile;
//        }
     }

Object::getType

(

)

Typ des Objektes ermitteln

Rückgabe:

String der Typ des Objektes entweder 'folder','file','page' oder 'link'

Erneute Implementation in Link.

Definiert in Zeile 409 der Datei Object.class.php.

Wird benutzt von getAllInheritedAclIds(), getInheritedAclIds() und getProperties().

     {
          if ($this->isFolder)
               return OR_TYPE_FOLDER;
          if ($this->isFile)
               return OR_TYPE_FILE;
          if ($this->isPage)
               return OR_TYPE_PAGE;
          if ($this->isLink)
               return OR_TYPE_LINK;

          return 'unknown';
     }

Object::goodFilename

(

$

filename

)

Ueberpruft einen Dateinamen auf Gueltigkeit.

Definiert in Zeile 465 der Datei Object.class.php.

Benutzt $filename und filename().

Wird benutzt von filename().

     {
          // Dateiname muss gueltig sein,
          // ungueltige Zeichen werden entfernt
          $gueltig = 'abcdefghijklmnopqrstuvwxyz0123456789.-_';
          $tmp = strtr($filename, $gueltig, str_repeat('#', strlen($gueltig)));
          return( str_replace('-','',strtr($this->filename, $tmp, str_repeat('-', strlen($tmp)))) );
     }

Object::hasRight

(

$

type

)

Pr?fen einer Berechtigung zu diesem Objekt

Definiert in Zeile 340 der Datei Object.class.php.

Benutzt $conf, $db, $type, db_connection(), Session::getProject(), Session::getProjectLanguage() und Session::getUser().

     {
//        $user = Session::getUser();
//        return $user->hasRight( $this->objectid,$type ) || (isset($this->parentid)&&$user->hasRight($this->parentid,$type)&&$user->hasRight($this->parentid,ACL_TRANSMIT));
          
          if   ( is_null($this->aclMask) )
          {
               $this->aclMask = 0;
               
               $project  = Session::getProject();
               $language = Session::getProjectLanguage();
               $user     = Session::getUser();
               
               if   ( $user->isAdmin && !$conf['security']['readonly'] )
                    $this->aclMask = ACL_READ +
                                     ACL_WRITE +
                                     ACL_PROP +
                                     ACL_DELETE +
                                     ACL_RELEASE +
                                     ACL_PUBLISH +
                                     ACL_CREATE_FOLDER +
                                     ACL_CREATE_FILE +
                                     ACL_CREATE_LINK +
                                     ACL_CREATE_PAGE +
                                     ACL_GRANT +
                                     ACL_TRANSMIT;

               if   ( $user->isAdmin && $type & ACL_READ )
                    return true;
     
               $sql = new Sql( <<<SQL
SELECT {t_acl}.* FROM {t_acl}
                      LEFT JOIN {t_object}
                             ON {t_object}.id={t_acl}.objectid
                      WHERE objectid={objectid}
                        AND ( languageid={languageid} OR languageid IS NULL )
                        AND ( {t_acl}.userid={userid} OR {group_clause}
                                                                 OR ({t_acl}.userid IS NULL AND {t_acl}.groupid IS NULL) )
SQL
);

               $sql->setInt  ( 'languageid'  ,$language->languageid   );
               $sql->setInt  ( 'objectid'    ,$this->objectid         );
               $sql->setInt  ( 'userid'      ,$user->userid           );
               $sql->setParam( 'group_clause',$user->getGroupClause() );
     
               $db = db_connection();
               foreach( $db->getAll( $sql->query ) as $row )
               {
                    $acl = new Acl();
                    $acl->setDatabaseRow( $row );
                    #Html::debug($acl,"ACL");
                    
                    $this->aclMask |= $acl->getMask();
               }
          }
          
//        Html::debug($type,"Anfrage");
//        Html::debug($this->aclMask,"Maske fuer Objekt ".$this->objectid);
//        Html::debug($this->aclMask & $type,"Ergebnis");
          return $this->aclMask & $type;
     }

Object::isObjectId

(

$

id

)

Gibt true zur?ck, wenn die angegebene Objekt-ID existiert

Parameter:

Integer

Objekt-ID

Rückgabe:

Boolean

Definiert in Zeile 1446 der Datei Object.class.php.

Benutzt $db, $id und db_connection().

     {
          $db = db_connection();
          
          $sql = new Sql( 'SELECT id FROM {t_object} '.
                          ' WHERE id={objectid}'.
                          '   AND projectid={projectid}' );
          $sql->setInt   ( 'projectid' ,$this->projectid );
          $sql->setInt   ( 'objectid'  ,$id              );

          return ($db->getOne($sql->query) == intval($id) );
     }

Object::load

(

)

Laden des Objektes

Veraltet:

bitte objectLoad() benutzen

Erneute Implementation in File, Folder, Link und Page.

Definiert in Zeile 722 der Datei Object.class.php.

Benutzt objectLoad().

Wird benutzt von getAllInheritedAclIds() und getInheritedAclIds().

     {
          $this->objectLoad();
     }

Object::Object

(

$

objectid = ''

)

Konstruktor F?llen des neuen Objektes mit Init-Werten Es werden die Standardwerte aus der Session benutzt, um Sprach-ID, Projektmodell-Id und Projekt-ID zu setzen

Parameter:

Integer

Objekt-ID (optional)

Definiert in Zeile 266 der Datei Object.class.php.

Benutzt $objectid, $SESS, Session::getProject(), Session::getProjectLanguage() und Session::getProjectModel().

Wird benutzt von File::File(), Folder::Folder(), Folder::getFirstPageOrLink(), Folder::getLastPageOrLink(), Folder::getObjects(), Link::Link(), Page::Page(), Page::path_to_object() und Folder::publish().

     {
          global $SESS;

          if   ( is_numeric($objectid) )
          {
               $this->objectid = $objectid;
               $this->id       = $objectid;
          }


          $language = Session::getProjectLanguage();
          $this->languageid = $language->languageid;

          $model = Session::getProjectModel();
          $this->modelid = $model->modelid;

          $project = Session::getProject();
          $this->projectid = $project->projectid;
     }

Object::objectAdd

(

)

Objekt hinzufuegen

Definiert in Zeile 919 der Datei Object.class.php.

Benutzt $db, $SESS, checkFilename(), db_connection(), filename() und Session::getUser().

Wird benutzt von Page::add(), Link::add(), Folder::add() und File::add().

     {
          global $SESS;
          $db = db_connection();

          // Neue Objekt-Id bestimmen
          $sql = new Sql('SELECT MAX(id) FROM {t_object}');
          $this->objectid = intval($db->getOne($sql->query))+1;

          $this->checkFilename();
          $sql = new Sql('INSERT INTO {t_object}'.
                         ' (id,parentid,projectid,filename,orderid,create_date,create_userid,lastchange_date,lastchange_userid,is_folder,is_file,is_page,is_link)'.
                         ' VALUES( {objectid},{parentid},{projectid},{filename},{orderid},{time},{userid},{time},{userid},{is_folder},{is_file},{is_page},{is_link} )');

          if   ( $this->isRoot )
               $sql->setNull('parentid');
          else $sql->setInt ('parentid',$this->parentid );

          $sql->setInt   ('objectid' , $this->objectid );
          $sql->setString('filename' , $this->filename );
          $sql->setString('projectid', $this->projectid);
          $sql->setInt   ('orderid'  , 99999           );
          $sql->setInt   ('time'     , time()          );
          $user = Session::getUser();
          $sql->setInt   ('userid'   , $user->userid   );

          $sql->setBoolean('is_folder',$this->isFolder);
          $sql->setBoolean('is_file',  $this->isFile);
          $sql->setBoolean('is_page',  $this->isPage);
          $sql->setBoolean('is_link',  $this->isLink);

          $db->query($sql->query);

          if   ( !empty($this->name) )
               $this->objectSaveName();
               
          $acl = new Acl();
          $acl->userid = $user->userid;
          $acl->objectid = $this->objectid;
          
          // Standard-Rechte fuer dieses neue Objekt setzen.
          // Der Benutzer hat Lese- und Schreibrechte auf das Objekt.
          $acl->read   = true;
          $acl->write  = true;
          $acl->prop   = true;
          $acl->delete = true;
          $acl->grant = true;
          if   ( $this->isFolder )
          {
               $acl->create_file   = true;
               $acl->create_page   = true;
               $acl->create_folder = true;
               $acl->create_link   = true;
          }
          $acl->add();

          // Aus dem Eltern-Ordner vererbbare Berechtigungen übernehmen.
          $folder = new Folder( $this->parentid );
          foreach( $folder->getAclIds() as $aclid )
          {
               $acl = new Acl( $aclid );
               $acl->load();
               
               if   ( $acl->transmit ) // ACL is vererbbar, also kopieren.
               {
                    $acl->objectid = $this->objectid;
                    $acl->add(); // ... und hinzufuegen.
               }
          }
     }

Object::objectDelete

(

)

Objekt loeschen. Es muss sichergestellt sein, dass auch das Unterobjekt geloeschet wird. Diese Methode wird daher normalerweise nur vom Unterobjekt augerufen protected

Definiert in Zeile 879 der Datei Object.class.php.

Benutzt $db, db_connection() und deleteAllACLs().

Wird benutzt von Page::delete(), Link::delete() und File::delete().

     {
          $db = db_connection();

          $sql = new Sql( 'UPDATE {t_element} '.
                          '  SET default_objectid=NULL '.
                          '  WHERE default_objectid={objectid}' );
          $sql->setInt('objectid',$this->objectid);
          $db->query( $sql->query );

          $sql = new Sql( 'UPDATE {t_value} '.
                          '  SET linkobjectid=NULL '.
                          '  WHERE linkobjectid={objectid}' );
          $sql->setInt('objectid',$this->objectid);
          $db->query( $sql->query );

          $sql = new Sql( 'UPDATE {t_link} '.
                          '  SET link_objectid=NULL '.
                          '  WHERE link_objectid={objectid}' );
          $sql->setInt('objectid',$this->objectid);
          $db->query( $sql->query );


          // Objekt-Namen l?schen
          $sql = new Sql('DELETE FROM {t_name} WHERE objectid={objectid}');
          $sql->setInt('objectid', $this->objectid);
          $db->query($sql->query);

          // Objekt l?schen
          $sql = new Sql('DELETE FROM {t_object} WHERE id={objectid}');
          $sql->setInt('objectid', $this->objectid);
          $db->query($sql->query);

          $this->deleteAllACLs();
     }

Object::objectLoad

(

)

Lesen der Eigenschaften aus der Datenbank Es werden

• die sprachunabh?ngigen Daten wie Dateiname, Typ sowie Erstellungs- und ?nderungsdatum geladen
• die sprachabh?ngigen Daten wie Name und Beschreibung geladen

Definiert in Zeile 573 der Datei Object.class.php.

Benutzt $db, $SESS, db_connection() und setDatabaseRow().

Wird benutzt von Page::load(), load(), Link::load(), Folder::load() und File::load().

     {
          global $SESS;
          $db = db_connection();

          $sql = new Sql('SELECT {t_object}.*,' .
                         '       {t_name}.name,{t_name}.descr,'.
                         '       lastchangeuser.name     as lastchange_username,     '.
                         '       lastchangeuser.fullname as lastchange_userfullname, '.
                         '       lastchangeuser.mail     as lastchange_usermail,     '.
                         '       createuser.name         as create_username,     '.
                         '       createuser.fullname     as create_userfullname, '.
                         '       createuser.mail         as create_usermail,     '.
                         '       {t_name}.name,{t_name}.descr'.
                         ' FROM {t_object}'.
                         ' LEFT JOIN {t_name} '.
                         '        ON {t_object}.id={t_name}.objectid AND {t_name}.languageid={languageid} '.
                         ' LEFT JOIN {t_user} as lastchangeuser '.
                         '        ON {t_object}.lastchange_userid=lastchangeuser.id '.
                         ' LEFT JOIN {t_user} as createuser '.
                         '        ON {t_object}.create_userid=createuser.id '.
                         ' WHERE {t_object}.id={objectid}');
          $sql->setInt('objectid'  , $this->objectid  );
          $sql->setInt('languageid', $this->languageid);

          $row = $db->getRow($sql->query);
          
          if   ( count($row)==0 )
               die('cannot load object '.$this->objectid );

          $this->setDatabaseRow( $row );

          if (count($row) == 0)
               die('fatal: Object::objectLoad(): objectid not found: '.$this->objectid.', SQL='.$sql->query );

     }

Object::objectLoadName

(

)

Lesen von logischem Namen und Beschreibung Diese Eigenschaften sind sprachabhaengig und stehen deswegen in einer separaten Tabelle private

Definiert in Zeile 733 der Datei Object.class.php.

Benutzt $db, $SESS, db_connection() und filename().

     {
          die();
          global $SESS;
          $db = db_connection();

          $sql = new Sql('SELECT *'.' FROM {t_name}'.' WHERE objectid={objectid}'.'   AND languageid={languageid}');
          $sql->setInt('objectid'  , $this->objectid  );
          $sql->setInt('languageid', $this->languageid);
          $res = $db->query($sql->query);

          if ($res->numRows() == 0)
          {
               // Wenn Name in dieser Sprache nicht vorhanden, dann irgendeinen Namen lesen
               $sql->setQuery('SELECT *'.' FROM {t_name}'.' WHERE objectid={objectid}'.'   AND name != {blank}');
               $sql->setString('blank', '');
               $res = $db->query($sql->query);
          }
          $row = $res->fetchRow();

          $this->name = $row['name'];
          $this->desc = $row['description'];

          // Falls leer, id<objectnr> als Dateinamen verwenden
          if ($this->name == '')
               $this->name = $this->filename;
     }

Object::objectLoadRaw

(

)

Lesen der Eigenschaften aus der Datenbank Es werden

• die sprachunabhaengigen Daten wie Dateiname, Typ sowie Erstellungs- und Aenderungsdatum geladen

Definiert in Zeile 616 der Datei Object.class.php.

Benutzt $db, $SESS, db_connection() und filename().

     {
          global $SESS;
          $db = db_connection();

          $sql = new Sql('SELECT * FROM {t_object}'.
                       ' WHERE {t_object}.id={objectid}');
          $sql->setInt('objectid'  , $this->objectid  );
          $row = $db->getRow($sql->query);

          if (count($row) == 0)
               die('fatal: Object::objectLoadRaw(): objectid not found: '.$this->objectid.', SQL='.$sql->query);

          $this->parentid  = $row['parentid' ];
          $this->filename  = $row['filename' ];
          $this->projectid = $row['projectid'];
          
          if   ( intval($this->parentid) == 0 )
               $this->isRoot = true;
          else
               $this->isRoot = false;

          $this->name = 'n/a';

          $this->create_date       = $row['create_date'];
          $this->create_userid     = $row['create_userid'];
          $this->lastchange_date   = $row['lastchange_date'];
          $this->lastchange_userid = $row['lastchange_userid'];


          $this->isFolder = ( $row['is_folder'] == '1' );
          $this->isFile   = ( $row['is_file'  ] == '1' );
          $this->isPage   = ( $row['is_page'  ] == '1' );
          $this->isLink   = ( $row['is_link'  ] == '1' );
     }

Object::objectSave

(

$

withName = true

)

Eigenschaften des Objektes in Datenbank speichern

Definiert in Zeile 764 der Datei Object.class.php.

Benutzt $db, $SESS, checkFilename(), db_connection(), filename() und Session::getUser().

Wird benutzt von Page::save(), Link::save(), Folder::save() und File::save().

     {
          global $SESS;
          $db = db_connection();

          $this->checkFilename();

          $sql = new Sql('UPDATE {t_object} SET '.
                         '  parentid={parentid},'.
                         '  lastchange_date   = {time}  ,'.
                         '  lastchange_userid = {userid},'.
                         '  filename  = {filename}'.
                         ' WHERE id={objectid}');

          if   ( $this->isRoot )
               $sql->setNull('parentid');
          else $sql->setInt ('parentid',$this->parentid );

          $sql->setInt   ('objectid', $this->objectid);
          $sql->setString('filename', $this->filename);

          $user = Session::getUser();
          $this->lastchangeUser = $user;
          $this->lastchangeDate = time();

          $sql->setInt   ('userid'  ,$this->lastchangeUser->userid  );
          $sql->setInt   ('time'    ,$this->lastchangeDate          );

          $db->query($sql->query);

          // Nur wenn nicht Wurzelordner
          if   ( !$this->isRoot && $withName )
          {
               if   ( $this->name == '' )
                    $this->name = $this->filename;

               $this->objectSaveName();
          }
     }

Object::ObjectSaveName

(

)

Logischen Namen und Beschreibung des Objektes in Datenbank speichern (wird von objectSave() automatisch aufgerufen)

private

Definiert in Zeile 838 der Datei Object.class.php.

Benutzt $db, $SESS und db_connection().

     {
          global $SESS;
          $db = db_connection();

          $sql = new Sql('SELECT COUNT(*) FROM {t_name} '.' WHERE objectid  ={objectid}'.'   AND languageid={languageid}');
          $sql->setInt( 'objectid'  , $this->objectid   );
          $sql->setInt( 'languageid', $this->languageid );
          $count = $db->getOne($sql->query);

          if ($count > 0)
          {
               $sql->setQuery('UPDATE {t_name} SET '.
                              '  name  = {name},'.
                              '  descr = {desc} '.
                              ' WHERE objectid  ={objectid}'.
                              '   AND languageid={languageid}');
               $sql->setString('name', $this->name);
               $sql->setString('desc', $this->desc);
               $db->query($sql->query);
          }
          else
          {
               $sql = new Sql('SELECT MAX(id) FROM {t_name}');
               $nameid = intval($db->getOne($sql->query))+1;

               $sql->setQuery('INSERT INTO {t_name}'.'  (id,objectid,languageid,name,descr)'.' VALUES( {nameid},{objectid},{languageid},{name},{desc} )');
               $sql->setInt   ('objectid'  , $this->objectid    );
               $sql->setInt   ('languageid', $this->languageid  );
               $sql->setInt   ('nameid', $nameid    );
               $sql->setString('name'  , $this->name);
               $sql->setString('desc'  , $this->desc);
               $db->query($sql->query);
          }
     }

Object::path

(

)

Ermitteln des physikalischen Dateipfades, in dem sich das Objekt befindet

Rückgabe:

String Pfadangabe, z.B. 'pfad/zu/objekt'

Definiert in Zeile 453 der Datei Object.class.php.

Wird benutzt von Page::full_filename() und full_filename().

     {
          $folder = new Folder($this->parentid);

          return implode('/', $folder->parentObjectFileNames(false, true));
     }

Object::setDatabaseRow

(

$

row

)

Setzt die Eigenschaften des Objektes mit einer Datenbank-Ergebniszeile

Parameter:

row

Ergebniszeile aus Datenbanktabelle

Definiert in Zeile 658 der Datei Object.class.php.

Benutzt checkName(), filename() und Session::getProject().

Wird benutzt von objectLoad().

     {
          if   ( count($row)==0 )
               die('setDatabaseRow() got empty array, oid='.$this->objectid);

          $this->parentid  = $row['parentid' ];
          $this->projectid = $row['projectid'];
          $this->filename  = $row['filename' ];
          $this->orderid   = $row['orderid'  ];
          
          if   ( intval($this->parentid) == 0 )
               $this->isRoot = true;
          else $this->isRoot = false;

          $this->createDate     = $row['create_date'    ];
          $this->lastchangeDate = $row['lastchange_date'];

          $this->createUser = new User();
          $this->createUser->userid       = $row['create_userid'          ];
          if   ( !empty($row['create_username']) )
          {
               $this->createUser->name         = $row['create_username'        ];
               $this->createUser->fullname     = $row['create_userfullname'    ];
               $this->createUser->mail         = $row['create_usermail'        ];
          }

          $this->lastchangeUser = new User();
          $this->lastchangeUser->userid   = $row['lastchange_userid'      ];
          
          if   ( !empty($row['lastchange_username']) )
          {
               $this->lastchangeUser->name     = $row['lastchange_username'    ];
               $this->lastchangeUser->fullname = $row['lastchange_userfullname'];
               $this->lastchangeUser->mail     = $row['lastchange_usermail'    ];
          }

          $this->isFolder = ( $row['is_folder'] == '1' );
          $this->isFile   = ( $row['is_file'  ] == '1' );
          $this->isPage   = ( $row['is_page'  ] == '1' );
          $this->isLink   = ( $row['is_link'  ] == '1' );

          if   ( $this->isRoot )
          {
               $project = Session::getProject();
               $this->name        = $project->name;
               $this->desc        = '';
               $this->description = '';
          }
          else
          {
               $this->name        = $row['name' ];
               $this->desc        = $row['descr'];
               $this->description = $row['descr'];
          }

          $this->checkName();
     }

Object::setOrderId

(

$

orderid

)

Reihenfolge-Sequenznr. dieses Objektes neu speichern die Nr. wird sofort in der Datenbank gespeichert.

Parameter:

Integer

neue Sequenz-Nr.

Erneute Implementation in Folder.

Definiert in Zeile 1289 der Datei Object.class.php.

Benutzt $db und db_connection().

     {
          $db = db_connection();

          $sql = new Sql('UPDATE {t_object} '.'  SET orderid={orderid}'.'  WHERE id={objectid}');
          $sql->setInt('objectid', $this->objectid);
          $sql->setInt('orderid', $orderid);

          $db->query($sql->query);
     }

Object::setParentId

(

$

parentid

)

?bergeordnete Objekt-ID dieses Objektes neu speichern die Nr. wird sofort in der Datenbank gespeichert.

Parameter:

Integer

?bergeordnete Objekt-ID

Definiert in Zeile 1307 der Datei Object.class.php.

Benutzt $db, $parentid und db_connection().

     {
          $db = db_connection();

          $sql = new Sql('UPDATE {t_object} '.'  SET parentid={parentid}'.'  WHERE id={objectid}');
          $sql->setInt('objectid', $this->objectid);
          $sql->setInt('parentid', $parentid);

          $db->query($sql->query);
     }

Object::setTimestamp

(

)

Aenderungsdatum auf Systemzeit setzen

Erneute Implementation in File und Page.

Definiert in Zeile 809 der Datei Object.class.php.

Benutzt $db, db_connection() und Session::getUser().

     {
          $db = db_connection();

          $sql = new Sql('UPDATE {t_object} SET '.
                         '  lastchange_date   = {time}  ,'.
                         '  lastchange_userid = {userid} '.
                         ' WHERE id={objectid}');

          $user = Session::getUser();
          $this->lastchangeUser = $user;
          $this->lastchangeDate = time();

          $sql->setInt   ('userid'  ,$this->lastchangeUser->userid  );
          $sql->setInt   ('objectid',$this->objectid                );
          $sql->setInt   ('time'    ,$this->lastchangeDate          );

          $db->query( $sql->query );
          
     }

Object::tmpfileYYYYYY

(

)

Dateinamen der temporaeren Datei bestimmen

Definiert in Zeile 1181 der Datei Object.class.php.

Benutzt $conf, Logger::debug() und Html::debug().

     {
          if   ( isset($this->tmpfile) && $this->tmpfile != '' )
               return $this->tmpfile; // Tempor�rer Dateiname bereits vorhanden.

          global $conf;
          
          // 1. Versuch: Temp-Dir aus Konfiguration.
          $tmpdir = @$conf['cache']['tmp_dir'];
          if   ( $this->tmpfile === FALSE )
               $this->tmpfile = @tempnam( $tmpdir,'openrat_tmp' );

          // 2. Versuch: Temp-Dir aus "upload_tmp_dir".
          if   ( $this->tmpfile === FALSE )
          {
               Html::debug($this->tmpfile,"nochmal");
               $tmpdir = ini_get('upload_tmp_dir');
               $this->tmpfile = @tempnam( $tmpdir,'openrat_tmp' );
          }
          
          elseif    ( $this->tmpfile === FALSE )
          {
          Html::debug($this->tmpfile,"nochmal");
               $this->tmpfile = @tempnam( '','openrat_tmp' );
          }
               
          Html::debug($this->tmpfile,"tmpfile in objekt");
          Logger::debug( 'creating temporary file: '.$this->tmpfile );

          return $this->tmpfile;
     }

---

Dokumentation der Datenelemente

Object::$aclMask = null

Definiert in Zeile 257 der Datei Object.class.php.

Object::$createDate

Zeitpunkt der Erstellung. Die Variable beinhaltet den Unix-Timestamp. Integer

Definiert in Zeile 177 der Datei Object.class.php.

Object::$createUser

Benutzer, welcher dieses Objekt erstellt hat. Integer

Definiert in Zeile 187 der Datei Object.class.php.

Object::$desc = ''

Erneute Implementation in Folder.

Definiert in Zeile 172 der Datei Object.class.php.

Object::$description = 'none'

Logische (sprachabhaengige) Beschreibung des Objektes (wird in Tabelle name abgelegt) String

Definiert in Zeile 171 der Datei Object.class.php.

Object::$filename = ''

Physikalischer Dateiname des Objektes (bei Links nicht gef?llt) enth?lt nicht die Dateinamen-Erweiterung String

Erneute Implementation in Folder.

Definiert in Zeile 159 der Datei Object.class.php.

Wird benutzt von filenameIsUnique(), Page::full_filename(), File::full_filename(), getTempFileName(), goodFilename(), File::parse_filename() und Page::tmpfile().

Object::$id

eindeutige ID dieses Objektes

Siehe auch:

$objectid Integer

Definiert in Zeile 141 der Datei Object.class.php.

Wird benutzt von Folder::addParentFolder(), Page::generate() und isObjectId().

Object::$isFile = false

Kennzeichen, ob Objekt eine binaere Datei ist Boolean

Definiert in Zeile 204 der Datei Object.class.php.

Object::$isFolder = false

Kennzeichen, ob Objekt ein Ordner ist Boolean

Definiert in Zeile 198 der Datei Object.class.php.

Object::$isLink = false

Kennzeichen, ob Objekt eine Verknuepfung (Link) ist Boolean

Definiert in Zeile 216 der Datei Object.class.php.

Object::$isPage = false

Kennzeichen, ob Objekt eine Seite ist Boolean

Definiert in Zeile 210 der Datei Object.class.php.

Object::$isRoot = false

Kennzeichen ob Objekt den Wurzelordner des Projektes darstellt (parentid ist dann NULL) Boolean

Definiert in Zeile 229 der Datei Object.class.php.

Object::$languageid

Sprach-ID

Siehe auch:

Language Integer

Definiert in Zeile 235 der Datei Object.class.php.

Wird benutzt von Page::publish().

Object::$lastchangeDate

Zeitpunkt der letzten Aenderung. Die Variable beinhaltet den Unix-Timestamp. Integer

Definiert in Zeile 182 der Datei Object.class.php.

Object::$lastchangeUser

Benutzer, welcher dieses Objekt zuletzt geaendert hat. Integer

Definiert in Zeile 192 der Datei Object.class.php.

Object::$modelid

Projektmodell-ID

Siehe auch:

Projectmodel Integer

Erneute Implementation in Page.

Definiert in Zeile 242 der Datei Object.class.php.

Object::$name = ''

Logischer (sprachabhaengiger) Name des Objektes (wird in Tabelle name abgelegt) String

Erneute Implementation in Folder.

Definiert in Zeile 165 der Datei Object.class.php.

Object::$objectid

eindeutige ID dieses Objektes Integer

Definiert in Zeile 146 der Datei Object.class.php.

Wird benutzt von available(), File::File(), Folder::Folder(), Page::getPageIdFromObjectId(), Link::Link(), Object(), Page::Page() und Page::path_to_object().

Object::$parentid

Objekt-ID des Ordners, in dem sich dieses Objekt befindet Kann "null" oder "0" sein, wenn es sich um den Wurzelordner des Projektes handelt

Siehe auch:

$isRoot Integer

Definiert in Zeile 153 der Datei Object.class.php.

Wird benutzt von Folder::parentfolder_bak() und setParentId().

Object::$projectid

Projekt-ID

Siehe auch:

Project Integer

Erneute Implementation in Folder.

Definiert in Zeile 249 der Datei Object.class.php.

Wird benutzt von getAllObjectIds().

Object::$tmpfile

Dateiname der temporaeren Datei String

Erneute Implementation in File.

Definiert in Zeile 255 der Datei Object.class.php.

Wird benutzt von getTempDir().

Object::$type = null

Kennzeichnet den Typ dieses Objektes. Muss den Inhalt OR_FILE, OR_FOLDER, OR_PAGE oder OR_LINK haben. Vorbelegung mit null. Integer

Definiert in Zeile 224 der Datei Object.class.php.

Wird benutzt von hasRight().

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• objectClasses/Object.class.php