RetailCRM-Mirror/NameCaseLib
1
0
Fork 0
mirror of https://github.com/retailcrm/NameCaseLib.git synced 2024-12-05 03:16:06 +03:00
Code Issues Projects Releases Wiki Activity
master
NameCaseLib/Docs/default/NCLNameCaseWord.html
Andriy Chaika bc6b3f5e6a [0.4] -> [0.4.1]
2011-07-11 20:56:11 +03:00

467 lines
16 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class NCLNameCaseWord</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class NCLNameCaseWord</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">NCLNameCaseWord - класс, который служит для хранения всей информации о каждом слове</p>
<ul class="tags">
<li><span class="field">author:</span> Андрей Чайка &lt;<a href="mailto:bymer3@gmail.com">bymer3@gmail.com</a>&gt;</li>
<li><span class="field">version:</span> 0.4.1</li>
</ul>
<p class="notes">
Located in <a class="field" href="_NCL---NCLNameCaseWord.php.html">/NCL/NCLNameCaseWord.php</a> (line <span class="field">8</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">NCLNameCaseWord</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$word</span>)
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#gender" title="details" class="method-name">gender</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getGender" title="details" class="method-name">getGender</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#getNameCases" title="details" class="method-name">getNameCases</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getNamePart" title="details" class="method-name">getNamePart</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#getWord" title="details" class="method-name">getWord</a>
()
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#isGenderSolved" title="details" class="method-name">isGenderSolved</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setGender" title="details" class="method-name">setGender</a>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$man</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$woman</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setNameCases" title="details" class="method-name">setNameCases</a>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$nameCases</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setNamePart" title="details" class="method-name">setNamePart</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$namePart</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setRule" title="details" class="method-name">setRule</a>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$ruleID</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setTrueGender" title="details" class="method-name">setTrueGender</a>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$gender</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">79</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Создание нового обьекта со словом <var>$word</var></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">NCLNameCaseWord</span>
<span class="method-name">
__construct
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$word</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$word</span><span class="var-description">: слово</span> </li>
</ul>
</div>
<a name="methodgender" id="gender"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">gender</span> (line <span class="line-number">172</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Расчитывает и возвращает пол текущего слова</p>
<ul class="tags">
<li><span class="field">return:</span> пол текущего слова</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
gender
</span>
()
</div>
</div>
<a name="methodgetGender" id="getGender"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getGender</span> (line <span class="line-number">215</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Возвращает массив вероятности того, что даное слово является мужчиной или женщиной</p>
<ul class="tags">
<li><span class="field">return:</span> массив вероятностей</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getGender
</span>
()
</div>
</div>
<a name="methodgetNameCases" id="getNameCases"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getNameCases</span> (line <span class="line-number">163</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Возвращает массив со всеми падежами текущего слова</p>
<ul class="tags">
<li><span class="field">return:</span> массив со всеми падежами</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
getNameCases
</span>
()
</div>
</div>
<a name="methodgetNamePart" id="getNamePart"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getNamePart</span> (line <span class="line-number">241</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Возвращает тип текущего слова</p>
<p class="description"><p><strong>Тип слова:</strong> <ul><li>S - Фамилия</li><li>N - Имя</li><li>F - Отчество</li></ul></p></p>
<ul class="tags">
<li><span class="field">return:</span> тип слова</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getNamePart
</span>
()
</div>
</div>
<a name="methodgetWord" id="getWord"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getWord</span> (line <span class="line-number">250</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Возвращает текущее слово.</p>
<ul class="tags">
<li><span class="field">return:</span> текущее слово</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
getWord
</span>
()
</div>
</div>
<a name="methodisGenderSolved" id="isGenderSolved"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">isGenderSolved</span> (line <span class="line-number">260</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Если уже был расчитан пол для всех слов системы, тогда каждому слову предается окончательное решение. Эта функция определяет было ли принято окончательное решение.</p>
<ul class="tags">
<li><span class="field">return:</span> было ли принято окончательное решение по поводу пола текущего слова</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
isGenderSolved
</span>
()
</div>
</div>
<a name="methodsetGender" id="setGender"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setGender</span> (line <span class="line-number">193</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Устанавливает вероятности того, что даное слово является мужчиной или женщиной</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setGender
</span>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$man</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$woman</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$man</span><span class="var-description">: вероятность того, что слово мужчина</span> </li>
<li>
<span class="var-type">int</span>
<span class="var-name">$woman</span><span class="var-description">: верятность того, что слово женщина</span> </li>
</ul>
</div>
<a name="methodsetNameCases" id="setNameCases"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setNameCases</span> (line <span class="line-number">153</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Сохраняет результат склонения текущего слова</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setNameCases
</span>
(<span class="var-type">array</span>&nbsp;<span class="var-name">$nameCases</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$nameCases</span><span class="var-description">: массив со всеми падежами</span> </li>
</ul>
</div>
<a name="methodsetNamePart" id="setNamePart"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setNamePart</span> (line <span class="line-number">228</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Устанавливает тип текущего слова</p>
<p class="description"><p><strong>Тип слова:</strong> <ul><li>S - Фамилия</li><li>N - Имя</li><li>F - Отчество</li></ul></p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setNamePart
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$namePart</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$namePart</span><span class="var-description">: тип слова</span> </li>
</ul>
</div>
<a name="methodsetRule" id="setRule"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setRule</span> (line <span class="line-number">269</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Устанавливает номер правила по которому склонялось текущее слово.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setRule
</span>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$ruleID</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$ruleID</span><span class="var-description">: номер правила</span> </li>
</ul>
</div>
<a name="methodsetTrueGender" id="setTrueGender"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setTrueGender</span> (line <span class="line-number">206</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Окончательно устанавливает пол человека</p>
<p class="description"><p><ul><li>0 - не определено</li><li>NCL::$MAN - мужчина</li><li>NCL::$WOMAN - женщина</li></ul></p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setTrueGender
</span>
(<span class="var-type">int</span>&nbsp;<span class="var-name">$gender</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">int</span>
<span class="var-name">$gender</span><span class="var-description">: пол человека</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 06 Jul 2011 13:46:18 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
Reference in New Issue View Git Blame Copy Permalink