FilemanagerAction Klassenreferenz

Klassendiagramm für FilemanagerAction:

Aufstellung aller Elemente

Öffentliche Methoden
	FilemanagerAction ()
	investigateCurrentFolder ()
	show ()
	setXmlHeaders ()
	createXmlHeader ()
	createXmlFooter ()
	sendError ($number, $text)
	sendErrorDocument ($number, $text)
	getFolders ()
	getFoldersAndFiles ()
	createFolder ()
	fileUpload ()
Öffentliche Attribute
	$command
	$resourceType
	$currentFolder
	$folder

---

Ausführliche Beschreibung

Definiert in Zeile 29 der Datei FilemanagerAction.class.php.

---

Dokumentation der Elementfunktionen

FilemanagerAction::createFolder

(

)

Legt einen neuen Unterordner an.

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

Benutzt Action::getRequestVar() und sendError().

Wird benutzt von show().

     {    
          // Possible Error Numbers are: 
          //   0 : No Errors Found. The folder has been created. 
          // 101 : Folder already exists. 
          // 102 : Invalid folder name. 
          // 103 : You have no permissions to create the folder. 
          // 110 : Unknown error creating folder.
          
          $filename = $this->getRequestVar('NewFolderName');
          
          if ( empty($filename) )
          {
               $this->sendError(102,'missing name for new folder.');
          }
          elseif( !$this->folder->hasRight(ACL_CREATE_FOLDER) )
          {
               $this->sendError(103,'You have no permissions to create the folder.');
          }
          elseif( $this->folder->hasFilename( $filename ) )
          {
               $this->sendError(101,'Folder already exists.');
          }
          else
          {
               $newFolder = new Folder();
               $newFolder->parentid = $this->folder->objectid;
               $newFolder->filename = $filename;
               $newFolder->name     = $filename;
               
               $newFolder->add();
               
               $this->sendError(0,"OK");
          }
     }

FilemanagerAction::createXmlFooter

(

)

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

Wird benutzt von sendErrorDocument() und show().

     {
          echo '</Connector>' ;
     }

FilemanagerAction::createXmlHeader

(

)

Definiert in Zeile 176 der Datei FilemanagerAction.class.php.

Benutzt convertToXmlAttribute().

Wird benutzt von sendErrorDocument() und show().

     {
          // Set the response format.
          header( 'Content-Type:text/xml' ) ;

          echo '<?xml version="1.0" encoding="utf-8" ?>' ;
          
          // Create the main "Connector" node.
          echo '<Connector command="' . $this->command . '" resourceType="' . $this->resourceType . '">' ;
          
          // Add the current folder node.
          echo '<CurrentFolder path="' . convertToXmlAttribute($this->currentFolder).'" url="'.convertToXmlAttribute($this->currentFolder) . '" />' ;
     }

FilemanagerAction::FilemanagerAction

(

)

Konstruktor

Definiert in Zeile 51 der Datei FilemanagerAction.class.php.

Benutzt Action::getRequestVar(), investigateCurrentFolder() und sendErrorDocument().

     {
          // PHP-Fehler ins Log schreiben, damit die Ausgabe nicht zerstört wird.
          set_error_handler('filemanagerErrorHandler',E_ALL & ~E_NOTICE);

          // Get the main request information.
          $this->command       = $this->getRequestVar('Command'      );
          $this->resourceType  = $this->getRequestVar('Type'         );
          $this->currentFolder = $this->getRequestVar('CurrentFolder');

          // Check if it is an allowed type.
          if ( !in_array( $this->resourceType, array('File','Image','Flash','Media') ) )
          {
               $this->sendErrorDocument(1,'unknown resource type');
               exit;
          }
     
          // Check the current folder syntax (must begin and end with a slash).
          if ( ! ereg( '/$', $this->currentFolder ) ) $this->currentFolder .= '/' ;
          if ( strpos( $this->currentFolder, '/' ) !== 0 ) $this->currentFolder = '/' . $this->currentFolder;      
          
          $this->investigateCurrentFolder();
     }

