nextcloud / server

lib/public/DB/QueryBuilder/IQueryBuilder.php

Indentation +848 added lines, -848 removed lines

@@ -31,852 +31,852 @@
  */
 interface IQueryBuilder {
 
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_NULL = \PDO::PARAM_NULL;
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_BOOL = \PDO::PARAM_BOOL;
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_INT = \PDO::PARAM_INT;
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_STR = \PDO::PARAM_STR;
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_LOB = \PDO::PARAM_LOB;
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_DATE = 'datetime';
-
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_INT_ARRAY = Connection::PARAM_INT_ARRAY;
-	/**
-	 * @since 9.0.0
-	 */
-	const PARAM_STR_ARRAY = Connection::PARAM_STR_ARRAY;
-
-
-	/**
-	 * Enable/disable automatic prefixing of table names with the oc_ prefix
-	 *
-	 * @param bool $enabled If set to true table names will be prefixed with the
-	 * owncloud database prefix automatically.
-	 * @since 8.2.0
-	 */
-	public function automaticTablePrefix($enabled);
-
-	/**
-	 * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
-	 * This producer method is intended for convenient inline usage. Example:
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where($qb->expr()->eq('u.id', 1));
-	 * </code>
-	 *
-	 * For more complex expression construction, consider storing the expression
-	 * builder object in a local variable.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IExpressionBuilder
-	 * @since 8.2.0
-	 */
-	public function expr();
-
-	/**
-	 * Gets the type of the currently built query.
-	 *
-	 * @return integer
-	 * @since 8.2.0
-	 */
-	public function getType();
-
-	/**
-	 * Gets the associated DBAL Connection for this query builder.
-	 *
-	 * @return \OCP\IDBConnection
-	 * @since 8.2.0
-	 */
-	public function getConnection();
-
-	/**
-	 * Gets the state of this query builder instance.
-	 *
-	 * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
-	 * @since 8.2.0
-	 */
-	public function getState();
-
-	/**
-	 * Executes this query using the bound parameters and their types.
-	 *
-	 * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
-	 * for insert, update and delete statements.
-	 *
-	 * @return \Doctrine\DBAL\Driver\Statement|int
-	 * @since 8.2.0
-	 */
-	public function execute();
-
-	/**
-	 * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('User', 'u')
-	 *     echo $qb->getSQL(); // SELECT u FROM User u
-	 * </code>
-	 *
-	 * @return string The SQL query string.
-	 * @since 8.2.0
-	 */
-	public function getSQL();
-
-	/**
-	 * Sets a query parameter for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id')
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string|integer $key The parameter position or name.
-	 * @param mixed $value The parameter value.
-	 * @param string|null $type One of the IQueryBuilder::PARAM_* constants.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setParameter($key, $value, $type = null);
-
-	/**
-	 * Sets a collection of query parameters for the query being constructed.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = :user_id1 OR u.id = :user_id2')
-	 *         ->setParameters(array(
-	 *             ':user_id1' => 1,
-	 *             ':user_id2' => 2
-	 *         ));
-	 * </code>
-	 *
-	 * @param array $params The query parameters to set.
-	 * @param array $types The query parameters types to set.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setParameters(array $params, array $types = array());
-
-	/**
-	 * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameters indexed by parameter index or name.
-	 * @since 8.2.0
-	 */
-	public function getParameters();
-
-	/**
-	 * Gets a (previously set) query parameter of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter.
-	 *
-	 * @return mixed The value of the bound parameter.
-	 * @since 8.2.0
-	 */
-	public function getParameter($key);
-
-	/**
-	 * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
-	 *
-	 * @return array The currently defined query parameter types indexed by parameter index or name.
-	 * @since 8.2.0
-	 */
-	public function getParameterTypes();
-
-	/**
-	 * Gets a (previously set) query parameter type of the query being constructed.
-	 *
-	 * @param mixed $key The key (index or name) of the bound parameter type.
-	 *
-	 * @return mixed The value of the bound parameter type.
-	 * @since 8.2.0
-	 */
-	public function getParameterType($key);
-
-	/**
-	 * Sets the position of the first result to retrieve (the "offset").
-	 *
-	 * @param integer $firstResult The first result to return.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setFirstResult($firstResult);
-
-	/**
-	 * Gets the position of the first result the query object was set to retrieve (the "offset").
-	 * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder.
-	 *
-	 * @return integer The position of the first result.
-	 * @since 8.2.0
-	 */
-	public function getFirstResult();
-
-	/**
-	 * Sets the maximum number of results to retrieve (the "limit").
-	 *
-	 * @param integer $maxResults The maximum number of results to retrieve.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setMaxResults($maxResults);
-
-	/**
-	 * Gets the maximum number of results the query object was set to retrieve (the "limit").
-	 * Returns NULL if {@link setMaxResults} was not applied to this query builder.
-	 *
-	 * @return integer The maximum number of results.
-	 * @since 8.2.0
-	 */
-	public function getMaxResults();
-
-	/**
-	 * Specifies an item that is to be returned in the query result.
-	 * Replaces any previously specified selections, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id', 'p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function select($select = null);
-
-	/**
-	 * Specifies an item that is to be returned with a different name in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectAlias('u.id', 'user_id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 * @param string $alias The column alias used in the constructed query.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.1
-	 */
-	public function selectAlias($select, $alias);
-
-	/**
-	 * Specifies an item that is to be returned uniquely in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->selectDistinct('type')
-	 *         ->from('users');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expressions.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 9.0.0
-	 */
-	public function selectDistinct($select);
-
-	/**
-	 * Adds an item that is to be returned in the query result.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->addSelect('p.id')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
-	 * </code>
-	 *
-	 * @param mixed $select The selection expression.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function addSelect($select = null);
-
-	/**
-	 * Turns the query being built into a bulk delete query that ranges over
-	 * a certain table.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->delete('users', 'u')
-	 *         ->where('u.id = :user_id');
-	 *         ->setParameter(':user_id', 1);
-	 * </code>
-	 *
-	 * @param string $delete The table whose rows are subject to the deletion.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function delete($delete = null, $alias = null);
-
-	/**
-	 * Turns the query being built into a bulk update query that ranges over
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $update The table whose rows are subject to the update.
-	 * @param string $alias The table alias used in the constructed query.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function update($update = null, $alias = null);
-
-	/**
-	 * Turns the query being built into an insert query that inserts into
-	 * a certain table
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param string $insert The table into which the rows should be inserted.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function insert($insert = null);
-
-	/**
-	 * Creates and adds a query root corresponding to the table identified by the
-	 * given alias, forming a cartesian product with any existing query roots.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.id')
-	 *         ->from('users', 'u')
-	 * </code>
-	 *
-	 * @param string $from The table.
-	 * @param string|null $alias The alias of the table.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function from($from, $alias = null);
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function join($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function innerJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a left join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function leftJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Creates and adds a right join to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
-	 * </code>
-	 *
-	 * @param string $fromAlias The alias that points to a from clause.
-	 * @param string $join The table name to join.
-	 * @param string $alias The alias of the join table.
-	 * @param string $condition The condition for the join.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function rightJoin($fromAlias, $join, $alias, $condition = null);
-
-	/**
-	 * Sets a new value for a column in a bulk update query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where('u.id = ?');
-	 * </code>
-	 *
-	 * @param string $key The column to set.
-	 * @param string $value The value, expression, placeholder, etc.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function set($key, $value);
-
-	/**
-	 * Specifies one or more restrictions to the query result.
-	 * Replaces any previously specified restrictions, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = ?');
-	 *
-	 *     // You can optionally programatically build and/or expressions
-	 *     $qb = $conn->getQueryBuilder();
-	 *
-	 *     $or = $qb->expr()->orx();
-	 *     $or->add($qb->expr()->eq('u.id', 1));
-	 *     $or->add($qb->expr()->eq('u.id', 2));
-	 *
-	 *     $qb->update('users', 'u')
-	 *         ->set('u.password', md5('password'))
-	 *         ->where($or);
-	 * </code>
-	 *
-	 * @param mixed $predicates The restriction predicates.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function where($predicates);
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * conjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u')
-	 *         ->from('users', 'u')
-	 *         ->where('u.username LIKE ?')
-	 *         ->andWhere('u.is_active = 1');
-	 * </code>
-	 *
-	 * @param mixed $where The query restrictions.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 *
-	 * @see where()
-	 * @since 8.2.0
-	 */
-	public function andWhere($where);
-
-	/**
-	 * Adds one or more restrictions to the query results, forming a logical
-	 * disjunction with any previously specified restrictions.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->where('u.id = 1')
-	 *         ->orWhere('u.id = 2');
-	 * </code>
-	 *
-	 * @param mixed $where The WHERE statement.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 *
-	 * @see where()
-	 * @since 8.2.0
-	 */
-	public function orWhere($where);
-
-	/**
-	 * Specifies a grouping over the results of the query.
-	 * Replaces any previously specified groupings, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.id');
-	 * </code>
-	 *
-	 * @param mixed $groupBy The grouping expression.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function groupBy($groupBy);
-
-	/**
-	 * Adds a grouping expression to the query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->select('u.name')
-	 *         ->from('users', 'u')
-	 *         ->groupBy('u.lastLogin');
-	 *         ->addGroupBy('u.createdAt')
-	 * </code>
-	 *
-	 * @param mixed $groupBy The grouping expression.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function addGroupBy($groupBy);
-
-	/**
-	 * Sets a value for a column in an insert query.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?'
-	 *             )
-	 *         )
-	 *         ->setValue('password', '?');
-	 * </code>
-	 *
-	 * @param string $column The column into which the value should be inserted.
-	 * @param string $value The value that should be inserted into the column.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function setValue($column, $value);
-
-	/**
-	 * Specifies values for an insert query indexed by column names.
-	 * Replaces any previous values, if any.
-	 *
-	 * <code>
-	 *     $qb = $conn->getQueryBuilder()
-	 *         ->insert('users')
-	 *         ->values(
-	 *             array(
-	 *                 'name' => '?',
-	 *                 'password' => '?'
-	 *             )
-	 *         );
-	 * </code>
-	 *
-	 * @param array $values The values to specify for the insert query indexed by column names.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function values(array $values);
-
-	/**
-	 * Specifies a restriction over the groups of the query.
-	 * Replaces any previous having restrictions, if any.
-	 *
-	 * @param mixed $having The restriction over the groups.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function having($having);
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * conjunction with any existing having restrictions.
-	 *
-	 * @param mixed $having The restriction to append.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function andHaving($having);
-
-	/**
-	 * Adds a restriction over the groups of the query, forming a logical
-	 * disjunction with any existing having restrictions.
-	 *
-	 * @param mixed $having The restriction to add.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function orHaving($having);
-
-	/**
-	 * Specifies an ordering for the query results.
-	 * Replaces any previously specified orderings, if any.
-	 *
-	 * @param string $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function orderBy($sort, $order = null);
-
-	/**
-	 * Adds an ordering to the query results.
-	 *
-	 * @param string $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function addOrderBy($sort, $order = null);
-
-	/**
-	 * Gets a query part by its name.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return mixed
-	 * @since 8.2.0
-	 */
-	public function getQueryPart($queryPartName);
-
-	/**
-	 * Gets all query parts.
-	 *
-	 * @return array
-	 * @since 8.2.0
-	 */
-	public function getQueryParts();
-
-	/**
-	 * Resets SQL parts.
-	 *
-	 * @param array|null $queryPartNames
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function resetQueryParts($queryPartNames = null);
-
-	/**
-	 * Resets a single SQL part.
-	 *
-	 * @param string $queryPartName
-	 *
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
-	 * @since 8.2.0
-	 */
-	public function resetQueryPart($queryPartName);
-
-	/**
-	 * Creates a new named parameter and bind the value $value to it.
-	 *
-	 * This method provides a shortcut for PDOStatement::bindValue
-	 * when using prepared statements.
-	 *
-	 * The parameter $value specifies the value that you want to bind. If
-	 * $placeholder is not provided bindValue() will automatically create a
-	 * placeholder for you. An automatic placeholder will be of the name
-	 * ':dcValue1', ':dcValue2' etc.
-	 *
-	 * For more information see {@link http://php.net/pdostatement-bindparam}
-	 *
-	 * Example:
-	 * <code>
-	 * $value = 2;
-	 * $q->eq( 'id', $q->bindValue( $value ) );
-	 * $stmt = $q->executeQuery(); // executed with 'id = 2'
-	 * </code>
-	 *
-	 * @license New BSD License
-	 * @link http://www.zetacomponents.org
-	 *
-	 * @param mixed $value
-	 * @param mixed $type
-	 * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 */
-	public function createNamedParameter($value, $type = self::PARAM_STR, $placeHolder = null);
-
-	/**
-	 * Creates a new positional parameter and bind the given value to it.
-	 *
-	 * Attention: If you are using positional parameters with the query builder you have
-	 * to be very careful to bind all parameters in the order they appear in the SQL
-	 * statement , otherwise they get bound in the wrong order which can lead to serious
-	 * bugs in your code.
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
-	 *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param mixed $value
-	 * @param integer $type
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 */
-	public function createPositionalParameter($value, $type = self::PARAM_STR);
-
-	/**
-	 * Creates a new parameter
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select('u.*')
-	 *     ->from('users', 'u')
-	 *     ->where('u.username = ' . $qb->createParameter('name'))
-	 *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
-	 * </code>
-	 *
-	 * @param string $name
-	 *
-	 * @return IParameter
-	 * @since 8.2.0
-	 */
-	public function createParameter($name);
-
-	/**
-	 * Creates a new function
-	 *
-	 * Attention: Column names inside the call have to be quoted before hand
-	 *
-	 * Example:
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(*)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
-	 * </code>
-	 * <code>
-	 *  $qb = $conn->getQueryBuilder();
-	 *  $qb->select($qb->createFunction('COUNT(`column`)'))
-	 *     ->from('users', 'u')
-	 *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
-	 * </code>
-	 *
-	 * @param string $call
-	 *
-	 * @return IQueryFunction
-	 * @since 8.2.0
-	 */
-	public function createFunction($call);
-
-	/**
-	 * Used to get the id of the last inserted element
-	 * @return int
-	 * @throws \BadMethodCallException When being called before an insert query has been run.
-	 * @since 9.0.0
-	 */
-	public function getLastInsertId();
-
-	/**
-	 * Returns the table name quoted and with database prefix as needed by the implementation
-	 *
-	 * @param string $table
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTableName($table);
-
-	/**
-	 * Returns the column name quoted and with table alias prefix as needed by the implementation
-	 *
-	 * @param string $column
-	 * @param string $tableAlias
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getColumnName($column, $tableAlias = '');
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_NULL = \PDO::PARAM_NULL;
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_BOOL = \PDO::PARAM_BOOL;
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_INT = \PDO::PARAM_INT;
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_STR = \PDO::PARAM_STR;
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_LOB = \PDO::PARAM_LOB;
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_DATE = 'datetime';
+
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_INT_ARRAY = Connection::PARAM_INT_ARRAY;
+    /**
+     * @since 9.0.0
+     */
+    const PARAM_STR_ARRAY = Connection::PARAM_STR_ARRAY;
+
+
+    /**
+     * Enable/disable automatic prefixing of table names with the oc_ prefix
+     *
+     * @param bool $enabled If set to true table names will be prefixed with the
+     * owncloud database prefix automatically.
+     * @since 8.2.0
+     */
+    public function automaticTablePrefix($enabled);
+
+    /**
+     * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
+     * This producer method is intended for convenient inline usage. Example:
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where($qb->expr()->eq('u.id', 1));
+     * </code>
+     *
+     * For more complex expression construction, consider storing the expression
+     * builder object in a local variable.
+     *
+     * @return \OCP\DB\QueryBuilder\IExpressionBuilder
+     * @since 8.2.0
+     */
+    public function expr();
+
+    /**
+     * Gets the type of the currently built query.
+     *
+     * @return integer
+     * @since 8.2.0
+     */
+    public function getType();
+
+    /**
+     * Gets the associated DBAL Connection for this query builder.
+     *
+     * @return \OCP\IDBConnection
+     * @since 8.2.0
+     */
+    public function getConnection();
+
+    /**
+     * Gets the state of this query builder instance.
+     *
+     * @return integer Either QueryBuilder::STATE_DIRTY or QueryBuilder::STATE_CLEAN.
+     * @since 8.2.0
+     */
+    public function getState();
+
+    /**
+     * Executes this query using the bound parameters and their types.
+     *
+     * Uses {@see Connection::executeQuery} for select statements and {@see Connection::executeUpdate}
+     * for insert, update and delete statements.
+     *
+     * @return \Doctrine\DBAL\Driver\Statement|int
+     * @since 8.2.0
+     */
+    public function execute();
+
+    /**
+     * Gets the complete SQL string formed by the current specifications of this QueryBuilder.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('User', 'u')
+     *     echo $qb->getSQL(); // SELECT u FROM User u
+     * </code>
+     *
+     * @return string The SQL query string.
+     * @since 8.2.0
+     */
+    public function getSQL();
+
+    /**
+     * Sets a query parameter for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id')
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string|integer $key The parameter position or name.
+     * @param mixed $value The parameter value.
+     * @param string|null $type One of the IQueryBuilder::PARAM_* constants.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setParameter($key, $value, $type = null);
+
+    /**
+     * Sets a collection of query parameters for the query being constructed.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.id = :user_id1 OR u.id = :user_id2')
+     *         ->setParameters(array(
+     *             ':user_id1' => 1,
+     *             ':user_id2' => 2
+     *         ));
+     * </code>
+     *
+     * @param array $params The query parameters to set.
+     * @param array $types The query parameters types to set.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setParameters(array $params, array $types = array());
+
+    /**
+     * Gets all defined query parameters for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameters indexed by parameter index or name.
+     * @since 8.2.0
+     */
+    public function getParameters();
+
+    /**
+     * Gets a (previously set) query parameter of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter.
+     *
+     * @return mixed The value of the bound parameter.
+     * @since 8.2.0
+     */
+    public function getParameter($key);
+
+    /**
+     * Gets all defined query parameter types for the query being constructed indexed by parameter index or name.
+     *
+     * @return array The currently defined query parameter types indexed by parameter index or name.
+     * @since 8.2.0
+     */
+    public function getParameterTypes();
+
+    /**
+     * Gets a (previously set) query parameter type of the query being constructed.
+     *
+     * @param mixed $key The key (index or name) of the bound parameter type.
+     *
+     * @return mixed The value of the bound parameter type.
+     * @since 8.2.0
+     */
+    public function getParameterType($key);
+
+    /**
+     * Sets the position of the first result to retrieve (the "offset").
+     *
+     * @param integer $firstResult The first result to return.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setFirstResult($firstResult);
+
+    /**
+     * Gets the position of the first result the query object was set to retrieve (the "offset").
+     * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder.
+     *
+     * @return integer The position of the first result.
+     * @since 8.2.0
+     */
+    public function getFirstResult();
+
+    /**
+     * Sets the maximum number of results to retrieve (the "limit").
+     *
+     * @param integer $maxResults The maximum number of results to retrieve.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setMaxResults($maxResults);
+
+    /**
+     * Gets the maximum number of results the query object was set to retrieve (the "limit").
+     * Returns NULL if {@link setMaxResults} was not applied to this query builder.
+     *
+     * @return integer The maximum number of results.
+     * @since 8.2.0
+     */
+    public function getMaxResults();
+
+    /**
+     * Specifies an item that is to be returned in the query result.
+     * Replaces any previously specified selections, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id', 'p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function select($select = null);
+
+    /**
+     * Specifies an item that is to be returned with a different name in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectAlias('u.id', 'user_id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     * @param string $alias The column alias used in the constructed query.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.1
+     */
+    public function selectAlias($select, $alias);
+
+    /**
+     * Specifies an item that is to be returned uniquely in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->selectDistinct('type')
+     *         ->from('users');
+     * </code>
+     *
+     * @param mixed $select The selection expressions.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 9.0.0
+     */
+    public function selectDistinct($select);
+
+    /**
+     * Adds an item that is to be returned in the query result.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->addSelect('p.id')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'u.id = p.user_id');
+     * </code>
+     *
+     * @param mixed $select The selection expression.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function addSelect($select = null);
+
+    /**
+     * Turns the query being built into a bulk delete query that ranges over
+     * a certain table.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->delete('users', 'u')
+     *         ->where('u.id = :user_id');
+     *         ->setParameter(':user_id', 1);
+     * </code>
+     *
+     * @param string $delete The table whose rows are subject to the deletion.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function delete($delete = null, $alias = null);
+
+    /**
+     * Turns the query being built into a bulk update query that ranges over
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $update The table whose rows are subject to the update.
+     * @param string $alias The table alias used in the constructed query.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function update($update = null, $alias = null);
+
+    /**
+     * Turns the query being built into an insert query that inserts into
+     * a certain table
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param string $insert The table into which the rows should be inserted.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function insert($insert = null);
+
+    /**
+     * Creates and adds a query root corresponding to the table identified by the
+     * given alias, forming a cartesian product with any existing query roots.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.id')
+     *         ->from('users', 'u')
+     * </code>
+     *
+     * @param string $from The table.
+     * @param string|null $alias The alias of the table.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function from($from, $alias = null);
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function join($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function innerJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a left join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function leftJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Creates and adds a right join to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
+     * </code>
+     *
+     * @param string $fromAlias The alias that points to a from clause.
+     * @param string $join The table name to join.
+     * @param string $alias The alias of the join table.
+     * @param string $condition The condition for the join.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function rightJoin($fromAlias, $join, $alias, $condition = null);
+
+    /**
+     * Sets a new value for a column in a bulk update query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where('u.id = ?');
+     * </code>
+     *
+     * @param string $key The column to set.
+     * @param string $value The value, expression, placeholder, etc.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function set($key, $value);
+
+    /**
+     * Specifies one or more restrictions to the query result.
+     * Replaces any previously specified restrictions, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = ?');
+     *
+     *     // You can optionally programatically build and/or expressions
+     *     $qb = $conn->getQueryBuilder();
+     *
+     *     $or = $qb->expr()->orx();
+     *     $or->add($qb->expr()->eq('u.id', 1));
+     *     $or->add($qb->expr()->eq('u.id', 2));
+     *
+     *     $qb->update('users', 'u')
+     *         ->set('u.password', md5('password'))
+     *         ->where($or);
+     * </code>
+     *
+     * @param mixed $predicates The restriction predicates.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function where($predicates);
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * conjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u')
+     *         ->from('users', 'u')
+     *         ->where('u.username LIKE ?')
+     *         ->andWhere('u.is_active = 1');
+     * </code>
+     *
+     * @param mixed $where The query restrictions.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     *
+     * @see where()
+     * @since 8.2.0
+     */
+    public function andWhere($where);
+
+    /**
+     * Adds one or more restrictions to the query results, forming a logical
+     * disjunction with any previously specified restrictions.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->where('u.id = 1')
+     *         ->orWhere('u.id = 2');
+     * </code>
+     *
+     * @param mixed $where The WHERE statement.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     *
+     * @see where()
+     * @since 8.2.0
+     */
+    public function orWhere($where);
+
+    /**
+     * Specifies a grouping over the results of the query.
+     * Replaces any previously specified groupings, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.id');
+     * </code>
+     *
+     * @param mixed $groupBy The grouping expression.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function groupBy($groupBy);
+
+    /**
+     * Adds a grouping expression to the query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->select('u.name')
+     *         ->from('users', 'u')
+     *         ->groupBy('u.lastLogin');
+     *         ->addGroupBy('u.createdAt')
+     * </code>
+     *
+     * @param mixed $groupBy The grouping expression.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function addGroupBy($groupBy);
+
+    /**
+     * Sets a value for a column in an insert query.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?'
+     *             )
+     *         )
+     *         ->setValue('password', '?');
+     * </code>
+     *
+     * @param string $column The column into which the value should be inserted.
+     * @param string $value The value that should be inserted into the column.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function setValue($column, $value);
+
+    /**
+     * Specifies values for an insert query indexed by column names.
+     * Replaces any previous values, if any.
+     *
+     * <code>
+     *     $qb = $conn->getQueryBuilder()
+     *         ->insert('users')
+     *         ->values(
+     *             array(
+     *                 'name' => '?',
+     *                 'password' => '?'
+     *             )
+     *         );
+     * </code>
+     *
+     * @param array $values The values to specify for the insert query indexed by column names.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function values(array $values);
+
+    /**
+     * Specifies a restriction over the groups of the query.
+     * Replaces any previous having restrictions, if any.
+     *
+     * @param mixed $having The restriction over the groups.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function having($having);
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * conjunction with any existing having restrictions.
+     *
+     * @param mixed $having The restriction to append.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function andHaving($having);
+
+    /**
+     * Adds a restriction over the groups of the query, forming a logical
+     * disjunction with any existing having restrictions.
+     *
+     * @param mixed $having The restriction to add.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function orHaving($having);
+
+    /**
+     * Specifies an ordering for the query results.
+     * Replaces any previously specified orderings, if any.
+     *
+     * @param string $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function orderBy($sort, $order = null);
+
+    /**
+     * Adds an ordering to the query results.
+     *
+     * @param string $sort The ordering expression.
+     * @param string $order The ordering direction.
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function addOrderBy($sort, $order = null);
+
+    /**
+     * Gets a query part by its name.
+     *
+     * @param string $queryPartName
+     *
+     * @return mixed
+     * @since 8.2.0
+     */
+    public function getQueryPart($queryPartName);
+
+    /**
+     * Gets all query parts.
+     *
+     * @return array
+     * @since 8.2.0
+     */
+    public function getQueryParts();
+
+    /**
+     * Resets SQL parts.
+     *
+     * @param array|null $queryPartNames
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function resetQueryParts($queryPartNames = null);
+
+    /**
+     * Resets a single SQL part.
+     *
+     * @param string $queryPartName
+     *
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder This QueryBuilder instance.
+     * @since 8.2.0
+     */
+    public function resetQueryPart($queryPartName);
+
+    /**
+     * Creates a new named parameter and bind the value $value to it.
+     *
+     * This method provides a shortcut for PDOStatement::bindValue
+     * when using prepared statements.
+     *
+     * The parameter $value specifies the value that you want to bind. If
+     * $placeholder is not provided bindValue() will automatically create a
+     * placeholder for you. An automatic placeholder will be of the name
+     * ':dcValue1', ':dcValue2' etc.
+     *
+     * For more information see {@link http://php.net/pdostatement-bindparam}
+     *
+     * Example:
+     * <code>
+     * $value = 2;
+     * $q->eq( 'id', $q->bindValue( $value ) );
+     * $stmt = $q->executeQuery(); // executed with 'id = 2'
+     * </code>
+     *
+     * @license New BSD License
+     * @link http://www.zetacomponents.org
+     *
+     * @param mixed $value
+     * @param mixed $type
+     * @param string $placeHolder The name to bind with. The string must start with a colon ':'.
+     *
+     * @return IParameter
+     * @since 8.2.0
+     */
+    public function createNamedParameter($value, $type = self::PARAM_STR, $placeHolder = null);
+
+    /**
+     * Creates a new positional parameter and bind the given value to it.
+     *
+     * Attention: If you are using positional parameters with the query builder you have
+     * to be very careful to bind all parameters in the order they appear in the SQL
+     * statement , otherwise they get bound in the wrong order which can lead to serious
+     * bugs in your code.
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createPositionalParameter('Foo', IQueryBuilder::PARAM_STR))
+     *     ->orWhere('u.username = ' . $qb->createPositionalParameter('Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param mixed $value
+     * @param integer $type
+     *
+     * @return IParameter
+     * @since 8.2.0
+     */
+    public function createPositionalParameter($value, $type = self::PARAM_STR);
+
+    /**
+     * Creates a new parameter
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select('u.*')
+     *     ->from('users', 'u')
+     *     ->where('u.username = ' . $qb->createParameter('name'))
+     *     ->setParameter('name', 'Bar', IQueryBuilder::PARAM_STR))
+     * </code>
+     *
+     * @param string $name
+     *
+     * @return IParameter
+     * @since 8.2.0
+     */
+    public function createParameter($name);
+
+    /**
+     * Creates a new function
+     *
+     * Attention: Column names inside the call have to be quoted before hand
+     *
+     * Example:
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(*)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(*) FROM `users` u
+     * </code>
+     * <code>
+     *  $qb = $conn->getQueryBuilder();
+     *  $qb->select($qb->createFunction('COUNT(`column`)'))
+     *     ->from('users', 'u')
+     *  echo $qb->getSQL(); // SELECT COUNT(`column`) FROM `users` u
+     * </code>
+     *
+     * @param string $call
+     *
+     * @return IQueryFunction
+     * @since 8.2.0
+     */
+    public function createFunction($call);
+
+    /**
+     * Used to get the id of the last inserted element
+     * @return int
+     * @throws \BadMethodCallException When being called before an insert query has been run.
+     * @since 9.0.0
+     */
+    public function getLastInsertId();
+
+    /**
+     * Returns the table name quoted and with database prefix as needed by the implementation
+     *
+     * @param string $table
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTableName($table);
+
+    /**
+     * Returns the column name quoted and with table alias prefix as needed by the implementation
+     *
+     * @param string $column
+     * @param string $tableAlias
+     * @return string
+     * @since 9.0.0
+     */
+    public function getColumnName($column, $tableAlias = '');
 }

