mago-analyzer 1.21.0

A PHP static analyzer that can detect type errors in PHP code, and provide suggestions for fixing them.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! `random_bytes()` return type provider.

use mago_codex::ttype::get_empty_string;
use mago_codex::ttype::get_non_empty_string;
use mago_codex::ttype::union::TUnion;

use crate::plugin::context::InvocationInfo;
use crate::plugin::context::ProviderContext;
use crate::plugin::provider::Provider;
use crate::plugin::provider::ProviderMeta;
use crate::plugin::provider::function::FunctionReturnTypeProvider;
use crate::plugin::provider::function::FunctionTarget;

static META: ProviderMeta =
    ProviderMeta::new("php::random::random_bytes", "random_bytes", "Returns non-empty-string when length > 0");

/// Provider for the `random_bytes()` function.
///
/// Returns `non-empty-string` when the length argument is > 0.
#[derive(Default)]
pub struct RandomBytesProvider;

impl Provider for RandomBytesProvider {
    fn meta() -> &'static ProviderMeta {
        &META
    }
}

impl FunctionReturnTypeProvider for RandomBytesProvider {
    fn targets() -> FunctionTarget {
        FunctionTarget::Exact("random_bytes")
    }

    fn get_return_type(
        &self,
        context: &ProviderContext<'_, '_, '_>,
        invocation: &InvocationInfo<'_, '_, '_>,
    ) -> Option<TUnion> {
        let length_argument = invocation.get_argument(0, &["length"])?;
        let length_argument_type = context.get_expression_type(length_argument)?;
        let length_argument_integer = length_argument_type.get_single_int()?;
        let minimum_value = length_argument_integer.get_minimum_value()?;

        Some(if minimum_value > 0 { get_non_empty_string() } else { get_empty_string() })
    }
}