Анналы show php. Использование дескриптора @see. Статические поля класса

Хочу рассмотреть принцип документирования программного PHP кода, основанный на DocBlock (DocBlock comments). Многие называют его стандартом, хотя каких-то авторитетных источников, подтверждающих это, я не нашел. Тем не менее, данный формат комментариев распространен во многих языка. Насколько я понимаю, пришел он из Java и по своему принципу наследует Javadoc. Он прекрасно поддерживается и интерпретируется средами разработки. Также существует немало решений, позволяющих автоматически генерировать документацию на основе таких комментариев.

DocBlock – это многострочный комментарий, требующий соблюдения определенного синтаксиса. В PHP данный способ более известен под другим именем – phpDoc. Оно происходит от названия утилиты phpDocumentor, предоставляющей возможность создавать страницы документации автоматически. Результат ее работы очень похож на официальную документацию PHP.

О пользе написания комментариев написано немало. Обычно призывы основаны на необходимости заботиться о тех, кому придется работать с вашим кодом в дальнейшем. Безусловно, я с этим согласен, но считаю это очень плохой мотивацией. Люди эгоистичны и зачастую действуют только в своих собственных интересах, что совершенно нормально.

Я хочу привести ряд аргументов, которые, возможно, смогут убедить в том, что хороший комментарий несет пользу прежде всего нам самим. phpDoc блоки позволяют увеличить не только читаемость существующего кода, но и ускорят написание нового за счет использования возможностей IDE.

Синтаксис phpDoc

Весь синтаксис строится на использовании дескрипторов и их значений, обернутых в Си подобный многострочный комментарий.

/** * @имя_дескриптора значение_директивы * @еще_дескриптор * */

Наверное, стоит заметить, что каждая строка внутри блока должна начинаться с символа *. Именам дескрипторов предшествует знак @.

phpDoc может описывать не только отдельные участки кода, но и весь файл скрипта, располагаясь в самом начале файла. Такой блок называется заголовочным.

Ниже предлагаю список дескрипторов phpDoc и мои комментарий к ним.

Дескриптор	Значения/Пример	Описание
@abstract	none	Описывает абстрактные классы, методы или свойства
@access	private/protected/public	Указывает на модификатор доступа свойства или метода класса.
@author	@author Oleg Murashov	Имя автора кода. phpDocumentor будет искать текст между угловыми скобками (). Если такая конструкция будет найдена и ее формат будет соответствовать e-mail адресу, то она будет преобразована в соответствующую ссылку.
@category	@category Zend	Имя категории, в которую объединены несколько пакетов.
@copyright	Copyright (c) 2005-2011 Company	Информация, указывающая на правообладателя кода.
@deprecated	@deprecated 1.7	Дескриптор указывает на то, что код устарел. В качестве значения дескриптора указывается версия, начиная с которой код считается устаревшим.
@example	@example /path/example.php описание	Указывает путь к файлу, содержащему пример использования кода. phpDocumentor опубликует пример, подсветив синтаксис и пронумеровав строки.
@final	none	Дескриптор отмечает методы или свойства, которые не могут быть перегружены в дочерних классах. Также может быть отмечен класс, который не должен быть наследован.
@filesource	none	Дескриптор может быть использован только в заголовочном комментарии. В других местах она игнорируется. Указывает phpDocumentor’у на необходимость вывести исходный код текущего файла, подсветить синтаксис и пронумеровать строки.
@global	@global datatype описание	Дескриптор для декларации глобальных переменных. Для понимания того, как верно использовать данную директиву, лучше всего обратиться к соответствующей документации .
@ignore	none	Сообщает phpDocumentor’у, что данный код не следует включать в лист документации
@internal	@internal комментарий	Значение дискриптора не будет добавлено в файлы документации. Удобно, если нужно оставить комментарий только для тех, кто работает с кодом
@license	@link http://www.example.com/License.txt GPL License	Добавляет ссылку на лицензию, под которой распространяется код
@link	@link http://www.example.com Текст ссылки	Дает возможность добавить ссылку в к любому документируемому коду.
@method	@method returntype описание	Используется для описания магического метода __call().
@name	@name $globalvariablename	Дает возможность сослаться на краткое имя глобальной переменной, объявленной с помощью @global
@package	@package Zend_Pdf	Указание имени пакета, в который входит данный программный код (файл). Используется в заголовочном блоке файла или в блоке комментариев класса.
@param	@param datatype1\|datatype2 $paramname описание	Дескриптор описывает входные параметры для функций и методов классов. Содержит информацию и типе данных параметра и его описание.
@property @property-read @property-write		Дескрипторы описывают свойства класса, которые могут быть записаны или прочитаны с помощью магических методов __set() и __get(). Если свойство доступно для чтения и записи, необходимо использовать директиву @property. Если только для чтения или только для записи, то @property-read или @property-write соответственно. Используются только в блоке описания класса.
@return	@return datatype1\|datatype2 описание	Используется для описания данных, возвращаемых функцией или методом класса. Синаксис схож с дискриптором @param. Если в качестве типа будет указано имя класса, phpDocumentor автоматически создаст ссылку на данный класс.
@see	@see …	Дескриптор предлагает обратиться к другому, уже существующему докблоку. Например, может быть использован при документировании метода, класс которого имплементирует интерфейс, где уже существует полноценный докблок. Позволяет избежать дублирования комментариев.
@since	@since v 0.7	Указывает на версию пакета/класса, с которой комментируемый элемент стал доступен. Например, при описаниии метода, который появился только в какой-то версии класса, можно указать эту версию.
@static	none	Маркирует статические методы или свойства класса
@subpackage	@subpackage Name	Используется для объединения нескольких пакетов в один раздел документации. Игнорируется, если нет дескриптора @package. Как и @package, помещается в заголовочном блоке комментариев.
@todo	@todo Something	Можно описать будущие возможные изменения кода
@throws	@throws MyException	Указывает тип исключения, который может быть возвращен участком кода
@var	@var string	Указывает тип свойства класса
@version	@version Version 1.1	Текущая версия реализации документируемого кода.