lib/public/DB/QueryBuilder/ICompositeExpression.php

Indentation +32 added lines, -32 removed lines

@@ -28,39 +28,39 @@
  * @since 8.2.0
  */
 interface ICompositeExpression {
-	/**
-	 * Adds multiple parts to composite expression.
-	 *
-	 * @param array $parts
-	 *
-	 * @return ICompositeExpression
-	 * @since 8.2.0
-	 */
-	public function addMultiple(array $parts = array());
+    /**
+     * Adds multiple parts to composite expression.
+     *
+     * @param array $parts
+     *
+     * @return ICompositeExpression
+     * @since 8.2.0
+     */
+    public function addMultiple(array $parts = array());
 
-	/**
-	 * Adds an expression to composite expression.
-	 *
-	 * @param mixed $part
-	 *
-	 * @return ICompositeExpression
-	 * @since 8.2.0
-	 */
-	public function add($part);
+    /**
+     * Adds an expression to composite expression.
+     *
+     * @param mixed $part
+     *
+     * @return ICompositeExpression
+     * @since 8.2.0
+     */
+    public function add($part);
 
-	/**
-	 * Retrieves the amount of expressions on composite expression.
-	 *
-	 * @return integer
-	 * @since 8.2.0
-	 */
-	public function count();
+    /**
+     * Retrieves the amount of expressions on composite expression.
+     *
+     * @return integer
+     * @since 8.2.0
+     */
+    public function count();
 
-	/**
-	 * Returns the type of this composite expression (AND/OR).
-	 *
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function getType();
+    /**
+     * Returns the type of this composite expression (AND/OR).
+     *
+     * @return string
+     * @since 8.2.0
+     */
+    public function getType();
 }

