Инструкция к API
Краткая информация о том, как работать с документацией по API для DevelNext.
Структура документации
Документация по API представляет из себя набор статей, где каждая статья описывает конкретный класс PHP. В develnext все построено на работе с классами и объектами. Зная класс объекта, вы можете прочитать полную документацию по нему - какие методы и свойства у него есть и что они означают.
Ключевые слова
В этой документации встречаются следующие ключевые слова, важно знать, что они означают:
double
- означает, что значение это вещественное число, не целое.int
- это всегда целое число, отрицательное или положительное.bool
- это булево значение, т.е.true
илиfalse
(да или нет, правда или ложь).string
- это строка, т.е. любой текст, строки в php заключают в одинарные или двойные кавычки.array
- это php массив.Только для чтения
- применимо для свойств объектов, означает, что свойство нельзя изменить через код, только взять значение свойства.
Описание класса
При описании класса пишется его короткое название, полное название и от какого класса он унаследован. Например, UXNode
- короткое название, php\gui\UXNode
- полное название (для use php\gui\UXNode
). В описании классов встречаются названия других классов в виде ссылок, которые ведут на описание этих классов.