Дескрипторы @access , @final и @abstract были актуальны в PHP 4, но сейчас их можно не использовать, так как они потеряли актуальность с появлением модификаторов доступа и ключевых слов final и abstract .

Каждый docBLock делится на несколько секций:

заголовок;
описание;
список дескрипторов.

Разделителем для секций служит пустая строка.

Примеры использования phpDoc комментариев

Я не хочу приводить синтетические примеры, поэтому заимствую код из популярного фреймворка Zend Framework, который, как мне кажется, имеет самые толковые и подробные блоки комментариев.

Я значительно укоротил многословные описания методов и классов, избегая избыточности в рамках примера. Обратите внимание на общий принцип документирования и на синтаксис дескрипторов.

Использование дескриптора @see

/** * @see Zend_Acl_Resource_Interface */ require_once "Zend/Acl/Resource/Interface.php";

Пример блока комментариев для метода класса

/** * Removes "deny" restrictions from the ACL * * @param Zend_Acl_Role_Interface|string|array $roles * @param Zend_Acl_Resource_Interface|string|array $resources * @param string|array $privileges * @uses Zend_Acl::setRule() * @return Zend_Acl Provides a fluent interface */ public function removeDeny($roles = null, $resources = null, $privileges = null) { return $this->setRule(self::OP_REMOVE, self::TYPE_DENY, $roles, $resources, $privileges); }

Свойство класса

/** * Role registry * * @var Zend_Acl_Role_Registry */ protected $_roleRegistry = null;

А вот один из примеров подсказок (), которые может предлагать среда разработки, в данном случае Eclipse.

Также среда разработки может выводить подсказки, основанные на docBlock. Например, подсказка, появляющаяся при наведении на имя метода Zend_Acl_Role_Registry::add() .

Почти детективный сюжет

"Это... вместе с приложенными к нему многочисленными описаниями проведенных опытов и пояснительных чертежей было отослано... с гонцом, который перевалил через горный хребет, плутал по непроходимым болотам, плыл по бурным рекам, подвергался опасности быть растерзанным дикими зверями, умереть от тоски, погибнуть от чумы, пока наконец не вышел к почтовому тракту."

"Сто лет одиночества"Г.Г.Маркес

В наше время все гораздо проще. Однажды за полночь я включил компьютер и вышел в Интернет, чтобы проверить почту...

"Здравствуй, ВААЛ!

Высылаем интересный материал. Это интервью и статьи одного товарища. Было бы неплохо дать их подробный анализ. см. аттач"

А в аттаче архив на 500 kb текста.

Жму кнопку Reply и пишу:

"Здравствуйте.

С интересом прочитал Ваше письмо. Анализ возможен, но для этого необходимо обговорить условия."

Отсылаю.
Письмо возвращается. Не указан адрес!

Совсем не обратил внимания на то, что исходное письмо не содержало обратного адреса. Значит, его пропустили через анонимайзер. Знакомые штучки-дрючки.
Решил более внимательно посмотреть, что же мне прислали в аттаче.

Семнадцать файлов с именами: 9912, 0001, 0003, 0006, 0007, 0008, 0009, 0010, 0011, 0012, 0101, 0102, 0103, 0104, 0105, 0107, 0109. Можно предположить, что первые две цифры - это год, а две последние - месяц.

Первая фраза файла 9912 - "Этот сайт появился в силу ошибки, совершенной на днях Ю.М.Лужковым, Е.М.Примаковым либо кем-то из их ответственных холуев." Что-то знакомое. Опять лезу в Интернет в Yandex , ввожу всю фразу целиком и жму Найти . Опаньки! Первая же найденная ссылка все расставляет на свои места:

Заявления и интервью руководства ФЭП Показать найденные слова
Заявления и интервью руководства ФЭП ПУБЛИКАЦИИ ЗАЯВЛЕНИЯ И ИНТЕРВЬЮ РУКОВОДСТВА ФЭП
Этот сайт появился в силу ошибки, совершенной на днях Ю.М.Лужковым, Е.М.Примаковым либо кем-то из их ответственных холуев. Впрочем, эта ошибка - следствие более крупной ошибки, сделанной раньше. http://www.fep.ru/publications/management/ovg31299i.html - 10К - строгое соответствие
Переход в категорию Внутренняя политика / Похожие документы / Еще с сервера не менее 1 док.

Опускаю детали умозаключений и перехожу к резюме.

