Skip to content

Commit 283f494

Browse files
committed
update doc
1 parent 290635c commit 283f494

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

doc/definitions.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Structure of the filter definition array (Container):
55
-----------------------------------------------------
66
- A container can have one of two properties: a condition or a collection.
77
- A collection is a collection of containers, each of which also has a condition or collection, and so on to "infinity".
8-
- In addition, the collection has the `andOrOperator` (AND | OR) property to define the condition for the previous collection.
8+
- In addition, the collection has the ``andOrOperator`` (AND | OR) property to define the condition for the previous collection.
99
- A condition is a field, an operator, a value.
1010
- Nesting conditions in the collection and determines the correct arrangement of brackets in the final SQL query.
1111

@@ -19,7 +19,7 @@ Structure of the filter definition array (Container):
1919
'value' => 'united', // the value by which we filter
2020
'function' => [ // SQL function applied to the field
2121
'aggregate' => false, // if the function is aggregating, then it must be true, otherwise you can not define
22-
'definition' => 'MY_FUNCTION({property}, {value}) = TRUE', // the function itself. Tokens `{property}` and `{value}` will be replaced by a field and value
22+
'definition' => 'MY_FUNCTION({property}, {value}) = TRUE', // the function itself. Tokens ``{property}`` and ``{value}`` will be replaced by a field and value
2323
],
2424
]
2525
@@ -115,11 +115,11 @@ Structure of the filter definition array (Container):
115115
- **notBetween** - not between
116116
- **in** - in
117117
- **notIn** - not In
118-
- **instanceOf** - instanceOf `for \Doctrine\ORM\QueryBuilder`
119-
- **notInstanceOf** - not InstanceOf `for \Doctrine\ORM\QueryBuilder`
118+
- **instanceOf** - instanceOf ``for \Doctrine\ORM\QueryBuilder``
119+
- **notInstanceOf** - not InstanceOf ``for \Doctrine\ORM\QueryBuilder``
120120

121121

122-
Structure of the `ORDER BY` definition array:
122+
Structure of the ``ORDER BY`` definition array:
123123
---------------------------------------------
124124

125125
.. code-block:: php
@@ -136,10 +136,10 @@ Structure of the `ORDER BY` definition array:
136136
],
137137
];
138138
139-
This definition will generate a SQL code like `ORDER BY LOWER(country.name) ASC, country.population DESC`
139+
This definition will generate a SQL code like ``ORDER BY LOWER(country.name) ASC, country.population DESC``
140140

141141

142-
Structure of the `LIMIT OFFSET` definition:
142+
Structure of the ``LIMIT OFFSET`` definition:
143143
-------------------------------------------
144144

145145
.. code-block:: php
@@ -148,4 +148,4 @@ Structure of the `LIMIT OFFSET` definition:
148148
->buildWhere($container)
149149
->buildOrderBy($orderBy);
150150
151-
$result = $query->getResult(30, 50); // `LIMIT 30 OFFSET 50`
151+
$result = $query->getResult(30, 50); // ``LIMIT 30 OFFSET 50``

doc/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Usage
22
=====
33

4-
As already mentioned, sps-component uses the `Doctrine\DBAL\Query\QueryBuilder` or `Doctrine\ORM\QueryBuilder`.
4+
As already mentioned, sps-component uses the ``Doctrine\DBAL\Query\QueryBuilder`` or ``Doctrine\ORM\QueryBuilder``.
55
There are small nuances of using each of them:
66
- ``ORM QueryBuilder`` uses DQL and returns array of objects or array of strings.
77
In the case of objects, you can use not only properties in the table columns, but also methods

0 commit comments

Comments
 (0)