Class: ScriptReorganizer_Type_Decorator_Pharize

Source Location: /ScriptReorganizer-0.3.0/Type/Decorator/Pharize.php

Class Overview

ScriptReorganizer_Type
   |
   --ScriptReorganizer_Type_Decorator
      |
      --ScriptReorganizer_Type_Decorator_Pharize

Decorator/Adapter for creating a PHP_Archive

Author(s):

Stefano F. Rausch <stefano at rausch-e.net>

Version:

Release: @package_version@

Copyright:

2005 Stefano F. Rausch <stefano@rausch-e.net>

Methods

Inherited Variables

Inherited Methods

Class: ScriptReorganizer_Type_Decorator

ScriptReorganizer_Type_Decorator::__construct(): Constructor
ScriptReorganizer_Type_Decorator::load(): Loads the script's content to be reorganized from disk
ScriptReorganizer_Type_Decorator::reformat(): Reorganizes the script's content by applying the chosen Strategy
ScriptReorganizer_Type_Decorator::save(): Saves the reorganized script's content to disk
ScriptReorganizer_Type_Decorator::_getContent(): Gets the script's content currently being reorganized
ScriptReorganizer_Type_Decorator::_setContent(): Sets the script's content currently being reorganized
ScriptReorganizer_Type_Decorator::__destruct(): Destructor

Class: ScriptReorganizer_Type

ScriptReorganizer_Type::__construct(): Constructor
ScriptReorganizer_Type::getEolIdentifier(): Detects the currently used end-of-line identifier
ScriptReorganizer_Type::load(): Loads the script's content to be reorganized from disk
ScriptReorganizer_Type::reformat(): Reorganizes the script's content by applying the chosen Strategy
ScriptReorganizer_Type::save(): Saves the reorganized script's content to disk
ScriptReorganizer_Type::_getContent(): Gets the script's content currently being reorganized
ScriptReorganizer_Type::_setContent(): Sets the script's content currently being reorganized
ScriptReorganizer_Type::__destruct(): Destructor

Class Details

[line 71]
Decorator/Adapter for creating a PHP_Archive

If a (complex) application is pharized, a non-ScriptReorganized source code tree should be shipped together with the optimized one, to enable third parties to track down undiscoverd bugs.

ANN: Decoration of a directly sequencing Pharize-Decorator or Bcompile-Decorator is not allowed.

Author: Stefano F. Rausch <stefano@rausch-e.net>
Version: Release: @package_version@
Copyright: 2005 Stefano F. Rausch <stefano@rausch-e.net>
Link: http://pear.php.net/package/ScriptReorganizer
Todo: implement method loadDirectory
License: LGPL License 2.1

[ Top ]

Method Detail

__construct (Constructor) [line 82]

ScriptReorganizer_Type_Decorator_Pharize __construct(
ScriptReorganizer_Type
$type)

Constructor

Throws: ScriptReorganizer_Type_Decorator_Exception
Access: public

Overrides ScriptReorganizer_Type_Decorator::__construct() (Constructor)

Parameters:

ScriptReorganizer_Type $type — a ScriptReorganizer_Type to decorate

[ Top ]

load [line 122]

void load(
string
$source, string
$target, [boolean
$magicRequire = false])

Loads the script's content to be reorganized from disk

Throws: ScriptReorganizer_Type_Decorator_Exception
Throws: ScriptReorganizer_Type_Exception
Access: public

Overrides ScriptReorganizer_Type_Decorator::load() (Loads the script's content to be reorganized from disk)

Parameters:

string	`$source`	—	a string representing the file's name to load
string	`$target`	—	a string representing the file's location in the PHP Archive
boolean	`$magicRequire`	—	boolean true, for phar-stream activation within the PHP Arcive; otherwise false

[ Top ]

loadFiles [line 158]

void loadFiles(
array
$files, [boolean
$magicRequire = false])

Loads the scripts' content to be reorganized from disk

Throws: ScriptReorganizer_Type_Decorator_Exception
Throws: ScriptReorganizer_Type_Exception
Access: public

Parameters:

array	`$files`	—	an associative array holding all files' name to load and the corresponding files' locations in the PHP Archive
boolean	`$magicRequire`	—	boolean true, for phar-stream activation within the PHP Archive; otherwise false

[ Top ]

reformat [line 180]

void reformat(
)

Reorganizes the script's content by applying the chosen Strategy

Access: public

Overrides ScriptReorganizer_Type_Decorator::reformat() (Reorganizes the script's content by applying the chosen Strategy)

[ Top ]

save [line 206]

void save(
string
$file, [string
$initFile = 'index.php'], [boolean
$compress = false], [mixed
$allowDirectAccess = false])

Saves the PHP Archive to disk

Throws: ScriptReorganizer_Type_Decorator_Exception
Access: public

Overrides ScriptReorganizer_Type_Decorator::save() (Saves the reorganized script's content to disk)

Parameters:

string	`$file`	—	a string representing the PHP Archive file's name to save
string	`$initFile`	—	a string representing the file's name called by default upon PHAR execution
boolean	`$compress`	—	boolean true, if the files have to be compressed; otherwise false
mixed	`$allowDirectAccess`	—	boolean true, for unrestricted file access; boolean false, for access restricted to the init file; a string representing the restricted file type (extension) access

[ Top ]

_getContent [line 251]

array _getContent(
)

Gets the scripts' contents currently being reorganized

Return: an associative array holding all files' locations in the PHP Archive and the corresponding contents
Since: Method available since Release 0.3.0
Access: public

Overrides ScriptReorganizer_Type_Decorator::_getContent() (Gets the script's content currently being reorganized)

[ Top ]

_setContent [line 271]

void _setContent(
array
$targets, [boolean
$magicRequire = false])

Sets the scripts' contents currently being reorganized

Throws: ScriptReorganizer_Type_Decorator_Exception
Since: Method available since Release 0.3.0
Access: public

Overrides ScriptReorganizer_Type_Decorator::_setContent() (Sets the script's content currently being reorganized)

Parameters:

array	`$targets`	—	an associative array holding all files' locations in the PHP Archive and the corresponding contents
boolean	`$magicRequire`	—	boolean true, for phar-stream activation within the PHP Arcive; otherwise false

[ Top ]