FilemanagerAction::fileUpload

(

)

Datei-Upload.

Definiert in Zeile 308 der Datei FilemanagerAction.class.php.

Wird benutzt von show().

     {
          $upload = new Upload('NewFile');
          
          // From FCK-Editor-Doc:
          // The "OnUploadCompleted" is a JavaScript function that is called to expose the upload result. The possible values are: 
          // OnUploadCompleted( 0 ) : no errors found on the upload process. 
          // OnUploadCompleted( 1, , , 'Reason' ) : the upload filed because of "Reason". 
          // OnUploadCompleted( 201, ,'FileName(1).ext' ) : the file has been uploaded successfully, but its name has been changed to "FileName(1).ext". 
          // OnUploadCompleted( 202 ) : invalid file.
          if   ( !$upload->isValid() )
          {
               $errorNr   = 202;
               $errorText = 'Upload failed, reason: '.$upload->error; 
          }
          else
          {
               $file = new File();
               $file->parentid = $this->folder->objectid;
               $file->filename = $upload->filename;
               $file->value    = $upload->value;
               $file->add();

               $errorNr   = 0;
               $errorText = $file->filename; 
          }
     
          echo '<script type="text/javascript">' ;
          echo 'window.parent.frames["frmUpload"].OnUploadCompleted(' .$errorNr.',"' . str_replace( '"', '\\"', $errorText ) . '") ;' ;
          echo '</script>' ;
     }

FilemanagerAction::getFolders

(

)

Ermittelt alle Unterordner.

Definiert in Zeile 230 der Datei FilemanagerAction.class.php.

Benutzt convertToXmlAttribute().

Wird benutzt von show().

     {
          echo "<Folders>" ;

          foreach( $this->folder->getSubfolderFilenames() as $id=>$name )
               echo '<Folder name="'. convertToXmlAttribute($name).'" />';
     
          echo "</Folders>" ;
     }

FilemanagerAction::getFoldersAndFiles

(

)

Ermittelt alle Unterordner und Dateien.

Definiert in Zeile 245 der Datei FilemanagerAction.class.php.

Benutzt convertToXmlAttribute() und Html::url().

Wird benutzt von show().

     {
          echo '<Folders>' ;

          foreach( $this->folder->getSubfolderFilenames() as $id=>$name )
               echo '<Folder name="'. convertToXmlAttribute($name).'" />';
               
          echo '</Folders>' ;
          echo '<Files>' ;

          foreach( $this->folder->getFileFilenames() as $id=>$name )
               echo '<File name="' . convertToXmlAttribute( $name ).'" url="'.convertToXmlAttribute( Html::url('file','show',$id,array('oid'=>'__OID__'.$id.'__') ) ).'" size="' . '1' . '" />' ;
     
          echo '</Files>' ;
     }

FilemanagerAction::investigateCurrentFolder

(

)

Ermittelt das aktuelle Ordnerobjekt.

Definiert in Zeile 80 der Datei FilemanagerAction.class.php.

Benutzt Session::getProject() und sendErrorDocument().

Wird benutzt von FilemanagerAction().

     {
          $project = Session::getProject();
          $folderid = $project->getRootObjectId();
          $this->folder = new Folder( $folderid );
          $parts = explode('/',$this->currentFolder);

          foreach( $parts as $part )
          {
               if   ( empty($part) )
                    continue;

               $oid = $this->folder->getObjectIdByFileName($part);
               
               if   ( !$this->folder->available($oid) )
                    $this->sendErrorDocument(102,"currentFolder is invalid (no folder inside): "+$this->currentFolder);
               
               $this->folder = new Folder($oid);

               if   ( ! $this->folder->isFolder )
                    $this->sendErrorDocument(102,"currentFolder is invalid (not a folder): "+$this->currentFolder);
          }
     }