Мне прислали семнадцать файлов интервью и статей Глеба Павловского, размещенных на сайте его ФЭП а http:/www.fep.ru . Несомненно, приславший письмо является искренним доброжелателем Павловского, так как предусмотрительно воспользовался анонимайзером. Он очень заинтересован в анализе, так как предварительно удалил из текстов интервью все не являющееся словами Павловского. Для этого нужно было 500 kb текста вручную перелопатить. Работа немалая и нудная! Все сделал, чтобы облегчить мне задачу, искуситель чертов.

Первоначальное желание отправить все в корзину отступило, и я решил все-таки проанализировать присланный материал. Но чтобы в свою очередь не искушать Доброжелателя , я почти ничего о самом Павловском не скажу. Не стану огорчать его описанием обнаруженных пороков Глеба Ольговича. Поступлю иначе.

Так как результаты будут в конечном итоге размещены на сайте (не пропадать же им даром!), то попробую на данном материале решить задачу определения того, как относится автор текста к различным упоминаемым им персонам (в том числе и к самому себе:-))). Это интересно потому, что позволяет на живом примере продемонстрировать еще один из методов ВААЛ-анализа.

Жизнь удалась!

Но все-таки без нескольких слов о самом Павловском не обойтись.

Напомню, что такое Валентность . Любая наша деятельность протекает в определенных условиях. На ее успешность влияют различные предметы, явления, другие люди, вступающие в конкуренцию или наоборот способствующие достижению поставленных нами целей. В зависимости от характера такого влияния их можно отнести к имеющим либо положительную , либо отрицательную валентность. Валентность не является свойством самих объектов, а лишь проявляется в рамках некоторой структуры отношений.

Красная кривая линия показывает степень выраженности положительной валентности в анализируемых статьях и интервью. Синяя кривая - степень выраженности отрицательной валентности. Зеленая кривая - это разница между значениями положительной и отрицательной валентности. Зеленая прямая линия - это линейный тренд разницы между значениями положительной и отрицательной валентности. Сильно закручено, но все делалось именно ради этой зеленой прямой .

Что же мы видим на диаграмме? А видим мы то, что за два прошедших года зеленая прямая выросла от -3 до почти +3 . Очень сильный рост! Это означает, что с течением времени все больше и больше предметов, явлений, других людей способствуют достижению поставленных Павловским целей.

Если в двух словах, то
Жизнь удалась!

О других и о себе

Как я уже писал выше, нашей целью будет выявление отношения Глеба Павловского к различным людям, которых он упоминал в своих статьях и многочисленных интервью. В качестве объектов исследования мы выбрали: Березовского, Гусинского, Ельцина, Лужкова, Примакова, Путина и самого Павловского (под псевдонимом Я ).

Решить эту задачу с помощью системы ВААЛ-2000 можно двумя способами. При любом из них предварительно требуется создать семь категорий упоминаемых персонажей. Т.е. на основании всего текста создаем словарь, а уже с его помощью формируем категории БЕРЕЗОВСКИЙ, ГУСИНСКИЙ и т.д.

Первый способ. Запустив контент-анализ, смотрим, как новые категории связаны (коррелируют) со встроенными категориями. На основе значимых связей делаем глубокомысленные выводы.

Второй способ(использованный нами) - контекстный анализ. Для знакомых с современным состоянием контент-анализа скажу, что это просто контент-анализ collocations упоминаемых персон. Для тех, кто не знает, что такое collocation , поясню.

Для каждого упомнания в тексте Лужкова мы можем взять слова, находящиеся от него в некоторой окрестности. Объединив такие окрестности для всех упоминаний Лужкова вместе, мы и получим для него collocation . Что взять в качестве окрестности, зависит от целей исследования. В нашем случае мы брали слова, просто находящиеся в одном предложении.

В предложении "Этот сайт появился в силу ошибки, совершенной на днях Ю.М.Лужковым,Е.М.Примаковым либо кем-тоиз их ответственных холуев." в окрестность Ю.М.Лужковым вошли слова: этот, сайт, появился, в, силу, ошибки, совершенной, на, днях, Е.М.Примаковым, либо, кем-то, из, их, ответственных, холуев .

Дальнейшие наши действия таковы. Для каждой из оценочных шкал (категорий) мы вычисляем ее среднее значение по всему массиву текста. Затем вычисляем оценки этих же шкал для полученных collocations и сравниваем их с общим средним значением. В случае эмоционально-лексических шкал операция сравнения - это просто взятие разницы двух величин, а в случае категорий - разница средних, нормированная по стандартному отклонению. Как видим, все очень естественно и просто. Поэтому я больше не буду никому морочить голову, а перейду непосредственно к результатам.

Результаты

По эмоционально-лексическим оценкам получили следующие результаты:

Персона	Резюме
Березовский	Темпераментный, умный, деловой, практичный, пунктуальный, аккуратный, волевой, раскрепощенный
Гусинский	Активный, деловой, раскованный, невыдержанный, раздражительный, лицеменрный, лживый, лукавый, угодливый, непоследовательный
Ельцин	Энергичный, кололритный, волевой, вспыльчивый, капризный, лицемерный, жестокий
Лужков	Думающий, умный, непокорный, сильный, собранный, опытный, упрямый, деловой, яркий, но в то же время зловредный и вероломный
Примаков	Умный, образованный, яркий, самобытный, элегантный, замкнутый, недобросовестный, лицемерный и лукавый
Путин	Обязательный, добросовестный, честный, справедливый, дельный, взыскательный, волевой
сам Павловский	Добрый и сердечный

