[ Index ]
 

Code source de Symfony 1.0.0

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/vendor/propel-generator/classes/propel/engine/builder/om/php5/ -> PHP5NodePeerBuilder.php (sommaire)

(pas de description)

Poids: 774 lignes (27 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

PHP5NodePeerBuilder:: (32 méthodes):
  getPackage()
  getClassname()
  addIncludes()
  addClassOpen()
  addClassBody()
  addClassClose()
  addConstants()
  addIsCodeBase()
  isCodeBase()
  addCreateNewRootNode()
  createNewRootNode()
  addInsertNewRootNode()
  insertNewRootNode()
  addRetrieveMethods()
  addRetrieveNodes()
  retrieveNodes()
  addRetrieveNodeByPK()
  retrieveNodeByPK()
  addRetrieveNodeByNP()
  retrieveNodeByNP()
  addRetrieveRootNode()
  retrieveRootNode()
  addMoveNodeSubTree()
  moveNodeSubTree()
  addDeleteNodeSubTree()
  deleteNodeSubTree()
  addBuildFamilyCriteria()
  buildFamilyCriteria()
  addBuildTree()
  buildTree()
  addPopulateNodes()
  populateNodes()


Classe: PHP5NodePeerBuilder  - X-Ref

Generates a PHP5 tree node Peer class for user object model (OM).

This class produces the base tree node object class (e.g. BaseMyTable) which contains all
the custom-built accessor and setter methods.

This class replaces the Node.tpl, with the intent of being easier for users
to customize (through extending & overriding).

getPackage()   X-Ref
Gets the package for the [base] object classes.

return: string

getClassname()   X-Ref
Returns the name of the current class being built.

return: string

addIncludes(&$script)   X-Ref
Adds the include() statements for files that this class depends on or utilizes.

param: string &$script The script will be modified in this method.

addClassOpen(&$script)   X-Ref
Adds class phpdoc comment and openning of class.

param: string &$script The script will be modified in this method.

addClassBody(&$script)   X-Ref
Specifies the methods that are added as part of the basic OM class.
This can be overridden by subclasses that wish to add more methods.


addClassClose(&$script)   X-Ref
Closes class.

param: string &$script The script will be modified in this method.

addConstants(&$script)   X-Ref
Pas de description

addIsCodeBase(&$script)   X-Ref
Pas de description

isCodeBase(\$con = null)   X-Ref
Temp function for CodeBase hacks that will go away.


addCreateNewRootNode(&$script)   X-Ref
Pas de description

createNewRootNode(\$obj, \$con = null)   X-Ref
Create a new Node at the top of tree. This method will destroy any
existing root node (along with its children).

Use at your own risk!

param: $objectClassname Object wrapped by new node.
param: Connection Connection to use.
return: $nodeObjectClassname

addInsertNewRootNode(&$script)   X-Ref
Pas de description

insertNewRootNode(\$obj, \$con = null)   X-Ref
Inserts a new Node at the top of tree. Any existing root node (along with
its children) will be made a child of the new root node. This is a
safer alternative to createNewRootNode().

param: $objectClassname Object wrapped by new node.
param: Connection Connection to use.
return: $nodeObjectClassname

addRetrieveMethods(&$script)   X-Ref
Adds the methods for retrieving nodes.


addRetrieveNodes(&$script)   X-Ref
Pas de description

retrieveNodes(\$criteria, \$ancestors = false, \$descendants = false, \$con = null)   X-Ref
Retrieves an array of tree nodes based on specified criteria. Optionally
includes all parent and/or child nodes of the matching nodes.

param: Criteria Criteria to use.
param: boolean True if ancestors should also be retrieved.
param: boolean True if descendants should also be retrieved.
param: Connection Connection to use.
return: array Array of root nodes.

addRetrieveNodeByPK(&$script)   X-Ref
Pas de description

retrieveNodeByPK(\$pk, \$ancestors = false, \$descendants = false, \$con = null)   X-Ref
Retrieves a tree node based on a primary key. Optionally includes all
parent and/or child nodes of the matching node.

param: mixed $objectClassname primary key (array for composite keys)
param: boolean True if ancestors should also be retrieved.
param: boolean True if descendants should also be retrieved.
param: Connection Connection to use.
return: $nodeObjectClassname

addRetrieveNodeByNP(&$script)   X-Ref
Pas de description

retrieveNodeByNP(\$np, \$ancestors = false, \$descendants = false, \$con = null)   X-Ref
Retrieves a tree node based on a node path. Optionally includes all
parent and/or child nodes of the matching node.

param: string Node path to retrieve.
param: boolean True if ancestors should also be retrieved.
param: boolean True if descendants should also be retrieved.
param: Connection Connection to use.
return: $objectClassname

addRetrieveRootNode(&$script)   X-Ref
Pas de description

retrieveRootNode(\$descendants = false, \$con = null)   X-Ref
Retrieves the root node.

param: string Node path to retrieve.
param: boolean True if descendants should also be retrieved.
param: Connection Connection to use.
return: ".$this->getStubNodeBuilder()->getClassname()."

addMoveNodeSubTree(&$script)   X-Ref
Pas de description

moveNodeSubTree(\$srcPath, \$dstPath, \$con = null)   X-Ref
Moves the node subtree at srcpath to the dstpath. This method is intended
for internal use by the BaseNode object. Note that it does not check for
preexisting nodes at the dstpath. It also does not update the  node path
of any Node objects that might currently be in memory.

Use at your own risk!

param: string Source node path to move (root of the src subtree).
param: string Destination node path to move to (root of the dst subtree).
param: Connection Connection to use.
return: void

addDeleteNodeSubTree(&$script)   X-Ref
Pas de description

deleteNodeSubTree(\$nodePath, \$con = null)   X-Ref
Deletes the node subtree at the specified node path from the database.

param: string Node path to delete
param: Connection Connection to use.
return: void

addBuildFamilyCriteria(&$script)   X-Ref
Pas de description

buildFamilyCriteria(\$criteria, \$ancestors = false, \$descendants = false)   X-Ref
Builds the criteria needed to retrieve node ancestors and/or descendants.

param: Criteria Criteria to start with
param: boolean True if ancestors should be retrieved.
param: boolean True if descendants should be retrieved.
return: Criteria

addBuildTree(&$script)   X-Ref
Pas de description

buildTree(\$nodes)   X-Ref
This method reconstructs as much of the tree structure as possible from
the given array of objects. Depending on how you execute your query, it
is possible for the ResultSet to contain multiple tree fragments (i.e.
subtrees). The array returned by this method will contain one entry
for each subtree root node it finds. The remaining subtree nodes are
accessible from the $nodeObjectClassname methods of the
subtree root nodes.

param: array Array of $nodeObjectClassname objects
return: array Array of $nodeObjectClassname objects

addPopulateNodes(&$script)   X-Ref
Pas de description

populateNodes(\$rs, \$criteria)   X-Ref
Populates the $objectClassname objects from the
specified ResultSet, wraps them in $nodeObjectClassname
objects and build the appropriate node relationships.
The array returned by this method will only include the initial targets
of the query, even if ancestors/descendants were also requested.
The ancestors/descendants will be cached in memory and are accessible via
the getNode() methods.

param: ResultSet
param: Criteria
return: array Array of $nodeObjectClassname objects.



Généré le : Fri Mar 16 22:42:14 2007 par Balluche grâce à PHPXref 0.7