lib/public/DB/QueryBuilder/IParameter.php

Indentation +5 added lines, -5 removed lines

@@ -26,9 +26,9 @@
  * @since 8.2.0
  */
 interface IParameter {
-	/**
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function __toString();
+    /**
+     * @return string
+     * @since 8.2.0
+     */
+    public function __toString();
 }

lib/public/DB/QueryBuilder/IExpressionBuilder.php

Spacing +3 added lines, -3 removed lines

@@ -35,7 +35,7 @@ 
 	/**
 	 * @since 9.0.0
 	 */
-	const EQ  = ExpressionBuilder::EQ;
+	const EQ = ExpressionBuilder::EQ;
 	/**
 	 * @since 9.0.0
 	 */
@@ -43,7 +43,7 @@ 
 	/**
 	 * @since 9.0.0
 	 */
-	const LT  = ExpressionBuilder::LT;
+	const LT = ExpressionBuilder::LT;
 	/**
 	 * @since 9.0.0
 	 */
@@ -51,7 +51,7 @@ 
 	/**
 	 * @since 9.0.0
 	 */
-	const GT  = ExpressionBuilder::GT;
+	const GT = ExpressionBuilder::GT;
 	/**
 	 * @since 9.0.0
 	 */

Indentation +275 added lines, -275 removed lines

