[ 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/ -> PHP5NodeBuilder.php (sommaire)

(pas de description)

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

Définit 1 class

PHP5NodeBuilder:: (69 méthodes):
  getPackage()
  getClassname()
  addIncludes()
  addClassOpen()
  addClassBody()
  addClassClose()
  addAttributes()
  addConstructor()
  __construct()
  addCallOverload()
  __call()
  addSetIteratorOptions()
  setIteratorOptions()
  addGetIterator()
  getIterator()
  addGetNodeObj()
  getNodeObj()
  addGetNodePath()
  getNodePath()
  addGetNodeIndex()
  getNodeIndex()
  addGetNodeLevel()
  getNodeLevel()
  addHasChildNode()
  hasChildNode()
  addGetChildNodeAt()
  getChildNodeAt()
  addGetFirstChildNode()
  getFirstChildNode()
  addGetLastChildNode()
  getLastChildNode()
  addGetSiblingNode()
  getSiblingNode()
  addGetParentNode()
  getParentNode()
  addGetAncestors()
  getAncestors()
  addIsRootNode()
  isRootNode()
  addSetNew()
  setNew()
  addSetDeleted()
  setDeleted()
  addAddChildNode()
  addChildNode()
  addMoveChildNode()
  moveChildNode()
  addSave()
  save()
  addDelete()
  delete()
  addEquals()
  equals()
  addAttachParentNode()
  attachParentNode()
  addAttachChildNode()
  attachChildNode()
  addDetachParentNode()
  detachParentNode()
  addDetachChildNode()
  detachChildNode()
  addShiftChildNodes()
  shiftChildNodes()
  addInsertNewChildNode()
  insertNewChildNode()
  addAdjustStatus()
  adjustStatus()
  addAdjustNodePath()
  adjustNodePath()


Classe: PHP5NodeBuilder  - X-Ref

Generates a PHP5 tree node Object 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.

addAttributes(&$script)   X-Ref
Adds class attributes.

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

addConstructor(&$script)   X-Ref
Adds the constructor.

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

__construct(\$obj = null)   X-Ref
Constructor.

param: ".$this->getStubObjectBuilder()->getClassname()." \$obj Object wrapped by this node.

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

__call(\$name, \$parms)   X-Ref
Convenience overload for wrapped object methods.

param: string Method name to call on wrapped object.
param: mixed Parameter accepted by wrapped object set method.
return: mixed Return value of wrapped object method.

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

setIteratorOptions(\$type, \$opts)   X-Ref
Sets the default options for iterators created from this object.
The options are specified in map format. The following options
are supported by all iterators. Some iterators may support other
options:

\"querydb\" - True if nodes should be retrieved from database.
\"con\" - Connection to use if retrieving from database.

param: string Type of iterator to use (\"pre\", \"post\", \"level\").
param: array Map of option name => value.
return: void

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

getIterator(\$type = null, \$opts = null)   X-Ref
Returns a pre-order iterator for this node and its children.

param: string Type of iterator to use (\"pre\", \"post\", \"level\")
param: array Map of option name => value.
return: NodeIterator

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

getNodeObj()   X-Ref
Returns the object wrapped by this class.

return: ".$this->getStubObjectBuilder()->getClassname()."

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

getNodePath()   X-Ref
Convenience method for retrieving nodepath.

return: string

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

getNodeIndex()   X-Ref
Returns one-based node index among siblings.

return: int

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

getNodeLevel()   X-Ref
Returns one-based node level within tree (root node is level 1).

return: int

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

hasChildNode(\$node, \$strict = false, \$recurse = false)   X-Ref
Returns true if specified node is a child of this node. If recurse is
true, checks if specified node is a descendant of this node.

param: ".$this->getStubNodeBuilder()->getClassname()." Node to look for.
param: boolean True if strict comparison should be used.
param: boolean True if all descendants should be checked.
return: boolean

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

getChildNodeAt(\$i, \$querydb = false, \$con = null)   X-Ref
Returns child node at one-based index. Retrieves from database if not
loaded yet.

param: int One-based child node index.
param: boolean True if child should be retrieved from database.
param: Connection Connection to use if retrieving from database.
return: ".$this->getStubNodeBuilder()->getClassname()."

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

getFirstChildNode(\$querydb = false, \$con = null)   X-Ref
Returns first child node (if any). Retrieves from database if not loaded yet.

param: boolean True if child should be retrieved from database.
param: Connection Connection to use if retrieving from database.
return: ".$this->getStubNodeBuilder()->getClassname()."

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

getLastChildNode(\$querydb = false, \$con = null)   X-Ref
Returns last child node (if any).

param: boolean True if child should be retrieved from database.
param: Connection Connection to use if retrieving from database.

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

getSiblingNode(\$prev = false, \$querydb = false, \$con = null)   X-Ref
Returns next (or previous) sibling node or null. Retrieves from database if
not loaded yet.

param: boolean True if previous sibling should be returned.
param: boolean True if sibling should be retrieved from database.
param: Connection Connection to use if retrieving from database.
return: ".$this->getStubNodeBuilder()->getClassname()."

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

getParentNode(\$querydb = true, \$con = null)   X-Ref
Returns parent node. Loads from database if not cached yet.

param: boolean True if parent should be retrieved from database.
param: Connection Connection to use if retrieving from database.
return: ".$this->getStubNodeBuilder()->getClassname()."

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

getAncestors(\$querydb = false, \$con = null)   X-Ref
Returns an array of all ancestor nodes, starting with the root node
first.

param: boolean True if ancestors should be retrieved from database.
param: Connection Connection to use if retrieving from database.
return: array

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

isRootNode()   X-Ref
Returns true if node is the root node of the tree.

return: boolean

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

setNew(\$b)   X-Ref
Changes the state of the object and its descendants to 'new'.
Also changes the node path to '0' to indicate that it is not a
stored node.

param: boolean
return: void

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

setDeleted(\$b)   X-Ref
Changes the state of the object and its descendants to 'deleted'.

param: boolean
return: void

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

addChildNode(\$node, \$beforeNode = null, \$con = null)   X-Ref
Adds the specified node (and its children) as a child to this node. If a
valid \$beforeNode is specified, the node will be inserted in front of
\$beforeNode. If \$beforeNode is not specified the node will be appended to
the end of the child nodes.

param: ".$this->getStubNodeBuilder()->getClassname()." Node to add.
param: ".$this->getStubNodeBuilder()->getClassname()." Node to insert before.
param: Connection Connection to use.

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

moveChildNode(\$node, \$direction, \$con = null)   X-Ref
Moves the specified child node in the specified direction.

param: ".$this->getStubNodeBuilder()->getClassname()." Node to move.
param: int Number of spaces to move among siblings (may be negative).
param: Connection Connection to use.

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

save(\$recurse = false, \$con = null)   X-Ref
Saves modified object data to the datastore.

param: boolean If true, descendants will be saved as well.
param: Connection Connection to use.

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

delete(\$con = null)   X-Ref
Removes this object and all descendants from datastore.

param: Connection Connection to use.
return: void

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

equals(\$node, \$strict = false)   X-Ref
Compares the object wrapped by this node with that of another node. Use
this instead of equality operators to prevent recursive dependency
errors.

param: $nodeClassname Node to compare.
param: boolean True if strict comparison should be used.
return: boolean

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

attachParentNode(\$node)   X-Ref
This method is used internally when constructing the tree structure
from the database. To set the parent of a node, you should call
addChildNode() on the parent.

param: $nodeClassname Parent node to attach.
return: void

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

attachChildNode(\$node)   X-Ref
This method is used internally when constructing the tree structure
from the database. To add a child to a node you should call the
addChildNode() method instead.

param: $nodeClassname Child node to attach.
return: void

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

detachParentNode(\$node)   X-Ref
This method is used internally when deleting nodes. It is used to break
the link to this node's parent.

param: $nodeClassname Parent node to detach from.
return: void

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

detachChildNode(\$node)   X-Ref
This method is used internally when deleting nodes. It is used to break
the link to this between this node and the specified child.

param: ".$this->getStubNodeBuilder()->getClassname()." Child node to detach.
return: void

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

shiftChildNodes(\$direction, \$offsetIdx, \$con)   X-Ref
Shifts child nodes in the specified direction and offset index. This
method assumes that there is already space available in the
direction/offset indicated.

param: int Direction/# spaces to shift. 1=leftshift, 1=rightshift
param: int Node index to start shift at.
param: Connection The connection to be used.
return: void

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

insertNewChildNode(\$node, \$childIdx, \$con)   X-Ref
Inserts the node and its children at the specified childIdx.

param: $nodeClassname Node to insert.
param: int One-based child index to insert at.
param: Connection Connection to use.
param: void

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

adjustStatus(\$status, \$b)   X-Ref
Adjust new/deleted status of node and all children.

param: string Status to change ('New' or 'Deleted')
param: boolean Value for status.
return: void

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

adjustNodePath(\$oldBasePath, \$newBasePath)   X-Ref
Adjust path of node and all children. This is used internally when
inserting/moving nodes.

param: string Section of old path to change.
param: string New section to replace old path with.
return: void



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