FilemanagerAction::sendError	(	$	number,
		$	text
	)

Sendet eine Fehlermeldung zum Client.

Parameter:

	Integer	$number FehlerNr.
	String	$text Fehlermeldung

Definiert in Zeile 205 der Datei FilemanagerAction.class.php.

Wird benutzt von createFolder(), sendErrorDocument() und show().

     {
          echo '<Error number="' . $number . '" text="' . htmlspecialchars( $text ) . '" />' ;
     }

FilemanagerAction::sendErrorDocument	(	$	number,
		$	text
	)

Sendet eine Fehlermeldung zum Client und beendet den Request.

Parameter:

	Integer	$number FehlerNr.
	String	$text Fehlermeldung

Definiert in Zeile 217 der Datei FilemanagerAction.class.php.

Benutzt createXmlFooter(), createXmlHeader() und sendError().

Wird benutzt von FilemanagerAction() und investigateCurrentFolder().

     {
          $this->createXmlHeader();
          $this->sendError( $number, $text );
          $this->createXmlFooter();
          exit ;
     }

FilemanagerAction::setXmlHeaders

(

)

Definiert in Zeile 156 der Datei FilemanagerAction.class.php.

Wird benutzt von show().

     {
          // Prevent the browser from caching the result.
          // Date in the past
          header("Expires: ".gmdate("D, d M Y H:i:s")." GMT");
          // always modified
          header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
          
          // HTTP/1.1
          header('Cache-Control: no-store, no-cache, must-revalidate') ;
          header('Cache-Control: post-check=0, pre-check=0', false) ;

          // HTTP/1.0
          header('Pragma: no-cache') ;
     }

FilemanagerAction::show

(

)

Anzeigen des Inhaltes, der Inhalt wird samt Header direkt auf die Standardausgabe geschrieben

Definiert in Zeile 110 der Datei FilemanagerAction.class.php.

Benutzt createFolder(), createXmlFooter(), createXmlHeader(), Logger::debug(), fileUpload(), getFolders(), getFoldersAndFiles(), sendError(), setXmlHeaders() und Logger::warn().

     {
          Logger::debug('Filemanager: '.getenv('REQUEST_URI'));
          Logger::debug($this->command);
          Logger::debug($this->resourceType);
          Logger::debug($this->currentFolder);
          Logger::debug($this->folder->objectid);

          // File Upload doesn't have to Return XML, so it must be intercepted before anything.
          if ( $this->command == 'FileUpload' )
          {
               $this->fileUpload() ;
               return ;
          }
          Logger::debug("Start");
          
          $this->setXmlHeaders();
          $this->createXmlHeader();
          
          // Execute the required command.
          switch ( $this->command )
          {
               case 'GetFolders':
                    $this->getFolders() ;
                    break ;
                    
               case 'GetFoldersAndFiles':
                    $this->getFoldersAndFiles() ;
                    break ;
                    
               case 'CreateFolder':
                    $this->createFolder() ;
                    break ;
                    
               default:
                    Logger::warn('Unknown Filemanager-Command: '.$this->command);
                    trigger_error('Unknown Command: '.$this->command);
                    $this->sendError( 1,"unknown command: ".$this->command ) ;
          }
          Logger::debug("ok");

          $this->createXmlFooter();
          exit;
     }

---

Dokumentation der Datenelemente

FilemanagerAction::$command

Definiert in Zeile 31 der Datei FilemanagerAction.class.php.

FilemanagerAction::$currentFolder

Definiert in Zeile 39 der Datei FilemanagerAction.class.php.

FilemanagerAction::$folder

Definiert in Zeile 46 der Datei FilemanagerAction.class.php.

FilemanagerAction::$resourceType

Definiert in Zeile 32 der Datei FilemanagerAction.class.php.

---

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

• actionClasses/FilemanagerAction.class.php