@@ -32,297 +32,297 @@
  * @since 8.2.0
  */
 interface IExpressionBuilder {
-	/**
-	 * @since 9.0.0
-	 */
-	const EQ  = ExpressionBuilder::EQ;
-	/**
-	 * @since 9.0.0
-	 */
-	const NEQ = ExpressionBuilder::NEQ;
-	/**
-	 * @since 9.0.0
-	 */
-	const LT  = ExpressionBuilder::LT;
-	/**
-	 * @since 9.0.0
-	 */
-	const LTE = ExpressionBuilder::LTE;
-	/**
-	 * @since 9.0.0
-	 */
-	const GT  = ExpressionBuilder::GT;
-	/**
-	 * @since 9.0.0
-	 */
-	const GTE = ExpressionBuilder::GTE;
+    /**
+     * @since 9.0.0
+     */
+    const EQ  = ExpressionBuilder::EQ;
+    /**
+     * @since 9.0.0
+     */
+    const NEQ = ExpressionBuilder::NEQ;
+    /**
+     * @since 9.0.0
+     */
+    const LT  = ExpressionBuilder::LT;
+    /**
+     * @since 9.0.0
+     */
+    const LTE = ExpressionBuilder::LTE;
+    /**
+     * @since 9.0.0
+     */
+    const GT  = ExpressionBuilder::GT;
+    /**
+     * @since 9.0.0
+     */
+    const GTE = ExpressionBuilder::GTE;
 
-	/**
-	 * Creates a conjunction of the given boolean expressions.
-	 *
-	 * Example:
-	 *
-	 *     [php]
-	 *     // (u.type = ?) AND (u.role = ?)
-	 *     $expr->andX('u.type = ?', 'u.role = ?'));
-	 *
-	 * @param mixed $x Optional clause. Defaults = null, but requires
-	 *                 at least one defined when converting to string.
-	 *
-	 * @return \OCP\DB\QueryBuilder\ICompositeExpression
-	 * @since 8.2.0
-	 */
-	public function andX($x = null);
+    /**
+     * Creates a conjunction of the given boolean expressions.
+     *
+     * Example:
+     *
+     *     [php]
+     *     // (u.type = ?) AND (u.role = ?)
+     *     $expr->andX('u.type = ?', 'u.role = ?'));
+     *
+     * @param mixed $x Optional clause. Defaults = null, but requires
+     *                 at least one defined when converting to string.
+     *
+     * @return \OCP\DB\QueryBuilder\ICompositeExpression
+     * @since 8.2.0
+     */
+    public function andX($x = null);
 
-	/**
-	 * Creates a disjunction of the given boolean expressions.
-	 *
-	 * Example:
-	 *
-	 *     [php]
-	 *     // (u.type = ?) OR (u.role = ?)
-	 *     $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?'));
-	 *
-	 * @param mixed $x Optional clause. Defaults = null, but requires
-	 *                 at least one defined when converting to string.
-	 *
-	 * @return \OCP\DB\QueryBuilder\ICompositeExpression
-	 * @since 8.2.0
-	 */
-	public function orX($x = null);
+    /**
+     * Creates a disjunction of the given boolean expressions.
+     *
+     * Example:
+     *
+     *     [php]
+     *     // (u.type = ?) OR (u.role = ?)
+     *     $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?'));
+     *
+     * @param mixed $x Optional clause. Defaults = null, but requires
+     *                 at least one defined when converting to string.
+     *
+     * @return \OCP\DB\QueryBuilder\ICompositeExpression
+     * @since 8.2.0
+     */
+    public function orX($x = null);
 
-	/**
-	 * Creates a comparison expression.
-	 *
-	 * @param mixed $x The left expression.
-	 * @param string $operator One of the IExpressionBuilder::* constants.
-	 * @param mixed $y The right expression.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function comparison($x, $operator, $y, $type = null);
+    /**
+     * Creates a comparison expression.
+     *
+     * @param mixed $x The left expression.
+     * @param string $operator One of the IExpressionBuilder::* constants.
+     * @param mixed $y The right expression.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function comparison($x, $operator, $y, $type = null);
 
-	/**
-	 * Creates an equality comparison expression with the given arguments.
-	 *
-	 * First argument is considered the left expression and the second is the right expression.
-	 * When converted to string, it will generated a <left expr> = <right expr>. Example:
-	 *
-	 *     [php]
-	 *     // u.id = ?
-	 *     $expr->eq('u.id', '?');
-	 *
-	 * @param mixed $x The left expression.
-	 * @param mixed $y The right expression.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function eq($x, $y, $type = null);
+    /**
+     * Creates an equality comparison expression with the given arguments.
+     *
+     * First argument is considered the left expression and the second is the right expression.
+     * When converted to string, it will generated a <left expr> = <right expr>. Example:
+     *
+     *     [php]
+     *     // u.id = ?
+     *     $expr->eq('u.id', '?');
+     *
+     * @param mixed $x The left expression.
+     * @param mixed $y The right expression.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function eq($x, $y, $type = null);
 
-	/**
-	 * Creates a non equality comparison expression with the given arguments.
-	 * First argument is considered the left expression and the second is the right expression.
-	 * When converted to string, it will generated a <left expr> <> <right expr>. Example:
-	 *
-	 *     [php]
-	 *     // u.id <> 1
-	 *     $q->where($q->expr()->neq('u.id', '1'));
-	 *
-	 * @param mixed $x The left expression.
-	 * @param mixed $y The right expression.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function neq($x, $y, $type = null);
+    /**
+     * Creates a non equality comparison expression with the given arguments.
+     * First argument is considered the left expression and the second is the right expression.
+     * When converted to string, it will generated a <left expr> <> <right expr>. Example:
+     *
+     *     [php]
+     *     // u.id <> 1
+     *     $q->where($q->expr()->neq('u.id', '1'));
+     *
+     * @param mixed $x The left expression.
+     * @param mixed $y The right expression.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function neq($x, $y, $type = null);
 
-	/**
-	 * Creates a lower-than comparison expression with the given arguments.
-	 * First argument is considered the left expression and the second is the right expression.
-	 * When converted to string, it will generated a <left expr> < <right expr>. Example:
-	 *
-	 *     [php]
-	 *     // u.id < ?
-	 *     $q->where($q->expr()->lt('u.id', '?'));
-	 *
-	 * @param mixed $x The left expression.
-	 * @param mixed $y The right expression.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function lt($x, $y, $type = null);
+    /**
+     * Creates a lower-than comparison expression with the given arguments.
+     * First argument is considered the left expression and the second is the right expression.
+     * When converted to string, it will generated a <left expr> < <right expr>. Example:
+     *
+     *     [php]
+     *     // u.id < ?
+     *     $q->where($q->expr()->lt('u.id', '?'));
+     *
+     * @param mixed $x The left expression.
+     * @param mixed $y The right expression.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function lt($x, $y, $type = null);
 
-	/**
-	 * Creates a lower-than-equal comparison expression with the given arguments.
-	 * First argument is considered the left expression and the second is the right expression.
-	 * When converted to string, it will generated a <left expr> <= <right expr>. Example:
-	 *
-	 *     [php]
-	 *     // u.id <= ?
-	 *     $q->where($q->expr()->lte('u.id', '?'));
-	 *
-	 * @param mixed $x The left expression.
-	 * @param mixed $y The right expression.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function lte($x, $y, $type = null);
+    /**
+     * Creates a lower-than-equal comparison expression with the given arguments.
+     * First argument is considered the left expression and the second is the right expression.
+     * When converted to string, it will generated a <left expr> <= <right expr>. Example:
+     *
+     *     [php]
+     *     // u.id <= ?
+     *     $q->where($q->expr()->lte('u.id', '?'));
+     *
+     * @param mixed $x The left expression.
+     * @param mixed $y The right expression.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function lte($x, $y, $type = null);
 
-	/**
-	 * Creates a greater-than comparison expression with the given arguments.
-	 * First argument is considered the left expression and the second is the right expression.
-	 * When converted to string, it will generated a <left expr> > <right expr>. Example:
-	 *
-	 *     [php]
-	 *     // u.id > ?
-	 *     $q->where($q->expr()->gt('u.id', '?'));
-	 *
-	 * @param mixed $x The left expression.
-	 * @param mixed $y The right expression.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function gt($x, $y, $type = null);
+    /**
+     * Creates a greater-than comparison expression with the given arguments.
+     * First argument is considered the left expression and the second is the right expression.
+     * When converted to string, it will generated a <left expr> > <right expr>. Example:
+     *
+     *     [php]
+     *     // u.id > ?
+     *     $q->where($q->expr()->gt('u.id', '?'));
+     *
+     * @param mixed $x The left expression.
+     * @param mixed $y The right expression.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function gt($x, $y, $type = null);
 
-	/**
-	 * Creates a greater-than-equal comparison expression with the given arguments.
-	 * First argument is considered the left expression and the second is the right expression.
-	 * When converted to string, it will generated a <left expr> >= <right expr>. Example:
-	 *
-	 *     [php]
-	 *     // u.id >= ?
-	 *     $q->where($q->expr()->gte('u.id', '?'));
-	 *
-	 * @param mixed $x The left expression.
-	 * @param mixed $y The right expression.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function gte($x, $y, $type = null);
+    /**
+     * Creates a greater-than-equal comparison expression with the given arguments.
+     * First argument is considered the left expression and the second is the right expression.
+     * When converted to string, it will generated a <left expr> >= <right expr>. Example:
+     *
+     *     [php]
+     *     // u.id >= ?
+     *     $q->where($q->expr()->gte('u.id', '?'));
+     *
+     * @param mixed $x The left expression.
+     * @param mixed $y The right expression.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function gte($x, $y, $type = null);
 
-	/**
-	 * Creates an IS NULL expression with the given arguments.
-	 *
-	 * @param string $x The field in string format to be restricted by IS NULL.
-	 *
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function isNull($x);
+    /**
+     * Creates an IS NULL expression with the given arguments.
+     *
+     * @param string $x The field in string format to be restricted by IS NULL.
+     *
+     * @return string
+     * @since 8.2.0
+     */
+    public function isNull($x);
 
-	/**
-	 * Creates an IS NOT NULL expression with the given arguments.
-	 *
-	 * @param string $x The field in string format to be restricted by IS NOT NULL.
-	 *
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function isNotNull($x);
+    /**
+     * Creates an IS NOT NULL expression with the given arguments.
+     *
+     * @param string $x The field in string format to be restricted by IS NOT NULL.
+     *
+     * @return string
+     * @since 8.2.0
+     */
+    public function isNotNull($x);
 
-	/**
-	 * Creates a LIKE() comparison expression with the given arguments.
-	 *
-	 * @param string $x Field in string format to be inspected by LIKE() comparison.
-	 * @param mixed $y Argument to be used in LIKE() comparison.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function like($x, $y, $type = null);
+    /**
+     * Creates a LIKE() comparison expression with the given arguments.
+     *
+     * @param string $x Field in string format to be inspected by LIKE() comparison.
+     * @param mixed $y Argument to be used in LIKE() comparison.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function like($x, $y, $type = null);
 
-	/**
-	 * Creates a NOT LIKE() comparison expression with the given arguments.
-	 *
-	 * @param string $x Field in string format to be inspected by NOT LIKE() comparison.
-	 * @param mixed $y Argument to be used in NOT LIKE() comparison.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function notLike($x, $y, $type = null);
+    /**
+     * Creates a NOT LIKE() comparison expression with the given arguments.
+     *
+     * @param string $x Field in string format to be inspected by NOT LIKE() comparison.
+     * @param mixed $y Argument to be used in NOT LIKE() comparison.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function notLike($x, $y, $type = null);
 
-	/**
-	 * Creates a ILIKE() comparison expression with the given arguments.
-	 *
-	 * @param string $x Field in string format to be inspected by ILIKE() comparison.
-	 * @param mixed $y Argument to be used in ILIKE() comparison.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function iLike($x, $y, $type = null);
+    /**
+     * Creates a ILIKE() comparison expression with the given arguments.
+     *
+     * @param string $x Field in string format to be inspected by ILIKE() comparison.
+     * @param mixed $y Argument to be used in ILIKE() comparison.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function iLike($x, $y, $type = null);
 
-	/**
-	 * Creates a IN () comparison expression with the given arguments.
-	 *
-	 * @param string $x The field in string format to be inspected by IN() comparison.
-	 * @param string|array $y The placeholder or the array of values to be used by IN() comparison.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function in($x, $y, $type = null);
+    /**
+     * Creates a IN () comparison expression with the given arguments.
+     *
+     * @param string $x The field in string format to be inspected by IN() comparison.
+     * @param string|array $y The placeholder or the array of values to be used by IN() comparison.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function in($x, $y, $type = null);
 
-	/**
-	 * Creates a NOT IN () comparison expression with the given arguments.
-	 *
-	 * @param string $x The field in string format to be inspected by NOT IN() comparison.
-	 * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison.
-	 * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
-	 *                  required when comparing text fields for oci compatibility
-	 *
-	 * @return string
-	 * @since 8.2.0 - Parameter $type was added in 9.0.0
-	 */
-	public function notIn($x, $y, $type = null);
+    /**
+     * Creates a NOT IN () comparison expression with the given arguments.
+     *
+     * @param string $x The field in string format to be inspected by NOT IN() comparison.
+     * @param string|array $y The placeholder or the array of values to be used by NOT IN() comparison.
+     * @param mixed|null $type one of the IQueryBuilder::PARAM_* constants
+     *                  required when comparing text fields for oci compatibility
+     *
+     * @return string
+     * @since 8.2.0 - Parameter $type was added in 9.0.0
+     */
+    public function notIn($x, $y, $type = null);
 
-	/**
-	 * Quotes a given input parameter.
-	 *
-	 * @param mixed $input The parameter to be quoted.
-	 * @param mixed|null $type One of the IQueryBuilder::PARAM_* constants
-	 *
-	 * @return string
-	 * @since 8.2.0
-	 */
-	public function literal($input, $type = null);
+    /**
+     * Quotes a given input parameter.
+     *
+     * @param mixed $input The parameter to be quoted.
+     * @param mixed|null $type One of the IQueryBuilder::PARAM_* constants
+     *
+     * @return string
+     * @since 8.2.0
+     */
+    public function literal($input, $type = null);
 
-	/**
-	 * Returns a IQueryFunction that casts the column to the given type
-	 *
-	 * @param string $column
-	 * @param mixed $type One of IQueryBuilder::PARAM_*
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function castColumn($column, $type);
+    /**
+     * Returns a IQueryFunction that casts the column to the given type
+     *
+     * @param string $column
+     * @param mixed $type One of IQueryBuilder::PARAM_*
+     * @return string
+     * @since 9.0.0
+     */
+    public function castColumn($column, $type);
 }