Показателем того, насколько эмоционально неравнодушен Павловскому тот или иной человек, может служить сумма абсолютных величин оценок по всем шкалам. При этом мы исходим из предположения, что чем более неравнодушны мы к человеку, тем более эмоционально нагруженные слова в отношении него употребляем. Результат на следующей диаграмме:

Получаем, что наиболее неравнодушен Павловский к Гусинскому и Лужкову Березовский, Примаков, Ельцин, Путин и сам Глеб Олегович . Наиболее терпимо он относится лишь к самому себе. Если вспомнить события последних лет, то результаты похожи на правду.

Сумму положительных категорных оценок можно интерпретировать как психологическую яркость личности в представлении Павловского.

На первом месте Лужков . Затем в порядке убывания идут Ельцин, Примаков, Путин, Гусинский , сам Павловский и в конце Березовский . Как видим, Лужков занимает устойчивое первое место в душе Павловского.

Маленькое расследование завершено. Теперь можно со спокойной совестью отправить присланные материалы в мусорную корзину и заняться более серьезными делами.

Добро пожаловать во второй урок из серии, посвященной ООП. В первой статье вы ознакомились с основами ООП в PHP, включая понятия классов, методов, полей и объектов. Также вы узнали, как создать простенький класс и реализовать его.

В данной статье вы узнаете еще больше о методах и полях класса. Это даст вам хорошую основу, для того чтобы приступить к изучению более профессиональных техник, таких как наследование.

Вот список того, о чем я расскажу вам в этой статье:

Конструкторы и деструкторы, которые позволяют назначить определенные действия объекту при его создании и удалении;
Статические поля и методы - это такие поля и методы, которые не связаны с конкретными объектами класса;
Константы класса, удобные для хранения фиксированных значений, относящихся к определенному классу;
Явное указание типа, используемое для задания ограничения типов параметров, которые можно передавать в тот или иной метод;
Специальные методы __get() и __set(), которые используются для задания и чтения значений полей классов;
Специальный метод __call(), применяемый для вызова метода класса.

Вы готовы? Тогда вперед!

Конструкторы и деструкторы

Иногда возникает необходимость выполнять какие-то действия одновременно с созданием объекта. Например, вам может понадобиться задать значения полям объекта сразу по его созданию, или же инициализировать их значениями из базы данных.

Подобно этому, вам также может понадобиться выполнять определенные действия по удалению объекта из памяти, например, удаление объектов, зависящих от удаляемого, закрытие соединения с базой данных или файлов.

На заметку: как удалить объект? PHP автоматически удаляет объект из памяти, когда не остается ни одной переменной, указывающей на него. Например, если вы создадите новый объект и сохраните его в переменной $myObject, а затем удалите ее с помощью метода unset($myObject), то сам объект также удалится. Также, если вы создали локальную переменную в какой-либо функции, она (вместе с объектом) удалится, когда функция завершит работу.

В PHP есть два специальных метода, которые можно применять для совершения определенных действий по созданию и удалению объектов:

Конструктор вызывается сразу после того, как вы создали объект;
Деструктор вызывается строго перед тем, как объект удаляется из памяти.

Работа с конструкторами

Применяйте конструкторы, чтобы задать действия, которые будут выполняться по созданию объекта класса. Эти действия могут включать инициализацию полей класса, открытие файлов, чтение данных.

Чтобы создать конструктор, добавьте в ваш класс специальный метод __construct() (перед словом construct - два символа подчеркивания). PHP автоматически вызовет этот метод при реализации вашего класса, то есть, при создании объекта этого класса.

Вот пример конструктора:

