CLASS_NAME
CLASS_NAME
The (dot-path) name of this class
This class defines the structure of the 'folder_document' table.
This map class is used by Propel to do runtime db structure discovery. For example, the createSelectSql() method checks the type of a given column used in an ORDER BY clause to know whether it needs to apply SQL to make the ORDER BY case-insensitive (i.e. if it's a text column type).
getPrimaryKeyHashFromRow(array $row, int $offset, string $indexType)
Retrieves a string version of the primary key from the DB resultset row that can be used to uniquely identify a row in this table.
For tables with a single-column primary key, that simple pkey value will be returned. For tables with a multi-column primary key, a serialize()d version of the primary key will be returned.
| array | $row | resultset row. |
| int | $offset | The 0-based offset for reading from the resultset row. |
| string | $indexType | One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM |
getPrimaryKeyFromRow(array $row, int $offset, string $indexType) : mixed
Retrieves the primary key from the DB resultset row For tables with a single-column primary key, that simple pkey value will be returned. For tables with a multi-column primary key, an array of the primary key columns will be returned.
| array | $row | resultset row. |
| int | $offset | The 0-based offset for reading from the resultset row. |
| string | $indexType | One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM |
The primary key of the row
getOMClass(boolean $withPrefix) : string
The class that the tableMap will make instances of.
If $withPrefix is true, the returned path uses a dot-path notation which is translated into a path relative to a location on the PHP include_path. (e.g. path.to.MyClass -> 'path/to/MyClass.php')
| boolean | $withPrefix | Whether or not to return the path with the class name |
path.to.ClassName
populateObject(array $row, int $offset, string $indexType) : array
Populates an object of the default type or an object that inherit from the default.
| array | $row | row returned by DataFetcher->fetch(). |
| int | $offset | The 0-based offset for reading from the resultset row. |
| string | $indexType | The index type of $row. Mostly DataFetcher->getIndexType(). One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. |
Any exceptions caught during processing will be rethrown wrapped into a PropelException.
(FolderDocument object, last column rank)
populateObjects(\Thelia\Model\Map\DataFetcherInterface $dataFetcher) : array
The returned array will contain objects of the default type or objects that inherit from the default.
| \Thelia\Model\Map\DataFetcherInterface | $dataFetcher |
Any exceptions caught during processing will be rethrown wrapped into a PropelException.
addSelectColumns(\Propel\Runtime\ActiveQuery\Criteria $criteria, string $alias)
Add all the columns needed to create a new object.
Note: any columns that were marked with lazyLoad="true" in the XML schema will not be added to the select list and only loaded on demand.
| \Propel\Runtime\ActiveQuery\Criteria | $criteria | object containing the columns to add. |
| string | $alias | optional table alias |
Any exceptions caught during processing will be rethrown wrapped into a PropelException.
getTableMap() : \Propel\Runtime\Map\TableMap
Returns the TableMap related to this object.
This method is not needed for general use but a specific application could have a need.
Any exceptions caught during processing will be rethrown wrapped into a PropelException.
doDelete(mixed $values, \Propel\Runtime\Connection\ConnectionInterface $con) : int
Performs a DELETE on the database, given a FolderDocument or Criteria object OR a primary key value.
| mixed | $values | Criteria or FolderDocument object or primary key or array of primary keys which is used to create the DELETE statement |
| \Propel\Runtime\Connection\ConnectionInterface | $con | the connection to use |
Any exceptions caught during processing will be rethrown wrapped into a PropelException.
The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows if supported by native driver or if emulated using Propel.
doDeleteAll(\Propel\Runtime\Connection\ConnectionInterface $con) : int
Deletes all rows from the folder_document table.
| \Propel\Runtime\Connection\ConnectionInterface | $con | the connection to use |
The number of affected rows (if supported by underlying database driver).
doInsert(mixed $criteria, \Propel\Runtime\Connection\ConnectionInterface $con) : mixed
Performs an INSERT on the database, given a FolderDocument or Criteria object.
| mixed | $criteria | Criteria or FolderDocument object containing data that is used to create the INSERT statement. |
| \Propel\Runtime\Connection\ConnectionInterface | $con | the ConnectionInterface connection to use |
Any exceptions caught during processing will be rethrown wrapped into a PropelException.
The new primary key.