lib/public/Contacts.php

Indentation +141 added lines, -141 removed lines

@@ -33,153 +33,153 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP {
 
-	/**
-	 * This class provides access to the contacts app. Use this class exclusively if you want to access contacts.
-	 *
-	 * Contacts in general will be expressed as an array of key-value-pairs.
-	 * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1
-	 *
-	 * Proposed workflow for working with contacts:
-	 *  - search for the contacts
-	 *  - manipulate the results array
-	 *  - createOrUpdate will save the given contacts overwriting the existing data
-	 *
-	 * For updating it is mandatory to keep the id.
-	 * Without an id a new contact will be created.
-	 *
-	 * @deprecated 8.1.0 use methods of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-	 * @since 5.0.0
-	 */
-	class Contacts {
+    /**
+     * This class provides access to the contacts app. Use this class exclusively if you want to access contacts.
+     *
+     * Contacts in general will be expressed as an array of key-value-pairs.
+     * The keys will match the property names defined in https://tools.ietf.org/html/rfc2426#section-1
+     *
+     * Proposed workflow for working with contacts:
+     *  - search for the contacts
+     *  - manipulate the results array
+     *  - createOrUpdate will save the given contacts overwriting the existing data
+     *
+     * For updating it is mandatory to keep the id.
+     * Without an id a new contact will be created.
+     *
+     * @deprecated 8.1.0 use methods of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+     * @since 5.0.0
+     */
+    class Contacts {
 
-		/**
-		 * This function is used to search and find contacts within the users address books.
-		 * In case $pattern is empty all contacts will be returned.
-		 *
-		 * Example:
-		 *  Following function shows how to search for contacts for the name and the email address.
-		 *
-		 *		public static function getMatchingRecipient($term) {
-		 *			// The API is not active -> nothing to do
-		 *			if (!\OCP\Contacts::isEnabled()) {
-		 *				return array();
-		 *			}
-		 *
-		 *			$result = \OCP\Contacts::search($term, array('FN', 'EMAIL'));
-		 *			$receivers = array();
-		 *			foreach ($result as $r) {
-		 *				$id = $r['id'];
-		 *				$fn = $r['FN'];
-		 *				$email = $r['EMAIL'];
-		 *				if (!is_array($email)) {
-		 *					$email = array($email);
-		 *				}
-		 *
-		 *				// loop through all email addresses of this contact
-		 *				foreach ($email as $e) {
-		 *				$displayName = $fn . " <$e>";
-		 *				$receivers[] = array(
-		 *					'id'    => $id,
-		 *					'label' => $displayName,
-		 *					'value' => $displayName);
-		 *				}
-		 *			}
-		 *
-		 *			return $receivers;
-		 *		}
-		 *
-		 *
-		 * @param string $pattern which should match within the $searchProperties
-		 * @param array $searchProperties defines the properties within the query pattern should match
-		 * @param array $options - for future use. One should always have options!
-		 * @return array an array of contacts which are arrays of key-value-pairs
-		 * @deprecated 8.1.0 use search() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function search($pattern, $searchProperties = array(), $options = array()) {
-			$cm = \OC::$server->getContactsManager();
-			return $cm->search($pattern, $searchProperties, $options);
-		}
+        /**
+         * This function is used to search and find contacts within the users address books.
+         * In case $pattern is empty all contacts will be returned.
+         *
+         * Example:
+         *  Following function shows how to search for contacts for the name and the email address.
+         *
+         *		public static function getMatchingRecipient($term) {
+         *			// The API is not active -> nothing to do
+         *			if (!\OCP\Contacts::isEnabled()) {
+         *				return array();
+         *			}
+         *
+         *			$result = \OCP\Contacts::search($term, array('FN', 'EMAIL'));
+         *			$receivers = array();
+         *			foreach ($result as $r) {
+         *				$id = $r['id'];
+         *				$fn = $r['FN'];
+         *				$email = $r['EMAIL'];
+         *				if (!is_array($email)) {
+         *					$email = array($email);
+         *				}
+         *
+         *				// loop through all email addresses of this contact
+         *				foreach ($email as $e) {
+         *				$displayName = $fn . " <$e>";
+         *				$receivers[] = array(
+         *					'id'    => $id,
+         *					'label' => $displayName,
+         *					'value' => $displayName);
+         *				}
+         *			}
+         *
+         *			return $receivers;
+         *		}
+         *
+         *
+         * @param string $pattern which should match within the $searchProperties
+         * @param array $searchProperties defines the properties within the query pattern should match
+         * @param array $options - for future use. One should always have options!
+         * @return array an array of contacts which are arrays of key-value-pairs
+         * @deprecated 8.1.0 use search() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function search($pattern, $searchProperties = array(), $options = array()) {
+            $cm = \OC::$server->getContactsManager();
+            return $cm->search($pattern, $searchProperties, $options);
+        }
 
-		/**
-		 * This function can be used to delete the contact identified by the given id
-		 *
-		 * @param object $id the unique identifier to a contact
-		 * @param string $address_book_key
-		 * @return bool successful or not
-		 * @deprecated 8.1.0 use delete() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function delete($id, $address_book_key) {
-			$cm = \OC::$server->getContactsManager();
-			return $cm->delete($id, $address_book_key);
-		}
+        /**
+         * This function can be used to delete the contact identified by the given id
+         *
+         * @param object $id the unique identifier to a contact
+         * @param string $address_book_key
+         * @return bool successful or not
+         * @deprecated 8.1.0 use delete() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function delete($id, $address_book_key) {
+            $cm = \OC::$server->getContactsManager();
+            return $cm->delete($id, $address_book_key);
+        }
 
-		/**
-		 * This function is used to create a new contact if 'id' is not given or not present.
-		 * Otherwise the contact will be updated by replacing the entire data set.
-		 *
-		 * @param array $properties this array if key-value-pairs defines a contact
-		 * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
-		 * @return array an array representing the contact just created or updated
-		 * @deprecated 8.1.0 use createOrUpdate() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function createOrUpdate($properties, $address_book_key) {
-			$cm = \OC::$server->getContactsManager();
-			return $cm->createOrUpdate($properties, $address_book_key);
-		}
+        /**
+         * This function is used to create a new contact if 'id' is not given or not present.
+         * Otherwise the contact will be updated by replacing the entire data set.
+         *
+         * @param array $properties this array if key-value-pairs defines a contact
+         * @param string $address_book_key identifier of the address book in which the contact shall be created or updated
+         * @return array an array representing the contact just created or updated
+         * @deprecated 8.1.0 use createOrUpdate() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function createOrUpdate($properties, $address_book_key) {
+            $cm = \OC::$server->getContactsManager();
+            return $cm->createOrUpdate($properties, $address_book_key);
+        }
 
-		/**
-		 * Check if contacts are available (e.g. contacts app enabled)
-		 *
-		 * @return bool true if enabled, false if not
-		 * @deprecated 8.1.0 use isEnabled() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function isEnabled() {
-			$cm = \OC::$server->getContactsManager();
-			return $cm->isEnabled();
-		}
+        /**
+         * Check if contacts are available (e.g. contacts app enabled)
+         *
+         * @return bool true if enabled, false if not
+         * @deprecated 8.1.0 use isEnabled() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function isEnabled() {
+            $cm = \OC::$server->getContactsManager();
+            return $cm->isEnabled();
+        }
 
-		/**
-		 * @param \OCP\IAddressBook $address_book
-		 * @deprecated 8.1.0 use registerAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function registerAddressBook(\OCP\IAddressBook $address_book) {
-			$cm = \OC::$server->getContactsManager();
-			$cm->registerAddressBook($address_book);
-		}
+        /**
+         * @param \OCP\IAddressBook $address_book
+         * @deprecated 8.1.0 use registerAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function registerAddressBook(\OCP\IAddressBook $address_book) {
+            $cm = \OC::$server->getContactsManager();
+            $cm->registerAddressBook($address_book);
+        }
 
-		/**
-		 * @param \OCP\IAddressBook $address_book
-		 * @deprecated 8.1.0 use unregisterAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function unregisterAddressBook(\OCP\IAddressBook $address_book) {
-			$cm = \OC::$server->getContactsManager();
-			$cm->unregisterAddressBook($address_book);
-		}
+        /**
+         * @param \OCP\IAddressBook $address_book
+         * @deprecated 8.1.0 use unregisterAddressBook() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function unregisterAddressBook(\OCP\IAddressBook $address_book) {
+            $cm = \OC::$server->getContactsManager();
+            $cm->unregisterAddressBook($address_book);
+        }
 
-		/**
-		 * @return array
-		 * @deprecated 8.1.0 use getAddressBooks() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function getAddressBooks() {
-			$cm = \OC::$server->getContactsManager();
-			return $cm->getAddressBooks();
-		}
+        /**
+         * @return array
+         * @deprecated 8.1.0 use getAddressBooks() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function getAddressBooks() {
+            $cm = \OC::$server->getContactsManager();
+            return $cm->getAddressBooks();
+        }
 
-		/**
-		 * removes all registered address book instances
-		 * @deprecated 8.1.0 use clear() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
-		 * @since 5.0.0
-		 */
-		public static function clear() {
-			$cm = \OC::$server->getContactsManager();
-			$cm->clear();
-		}
-	}
+        /**
+         * removes all registered address book instances
+         * @deprecated 8.1.0 use clear() of \OCP\Contacts\IManager - \OC::$server->getContactsManager();
+         * @since 5.0.0
+         */
+        public static function clear() {
+            $cm = \OC::$server->getContactsManager();
+            $cm->clear();
+        }
+    }
 }