Class MyClass { public function __construct() { echo "I"ve just been created!"; } } $myObject = new MyClass(); // отобразит "I"ve just been created!"

В классе MyClass есть конструктор, который выводит на страницу строку "I"ve just been created!". Последняя строка кода создает новый объект класса MyClass. Когда это происходит, PHP автоматически вызывает конструктор, и сообщение отображается в браузере. Теперь на практике - инициализация полей класса:

Class Member { private $username; private $location; private $homepage; public function __construct($username, $location, $homepage) { $this->username = $username; $this->location = $location; $this->homepage = $homepage; } public function showProfile() { echo "

Username:: $this->username
Location:: $this->location
Homepage:: $this->homepage

"; } } $aMember = new Member("fred", "Chicago", "http://example.com/"); $aMember->showProfile();

Данный скрипт отобразит на странице следующее:

Username: fred Location: Chicago Homepage: http://example.com/

В нашем классе Member есть три поля и конструктор, который принимает в качестве параметров 3 значения - по одному для каждого поля. Конструктор назначит полям объекта значения, полученные в качестве аргументов. В классе также есть метод для отображения на странице значений полей объекта.

Затем в коде создается объект класса Member, в который мы передаем 3 значения "fred", "Chicago", и "http://example.com/", так как конструктор принимает именно 3 параметра. Конструктор записывает эти значения в поля созданного объекта. В завершение, вызывается метод showProfile() для созданного объекта, чтобы отобразить полученные значения.

Работа с деструкторами

Применяйте деструктор, когда объект удаляется из памяти. Вам может понадобиться сохранить объект в базе данных, закрыть открытые файлы, которые взаимодействовали с объектом. Чтобы создать деструктор, добавьте в класс метод __destruct(). Он вызовется как раз перед удалением объекта автоматически. Вот простой пример:

Class MyClass { public function __destruct() { echo "I"m about to disappear - bye bye!"; // (очистить память) } } $myObject = new MyClass(); unset($myObject); // отобразит "I"m about to disappear - bye bye!"

Мы создали простенький деструктор, который отображает на странице сообщение. Затем мы создали объект нашего класса и сразу же удалили его, вызвав метод unset() для переменной, которая ссылается на объект. Перед самым удалением объекта вызвался деструктор, который отобразил в браузере сообщение "I"m about to disappear - bye bye!".

На заметку: в отличие от конструкторов, в деструкторы нельзя передавать никакие параметры.

Деструктор также вызывается при выходе из скрипта, так как все объекты и переменные при выходе из метода удаляются. Так, следующий код также вызовет деструктор:

Class MyClass { public function __destruct() { echo "I"m about to disappear - bye bye!"; // (очистить память) } } $myObject = new MyClass(); exit; // отобразит "I"m about to disappear - bye bye!"

Также, если работа скрипта прекратится из-за возникшей ошибки, деструктор тоже вызовется.

На заметку: при создании объектов класса-наследника, конструкторы класса-родителя не вызываются автоматически. Вызывается только конструктор самого наследника. Тем не менее вы можете вызвать конструктор родителя из класса-наследника таким образом:

parent::__construct(). То же самое касается деструкторов. Вызвать деструктор родителя можно так: parent:__destruct(). Я расскажу вам о классах-родителях и наследниках в следующем уроке, посвященном наследованию.

Статические поля класса

Мы рассмотрели статические переменные в статье PHP Variable Scope: All You Need to Know. Как обычная локальная переменная, статическая переменная доступна только в пределах функции. Тем не менее, в отличие от обычных локальных, статические переменные сохраняют значения между вызовами функции.

Статические поля класса работают по такому же принципу. Статическое поле класса связано со своим классом, однако оно сохраняет свое значение на протяжении всей работы скрипта. Сравните это с обычными полями: они связаны с определенным объектом, и они теряются при удалении этого объекта.

Статические поля полезны в случаях, когда вам нужно хранить определенное значение, относящееся ко всему классу, а не к отдельному объекту. Они похожи на глобальные переменные класса.

Чтобы создать статическую переменную, добавьте ключевое слово static в ее задании:

Class MyClass { public static $myProperty; }

Вот пример того, как работают статические переменные:

Class Member { private $username; public static $numMembers = 0; public function __construct($username) { $this->username = $username; self::$numMembers++; } } echo Member::$numMembers . "
"; // отобразит "0" $aMember = new Member("fred"); echo Member::$numMembers . "
"; // отобразит "1" $anotherMember = new Member("mary"); echo Member::$numMembers . "
"; // отобразит "2"

Есть несколько интересных вещей, так что давайте разберем данный скрипт:

В классе Member два поля: частное поле $username и статическое $numMembers, которое изначально получает значение 0;
Конструктор получает в качестве параметра аргумент $username и устанавливает полю только что созданного объекта значение этого параметра. В то же время, он инкрементирует значение поля $numMembers, тем самым давая понять, что число объектов нашего класса увеличилось на 1.

Отметьте, что конструктор обращается к статическому полю так: self::$numMembers. Ключевое слово self похоже на $this, которое мы рассмотрели в прошлом уроке. Тогда как $this ссылается на текущий объект, self - на текущий класс. Также тогда как для получения доступа к полям и методам объекта вы используете ->, то в этом случае используйте:: для получения доступа к полям и методам класса.

В завершении скрипт создает несколько объектов класса Member и отображает на странице их количество, т.е. значение статической переменной $numMembers. Отметьте, что данная переменная сохраняет свое значение на протяжении всей работы скрипта, несмотря на объекты класса.

Итак, чтобы получить доступ к статическому полю класса, применяйте оператор::. Здесь мы не можем воспользоваться ключевым словом self, так как код находится за пределами класса, поэтому мы пишем имя класса, затем::, а затем имя поля (Member::$numMembers). В пределах конструктора тоже нужно использовать именно такую структуру, а не self.

На заметку: нашему скрипту ничего не стоило получить доступ к полю класса $numMembers перед тем, как создался первый объект данного класса. Нет необходимости создавать объекты класса для того, чтобы пользоваться его статическими полями.

Статические методы

Наряду со статическими полями класса, вы также можете создавать статические методы. Статические методы, так же как и поля, связаны с классом, но нет необходимости создавать объект класса, чтобы вызвать статический метод. Это делает такие методы полезными в случае, если вам нужен класс, который не оперирует реальными объектами.

Чтобы создать статический метод, нужно добавить в его объявлении ключевое слово static:

Class MyClass { public static function myMethod() { // (действия) } }

В нашем предыдущем примере, касающемся статических полей, было статическое поле $numMembers. Делать поля частными, а методы для доступа к ним - открытыми, - это хорошая практика. Давайте сделаем наше статическое поле частным и напишем статический метод public для получения значения данного поля:

Class Member { private $username; private static $numMembers = 0; public function __construct($username) { $this->username = $username; self::$numMembers++; } public static function getNumMembers() { return self::$numMembers; } } echo Member::getNumMembers() . "
"; // отобразит "0" $aMember = new Member("fred"); echo Member::getNumMembers() . "
"; // отобразит "1" $anotherMember = new Member("mary"); echo Member::getNumMembers() . "
"; // отобразит "2"

Здесь мы создали статический метод getNumMembers(), который возвращает значение статического поля $numMembers. Мы также сделали это поле частным, чтобы нельзя было получить его значение извне.

Мы также изменили код вызова, применив метод getNumMembers() для получения значения поля $numMembers. Отметьте, можно вызывать данный метод без того, чтобы создавать объект класса, потому что метод - статический.

Константы класса

Константы позволяют задать глобальное значение для всего вашего кода. Это значение фиксированное, оно не может быть изменено. Константы класса схожи с обычными константами. Основное их отличие заключается в том, что помимо того, что классовая константа глобальна, к ней можно получить доступ из класса, в котором она определена. Классовые константы полезны в случаях, когда вам нужно хранить определенные значения, которые относятся к определенному классу.

Определить классовую константу можно с помощью ключевого слова const. Например:

Class MyClass { const CONSTANT_NAME = value; }

Обратиться в последствии к классовой константе можно через имя класса и оператор::. Например, так:

MyClass::CONSTANT_NAME

На заметку: как и в случае со статическими полями и методами, вы можете обратиться к константе через ключевое слово self.

Давайте рассмотрим классовые константы на примере. Добавим в класс Member константы, в которых будут храниться значения их роли (участник, модератор или администратор). Применив константы вместо обычных численных значений, мы сделали код более читабельным. Вот скрипт:

Class Member { const MEMBER = 1; const MODERATOR = 2; const ADMINISTRATOR = 3; private $username; private $level; public function __construct($username, $level) { $this->username = $username; $this->level = $level; } public function getUsername() { return $this->username; } public function getLevel() { if ($this->level == self::MEMBER) return "a member"; if ($this->level == self::MODERATOR) return "a moderator"; if ($this->level == self::ADMINISTRATOR) return "an administrator"; return "unknown"; } } $aMember = new Member("fred", Member::MEMBER); $anotherMember = new Member("mary", Member::ADMINISTRATOR); echo $aMember->getUsername() . " is " . $aMember->getLevel() . "
"; // отобразит "fred is a member" echo $anotherMember->getUsername() . " is " . $anotherMember->getLevel() . "
"; // отобразит "mary is an administrator"

Мы создали три классовые константы: MEMBER, MODERATOR и ADMINISTRATOR, и задали им значения 1, 2 и 3 соответственно. Затем мы добавляем поле $level для хранения ролей и немного изменяем конструктор так, чтобы инициализировать еще и это поле. В классе также появился еще один метод - getLevel(), который возвращает определенное сообщение в зависимости от значения поля $level. Он сравнивает это значение с каждой из классовых констант и возвращает нужную строку.

Скрипт создает несколько объектов с разными ролями. Для задания объектам ролей используются именно классовые константы, а не простые численные значения. Затем идут вызовы методов getUsername() и getLevel() для каждого объекта, и результаты отображаются на странице.

Явное указание типов аргументов функций

В PHP можно не задавать типы данных, так что можно не переживать о том, какие аргументы вы передаете в методы. Например, вы можете спокойно передать в функцию strlen(), считающую длину строки, численное значение. PHP сперва переведет число в строку, а затем вернет ее длину:

Echo strlen(123); // отобразит"3"

Иногда явное указание типа полезно, но оно может привести к багам, с которыми трудно будет справиться, особенно в случае, если вы работаете с такими сложными типами данных, как объекты.

Например

Посмотрите на этот код:

Class Member { private $username; public function __construct($username) { $this->username = $username; } public function getUsername() { return $this->username; } } class Topic { private $member; private $subject; public function __construct($member, $subject) { $this->member = $member; $this->subject = $subject; } public function getUsername() { return $this->member->getUsername(); } } $aMember = new Member("fred"); $aTopic = new Topic($aMember, "Hello everybody!"); echo $aTopic->getUsername(); // отобразит "fred"

Данный скрипт работает так:

Мы создаем наш класс Member с полем $username, конструктором и методом getUsername();
Также создаем класс Topic для управления статьями форума. У него два поля: $member и $subject. $member - это объект класса Member, это будет автор статьи. Поле $subject - это тема статьи.
В классе Topic также содержится конструктор, который принимает объект класса Member и строку - тему статьи. Этими значениями он инициализирует поля класса. У него еще есть метод getUsername(), который возвращает имя участника форума. Это достигается через вызов метода getUsername() объекта Member.
В завершении создаем объект класса Member со значением поля username “fred”. Затем создаем объект класса Topic, передав ему Фреда и тему статьи “Hello everybody!”. В конце вызываем метод getUsername() класса Topic и отображаем на странице имя пользователя (“fred”).

Это все очень хорошо, но...

Давайте сделаем лучше!

Добавим этот фрагмент кода в конце:

Class Widget { private $colour; public function __construct($colour) { $this->colour = $colour; } public function getColour() { return $this->colour; } } $aWidget = new Widget("blue"); $anotherTopic = new Topic($aWidget, "Oops!"); // отобразит "Fatal error: Call to undefined method Widget::getUsername()" echo $anotherTopic->getUsername();

Здесь мы создаем класс Widget с полем $colour, конструктором и методом getColour(), который возвращает цвет виджета.

Затем мы создадим объект данного класса, а за ним объект Topic с аргументом $aWidget, когда на самом деле нужно передавать автора статьи, т.е. объект класса Member.

Теперь попытаемся вызвать метод getUsername() класса Topic. Этот метод обращается к методу getUsername() класса Widget. И так как в этом классе нет такого метода, мы получаем ошибку:

Fatal error: Call to undefined method Widget::getUsername()

Проблема в том, что причина ошибки не так легко уяснима. Почему объект Topic ищет метод в классе Widget, а не Member? В сложной иерархии классов будет очень сложно найти выход из такого рода ситуации.

Даем подсказку

Было бы лучше ограничить конструктор класса Topic на прием аргументов так, чтобы он мог принимать в качестве первого параметра объекты только класса Member, тем самым предостеречься от фатальных ошибок.

Это как раз то, чем занимается явное указание типов. Чтобы явно указать тип параметра, вставьте имя класса перед названием аргумента в объявлении метода:

Function myMethod(ClassName $object) { // (действия) }

Давайте подкорректируем конструктор класса Topic так, чтобы он принимал только Member:

Class Topic { private $member; private $subject; public function __construct(Member $member, $subject) { $this->member = $member; $this->subject = $subject; } public function getUsername() { return $this->member->getUsername(); } }

Теперь снова попытаемся создать объект Topic, передав ему Widget:

$aWidget = new Widget("blue"); $anotherTopic = new Topic($aWidget, "Oops!");

На этот раз PHP отобразит конкретную ошибку:

Catchable fatal error: Argument 1 passed to Topic::__construct() must be an instance of Member, instance of Widget given, called in script.php on line 55 and defined in script.php on line 24

С этой проблемой будет намного легче справиться, так как мы точно знаем, в чем именно заключается причина ошибки - мы попытались передать в конструктор параметр не того типа, который нужен. В сообщении об ошибке даже точно указаны строчки кода, где был вызван метод, ставший ее причиной.

Инициализация и чтение значений полей класса при помощи get() и set()

Как вы уже знаете, классы обычно содержат поля:

Class MyClass { public $aProperty; public $anotherProperty; }

Если поля класса - public, вы можете получить к ним доступ с помощью оператора ->:

$myObject = new MyClass; $myObject->aProperty = "hello";

Тем не менее, PHP позволяет создавать “виртуальные” поля, которых на самом деле нет в классе, но к которым можно получить доступ через оператор ->. Они могут быть полезны в таких случаях:

Когда у вас очень много полей, и вы хотите создать для них массив, чтобы не объявлять каждое поле отдельно;
Когда вам нужно хранить поле за пределами объекта, например, в другом объекте, или даже в файле или базе данных;
Когда вам нужно вычислять значения полей “на лету”, а не хранить их значения где-либо.

Чтобы создать такие “виртуальные” поля, нужно добавить в класс парочку волшебных методов:

__get($propName) вызывается автоматически при попытке прочитать значение “невидимого” поля $propName;
__set($propName,$propValue) вызывается автоматически при попытке задать “невидимому” полю $propName значение $propValue.

“Невидимый” в данном контексте значит, что на данном участке кода нельзя прямо получить доступ к данным полям. Например, если такого поля вообще нет в классе, или если оно существует, но оно частное, и за пределами класса нет доступа к такому полю.

Перейдем к практике. Изменим наш класс Member так, чтобы в дополнение полю $username были еще и другие случайные поля, которые будут храниться в массиве $data:

Class Member { private $username; private $data = array(); public function __get($property) { if ($property == "username") { return $this->username; } else { if (array_key_exists($property, $this->data)) { return $this->data[$property]; } else { return null; } } } public function __set($property, $value) { if ($property == "username") { $this->username = $value; } else { $this->data[$property] = $value; } } } $aMember = new Member(); $aMember->username = "fred"; $aMember->location = "San Francisco"; echo $aMember->username . "
"; // отобразит "fred" echo $aMember->location . "
"; // отобразит "San Francisco"

Вот, как это работает:

В классе Member есть постоянное поле private $username и private массив $data для хранения случайных “виртуальных” полей;
Метод __get() принимает единственный параметр $property - имя поля, значение которого нужно вернуть. Если $property = “username”, то метод вернет значение поля $username. В другом случае, метод проверит, встречается ли такой $property в ключах массива $data. Если найдется такой ключ, он вернет значение данного поля, в противном случае - null.
Метод __set() принимает 2 параметра: $property - имя поля, которое нужно инициализировать, и $value - значение, которое нужно задать данному полю. Если $property = “username”, метод инициализирует поле $username значением из параметра $value. В противном случае, добавляет в массив $data ключ $property со значением $value.
После создания класса Member, создаем объект этого класса и инициализируем его поле $username значением “fred”. Это вызывает метод __set(), который задаст значение $username объекту. Затем устанавливаем значение поля $location в “San Francisco”. Так как такого поля не существует в объекте, метод записывает его в массив $data.
В конце, достаем значения $username и $location и выводим их на страницу. Метод __get() достает действительное значение $username из существующего поля $username, а значение $location - из массива $data.

Как видите, с помощью методов __get() и __set() мы создали класс, в котором могут быть как настоящие поля, так и любые “виртуальные”. Из фрагмента кода, где задается значение тому или иному полю, не обязательно знать, существует ли такое поле или нет в объекте. Через обычный оператор -> можно задать полю значение или прочитать его.

В примере также показано, как можно легко создать методы, называемые “геттерами” и “сеттерами”, для доступа к частным полям. Нам не нужно создавать отдельные методы getUsername() и setUsername() для получения доступа к частному полю $username. Вместо этого мы создали методы __get() и __set() для манипулирования данным полем. Это значит, что нам нужно всего 2 метода в общем, а не по 2 метода для каждого частного поля.

На заметку: Слово о инкапсуляции. Использование частных полей класса в комбинации с геттерами и сеттерами - это лучше, чем использование переменных public. Геттеры и сеттеры дополнительно могут обрабатывать данные, задаваемые полям объекта и получаемые из них, например, проверять, в правильном ли формате находится значение, или конвертировать его в нужный формат. Геттеры и сеттеры также скрывают детали того, как имплементируются поля класса, что упрощает процесс модификации внутренней части класса, так как не нужно переписывать код, который оперирует объектами данного класса. Например, вы вдруг захотели хранить значение поля в базе данных. Если у вас уже были геттеры и сеттеры, все, что вам нужно, - это переписать их. А вызывающий код останется таким же. Эта техника называется инкапсуляцией, и это одно из главных преимуществ ООП.

Перегрузка методов с помощью __call()

Геттеры и сеттеры используются для запрета на доступ к частным переменным. В этом же направлении используется метод __call() для запрета доступа к частным методам. Как только из кода вызывается метод класса, который либо не существует, либо он недоступен, автоматически вызывается метод __call(). Вот общий синтаксис метода:

Public function __call($methodName, $arguments) { // (действия) }

Когда производится попытка вызвать недоступный метод класса, PHP автоматически вызывает метод __call(), в который передает строку - имя вызываемого метода и список передаваемых параметров в массиве. Затем ваш метод __call() должен будет определенным способом обработать вызов и, в случае необходимости, вернуть значения.

Метод __call() полезен в ситуациях, когда вам нужно передать некую функциональность класса другому классу. Вот простой пример:

Class Member { private $username; public function __construct($username) { $this->username = $username; } public function getUsername() { return $this->username; } } class Topic { private $member; private $subject; public function __construct($member, $subject) { $this->member = $member; $this->subject = $subject; } public function getSubject() { return $this->subject; } public function __call($method, $arguments) { return $this->member->$method($arguments); } } $aMember = new Member("fred"); $aTopic = new Topic($aMember, "Hello everybody!"); echo $aTopic->getSubject() . "
"; // отобразит "Hello everybody!" echo $aTopic->getUsername() . "
"; // отобразит "fred"

Данный пример похож на тот, что приводился в разделе о явном указании типов. У нас есть класс Member с полем $username и класс Topic с полем - объектом класса Member (автор статьи) и полем $subject - темой статьи. Класс Topic содержит метод getSubject() для получения темы статьи, но в нем нет метода, который возвращал бы имя автора статьи. Вместо него в нем есть метод __call(), который вызывает несуществующий метод и передает аргументы методу класса Member.

Когда в коде вызывается метод $aTopic->getUsername(), PHP понимает, что такого метода в классе Topic не существует. Поэтому вызывается метод __call(), который в свою очередь, вызывает метод getUsername() класса Member. Этот метод возвращает имя автора методу __call(), а тот отправляет полученное значение вызывающему коду.

На заметку: в PHP есть и другие методы, касающиеся перегрузки, например, __isset(), __unset(), и __callStatic().

Заключение

В этом уроке вы углубили свои знания по ООП в PHP, рассмотрев более детально поля и методы. Вы изучили:

Конструкторы и деструкторы, полезные для инициализации полей и очистки памяти после удаления объектов;
Статические поля и методы, которые работают на уровне класса, а не на уровне объекта;
Классовые константы, полезные для хранения фиксированных значений, необходимых на уровне класса;
Явное указание типов, с помощью которого можно лимитировать типы аргументов, передаваемых в метод;
Волшебные методы __get(), __set() и __call(), которые служат для получения доступа к частным полям и методам класса. Реализация этих методов позволяет вам создавать “виртуальные” поля и методы, которые не существуют в классе, но в то же время, могут быть вызваны.

Со знаниями, полученными в этом и предыдущем уроках, вы можете начать писать на ООП. Но на этом все только начинается! В следующем уроке мы поговорим о силе ООП - способности классов наследовать функциональность от других классов.

Удачного программирования!