lib/public/ICertificateManager.php

Indentation +36 added lines, -36 removed lines

@@ -29,44 +29,44 @@
  * @since 8.0.0
  */
 interface ICertificateManager {
-	/**
-	 * Returns all certificates trusted by the user
-	 *
-	 * @return \OCP\ICertificate[]
-	 * @since 8.0.0
-	 */
-	public function listCertificates();
+    /**
+     * Returns all certificates trusted by the user
+     *
+     * @return \OCP\ICertificate[]
+     * @since 8.0.0
+     */
+    public function listCertificates();
 
-	/**
-	 * @param string $certificate the certificate data
-	 * @param string $name the filename for the certificate
-	 * @return \OCP\ICertificate
-	 * @throws \Exception If the certificate could not get added
-	 * @since 8.0.0 - since 8.1.0 throws exception instead of returning false
-	 */
-	public function addCertificate($certificate, $name);
+    /**
+     * @param string $certificate the certificate data
+     * @param string $name the filename for the certificate
+     * @return \OCP\ICertificate
+     * @throws \Exception If the certificate could not get added
+     * @since 8.0.0 - since 8.1.0 throws exception instead of returning false
+     */
+    public function addCertificate($certificate, $name);
 
-	/**
-	 * @param string $name
-	 * @since 8.0.0
-	 */
-	public function removeCertificate($name);
+    /**
+     * @param string $name
+     * @since 8.0.0
+     */
+    public function removeCertificate($name);
 
-	/**
-	 * Get the path to the certificate bundle for this user
-	 *
-	 * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0)
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getCertificateBundle($uid = '');
+    /**
+     * Get the path to the certificate bundle for this user
+     *
+     * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle (since 9.0.0)
+     * @return string
+     * @since 8.0.0
+     */
+    public function getCertificateBundle($uid = '');
 
-	/**
-	 * Get the full local path to the certificate bundle for this user
-	 *
-	 * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getAbsoluteBundlePath($uid = '');
+    /**
+     * Get the full local path to the certificate bundle for this user
+     *
+     * @param string $uid (optional) user to get the certificate bundle for, use `null` to get the system bundle
+     * @return string
+     * @since 9.0.0
+     */
+    public function getAbsoluteBundlePath($uid = '');
 }

lib/public/IAvatarManager.php

Indentation +10 added lines, -10 removed lines

@@ -33,14 +33,14 @@
 
 interface IAvatarManager {
 
-	/**
-	 * return a user specific instance of \OCP\IAvatar
-	 * @see \OCP\IAvatar
-	 * @param string $user the ownCloud user id
-	 * @return \OCP\IAvatar
-	 * @throws \Exception In case the username is potentially dangerous
-	 * @throws \OCP\Files\NotFoundException In case there is no user folder yet
-	 * @since 6.0.0
-	 */
-	public function getAvatar($user);
+    /**
+     * return a user specific instance of \OCP\IAvatar
+     * @see \OCP\IAvatar
+     * @param string $user the ownCloud user id
+     * @return \OCP\IAvatar
+     * @throws \Exception In case the username is potentially dangerous
+     * @throws \OCP\Files\NotFoundException In case there is no user folder yet
+     * @since 6.0.0
+     */
+    public function getAvatar($user);
 }

lib/public/IImage.php

Indentation +154 added lines, -154 removed lines

@@ -29,158 +29,158 @@
  * @since 8.1.0
  */
 interface IImage {
-	/**
-	 * Determine whether the object contains an image resource.
-	 *
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function valid();
-
-	/**
-	 * Returns the MIME type of the image or an empty string if no image is loaded.
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function mimeType();
-
-	/**
-	 * Returns the width of the image or -1 if no image is loaded.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function width();
-
-	/**
-	 * Returns the height of the image or -1 if no image is loaded.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function height();
-
-	/**
-	 * Returns the width when the image orientation is top-left.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function widthTopLeft();
-
-	/**
-	 * Returns the height when the image orientation is top-left.
-	 *
-	 * @return int
-	 * @since 8.1.0
-	 */
-	public function heightTopLeft();
-
-	/**
-	 * Outputs the image.
-	 *
-	 * @param string $mimeType
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function show($mimeType = null);
-
-	/**
-	 * Saves the image.
-	 *
-	 * @param string $filePath
-	 * @param string $mimeType
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function save($filePath = null, $mimeType = null);
-
-	/**
-	 * @return resource Returns the image resource in any.
-	 * @since 8.1.0
-	 */
-	public function resource();
-
-	/**
-	 * @return string Returns the raw image data.
-	 * @since 8.1.0
-	 */
-	public function data();
-
-	/**
-	 * (I'm open for suggestions on better method name ;)
-	 * Get the orientation based on EXIF data.
-	 *
-	 * @return int The orientation or -1 if no EXIF data is available.
-	 * @since 8.1.0
-	 */
-	public function getOrientation();
-
-	/**
-	 * (I'm open for suggestions on better method name ;)
-	 * Fixes orientation based on EXIF data.
-	 *
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function fixOrientation();
-
-	/**
-	 * Resizes the image preserving ratio.
-	 *
-	 * @param integer $maxSize The maximum size of either the width or height.
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function resize($maxSize);
-
-	/**
-	 * @param int $width
-	 * @param int $height
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function preciseResize($width, $height);
-
-	/**
-	 * Crops the image to the middle square. If the image is already square it just returns.
-	 *
-	 * @param int $size maximum size for the result (optional)
-	 * @return bool for success or failure
-	 * @since 8.1.0
-	 */
-	public function centerCrop($size = 0);
-
-	/**
-	 * Crops the image from point $x$y with dimension $wx$h.
-	 *
-	 * @param int $x Horizontal position
-	 * @param int $y Vertical position
-	 * @param int $w Width
-	 * @param int $h Height
-	 * @return bool for success or failure
-	 * @since 8.1.0
-	 */
-	public function crop($x, $y, $w, $h);
-
-	/**
-	 * Resizes the image to fit within a boundary while preserving ratio.
-	 *
-	 * @param integer $maxWidth
-	 * @param integer $maxHeight
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function fitIn($maxWidth, $maxHeight);
-
-	/**
-	 * Shrinks the image to fit within a boundary while preserving ratio.
-	 *
-	 * @param integer $maxWidth
-	 * @param integer $maxHeight
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function scaleDownToFit($maxWidth, $maxHeight);
+    /**
+     * Determine whether the object contains an image resource.
+     *
+     * @return bool
+     * @since 8.1.0
+     */
+    public function valid();
+
+    /**
+     * Returns the MIME type of the image or an empty string if no image is loaded.
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function mimeType();
+
+    /**
+     * Returns the width of the image or -1 if no image is loaded.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function width();
+
+    /**
+     * Returns the height of the image or -1 if no image is loaded.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function height();
+
+    /**
+     * Returns the width when the image orientation is top-left.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function widthTopLeft();
+
+    /**
+     * Returns the height when the image orientation is top-left.
+     *
+     * @return int
+     * @since 8.1.0
+     */
+    public function heightTopLeft();
+
+    /**
+     * Outputs the image.
+     *
+     * @param string $mimeType
+     * @return bool
+     * @since 8.1.0
+     */
+    public function show($mimeType = null);
+
+    /**
+     * Saves the image.
+     *
+     * @param string $filePath
+     * @param string $mimeType
+     * @return bool
+     * @since 8.1.0
+     */
+    public function save($filePath = null, $mimeType = null);
+
+    /**
+     * @return resource Returns the image resource in any.
+     * @since 8.1.0
+     */
+    public function resource();
+
+    /**
+     * @return string Returns the raw image data.
+     * @since 8.1.0
+     */
+    public function data();
+
+    /**
+     * (I'm open for suggestions on better method name ;)
+     * Get the orientation based on EXIF data.
+     *
+     * @return int The orientation or -1 if no EXIF data is available.
+     * @since 8.1.0
+     */
+    public function getOrientation();
+
+    /**
+     * (I'm open for suggestions on better method name ;)
+     * Fixes orientation based on EXIF data.
+     *
+     * @return bool
+     * @since 8.1.0
+     */
+    public function fixOrientation();
+
+    /**
+     * Resizes the image preserving ratio.
+     *
+     * @param integer $maxSize The maximum size of either the width or height.
+     * @return bool
+     * @since 8.1.0
+     */
+    public function resize($maxSize);
+
+    /**
+     * @param int $width
+     * @param int $height
+     * @return bool
+     * @since 8.1.0
+     */
+    public function preciseResize($width, $height);
+
+    /**
+     * Crops the image to the middle square. If the image is already square it just returns.
+     *
+     * @param int $size maximum size for the result (optional)
+     * @return bool for success or failure
+     * @since 8.1.0
+     */
+    public function centerCrop($size = 0);
+
+    /**
+     * Crops the image from point $x$y with dimension $wx$h.
+     *
+     * @param int $x Horizontal position
+     * @param int $y Vertical position
+     * @param int $w Width
+     * @param int $h Height
+     * @return bool for success or failure
+     * @since 8.1.0
+     */
+    public function crop($x, $y, $w, $h);
+
+    /**
+     * Resizes the image to fit within a boundary while preserving ratio.
+     *
+     * @param integer $maxWidth
+     * @param integer $maxHeight
+     * @return bool
+     * @since 8.1.0
+     */
+    public function fitIn($maxWidth, $maxHeight);
+
+    /**
+     * Shrinks the image to fit within a boundary while preserving ratio.
+     *
+     * @param integer $maxWidth
+     * @param integer $maxHeight
+     * @return bool
+     * @since 8.1.0
+     */
+    public function scaleDownToFit($maxWidth, $maxHeight);
 }

lib/public/Preview/IProvider.php

Indentation +25 added lines, -25 removed lines

@@ -29,31 +29,31 @@
  * @since 8.1.0
  */
 interface IProvider {
-	/**
-	 * @return string Regex with the mimetypes that are supported by this provider
-	 * @since 8.1.0
-	 */
-	public function getMimeType();
+    /**
+     * @return string Regex with the mimetypes that are supported by this provider
+     * @since 8.1.0
+     */
+    public function getMimeType();
 
-	/**
-	 * Check if a preview can be generated for $path
-	 *
-	 * @param \OCP\Files\FileInfo $file
-	 * @return bool
-	 * @since 8.1.0
-	 */
-	public function isAvailable(\OCP\Files\FileInfo $file);
+    /**
+     * Check if a preview can be generated for $path
+     *
+     * @param \OCP\Files\FileInfo $file
+     * @return bool
+     * @since 8.1.0
+     */
+    public function isAvailable(\OCP\Files\FileInfo $file);
 
-	/**
-	 * get thumbnail for file at path $path
-	 *
-	 * @param string $path Path of file
-	 * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param bool $scalingup Disable/Enable upscaling of previews
-	 * @param \OC\Files\View $fileview fileview object of user folder
-	 * @return bool|\OCP\IImage false if no preview was generated
-	 * @since 8.1.0
-	 */
-	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
+    /**
+     * get thumbnail for file at path $path
+     *
+     * @param string $path Path of file
+     * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param bool $scalingup Disable/Enable upscaling of previews
+     * @param \OC\Files\View $fileview fileview object of user folder
+     * @return bool|\OCP\IImage false if no preview was generated
+     * @since 8.1.0
+     */
+    public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
 }